pipenv使用详解

pipenv使用详解

选项说明

1. 项目与环境信息类
   • --where：输出项目主目录信息，帮助你确认当前 pipenv 所关联的项目根路径。
   • --venv：输出虚拟环境的相关信息，比如虚拟环境的具体路径。
   • --py：输出 Python 解释器的信息，像 Python 解释器的路径和版本。
   • --envs：输出环境变量选项，可查看与 pipenv 相关的环境变量设置。
2. 虚拟环境操作类
   • --rm：移除当前项目关联的虚拟环境，清理项目的虚拟环境空间。
   • --site-packages / --no - site-packages：在创建虚拟环境时，决定是否启用系统全局的 Python 包（site - packages）。启用后，虚拟环境可以访问系统已安装的包。
   • --python TEXT：指定虚拟环境要使用的 Python 版本，例如 pipenv --python 3.8 会创建使用 Python 3.8 的虚拟环境。
3. 输出与帮助类
   • --bare：以最少的信息输出，适用于只需要核心信息的场景。
   • --man：显示 pipenv 的手册页，提供更详细的工具使用说明。
   • --support：输出诊断信息，方便你在 GitHub 上提交问题时提供相关的环境和配置信息。
   • -q, --quiet：安静模式，减少不必要的输出，只显示关键信息。
   • -v, --verbose：详细模式，输出更多的操作细节和调试信息。
   • --pypi - mirror TEXT：指定 PyPI 镜像源，加快包的下载速度，例如 --pypi - mirror https://pypi.tuna.tsinghua.edu.cn/simple。
   • --version：显示 pipenv 的版本信息并退出。
   • -h, --help：显示帮助信息并退出，就是你看到的这段文档内容。
4. 缓存清理类
   • --clear：清除 pipenv 和 pip 的缓存，避免因缓存问题导致的安装异常。

使用示例解读

1. 创建特定 Python 版本的项目

   $ pipenv --python 3.7
   

   此命令会创建一个使用 Python 3.7 的虚拟环境，并生成对应的Pipfile Pipfile.lock文件。

2. 移除项目虚拟环境

   $ pipenv --rm
   

   该命令会删除当前项目目录下关联的虚拟环境及其所有安装的包。

3. 安装项目所有依赖（包括开发依赖）

   $ pipenv install --dev
   

   执行此命令会安装Pipfile中所有的依赖包，包括标记为开发环境使用的包。

4. 创建包含预发布版本的锁文件

   $ pipenv lock --pre
   

   当需要包含预发布版本的包时，使用此命令生成Pipfile.lock文件。

5. 显示已安装依赖的关系图

   $ pipenv graph
   

   以图形化方式展示项目中已安装的包及其依赖关系，方便查看包之间的依赖层级。

6. 检查已安装依赖的安全漏洞

   $ pipenv check
   

   借助 PyUp Safety 工具检查项目中已安装的包是否存在安全漏洞。

7. 将本地 setup.py 安装到虚拟环境和 Pipfile 中

   $ pipenv install -e .
   

   对于本地开发的 Python 包，使用此命令将其以可编辑模式安装到虚拟环境中，并记录到Pipfile 里。

8. 使用底层 pip 命令

   $ pipenv run pip freeze
   

   通过

   pipenv run
   

   在虚拟环境中执行底层的

   pip
   

   命令，这里的

   pip freeze
   

   用于列出虚拟环境中安装的所有包及其版本。

命令说明

1. 依赖安全与检查类
   • check：检查 Pipfile 中指定的包是否存在安全漏洞，同时验证是否符合 PEP 508 标记规则。
2. 依赖清理类
   • clean：卸载 Pipfile.lock 中未指定的所有包，清理不必要的依赖。
3. 依赖关系展示类
   • graph：显示当前已安装的依赖关系图，直观呈现包之间的依赖层级。
4. 依赖安装类
   • install：安装指定的包并将其添加到 Pipfile 中；若未指定包，则安装 Pipfile 中的所有包。
5. 锁文件生成类
   • lock：生成 Pipfile.lock 文件，锁定项目依赖的确切版本。
6. 模块查看类
   • open：在编辑器中打开指定的 Python 模块，方便查看模块代码。
7. 依赖文件转换类
   • requirements：从 Pipfile.lock 生成 requirements.txt 文件，以便与只支持 requirements.txt 的工具兼容。
8. 命令执行类
   • run：在虚拟环境中执行指定的命令，无需先激活虚拟环境。
9. 脚本列表类
   • scripts：列出当前环境配置中的脚本，可快速查看项目中定义的可执行脚本。
10. 虚拟环境交互类
    • shell：在虚拟环境中启动一个新的 shell 会话，方便在虚拟环境中执行各种命令。
    • sync：根据 Pipfile.lock 安装所有指定的包，确保环境与锁文件一致。
11. 依赖卸载类
    • uninstall：卸载指定的包并从 Pipfile 中移除。
12. 依赖更新类
    • update：先执行 lock 命令更新 Pipfile.lock，再执行 sync 命令同步安装最新依赖。
    • upgrade：解析指定的包并添加到 Pipfile 中；若未指定包，则将更新合并到 Pipfile.lock 中。
13. 锁文件验证类
    • verify：验证 Pipfile.lock 中的哈希值是否为最新，确保依赖的完整性。