华为云用户手册

检查暂停的程序 当您启动调试会话时，“运行和调试”视图将自动打开并显示与运行和调试相关的所有信息。要手动打开“运行和调试”视图，请单击CodeArts IDE底部面板中的“运行和调试”按钮（），或按 “Ctrl+Shift+D” / “Shift+Alt+F9”（IDEA快捷键）/ “Alt+5”（IDEA快捷键）/ “Ctrl +Shift+F8”（IDEA快捷键）。 “运行和调试”视图包含以下部分： 变量 调用堆栈 检视 断点 要自定义“运行和调试”视图内容，请单击右上角的“视图和更多操作”按钮（），然后在上下文菜单中勾选要显示的部分。或者可以右键单击“运行和调试”视图中任意部分的标题栏，然后在上下文菜单中选择。 检查变量 检查调用堆栈 监视 断点 父主题： 调试

将测试框架集成到项目中 在您的项目中启动测试框架集成： 单击CodeArts IDE底部的“测试“（）按钮来打开测试视图。 在测试视图中，单击“Configure Python Tests“按钮。 在弹出的窗口中选择测试框架来启动对应集成。 如果您选择“pytest“，Codearts会根据pytest的测试识别规范自动发现测试用例。 如果您选择“unlttest“，您需要执行以下步骤来识别测试用例。 在打开的对话框中，选择包含测试源文件的项目文件夹。 在接着打开的对话框中，选择用于识别您的测试文件的文件通配符模式。 测试框架集成配置完成后，CodeArts IDE会在测试视图中展示发现的测试用例。 父主题： 测试

unittest 使用该启动配置来运行unittest测试。 要在没有手动创建启动配置的时候快速运行 unittest 测试，请在测试文件的代码编辑器中，单击测试类声明旁边的“全部运行”按钮（）（以运行类中的所有测试），或测试方法旁边的“运行方法”按钮（）（仅运行单个测试）。 CodeArts IDE会自动创建相应的unittest启动配置并将其显示在配置列表中。 从启动配置中包含/排除测试 启动配置属性 启动配置示例 父主题： 启动配置

异常断点 CodeArts IDE调试器支持异常断点，每当抛出异常时，都会暂停程序执行。异常断点是应用于全局的，不需要特定的源代码引用。 单击CodeArts IDE底部面板中的“运行和调试”按钮（），或按下 “Ctrl+Shift+D” / “Shift+Alt+F9”（IDEA快捷键） / “Alt+5”（IDEA快捷键） / “Ctrl+Shift+F8”（IDEA快捷键）来打开“运行和调试”视图。 展开“断点”部分，并勾选你想要设置的异常断点旁边的复选框。 CodeArts IDE提供了几种类型的异常断点，这些断点定义了抛出时会导致程序执行暂停的特定异常。 抛出异常：任何抛出的异常，无论是否被捕获。 未捕获的异常：任何被抛出且未被捕获的异常。 用户未捕获的异常：源自用户代码（而非库）的任何未捕获异常。 父主题： 设置断点

简介 CodeArts IDE带有Python扩展，为Pytho语言提供了广泛的支持。Python扩展可以利用CodeArts IDE的代码补全、验证、调试和单元测试等特性，与多种Python解释器协同工作，轻松切换包括虚拟环境和conda环境的Python环境。 本文简要概述了CodeArts IDE中为Python提供的特性。您可以在以下主题了解更多关于特定特性的信息。 开始Python工程 在CodeArts IDE中构建Python环境 编辑Python源代码 在CodeArts IDE中浏览代码 搜索代码 代码校验 在CodeArts IDE中测试Python代码 调试 启动配置 安装Python 新建Python项目 使用代码提示 浏览代码 运行代码 调试代码 安装依赖 测试代码 父主题： Python

指定项目环境 在命令面板（“Ctrl+Ctrl”/“Ctrl+Shift+P”）中，搜索并运行“Python: 选择解释器”命令，或者单击状态栏右侧的按钮。 在“选择解释器“对话框中选择“创建环境“。 在创建环境的过程中，CodeArts IDE会自动安装列在requirements.txt文件中的项目依赖。如果有复数requirements.txt文件，那么在打开的对话框中，可以勾选想要安装的依赖旁的复选框，然后单击“下一步”。 在打开的“创建虚拟环境“对话框中，选择需要应用的环境创建选项。 在“环境位置“中选择环境新建的目标路径，可以选择项目路径、默认虚拟环境路径或是任意路径。单击浏览按钮（）手动指定路径。 在”基础解释器”列表中选择一个已安装的Python解释器，或者单击浏览按钮（）来手动指定解释器路径。 勾选“继承全局site-packages”会将全局Python中可用的所有包安装到创建的虚拟环境中。 勾选“安装pytest”将会安装pytest包。有关Python代码测试的详细信息，参阅“Python测试”相关文档。 单击“创建”。CodeArts IDE将在指定的文件夹中创建一个新的环境，并将其设置为项目的解释器。该环境将包含全局Python解释器的一个副本，并且特定于项目（安装到该环境中的所有包只应用于项目内部）。 父主题： 使用Python环境

启动配置示例 以下是一个可运行的启动配置示例。 { "request": "launch", "console": "integratedTerminal", "jinja": true, "python": "${command:python.interpreterPath}", "stopOnEntry": false, "redirectOutput": true, "module": "example.py", "env": {}, "type": "python", "logToFile": false, "args": [], "cwd": "${workspaceFolder}", "subProcess": false, "justMyCode": true, "pythonArgs": [], "name": "Python: Module", "showReturnValue": true } 父主题： Python模块

开始工程 在CodeArts IDE中打开带有“py”源代码的任意文件夹即可将其作为Python项目开始工程。此外，CodeArts IDE还提供了Python项目向导，帮助简化创建新项目和配置环境的过程。为了在CodeArts IDE中获得完整的编码支持和其他Python相关功能，您需要为项目指定一个解释器。 您的Python项目的内容会显示在资源管理器视图中（“Ctrl+Shift+E”/“Alt+1”（IDEA快捷键））中，该视图提供了常见的文件管理功能。 管理Python项目 父主题： Python

动态启动配置 您可以通过在“资源管理器”或代码编辑器中右键单击任意Python文件，并从上下文菜单中选择“在终端中运行 Python 文件”来运行它。您还可以使用编辑器边栏中的按钮直接从代码编辑器中运行Python测试。在这些情况下，CodeArts IDE会根据运行的文件自动创建 Python 文件、pytest 或 unittest 启动配置。 然后，您可以从CodeArts IDE主工具栏中选择并运行创建的启动配置。 父主题： 简介

简介 Python程序重构的目标是进行系统级的代码更改，同时不影响程序的行为。CodeArts IDE提供了许多易于访问的重构选项。 重构命令可以从编辑器的上下文菜单中获取。选择您想要重构的元素，右键单击它，并从上下文菜单中选择“重构”。 以下是一些可用的重构选项： 内联变量 这种重构允许您用变量的初值替换变量本身。这是引入变量重构的相反操作。 引入变量 这种重构允许您创建一个新变量，用选定的表达式初始化它，并将原始表达式替换为对新创建变量的引用。 变量重命名 这种重构允许您在整个项目文件中重命名一个符号及其所有使用的地方。 父主题： 代码重构

设置默认项目环境 如果您想要手动指定首次打开项目时使用的默认解释器，可以使用Python可执行文件的完整路径创建或修改 “python.defaultInterpreterPath” 设置的条目，如： Windows { "python.defaultInterpreterPath": "c:/python39/python.exe", } Linux { "python.defaultInterpreterPath": "/home/python39/python", } 您也可以将“python.defaultInterpreterPath”指向虚拟环境，如： Windows { "python.defaultInterpreterPath": "c:/dev/ala/venv/Scripts/python.exe", } Linux { "python.defaultInterpreterPath": "/home/abc/dev/ala/venv/bin/python", } 在为工作区选择解释器后，不会应用“python.defaultInterpreterPath”设置的更改；一旦为工作区选择了初始解释器，后续对设置的任何更改都将被忽略。 您还可以使用语法“${env:VARIABLE}”在路径设置中使用环境变量。如果您创建了一个名为“PYTHON_INSTALL_LOC”的变量及解释器的路径，则可以使用以下设置值： "python.defaultInterpreterPath": "${env:PYTHON_INSTALL_LOC}", 变量替换仅在CodeArts IDE设置文件中支持，在“.env”环境文件中不会生效。 通过使用环境变量，确保在操作系统上设置环境变量，您可以轻松地实现在路径不同的操作系统之间移动项目。 父主题： 使用Python环境

控制程序执行 启动调试会话后，您可以使用调试工具栏操作控制程序执行。 图标 对应动作 快捷键 描述 / 暂停/继续 “F5” / “F8” / “F9” （IDEA快捷键） 暂停/恢复调试会话。 单步跳过 “F10” / “F6” / “F8” （IDEA快捷键） 跳过当前代码行到下一行。如果当前行中有方法调用，则会跳过它们的实现，以便您移至调用者方法的下一行。 单步调试 “F11” / “F5” / “F7” （IDEA快捷键） 进入方法里展示实现代码。 单步跳出 “Shift+F11” / “F7” / “Shift+F8” (IDEA快捷键) 跳出当前方法并跳转到调用者方法。 重启 “Ctrl+Shift+F5” / “Shift+F9” （IDEA快捷键） 重启调试会话。 停止 “Shift+F5” / “Ctrl+F2” 停止调试会话。 运行到光标处 “Alt+F9”（IDEA快捷键） 恢复调试会话，在光标处暂停。 运行到光标处 进入目标单步执行 父主题： 调试

浏览代码 CodeArts提供了丰富的代码导航功能。例如，您可以在代码编辑器中将鼠标悬停在符号上，以查看其快速信息。通过 “Ctrl+单击” 符号，或按下 “F3” / “Alt+F11”（IDEA快捷键） / “F4”（IDEA快捷键） / “Ctrl+Enter”（IDEA快捷键） / “Ctrl+B”（IDEA快捷键），快速导航到符号的声明位置。 您也可以借助CodeArts IDE SmartSearch功能，立即搜索并导航到任何项目位置，查找和执行任何CodeArts IDE命令。 父主题： 简介

pytest 使用该启动配置来运行pytest测试。 要在没有手动创建启动配置的时候快速运行 pytest 测试，请在测试文件的代码编辑器中，单击测试类声明旁边的“全部运行”按钮（）（以运行类中的所有测试），或测试方法旁边的“运行方法”按钮（）（仅运行单个测试）。 CodeArts IDE会自动创建相应的pytest启动配置并将其显示在配置列表中。 从启动配置中包含/排除测试 启动配置属性 启动配置示例 父主题： 启动配置

搜索查询语法 搜索查询是一个字符串，由“dataSource:stringToMatch”对组成，这些对可以通过空格或运算符连接。如果查询中省略了“dataSource”，则搜索将在所有可用的数据源中进行。使用“stringToMatch:dataSource”，即反向模式，也是可能的。 以下是可用的数据源列表： 数据源名称 数据源缩写 描述 “class”/“type” “c”/“t” 类实体 “member” - 成员实体，即类方法或类字段实体 “text” - 文本实体 “file” “fn” 文件和文件夹实体 “command” - 命令实体 父主题： 基本用法

基本用法 通过按下 “Shift+Shift” / “Ctrl+Shift+A” 来启动SmartSearch。 输入搜索请求。要缩小搜索范围，例如仅搜索类成员或CodeArts IDE命令，可以在SmartSearch窗口中通过按下“Tab”/“Shift+Tab”来切换标签页，或者使用搜索查询语法。 使用光标在条目之间导航，并按下“Enter”键跳转到相应的位置或执行命令。另外，也可以双击所需的条目。要关闭SmartSearch窗口，请按下“Escape”键。 搜索查询语法 搜索运算符 父主题： 搜索代码

从命令行新建虚拟环境 要使用“venv”手动创建虚拟环境，请使用以下命令。其中“.venv”是环境文件夹的名字 Windows # You can also use py -3 -m venv .venv python -m venv .venv Linux # You may need to run sudo apt-get install python3-venv first python3 -m venv .venv 有关venv模块的更多详细信息，请参见Python.org上创建虚拟环境。 当您在项目文件夹内创建新的虚拟环境时，CodeArts IDE会提示您将其设置为项目解释器。 父主题： 使用Python环境

一般语句 代码片段描述 缩写 扩展内容 为表达式引入变量 “var” var my_expression 从封闭方法返回表达式的值 “return” return my_expression 将表达式用括号包围 “par” (my_expression) 给表达式取反 “not” not (my_expression) 返回表达式的长度（项目数） “len” len(my_expression) 父主题： 后缀片段

Python文件 可以使用该配置来运行任意Python文件。 要在没有手动创建启动配置的时候快速运行Python文件，可以在资源管理器右键单击该文件或其代码编辑器中右键单击，从上下文菜单中选择“在终端中运行 Python 文件“。CodeArts IDE会自动为此文件创建Python 文件启动配置。 之后您就可以从CodeArts IDE主工具栏选择并运行创建的启动配置。 启动配置属性 启动配置示例 父主题： 启动配置

选择并激活环境 在使用项目向导创建项目时，通常会指定一个该项目的解释器。如果打开任意项目文件夹，CodeArts IDE会自动将系统路径中找到的第一个Python解释器设置为项目解释器，但您可以手动覆盖此设置。 您可以在任何时候切换环境，以便根据需要使用不同的解释器或库版本来测试项目的不同部分。 在命令面板（“Ctrl+Ctrl”/“Ctrl+Shift+P”）中，搜索并运行“Python: 选择解释器”命令，或者单击状态栏右侧的按钮。 从可用的全局和虚拟环境列表中选择所需的环境。 所选环境将用于运行Python代码并提供Python编码帮助（代码补全、验证、格式化等）。此外，当使用“终端：创建新的终端”命令打开终端时，CodeArts IDE会自动激活所选环境。若要防止自动激活所选环境，请禁用“python.terminal.activateEnvironment”设置项。 如果激活命令产生消息“Activate.ps1 is not digitally signed. You cannot run this script on the current system.”，那么您需要暂时更改 PowerShell 的执行策略以允许脚本运行（请参阅 PowerShell 文档中的“关于执行策略”部分）：“Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process”。 默认情况下，CodeArts IDE 在调试代码时使用为您的工作区选定的解释器。您可以通过在调试配置的 python 属性中指定不同的路径来覆盖此行为。请参阅“选择调试环境”。 如果未选择解释器，状态栏也会有所反映。 父主题： 使用Python环境

后缀片段 后缀片段（Postfix snippets）是用于将一个现有的表达式转换为另一个表达式的工具。要使用后缀片段，只需在表达式后面添加一个点（“.”），然后从代码补全建议列表中选择所需的片段。例如，通过使用“main”后缀片段，你可以将一个表达式包装成一个条件性的名为main的表达式。 有些代码片段初始化时是包含占位符的不完整片段，需要填充对应占位符来使代码片段成为完整的可执行代码。您可以通过按Tab键在这些占位符之间跳转。 一般语句 条件语句 循环语句 程序输出 父主题： 代码片段

PYTHONPATH变量使用 PYTHONPATH环境变量指定了Python解释器应该查找模块的额外位置。在CodeArts IDE中，“PYTHONPATH”可以通过终端设置（“terminal.integrated.env.*”）、“.env”文件或者同时使用这两种方法来设置。 当使用终端设置时，“PYTHONPATH”会影响在终端中运行的任何工具，以及CodeArts IDE通过终端执行的如调试等的任何操作。然而，如果CodeArts IDE执行的操作不是通过终端进行的，比如使用linter或格式化器时，这个设置将不会影响模块的查找。 当使用“.env”文件设置“PYTHONPATH”时，它会影响CodeArts IDE代表您执行的所有操作以及调试器执行的操作，但不会影响在终端中运行的工具。 一个使用“PYTHONPATH”的例子是，如果您有一个包含源代码的“src”文件夹和一个包含测试的“tests”文件夹。在运行测试时，这些测试通常无法访问“src”中的模块，除非您硬编码相对路径。 为了解决这个问题，您可以在CodeArts IDE工作区内创建一个“.env”文件，并将“src”的路径添加到“PYTHONPATH”中。 PYTHONPATH=src 然后在 “settings.json” 文件中设置 “python.envFile” ，指向您刚刚创建的 “.env” 文件。如果 “.env” 文件位于项目根目录下，则 “settings.json” 应设置如下： "python.envFile": "${workspaceFolder}/.env" PYTHONPATH的值可以包含由 “os.pathsep” 分隔的多个位置：Windows上为分号 （“;”），Linux 上为冒号 （“:”）。无效路径将被忽略。如果您发现 PYTHONPATH的值未按预期工作，请确保在操作系统的位置间使用正确的分隔符。在Windows上使用冒号分隔位置，或在Linux上使用分号分隔位置会导致 PYTHONPATH值无效，该值将被忽略。 PYTHONPATH不指定Python解释器本身的路径。有关PYTHONPATH的其他信息，请阅读 PYTHONPATH 文档。 父主题： 环境变量

构建环境 在Python中，“环境”由解释器和所有已安装的包组成，定义了程序运行的上下文。CodeArts IDE能够自动检测标准位置安装的Python解释器和工作区文件夹中的虚拟环境。 默认情况下，Python解释器在全局环境下运行，不会对特定项目有额外操作，因此任何安装或卸载的包都会影响全局环境及在其中运行的所有程序。随着时间的推移，全局环境可能会变得拥挤，难以测试应用程序。 为了避免这种混乱和不便，您可以为项目创建一个虚拟环境。虚拟环境是一个包含特定解释器副本的文件夹。安装到虚拟环境中的包仅安装在该文件夹中，而不会污染全局Python解释器。当您在该环境中运行程序时，它仅使用虚拟环境中这些特定的包来运行。 CodeArts IDE会自动在以下位置查找解释器： 标准安装位置，如“/usr/local/bin”、“/usr/sbin”、“/sbin”、“c:\python27”、“c:\python36”等。 工作区（项目）文件夹下直接创建的虚拟环境。 由“python.venvPath”设置的文件夹中的虚拟环境。该文件夹可以包含多个虚拟环境，扩展程序会在“venvPath”的第一级子文件夹中查找虚拟环境。 通过pyenv和Pipenv安装的解释器。 如果CodeArts IDE无法自动定位您的解释器，您可以手动指定它。此外，CodeArts IDE还会加载由“python.envFile”设置的环境变量定义文件，默认值为“${workspaceFolder}/.env”。 使用Python环境 环境变量 父主题： Python

创建Python启动配置 在CodeArts IDE主工具栏上，从列表中选择“编辑配置”。 在打开的“运行/调试配置”对话框中，单击工具栏上的“新增配置项”按钮（）或使用“新增配置项”链接。在出现的列表中，选择“Python”条目下所需的启动配置模板。 在参数区域中提供启动配置参数。 关于启动配置参数的详细说明，请参考相应的主题： 当前 Python 文件 Python 文件 Python 模块 附加到进程 Django 应用程序 FastAPI 应用程序 Flask 应用程序 Pyramid 应用程序 pytest unittest 单击“确定”以应用更改并关闭对话框。 要删除启动配置，请在“运行/调试配置”对话框中单击工具栏上的“删除所选配置”按钮（）。 父主题： 简介

环境变量定义文件 环境变量定义文件是一个以“environment_variable=value”为形式，键值对构成的纯文本文件，其中“#”用于注释。该文件不支持多行值，但值可以引用系统中或文件中先前已定义的其他任何环境变量。有关更多信息，请参阅变量替换。环境变量定义文件可用于调试和工具执行（包括linters、格式化器、代码补全和测试工具）等场景，但不应用于终端。 默认情况下，CodeArts IDE会在当前项目文件夹中查找并加载名为“.env”的文件，并应用这些定义。这是由用户设置中的默认条目“"python.envFile": "${workspaceFolder}/.env"”来决定的。你可以更改“python.envFile”设置来使用不同的定义文件。 例如，在开发Web应用程序时，你可以使用不同的定义文件来存储不同的URL和其他设置，而不是直接在代码中设置。这样您就可以轻松地在开发服务器和生产服务器之间切换，如： dev.env file # dev.env - development configuration # API endpoint MYPROJECT_APIENDPOINT=https://my.domain.com/api/dev/ # Variables for the database MYPROJECT_DBURL=https://my.domain.com/db/dev MYPROJECT_DBUSER=devadmin MYPROJECT_DBPASSWORD=!dfka**213= prod.env file # prod.env - production configuration # API endpoint MYPROJECT_APIENDPOINT=https://my.domain.com/api/ # Variables for the database MYPROJECT_DBURL=https://my.domain.com/db/ MYPROJECT_DBUSER=coreuser MYPROJECT_DBPASSWORD=kKKfa98*11@ 然后，您可以将 “python.envFile” 设置设置为 “${workspaceFolder}/prod.env”，然后将调试配置中的 “envFile” 属性设置为 “${workspaceFolder}/dev.env”。 当使用多种方法指定环境变量时，有以下的优先顺序。 “python.envFile” 设置指定的 “.env” 文件中包含的环境变量会覆盖 “launch.json” 中 “envFile” 设置中定义的变量，以及直接在 “launch.json” 文件中定义的任何环境变量。 “launch.json” 中的 “envFile” 设置中定义的环境变量会覆盖直接在 “launch.json” 文件中定义的环境变量。 父主题： 环境变量

类型层次结构 “类型层次结构”视图显示了继承关系，允许您查看选定类的父类和子类。要打开该视图，请在右侧的“活动栏”中单击“类型层次结构”。 右键单击一个类型，选择“显示类型层次结构”，或按下 “Ctrl+H”（IDEA快捷键）。 使用“类型层次结构”视图工具栏按钮，可以切换查看子类、父类或一起查看。 ：查看父类和子类。 ：仅查看父类。 ：仅查看子类。 /: 展开/折叠列表中的所有项。 ：按字母顺序对列表进行排序。 ：刷新列表内容。 在“类型层次结构”视图中，您可以右键单击一个类，并从上下文菜单中选择“基于此类型构建”，以基于选定的类重新构建层次结构。 父主题： 浏览代码

使用代码提示 在编写代码时，CodeArts IDE会为您的项目文件、内置模块和第三方模块提供代码补全建议。代码补全功能会在您键入时自动显示符号和文档，您也可以通过手动按下 “Ctrl+I” / “Ctrl+Space” / “Ctrl+Shift+空格键” 来随时触发它。此外，您还可以将鼠标悬停在标识符上以获取更多相关信息。 除了代码补全外，CodeArts IDE还提供了其他如导航和重构的重要编码辅助功能。要获取更多详情，请查看编辑代码、浏览代码和搜索代码等相关文档。 父主题： 简介

启动配置示例 以下是一个可运行的启动配置示例。 { "request": "launch", "console": "integratedTerminal", "jinja": true, "python": "${command:python.interpreterPath}", "stopOnEntry": false, "redirectOutput": true, "program": "${workspaceFolder}\\manage.py", "env": {}, "type": "python", "logToFile": false, "args": [ "runserver" ], "cwd": "${workspaceFolder}", "subProcess": false, "justMyCode": true, "django": true, "pythonArgs": [], "name": "Python: Django", "showReturnValue": true } 父主题： Django应用

代码片段 代码片段是模板，可以简化如循环或条件语句等重复代码模式的输入。CodeArts IDE为Python语言提供了多个内置的代码片段，这些片段和其他建议一起出现在代码补全（“Ctrl+I” / “Ctrl+Space”/“Ctrl+Shift+Space”）中。 代码片段通常放置在代码补全建议列表底部。要快速访问它们，请触发代码补全（“Ctrl+I”/“Ctrl+Space” /“Ctrl+Shift+Space”），然后按“Ctrl+Up”/“Up”。 常规片段 后缀片段 父主题： 编辑代码

折叠区域 折叠区域允许您折叠或展开代码片段，以便更好地查看源代码。在Python上下文中，使用以下字符来标记折叠区域： 开始区域：“#region” 或 “# region” 结束区域：“#endregion” 或 # endregion 然后就可以使用 “Ctrl+Shift+[” / “Ctrl+-”（IDEA快捷键）/ “Ctrl+Numpad-”（IDEA快捷键）来折叠光标处最内部的未折叠区域，以及 “Ctrl+Shift+]” / “Ctrl+=”（IDEA快捷键）/“Ctrl+Numpad+”（IDEA快捷键）来展开光标处的折叠区域。 有关代码折叠的更多详细信息，请参阅代码折叠。 父主题： 简介