VSCode 打包 Python 项目依赖的包
在开发 Python 项目时，管理和打包依赖库是确保项目可重复、可移植的重要步骤。本文将介绍如何在 Visual Studio Code (VSCode) 中打包 Python 项目的依赖，并附有代码示例。
什么是 Python 项目打包？
Python 项目打包是将项目及其依赖项打包成一个可分发的格式，以便其他用户或开发者能够轻松安装和使用该项目。常见的打包工具有 setuptools 和 pipenv，后者涉及环境管理和依赖安装。
准备工作
首先，请确保你的开发环境中已经安装了 Python 和 VSCode。如果还没有安装，可以到 Python 的官方网站下载并安装 Python，并在 VSCode 的扩展市场中安装 "Python" 扩展。
接下来，确保你已经有一个 Python 项目。我们以 my_project 为例，代码结构如下：
my_project/
├── main.py
├── requirements.txt
main.py是我们的主程序。requirements.txt列出了项目依赖的库。
创建 requirements.txt
使用 pip freeze 命令可以很容易地将当前环境中的所有包列出并保存到 requirements.txt 文件中。
pip freeze > requirements.txt
将会在项目根目录创建一个 requirements.txt 文件，内容可能如下：
requests==2.25.1
numpy==1.21.0
这些包在其他环境中安装时会显示具体的版本号，确保一致性。
使用 setup.py 进行打包
接下来的步骤是创建一个 setup.py 文件，这是 Python 包的配置文件。我们可以在项目目录中添加该文件，内容如下：
from setuptools import setup, find_packages
setup(
name='my_project',
version='0.1',
packages=find_packages(),
install_requires=[
'requests==2.25.1',
'numpy==1.21.0',
],
)
在这个文件中，我们指定了项目名称、版本号和所依赖的包及其版本。
打包并发布
一旦创建了 setup.py，就可以通过以下命令进行打包：
python setup.py sdist bdist_wheel
执行完后，会在 dist 目录下生成 .tar.gz 和 .whl 文件。
使用 VSCode 编写代码
在 VSCode 中，你可以直接在 main.py 中编写代码。下面是一个简单的示例，演示如何使用 requests 和 numpy 这两个库：
import requests
import numpy as np
response = requests.get("
data = response.json()
print(f"Task: {data['title']}")
print(f"Completed: {data['completed']}")
arr = np.array([1, 2, 3, 4])
print(f"Sum of array: {np.sum(arr)}")
依赖的安装
在新的环境中，使用 pip 安装依赖只需以下命令：
pip install -r requirements.txt
这会自动安装 requirements.txt 文件中列出的所有包，使得项目立刻可以运行。
使用 pipenv 进行环境管理
除了传统的 venv，使用 pipenv 也可以更方便地管理依赖和环境。通过以下命令创建一个新的环境：
pipenv install requests numpy
pipenv 会自动为你创建 Pipfile，并添加相应的依赖。
整个过程的旅行图
以下是打包和管理 Python 项目依赖的步骤旅行图：
journey
title Python 项目打包
section 环境准备
安装 Python : 5: 确定
安装 VSCode : 5: 确定
section 创建项目
创建项目目录 : 4: 确定
创建 main.py : 5: 确定
编写代码 : 4: 确定
section 管理依赖
使用 pip 生成 requirements.txt : 4: 确定
创建 setup.py : 5: 确定
section 打包项目
执行打包命令 : 5: 确定
检查 dist 目录 : 4: 确定
section 发布使用
使用 pip 安装依赖 : 5: 行动
运行 main.py : 5: 行动
总结
通过本文，我们了解了如何在 VSCode 中打包 Python 项目及其依赖的包。我们首先创建了 requirements.txt 和 setup.py 文件，并通过命令行工具打包并发布了项目。这一过程使得项目的分发与安装变得简单高效。
确保项目的可移植性是现代开发中不可忽视的重要环节，希望你能将这些知识应用于自己的项目中。通过不断实践，相信你将更熟悉打包 Python 项目的全套流程。
