用于VS代码的Python扩展是高度可配置的。此页面介绍了可以使用的关键设置。
请参阅用户和工作区设置，以了解有关在VS代码中使用设置的更多信息。
常规设置
| 设置 | 默认 | 描述 |
|---|---|---|
| python.pythonPath | "python" |
python解释器的路径，或包含Python解释器的文件夹的路径。可以使用${workspaceFolder}和等变量${workspaceFolder}/.venv。使用文件夹的路径允许使用项目的任何人.venv根据其操作系统在文件夹中创建环境，而不必指定精确的平台相关路径。 |
| python.disableInstallationCheck | false |
如果设置为true，如果未安装Python解释器，则禁用来自扩展的警告。在macOS上，如果您使用的是OS安装的Python解释器，也会禁用出现的警告。通常建议在macOS上安装一个单独的解释器。 |
| python.venvPath | "" |
包含虚拟环境的文件夹的路径，其中扩展名在第一级子文件夹中查找虚拟环境。值的示例：${workspaceFolder}/.pyenv，${workspaceFolder}\venv，.envs，~/.virtualenvs，等等，在这种情况下该文件夹可能具有直接的子文件夹，例如env，env2，ds_analysis_env，等等，它们本身虚拟环境。 |
| python.envFile | "${workspaceFolder}/.env" |
包含环境变量定义的文件的绝对路径。请参阅配置Python环境 - 环境变量定义文件。 |
| python.globalModuleInstallation | false |
指定是仅使用--user命令行参数（缺省值）为当前用户安装软件包，还是为全局环境中的所有用户安装（设置为时true）。使用虚拟环境时忽略。有关--user参数的更多信息，请参阅pip - 用户安装。 |
| python.terminal.launchArgs | [] |
在运行文件时给定Python解释器启动参数，其中由空格分隔的每个顶级元素是列表中的单独项。 |
| python.terminal.executeInFileDir | false |
指示是否在文件目录中运行文件而不是当前文件夹。 |
| python.terminal.activateEnvironment | true |
指示在使用Python时是否激活选定的虚拟环境或conda环境：创建终端命令或涉及终端的任何其他操作，例如“ 将Python文件发送到终端”菜单命令。如果false，在运行命令之前跳过激活虚拟环境和conda环境。 |
| python.jediEnabled | '真正' | 指示是使用Jedi作为IntelliSense引擎（true）还是Microsoft Python语言服务器（false）。 |
| python.jediPath | "" |
包含Jedi库的文件夹的路径（文件夹应包含jedi子文件夹）。 |
| python.jediMemoryLimit | 0 | Jedi完成引擎的内存限制，以兆字节为单位。零（默认值）表示1024MB。-1禁用内存限制检查。 |
工作区符号（标签）设置
工作区符号是ctags工具生成的C源代码中的符号（在Wikipedia和ctags.sourceforge.net上描述）。引用维基百科，ctags“生成在各种编程语言的源文件和头文件中找到的名称的索引（或标记）文件。” 在Python方面，ctags可以更容易地跳转到C / C ++扩展模块中定义的函数和其他符号。
| 设置 （python.workspaceSymbols。） | 默认 | 描述 |
|---|---|---|
| tagFilePath | "${workspaceFolder}/.vscode/tags" |
标记文件的完全限定路径（一个充满活力的ctag文件），用于提供工作空间符号。 |
| 启用 | true |
指定是否启用工作空间符号提供程序。 |
| rebuildOnStart | true |
指定是否在start时重新构建标记文件。 |
| rebuildOnFileSave | true |
指定在保存Python文件时是否重新构建标记文件。 |
| ctagsPath | "ctags" |
ctags可执行文件的完全限定路径; 默认值假定它在当前环境中。 |
| exclusionPatterns | ["**/site-packages/**"] |
用于从ctags中排除文件和文件夹的模式。 |
自动完成设置
| 设置 （python.autoComplete。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| addBrackets | false |
指定VS代码()在自动填充函数名称时是否自动添加括号（）。 |
编辑 |
| preloadModules | [] |
指定要预加载的模块以提高自动完成性能。 | 编辑 |
| extraPaths | [] |
指定要为其加载自动填充数据的其他包的位置。 | 编辑 |
格式化设置
| 设置 （python.formatting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| 提供商 | "autopep8" |
指定要使用的格式化程序，“autopep8”，“black”或“yapf”。 | 编辑 - 格式化 |
| autopep8Path | "autopep8" |
autopep8的路径 | 编辑 - 格式化 |
| autopep8Args | [] |
autopep8的参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 编辑 - 格式化 |
| blackPath | "black" |
黑色的路径 | 编辑 - 格式化 |
| blackArgs | [] |
黑色的参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 编辑 - 格式化 |
| yapfPath | "yapf" |
yapf的路径 | 编辑 - 格式化 |
| yapfArgs | [] |
yapf的参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 编辑 - 格式化 |
重构 - 排序导入设置
| 设置 （python.sortImports。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| 路径 | "" |
isort脚本的路径 | 编辑 - 重构 - 对进口进行排序 |
| ARGS | [] |
isort的参数，每个参数作为数组中的单独项。 | 编辑 - 重构 - 对进口进行排序 |
Linting设置
一般
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| 启用 | true |
指定是否一般启用linting。 | 掉毛 |
| lintOnSave | true |
指定保存文件时是否排队。 | 掉毛 |
| maxNumberOfProblems | 100 |
限制显示的linting消息数。 | 掉毛 |
| ignorePatterns | [".vscode/*.py", "**/site-packages/**/*.py"] |
排除文件和文件夹模式。 | 掉毛 |
pylint的
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| pylintEnabled | true |
指定是否启用Pylint。 | 掉毛 |
| pylintArgs | [] |
Pylint的其他参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| python.linting.pylintUseMinimalCheckers | true |
指定是否使用pylintArgs的默认值。 | 掉毛 |
| pylintPath | "pylint" |
Pylint的路径。 | 掉毛 |
| pylintCategorySeverity.convention | "Information" |
将Pylint约定消息映射到VS代码类型。 | 掉毛 |
| pylintCategorySeverity.refactor | "Hint" |
将Pylint重构消息映射到VS代码类型。 | 掉毛 |
| pylintCategorySeverity.warning | "Warning" |
将Pylint警告消息映射到VS代码类型。 | 掉毛 |
| pylintCategorySeverity.error | "Error" |
将Pylint错误消息映射到VS代码类型。 | 掉毛 |
| pylintCategorySeverity.fatal | "Error" |
将Pylint致命消息映射到VS代码类型。 | 掉毛 |
PEP8 / pycodestyle
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| pep8Enabled | false |
指定是否启用pep8。 | 掉毛 |
| pep8Args | [] |
pep8的其他参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| pep8Path | "pep8" |
pep8的路径。 | 掉毛 |
| pep8CategorySeverity.W | "Warning" |
将pep8 W消息映射到VS代码类型。 | 掉毛 |
| pep8CategorySeverity.E | "Error" |
将pep8 E消息映射到VS代码类型。 | 掉毛 |
Flake8
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| flake8Enabled | false |
指定是否启用flake8。 | 掉毛 |
| flake8Args | [] |
flake8的其他参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| flake8Path | "flake8" |
片状路径8。 | 掉毛 |
| flake8CategorySeverity.F | "Error" |
将flake8 F消息映射到VS Code类型。 | 掉毛 |
| flake8CategorySeverity.E | "Error" |
将flake8 E消息映射到VS代码类型。 | 掉毛 |
| flake8CategorySeverity.W | "Warning" |
将flake8 W消息映射到VS代码类型。 | 掉毛 |
mypy
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| mypyEnabled | false |
指定是否启用mypy。 | 掉毛 |
| mypyArgs | ["--ignore-missing-imports", "--follow-imports=silent"] |
mypy的其他参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| mypyPath | "mypy" |
mypy的路径。 | 掉毛 |
| mypyCategorySeverity.error | "Error" |
将mypy错误消息映射到VS代码类型。 | 掉毛 |
| mypyCategorySeverity.note | "Information" |
将mypy note消息映射到VS Code类型。 | 掉毛 |
pydocstyle
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| pydocstyleEnabled | false |
指定是否启用pydocstyle。 | 掉毛 |
| pydocstyleArgs | [] |
pydocstyle的附加参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| pydocstylePath | "pydocstyle" |
pydocstyle的路径。 | 掉毛 |
采矿者
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| prospectorEnabled | false |
指定是否启用prospector。 | 掉毛 |
| prospectorArgs | [] |
prospector的其他参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| prospectorPath | "prospector" |
探矿者之路。 | 掉毛 |
pylama
| 设置 （python.linting。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| pylamaEnabled | false |
指定是否启用pylama。 | 掉毛 |
| pylamaArgs | [] |
pylama的附加参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 掉毛 |
| pylamaPath | "pylama" |
pylama的路径。 | 掉毛 |
单元测试设置
UnitTest框架
| 设置 （python.unitTest。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| unittestEnabled | false |
指定是否为单元测试启用UnitTest。 | 单元测试 |
| unittestArgs | ["-v", "-s", ".", "-p", "*test*.py"] |
传递给unittest的参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 单元测试 |
| CWD | 空值 | 指定单元测试的可选工作目录。 | |
| outputWindow | "Python Test Log" |
用于单元测试输出的窗口。 | 单元测试 |
| promptToConfigure | true |
指定VS代码是否在发现潜在测试时提示配置测试框架。 | 单元测试 |
| DEBUGPORT | 3000 |
用于调试UnitTest测试的端口号。 | 单元测试 |
| autoTestDiscoverOnSaveEnabled | true |
指定在保存单元测试文件时是启用还是禁用自动运行测试发现。 |
PyTest框架
| 设置 （python.unitTest。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| pyTestEnabled | false |
指定是否为单元测试启用pytest。 | 单元测试 |
| pyTestPath | "py.test" |
pytest的路径。如果pytest位于当前环境之外，请使用完整路径。 | 单元测试 |
| pyTestArgs | [] |
传递给PyTest的参数，其中由空格分隔的每个顶级元素是列表中的单独项。在使用pytest-cov安装调试单元测试时，请包含--no-cov在这些参数中。 |
单元测试 |
鼻子框架
| 设置 （python.unitTest。） | 默认 | 描述 | 也可以看看 |
|---|---|---|---|
| nosetestsEnabled | false |
指定是否为单元测试启用Nose。 | 单元测试 |
| nosetestPath | "nosetests" |
鼻子的路径。如果PyTest位于当前环境之外，请使用完整路径。 | 单元测试 |
| nosetestArgs | [] |
传递给Nose的参数，其中由空格分隔的每个顶级元素是列表中的单独项。 | 单元测试 |