Python | 十一、项目搭建

项目环境配置

python setup.py 是 Python 中设置、分发和安装模块的传统方式。setup.py 文件通常位于一个 Python 项目的根目录下，并且定义了一个名为 setup 的函数。这个 setup 函数是 setuptools（或者早期的 distutils）模块的一部分，它负责处理项目的构建、打包和安装。

以下是 setup.py 文件的一些常见用法：

安装模块

要安装 setup.py 中定义的模块，你可以从项目的根目录运行以下命令：

python setup.py install

这个命令会构建模块（如果必需的话），然后将其安装到你的 Python 环境中。

打包和分发

如果你是一个库的作者，并且希望将你的库打包以便于分发，可以使用 setup.py 中的 sdist 命令来创建一个源代码分发包：

python setup.py sdist

这将会在项目目录下生成一个 dist/ 文件夹，包含了 .tar.gz 格式的源代码包。

构建扩展模块

如果你的项目包含一些需要编译的扩展模块，可以使用下面的命令来构建它们：

python setup.py build_ext --inplace

创建轮式分发文件（Wheel）

轮式分发文件（Wheel）是 Python 的二进制分发包格式，用 bdist_wheel 命令来创建：

python setup.py bdist_wheel

这也会在 dist/ 文件夹中产生对应的 .whl 文件。

清理

在开发过程中生成的临时文件或构建产物可以通过 clean 命令来清理：

python setup.py clean --all

setup.py 文件通常包括库或模块的元数据（如名称、版本、作者信息）、依赖列表和更多的信息。随着时间的发展，setuptools 成为构建和分发 Python 包的事实标准，但近年来，pip 和 wheel 替代了许多 setup.py 的用法。Python 官方也推荐使用 pyproject.toml 配置文件以同时兼容更多的构建系统（比如 Poetry 或 Flit）。

尽管如此，你仍然可能会遇到许多使用 setup.py 的项目，特别是在一些旧项目或需要特定构建步骤的项目中。在处理这些项目时理解 setup.py 的用法是很有帮助的。