在VSCode中添加KBEngine代码提示

1、下载KBEngine 提供的 tips 代码提示包

可以参考这篇文章的中的下载地址https://blog.csdn.net/qq_36064018/article/details/114739793
或者github:https://github.com/likecg2010/KBEngine-Python-Tips
下载完毕之后,将tips文件夹放到该路径下:python安装目录/Lib
image

2、安装VSCode插件

必须安:Pylance、Python
可能要安:C/C++

3、配置代码提示

  1. 创建一个新的VSCode工作区, 将kbengine的服务器资源目录(点击new_assets.bat生成的目录,我这里是叫get_started_assets)中的scripts文件夹中的logger、login、base、bots、cell、common、db、interface目录移动到该工作区中,保证它们都是该工作区中的根目录
    image

  2. 下面为logger、login、base、bots、cell、common、db、interface目录,各自进行配置,以logger为例子:
    ctrl + shift + p输入Python:Select Interpreter选择python解释器,我们现在为logger进行配置,因此选择下图中的logger选项
    image

  3. 选择创建虚拟环境,给logger单独创建一个虚拟环境
    image

  4. 勾选logger,并点击确定
    image

  5. 选择venv
    image

  6. 选择虚拟环境需要的python解释器,据说python版本要3.8以上,这里的python版本是3.13
    image

  7. 这里还是不要起名字了,直接回车,不然会影响到客户端SDK生成
    image

  8. 最后这步选择Skip package installation
    image

  9. 创建成功之后,在logger目录下就会生成.vscodeKBEngine_Logger.venv这两个目录,打开.vscode/settings.json,添加如下语句,让vscode找到代码提示包在哪里

	"python.analysis.extraPaths": [
        "python安装目录/Lib/tips/logger"
    ]

image

logger、login、base、bots、cell、common、db、interface这些目录与tips中的各个目录对应关系如下:

服务资源目录 tips文件夹
logger logger
login loginapp
base baseapp
bots bots
cell cellapp
common common
db dbmgr
interface interfaces
  1. 重复上述步骤,为logger、login、base、bots、cell、common、db、interface全部配置即可,唯一需要注意的是"python.analysis.extraPaths"中的路径各个文件夹不同,参考上表的对照关系即可

  2. 测试下代码提示效果,打开logger/kbemain.py文件,输入KBEngine.,出现代码提示,非常成功。注意:tips/common文件夹下是没有KBEngine文件的,因此在common目录下输入KBEngine.没有代码提示是正常的
    image

4、配置子工作区域

当使用另一个工作区打开服务器资源目录/scripts,发现刚才配置的代码提示失效了,我们需要配置一下,让子目录的.vscode/setting.json覆盖掉根目录的.vscode/setting.json

用文本方式打开工作区文件,找到"folders",添加如下值,注意"path"要替换成你自己的路径,保存之后,重新打开工作区,发现代码提示生效

"folders": [
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts", 
			"name": "MainProject"
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/base"},
			"name": BaseModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/bots"},
			"name": BotsModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/cell"},
			"name": CellModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/common"},
			"name": CommonModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/db"},
			"name": DbModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/interface"},
			"name": InterfaceModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/logger"},
			"name": LoggerModule
		},
		{
			"path": "../../../kbengine-2.5.12/get_started_assets/scripts/login"},
			"name": LoginModule
		},


	],
posted @ 2025-07-26 18:00  HithertoUnknown  阅读(35)  评论(0)    收藏  举报