告别setup.py：理解新的构建与清理范式
在python生态系统中，项目构建和分发的方式正在演进。过去，setup.py文件是项目配置和构建的核心，它提供了如python setup.py clean --all这样的便捷命令来清除构建过程中产生的临时文件和目录。然而，随着pep 517和pep 518的引入，pyproject.toml文件和构建后端（如build模块）成为了现代python项目的首选。这种转变虽然带来了更灵活、更标准化的构建体验，但也意味着setup.py中的清理功能不再直接可用。对于那些完全基于pyproject.toml且不包含setup.py的项目，开发者需要一种新的方法来手动识别和清除构建产物。
常见的待清理构建产物
在Python项目的开发和构建过程中，会生成多种临时文件和目录，它们通常不需要被版本控制，并且在项目清理时应该被删除以确保环境的整洁。以下是几种最常见的类型：
-
__pycache__ 目录
- 含义： Python解释器为了提高模块加载速度而生成的字节码缓存目录。当Python文件被导入时，解释器会将其编译成字节码并存储在.pyc文件中，这些文件通常位于与其对应的.py文件同级的__pycache__子目录中。
- 生成原因： 模块首次导入或源文件更新时自动生成。
-
.pyc 文件
- 含义： 编译后的Python字节码文件。在Python 3.2及更高版本中，它们主要存在于__pycache__目录中。在旧版Python或特定情况下，也可能直接出现在.py文件旁边。
- 生成原因： 同__pycache__，由Python解释器自动生成。
-
.swp 文件
- 含义： 这类文件通常与文本编辑器（尤其是Vim）相关，是编辑文件时产生的交换文件（swap file）。它们用于在编辑器崩溃时恢复未保存的更改。
- 生成原因： 在使用Vim等编辑器编辑文件时自动生成。虽然不是严格意义上的“构建文件”，但它们是开发过程中常见的临时文件，通常也需要被清理。
-
build 目录
- 含义： 这是在项目构建过程中（例如，使用python -m build命令）生成的临时目录，用于存放构建过程中的中间文件，以及最终的发行包（如wheel文件和源分发包）在打包前的准备阶段。
- 生成原因： 执行构建命令时（如python -m build）自动创建。
手动清理操作指南
由于没有setup.py clean命令，我们需要通过命令行工具手动定位并删除这些文件和目录。
1. 清理 __pycache__ 目录
要删除项目中所有__pycache__目录，可以使用find命令：
find . -name "__pycache__" -type d -exec rm -rf {} +- find .：在当前目录及其子目录中查找。
- -name "__pycache__"：查找名为__pycache__的文件或目录。
- -type d：指定只查找目录。
- -exec rm -rf {} +：对找到的每个目录执行rm -rf命令。{}会被替换为找到的目录路径，+表示将所有找到的目录一次性传递给rm -rf，而不是为每个目录单独执行一次。
2. 清理 .pyc 文件
虽然大多数.pyc文件位于__pycache__中，但为了保险起见，也可以单独清理散落在项目根目录或其他位置的.pyc文件：
find . -name "*.pyc" -type f -exec rm -f {} +- -name "*.pyc"：查找所有以.pyc结尾的文件。
- -type f：指定只查找文件。
- -exec rm -f {} +：删除找到的每个.pyc文件。
3. 清理 .swp 文件
删除项目中所有.swp文件：
find . -name "*.swp" -type f -exec rm -f {} +- -name "*.swp"：查找所有以.swp结尾的文件。
- -type f：指定只查找文件。
- -exec rm -f {} +：删除找到的每个.swp文件。
4. 清理 build 目录
build目录通常位于项目的根目录。直接删除即可：
rm -rf build
如果您的项目还生成了dist目录（通常包含最终的wheel和sdist包），也应一并清理：
rm -rf dist
自动化清理实践
为了简化重复的清理工作，您可以将上述命令整合到一个脚本中，或者利用git clean命令（如果您的项目受Git版本控制）。
1. 创建清理脚本
在项目根目录创建一个名为clean.sh（或clean.bat，取决于操作系统）的脚本文件：
#!/bin/bash
echo "清理 __pycache__ 目录..."
find . -name "__pycache__" -type d -exec rm -rf {} +
echo "清理 .pyc 文件..."
find . -name "*.pyc" -type f -exec rm -f {} +
echo "清理 .swp 文件..."
find . -name "*.swp" -type f -exec rm -f {} +
echo "清理 build 和 dist 目录..."
rm -rf build dist
echo "清理完成！"然后，通过chmod +x clean.sh赋予执行权限，并通过./clean.sh运行。
2. 使用 git clean
如果您的项目使用Git进行版本控制，并且.gitignore文件配置得当（包含了所有应忽略的构建产物），那么git clean命令是一个非常强大的清理工具。
git clean -fdX
- -f (或 --force)：强制删除，因为git clean默认是安全的，需要强制选项。
- -d：删除未跟踪的目录。
- -X：只删除那些被.gitignore忽略的未跟踪文件。
注意： 使用git clean前请务必确认.gitignore文件已正确配置，并且您清楚将要删除哪些文件，以免误删重要数据。可以先运行git clean -n -fdX进行预览。
注意事项与最佳实践
确认再删除： 在执行任何删除命令前，尤其是rm -rf或git clean，请务必确认您了解这些命令将删除什么，避免误删重要文件。
-
.gitignore 的重要性： 始终在您的项目中使用.gitignore文件来忽略所有构建产物、临时文件和编辑器交换文件。这不仅可以防止这些文件被意外提交到版本库，也为git clean提供了清理依据。 一个典型的Python项目.gitignore文件可能包含：
# Byte-code files *.pyc __pycache__/ # Editors *.swp *~ # Build artifacts build/ dist/ *.egg-info/ .eggs/ # Virtual environment .venv/ venv/ # Test and coverage .pytest_cache/ .coverage htmlcov/ # Mypy .mypy_cache/
虚拟环境： 始终在虚拟环境（如venv或conda）中进行开发和测试。这可以有效隔离项目的依赖和构建过程，避免污染系统Python环境。清理虚拟环境通常只需删除对应的目录即可。
总结
尽管现代Python项目构建流程不再提供像setup.py clean那样的一键清理命令，但通过理解常见的构建产物及其生成机制，我们可以利用简单的命令行工具或脚本，有效地手动清除这些临时文件和目录。结合良好的.gitignore实践和git clean工具，可以确保您的Python项目环境始终保持整洁、高效。
以上就是Python项目清理：告别setup.py，手动清除构建文件的详细内容，更多请关注资源网其它相关文章！
发表评论:
◎欢迎参与讨论，请在这里发表您的看法、交流您的观点。