华为云用户手册

测试代码 Python扩展支持使用unittest和pytest框架进行测试。CodeArts可以帮助您配置框架集成，并提供专用的“测试”视图，让您能够方便地识别和运行测试。 以下是一个如何创建和运行一个unittest测试的示例。 创建一个测试对象，也就是新建一个名为 “inc_dec.py” 的文件，它包含以下内容： def increment(x): return x + 1def decrement(x): return x - 1 创建一个 “unittest” 测试来覆盖这个测试对象，即创建一个名为 “inc_decunittest.py” 的文件，包含以下内容： import inc_dec # The code to testimport unittest # The test frameworkclass Test_TestIncrementDecrement(unittest.TestCase): def test_increment(self): self.assertEqual(inc_dec.increment(3), 4) def test_decrement(self): self.assertEqual(inc_dec.decrement(3), 4)if __name__ == '__main__': unittest.main() 在CodeArts IDE中配置unittest框架集成。 单击CodeArts IDE底部面板中的“测试”按钮（）打开“测试”视图，单击“Configure Python Tests”按钮。 在弹出的对话框中，选择您想要启用集成的测试框架，在本例中是 “unittest”。 在接下来的对话框中，选择包含测试源文件的项目文件夹。在我们的例子中，是项目根文件夹（“.”）。 下一个对话框中，选择用于标识测试文件的文件通配符模式，本例中为 “*test.py”。 在配置完框架集成后，CodeArts IDE会自动检测测试并在“测试”视图中显示它们。 现在，您可以使用各种命令（在命令面板（“Ctrl Ctrl” / “Ctrl+Shift+P”）中，在编辑器行号区，或在“测试”视图中）来运行和调试测试，包括运行单个测试文件和单个方法。 有关测试Python代码的更多详细信息，请参阅Python 测试文档。 父主题： 简介

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

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

监视 “监视”部分允许您在程序运行时跟踪变量或任意表达式的求值结果。 要添加一个表达式，您可以执行以下操作之一： 在“监视”部分的任意位置双击，或者单击“添加表达式”按钮（），并在出现的输入框中输入您想要监视的表达式。 如要快速为某变量添加监视，请在“变量”部分中右键单击变量名，并在上下文菜单中选择“添加到监视”。 要删除一个表达式，只需选择它并按 “Delete” 键。若要一次性删除所有表达式，请单击“删除所有表达式”按钮（）。 父主题： 检查暂停的程序

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

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

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

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

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

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

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

从代码编辑器启动调试会话 如果您不打算向您的程序传递任何参数，可以直接从代码编辑器开始一个调试会话。 在Python文件的代码编辑器中，单击编辑器边缘中的运行按钮（），并从弹出菜单中选择“调试”。或者，您可以右键单击代码编辑器，从上下文菜单中选择“调试 Python 文件”。Python 文件启动配置将被创建并自动运行。 创建的启动配置会自动保存，之后你可以在任何时候从CodeArts IDE主工具栏上的配置列表中选择它。 父主题： 在调试模式下运行程序

启动配置 CodArts允许您自定义运行测试用例的配置。您可以在项目中添加对应的启动配置文件。 在CodeArts IDE主工具栏中，选择列表中的“编辑配置“。 在打开的“运行/调试配置”对话框中，单击工具栏上的“新增配置项”按钮（）或使用“新增配置项”链接。在出现的列表中，选择Python条目下所需的启动配置模板。 以下是用于运行和调试测试，开箱即用的配置模板： pytest unittest 在配置参数区域里填入启动配置参数。 pytest测试 unittest测试 父主题： 测试

启动配置示例 以下是一个可运行的启动配置示例，该示例从 “test_file_name::test_class_name::test_method_name” 运行测试。 { "excludeTestIds": [], "request": "test", "jinja": true, "python": "${command:python.interpreterPath}", "stopOnEntry": false, "redirectOutput": true, "env": {}, "type": "python", "logToFile": false, "testIds": [ "test_file_name::test_class_name::test_method_name" ], "cwd": "${workspaceFolder}", "subProcess": false, "justMyCode": true, "provider": "PYTEST", "pythonArgs": [], "name": "Python pytest tests", "showReturnValue": true} 父主题： pytest测试

构建环境 在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

约束与限制 当使用多种方法指定环境变量时，有以下的优先顺序。 “launch.json”中直接定义的“env” 变量会覆盖“launch.json”中 “envFile”设置中定义的变量，以及“python.envFile”设置指定的“.env”文件包含的环境变量。 “launch.json”的“envFile”设置中定义的环境变量会覆盖“python.envFile”设置指定的“.env”文件包含的环境变量。

运行代码 您可以通过以下的任意方式来使用当前选定的解释器运行代码： 单击CodeArts IDE主工具栏上的“开始执行（不调试）”按钮 （），以启动内置的“当前文件”启动配置。 在代码编辑器的任意位置右键单击，并选择“在终端中运行 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环境

多光标修改器 如果您想将通过鼠标添加多个光标时使用的修改键改为“Ctrl+Click”，您可以通过editor.multiCursorModifier设置项来实现。这让来自其他编辑器（如Sublime Text或Atom）的用户可以继续使用他们熟悉的键盘修改器。 设置项可以被设置为： ctrlCmd - 映射到Windows上的“Ctrl”。 alt - 现有的默认“Alt”。 在"编辑"菜单中，使用菜单Switch to Ctrl+Click for Multi-Cursor可快速切换此设置。 “转到定义”和“打开链接”功能所需的鼠标动作将会相应调整，并且不会与多光标修改键冲突。例如，当设置为ctrlCmd时，可以使用“Ctrl+Click”添加多个光标，打开链接或转到定义可以使用“Alt+Click”调用。

常用设置项 排除或包含某些文件夹 Tag 或 Hybrid 模式下： 排除某些目录 设置项中搜索huawei-cpp.wecodeDb.excludePaths，默认值为： **/.mm/****/.git/** **/build/** **/output/** 包含文件夹 设置项中搜索huawei-cpp.wecodeDb.includeFolders，将文件夹绝对路径填入即可。 Compiler 模式下： 排除某些目录： 设置项搜索：huawei-cpp.codebase.generator.pathsExclude，使用 Glob 通配符排除一些路径，然后重新生成 compile_commands.json 才会生效。 开启/关闭问题窗口中的诊断信息 设置项中搜索huawei-cpp.clangd.ignoreDiagnostics： none： 显示所有诊断信息。 all： 隐藏所有诊断信息。 not_indexed：仅当当前文件有编译选项或已经索引时显示诊断信息。 修改系统头文件提供方 Huawei C/C++默认从 compile_commands.json 中的编译器提取系统头文件，如果无法提取则使用自带的 RTOS 头文件，可通过修改设置项改变默认规则： 设置项中搜索huawei-cpp.codebase.systemHeaderProvider： Compiler： 仅根据 compile_commands.json 中提取系统头文件。 None： 从环境变量中获取系统头文件 开启内联提示/高亮不活跃代码，开启/关闭/修改语义高亮颜色 开启或关闭内联提示： huawei-cpp.clangd.enableInlayHints 开启或关闭高亮不活跃代码： huawei-cpp.syntaxColor.enableInactiveCode 开启或关闭语义高亮： huawei-cpp.syntaxColor.enable cmake工程构建工具的路径 CodeArts IDE for C/C++提供了CMake工程构建、调试所需要的相关工具， 用户可以直接构建、调试CMake工程， 不必手动配置相关环境变量。用户目录下.codearts下面内置了cmake、MinGW、ninja工具CMake Build Tool插件默认先读取内置工具路径。 cpp-build-tool.CMakeBuildTool.CMake获取cmake工具的路径。 cpp-build-tool.CMakeBuildTool.debugger获取MinGW工具的路径。 cpp-build-tool.CMakeBuildTool.buildTool获取ninja工具的路径。 父主题： C/C++

多重选择（多光标） CodeArts IDE支持多个光标以实现快速的同步编辑。您可以使用“Alt+单击”添加二级光标。每个光标根据其所在的上下文独立运行。添加更多光标的常见方法是使用Ctrl+Alt+Down或Ctrl+Alt+Up将光标插入下方或上方。 注意：您的显卡驱动程序可能会覆盖这些默认的快捷方式。 按“Ctrl+D”/“Alt+J”(IDEA键盘映射)选择光标处的单词，或选择当前出现的下一个匹配的单词。 您还可以使用“Ctrl+Shift+L”/“Ctrl+Shift+Alt+J”（IDEA键盘映射）同时添加更多光标，这将在当前选中的文本的每一个匹配项添加一个光标。

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

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

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

启动配置示例 以下是一个可运行的启动配置示例。 { "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模块

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

多种构建类型 CMake工程一共有四种构建类型，分别是 Debug，MimSizeRel，Release，RelWithDebInfo。选择需要的构建类型，工程构建之后， 生成对应的目录。 Debug：禁用优化并包含调试信息。 Release：包括优化但没有调试信息。 MinRelSize：优化大小。没有调试信息。 RelWithDebInfo：优化速度并包含调试信息。 父主题： Cmake工程支持

自动检测 CodeArts IDE会根据您所打开的文件来决定文档中使用的缩进。自动检测的缩进将覆盖默认的缩进设置。检测到的设置将显示在底部状态栏的右侧。 您可以通过单击状态栏中的缩进设置打开缩进命令列表，然后更改打开文件的默认缩进设置或在制表符和空格之间转换。 CodeArts IDE自动检测检查2、4、6或8空格的缩进。如果文件使用不同数量的空格，则可能无法正确检测缩进。例如，如果您需使用3个空格缩进，则您需关闭editor.detectIndentation选项，并将选项卡大小显式设置为3。 "editor.detectIndentation": false,"editor.tabSize": 3,

简介 编写代码时，CodeArts IDE会根据预定义的验证规则自动在后台分析代码。CodeArts IDE可以发现各种问题，识别可能的错误、拼写问题等。这有助于您在运行代码之前检测和更正代码中的问题。对于许多问题，CodeArts IDE提供了快速修复功能，让您可以迅速修复它们。 警告和错误显示在CodeArts IDE用户界面的几个位置： 状态栏显示所有错误和警告的摘要。 “问题”视图列出了当前打开的文件中的所有问题。 打开文件时，所有错误和警告都将直接在代码编辑器中呈现，与文本内联，并在概述标尺中呈现。 父主题： 代码校验

插件调试与运行 后端调试 在插件的 src/node/ 目录下存放的是插件的后端代码，后端代码运行在 nodejs 环境中，插件工程在创建的时候已经默认生成了一个后端文件 backend.ts，对于轻量级的插件，只需要在该文件中添加自己想要实现的业务功能即可，该文件包含了三个默认的方法 init()、run()、stop()。另外还默认添加了一个 doSomething 方法，这个方法仅仅是作为示例使用，开发者可以根据需要进行修改或删除。 这里我们简单介绍下init，run和stop方法： init 函数：作为该后端实例的初始化方法，可以在插件启动的时候进行一些初始化操作，写在该函数中的代码一定会先于 run 和其他函数被调用，这里需要注意的是，对于前端暴露给后端的函数不能在 init 函数中进行调用，也就是不能在 init 方法中执行 this.plugin.call 调用。 run 函数：作为后端实例的主逻辑函数，承担着业务功能入口的作用，在该函数中可以方便地调用 CodeArts IDE 的 API，比如 codearts.window.showInformationMessage(`hello world!`); 也可以调用前端暴露出来的函数，也就是可以在该方法中执行 this.plugin.call 调用。 stop 函数：将会在插件被停止前被调用，如有需要可以进行一些资源清理的操作。 添加断点：在backend.ts 的 run() 函数中添加一个断点。 打开调试窗口：按 F5 或者单击右上角调试工具栏中的开始调试按钮，打开【扩展开发宿主】窗口。 进入断点，进行调试。 前端调试 与插件的后端不同，前端的代码最终将被编译并运行于浏览器环境中，前端的代码存放于 src/browser 目录中，插件工程在创建的时候会默认生成两个前端源码文件 frontend.ts 和 dynamic-webview.ts。这两个文件的内容与后端 backend.ts 的结构非常相似，只不过运行的环境不同而已，这里就不再重复对这两个文件中 init()、run()、stop() 方法进行介绍。由于前端运行在浏览器环境中，代码调试将借助于浏览器自带的调试功能。如果需要自动重新编译前端代码，可以在终端中执行命令 npm run watch-browser，然后再运行调试。在启动调试后如果修改了代码，只需在调试窗口按 Ctrl+R 重新加载窗口即可看到修改后的效果。 前端调试前，需要先把 webpack.config.js 文件中的 devtool 配置为 'inline-source-map'，然后在命令行执行 npm run prepare。 添加断点：在 frontend.ts 的 run() 函数中添加一个断点。 打开调试窗口：按 F5 或者单击右上角调试工具栏中的开始调试按钮，打开【扩展开发宿主】窗口。 打开插件注册的视图，进入断点，进行前端的调试，若无法进入断点，可以使用“Ctrl + Shift + I”打开“开发人员工具”，再“Ctrl + R”重新加载当前窗口。