PyCharm 2025.2 Help

使用 requirements.txt

PyCharm 提供与主要需求管理方式的集成,并使您能够跟踪项目中未满足的需求,并基于 创建虚拟环境 ,基于 requirements.txt 文件。

创建 requirements 文件

如果您的项目中尚未包含 requirements 文件,您可以手动创建:

  1. 请执行以下操作之一:

    • Project 工具窗口(Alt+1 )中,选择要在其中创建新文件的 目录 或包,然后从主菜单中选择 文件|新建

    • 右键点击 目录 或包,并从上下文菜单中选择 新建

    • 选择 目录,然后按 Alt+Insert

  2. 选择 文件 从列表中。

  3. 指定 requirements 文件的名称。 推荐的需求文件名称是 requirements.txt 。 当将具有此名称的文件添加到根项目目录时, Python 集成工具会自动检测到它。

  4. 点击 确定。 新文件将创建在目标位置下。

您还可以在命令行中运行 pip freeze > requirements.txt 来为您的项目生成一个 requirements.txt 文件。 有关更多详细信息,请参阅 https://pip.pypa.io/en/stable/reference/pip_freeze/

如果需求文件的名称与 requirements.txt 不同,或者当一个项目中有多个需求文件时,您需要通知 PyCharm 您想要应用的需求文件。

配置默认的需求文件

  1. 按下 Ctrl+Alt+S 打开设置,然后选择 工具 | Python 集成工具

  2. 软件包要求文件 字段中,输入 requirements 文件的名称,或单击浏览按钮选择该文件。

  3. 请点击 确定 以保存更改。

PyCharm 提供快速修复功能,可填充 requirements 文件。

定义需求

  1. 在编辑器中打开 requirements.txt 文件。

    如果您的 requirements.txt 文件为空,且项目中已导入 package,PyCharm 提供快速修复以更新 requirements 文件。

  2. 单击 将导入的软件包添加到要求中… 链接:

    快速修复以更新 requirements 文件
  3. 在打开的对话框中,指定需求文件的名称。

    定义 requirements.txt
  4. 选择处理所需库版本的方法。 可以定义版本号的方式:

    方法

    示例

    强相等

    Django==3.0.3

    大于或等于

    Django>=3.0.3

    兼容版本

    Django~=3.0.3

  5. 定义需求管理策略:

    策略

    操作

    移除未使用的需求

    删除与未使用的库和包对应的记录。

    修改基础文件

    允许修改基础需求文件(如果在 requirements.txt 文件中引用了任何文件)。

    如果现有版本与当前版本相匹配,则保留现有版本说明符

    如果版本号满足所选的版本处理方法,则保持不变。

  6. 单击 确定 ,并检查更新后的文件。

更新需求文件

  • 在 Python 文件的 import 语句中,将插入符号放在高亮显示的包上,然后按 Alt+Enter。 使用 PyCharm 提供的快速修复:

    快速修复以将需求添加到 requirement.txt 文件

指定项目依赖项

  1. 在编辑器中打开 requirements.txt

  2. 指定所需包的名称及其版本。

    当您开始输入包名时,PyCharm 会提供补全选项:

    在 requirements.txt 中为包名提供代码补全

    Enter 插入建议。

PyCharm 提供与未满足的依赖项相关的快速修复和通知。

从 requirements.txt 安装所需的包

  1. 当您打开 requirements.txt 或包含 requirements.txt 的项目中的 Python 文件时,PyCharm 会检查 requirements.txt 中指定的所有包是否已为当前的 Python 解释器安装。

    关于需求的通知
  2. 如果缺少任何包,通知栏会显示在编辑器顶部。 点击 安装依赖项

您也可以点击 忽略依赖项。 在这种情况下,您将能够从被忽略的包列表中移除这些包。

管理被忽略的依赖项

  1. Ctrl+Alt+S 打开项目 设置

  2. 在主菜单中,转到 编辑器 | 检查

  3. 在检查列表中,选择 未满足的软件包要求

  4. 预览被忽略需求的列表,然后点击 添加 图标(添加软件包 )以添加它们。

    添加被忽略的包
最后修改日期: 2025年 9月 26日