Python 打包与分发：setuptools, Wheel, PyPI - 智猿学院-IT界的百科全书

好的，各位代码界的段子手、bug界的福尔摩斯们，今天咱们不聊诗和远方，就聊聊怎么把辛辛苦苦码出来的“娃”，漂漂亮亮地“嫁”出去，让全世界人民都能用上你的代码！😎

主题：Python 打包与分发：setuptools, Wheel, PyPI，让你的代码“全球出道”！

(开场白：程序员的浪漫)

各位都知道，程序员的世界里，最浪漫的事莫过于写出一个让无数人受益的程序，然后看着它像蒲公英一样，乘着互联网的风，飘向世界的每一个角落。但理想很丰满，现实往往很骨感。你写的代码，别人想用，得先解决环境依赖、版本兼容、安装配置等等一堆破事儿，稍不留神就掉进坑里，体验比蜀道还难。

所以，今天咱们就来聊聊怎么把你的代码打包成“豪华套餐”，让用户一键安装，轻松享用，让你的代码真正实现“全球出道”的梦想！

(第一幕：江湖规矩 – 为什么要打包？)

在咱们进入技术细节之前，先来聊聊“打包”这门手艺的意义。想象一下，你是一名厨师，你做了一道绝世美味的“Python炒代码”，你想把这道菜分享给全世界。

不打包： 你把菜谱（源代码）和食材清单（依赖库）一股脑儿扔给别人，让别人自己去买菜、切菜、炒菜。结果呢？有人买错了菜，有人炒糊了锅，有人根本不知道怎么下手。用户体验极差！
打包： 你把所有食材都洗净切好，配上秘制酱料（依赖库），用精美的餐盒（打包工具）装好，再附上一份详细的烹饪指南（安装说明）。用户只需要打开餐盒，简单加热一下，就能享用到美味佳肴。用户体验棒棒哒！👍

所以，打包的意义就在于：

简化安装： 让用户一键安装，告别繁琐的依赖管理。
提高兼容性： 解决不同操作系统、Python版本之间的兼容性问题。
方便分发： 让你的代码更容易被分享和传播。
保护代码： 可以将代码编译成二进制文件，防止被轻易篡改。
版本控制： 方便管理和维护不同版本的代码。

(第二幕：三大主角登场 – setuptools, Wheel, PyPI)

好了，废话不多说，咱们的主角要登场了！

1. setuptools：打包界的“老法师”

setuptools 是 Python 打包的“老法师”，它就像一位经验丰富的裁缝，能帮你把各种零散的代码文件、依赖库、资源文件缝制成一个完整的“程序套装”。

功能：
- 定义项目元数据（项目名称、版本号、作者、依赖等等）。
- 自动处理依赖关系。
- 创建各种类型的软件包（如 sdist 和 wheel）。
- 支持自定义安装脚本。

核心文件：setup.py

setup.py 是 setuptools 的灵魂，它就像一份“打包说明书”，告诉 setuptools 你的项目应该如何打包。

一个简单的 setup.py 看起来像这样：

from setuptools import setup, find_packages

setup(
    name='my_awesome_package',  # 项目名称
    version='0.1.0',  # 版本号
    description='A super cool package!',  # 项目描述
    author='Your Name',  # 作者
    author_email='[email protected]',  # 作者邮箱
    url='https://github.com/yourusername/my_awesome_package',  # 项目主页
    packages=find_packages(),  # 自动查找项目中的所有包
    install_requires=[  # 依赖的第三方库
        'requests',
        'numpy',
    ],
    classifiers=[  # 项目分类信息，方便 PyPI 搜索
        'Development Status :: 3 - Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
)

代码解释：

name：你的项目名称，要独一无二，就像你的网名一样！
version：版本号，遵循语义化版本规范（Semantic Versioning）。
description：项目描述，用一句话概括你的项目是干嘛的。
author：作者，留下你的大名！
author_email：作者邮箱，方便别人联系你。
url：项目主页，最好是 GitHub 仓库地址。
packages=find_packages()：自动查找项目中的所有包，避免手动一个个列出来。
install_requires：列出你的项目依赖的所有第三方库，setuptools 会自动安装它们。
classifiers：项目分类信息，方便用户在 PyPI 上搜索你的项目。

常用命令：
- python setup.py sdist：创建源代码包 (sdist)。
- python setup.py bdist_wheel：创建 wheel 包。
- python setup.py install：安装你的项目。

2. Wheel：打包界的“顺丰快递”

Wheel 是一种 Python 的打包格式，它就像一位高效的快递员，能更快、更可靠地把你的代码送到用户手中。

优点：
- 更快： Wheel 包是预编译的，安装速度比 sdist 快得多。
- 更可靠： Wheel 包包含所有依赖项，避免了在安装过程中出现依赖缺失的问题。
- 平台兼容性： Wheel 包可以包含特定平台的二进制文件，提高兼容性。
为什么需要 Wheel？

传统的 sdist 包需要用户在安装时编译源代码，这可能会遇到各种问题，比如缺少编译器、依赖库版本不兼容等等。而 Wheel 包是预编译的，用户可以直接安装，避免了这些问题。

想象一下，你网购了一台电脑，如果商家给你寄来的是一堆零件，让你自己组装，你会崩溃的！但如果商家给你寄来的是一台组装好的电脑，你只需要插上电源就能用，你会觉得很方便！Wheel 包就是 Python 世界里的“组装好的电脑”。
生成 Wheel 包：
```
python setup.py bdist_wheel
```
这条命令会在 dist 目录下生成一个 .whl 文件，这就是你的 Wheel 包。

3. PyPI：Python 代码的“App Store”

PyPI (Python Package Index) 是 Python 官方的软件包索引，它就像一个巨大的“App Store”，汇集了来自世界各地的 Python 代码。

功能：
- 托管 Python 软件包。
- 提供软件包的搜索、下载和安装功能。
- 允许开发者上传自己的软件包。
上传你的软件包到 PyPI：
1. 注册 PyPI 账号： 访问 https://pypi.org/ 注册一个账号。
2. 安装 twine： twine 是一个用于安全上传软件包到 PyPI 的工具。
```
pip install twine
```
3. 生成 sdist 和 wheel 包：
```
python setup.py sdist bdist_wheel
```
4. 上传软件包：
```
twine upload dist/*
```
  按照提示输入你的 PyPI 用户名和密码。
  
  注意： 为了安全起见，建议使用 API token 代替密码。可以在 PyPI 网站上生成 API token。
5. 验证： 上传成功后，你就可以在 PyPI 上搜索到你的软件包了！

(第三幕：实战演练 – 从零开始打包一个简单的项目)

理论讲了一大堆，现在咱们来点实际的，从零开始打包一个简单的 Python 项目。

1. 创建项目结构：

my_project/
├── my_package/
│   ├── __init__.py
│   └── my_module.py
├── LICENSE
├── README.md
└── setup.py

my_project：项目根目录。
my_package：你的 Python 包。
__init__.py：让 Python 知道 my_package 是一个包。
my_module.py：你的代码文件。
LICENSE：开源许可证。
README.md：项目说明文档。
setup.py：打包配置文件。

2. 编写代码：

my_module.py

def greet(name):
    """打招呼函数"""
    return f"Hello, {name}!"

__init__.py (可以为空，也可以包含一些初始化代码)
```
from .my_module import greet
```

3. 编写 setup.py：

from setuptools import setup, find_packages

setup(
    name='my_awesome_package',
    version='0.1.0',
    description='A simple example package',
    author='Your Name',
    author_email='[email protected]',
    url='https://github.com/yourusername/my_awesome_package',
    packages=find_packages(),
    install_requires=[
        # 这里可以添加依赖的第三方库
    ],
    classifiers=[
        'Development Status :: 3 - Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
)

4. 生成 sdist 和 wheel 包：

python setup.py sdist bdist_wheel

5. 上传到 PyPI (可选)：

twine upload dist/*

6. 安装你的软件包：

pip install dist/my_awesome_package-0.1.0-py3-none-any.whl  # 安装 wheel 包
# 或者
pip install my_awesome_package  # 从 PyPI 安装

(第四幕：进阶技巧 – 让你的打包更上一层楼)

使用 MANIFEST.in：

MANIFEST.in 文件用于指定哪些非 Python 文件（如数据文件、配置文件、模板文件）需要包含在你的软件包中。

例如：
```
include my_package/data/*
include README.md
include LICENSE
```
使用 package_data：

在 setup.py 中使用 package_data 可以更精确地控制哪些数据文件需要包含在你的软件包中。
```
setup(
    # ...
    package_data={
        'my_package': ['data/*.txt'],
    },
)
```
使用 entry_points：

entry_points 允许你定义命令行工具或其他类型的入口点。
```
setup(
    # ...
    entry_points={
        'console_scripts': [
            'my_command = my_package.my_module:main',
        ],
    },
)
```
这样，用户安装你的软件包后，就可以在命令行中使用 my_command 命令了。
使用 setup.cfg：

setup.cfg 文件可以用来配置 setuptools 的行为，比如指定默认的构建选项、添加自定义命令等等。
自动化打包流程：

可以使用 CI/CD 工具（如 GitHub Actions、GitLab CI）自动化打包和发布流程，每次代码提交后自动生成软件包并上传到 PyPI。

(结尾：让你的代码闪耀光芒)

各位，今天咱们聊了 Python 打包与分发的方方面面，从为什么要打包，到如何使用 setuptools, Wheel, PyPI，再到一些进阶技巧，希望对大家有所帮助。

记住，好的代码不仅要功能强大，还要易于使用和分享。把你的代码打包成精美的“豪华套餐”，让全世界人民都能轻松享用，让你的代码真正实现“全球出道”的梦想！✨

最后，祝各位的代码永远没有 bug，永远闪耀光芒！🎉

发表回复 取消回复

发表回复取消回复