PyCharm 2025.2 Help

集成工具

使用本页配置需求管理文件、默认测试运行程序和文档字符串处理。

项目

描述

软件包要求文件

请输入 requirements 文件 的名称,或点击浏览按钮,并使用 Select Path 对话框从文件系统中选择所需的 requirements 文件。

Pipenv 可执行文件路径

此路径是将 Pipenv 环境添加到 Python 项目所必需的。 如果添加到 PATH 环境变量中,系统可以自动检测此路径。 要发现路径,请按照操作系统特定的 pipenv 安装步骤。 示例:

  • C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe (Windows)

  • /Users/jetbrains/.loca/bin/pipenv (macOS)

默认测试运行器

选择每次在测试用例的上下文菜单中选择 运行 时,PyCharm 将建议的测试运行/调试配置。

可能的选项包括:

  • 单元测试

  • pytest

  • Nosetests

  • Twisted Trial

在 Jupyter Notebook 中检测测试

如果您希望将 Jupyter Notebook 文件包含在单元测试检测作用域内,请选中此复选框。

文档字符串格式

请选择 PyCharm 要识别的文档字符串格式。

根据所选的 docstring 格式,PyCharm 将生成存根文档注释,并在 显示快速文档中呈现文本:

  • 普通 :在按下 Enter 或空格后打开引号后,会生成一个空stub;快速文档显示为普通文本。

  • reStructuredText :按下 Enter 或空格后,打开引号后会根据 reStructuredText 格式生成存根文档注释;快速文档由 Docutils 渲染。

  • NumPy :按下 Enter 或空格后添加引号时,将按照 NumPy格式生成存根文档注释;快速文档由 Napoleon和Docutils渲染。

  • Google :按下 Enter 或空格键后,在开引号之后会生成符合 Google格式的文档注释存根;快速文档由 Napoleon和 Docutils 渲染。

各种类型的文档字符串功能:

  • 正确生成 docstrings

  • 应用意图操作和快速修复后的更新

  • 编码辅助

  • 章节标题自动补全

分析文档字符串中的 Python 代码

如果选中此复选框,PyCharm 会高亮代码示例并进行语法检查和代码检查。

如果此复选框未选中,docstrings 内的代码片段将不被分析。

stdlib 渲染外部文档。

启用显示来自 http://docs.python.org查看 | 快速文档 的标准库函数文档。

Sphinx 工作目录

指定包含 .rst 文件和 conf.py 配置的目录路径。 PyCharm 使用它来识别自定义角色,并为 Sphinx 文档提供准确的高亮和渲染。

.txt 文件视为 reStructuredText

如果选中此复选框,则具有 .txt 扩展名的文件将与具有 .rst 扩展名的文件以相同方式高亮显示。

最后修改日期: 2025年 9月 26日