Python 是一種出色的程式語言，而且還有更多優點。然而，其最弱點之一是包裝。這是社會上眾所周知的事實。多年來，安裝、匯入、使用和建立套件已經有所改進，但它仍然無法與 Go 和 Rust 等較新的語言相提並論，後者可以從 Python 和其他更成熟的語言的鬥爭中學到很多東西。
在本教程中，您將學習建立和共享自己的套件所需的一切。有關 Python 套件的一般背景信息，請閱讀如何使用 Python 套件。
打包專案是一個過程，透過這個過程，您可以獲得一組一致的 Python 模組和可能的其他文件，並將它們放入可以輕鬆使用的結構中。您必須考慮多種因素，例如對其他套件的依賴關係、內部結構（子套件）、版本控制、目標受眾以及套件的形式（原始程式碼和/或二進位）。
讓我們從一個簡單的例子開始。 conman 套件是用於管理配置的套件。它支援多種檔案格式以及使用 etcd 的分散式配置。
套件的內容通常儲存在單一目錄中（儘管將子套件拆分到多個目錄中很常見），有時（如本例所示）會儲存在其自己的 git 儲存庫中。
根目錄包含各種設定檔（setup.py是必要的，也是最重要的一個），套件程式碼本身通常位於一個子目錄中，其名稱最好是套件的名稱一個測試目錄。這是 conman 的樣子：
> tree . ├── LICENSE ├── MANIFEST.in ├── README.md ├── conman │ ├── __init__.py │ ├── __pycache__ │ ├── conman_base.py │ ├── conman_etcd.py │ └── conman_file.py ├── requirements.txt ├── setup.cfg ├── setup.py ├── test-requirements.txt ├── tests │ ├── __pycache__ │ ├── conman_etcd_test.py │ ├── conman_file_test.py │ └── etcd_test_util.py └── tox.ini
讓我們快速瀏覽一下 setup.py 檔案。它從 setuptools 套件中導入兩個函數：setup() 和 find_packages()。然後它呼叫 setup() 函數並使用 find_packages() 作為參數之一。
from setuptools import setup, find_packages
setup(name='conman',
version='0.3',
url='https://github.com/the-gigi/conman',
license='MIT',
author='Gigi Sayfan',
author_email='the.gigi@gmail.com',
description='Manage configuration files',
packages=find_packages(exclude=['tests']),
long_description=open('README.md').read(),
zip_safe=False,
setup_requires=['nose>=1.0'],
test_suite='nose.collector')
這很正常。雖然setup.py 文件是一個常規的Python 文件，您可以在其中做任何您想做的事情，但它的主要工作是使用適當的參數呼叫setup()函數參數，因為在安裝套件時它將由各種工具以標準方式呼叫。我將在下一節中詳細介紹。
除了setup.py之外，還有一些其他可選設定檔可以顯示在此處並用於各種目的。
setup() 函數採用大量命名參數來控制套件安裝的許多方面以及執行各種命令。許多參數指定將包上傳到儲存庫時用於搜尋和過濾的元資料。
name：你的套件的名稱（以及它將如何在 PyPI 上列出）version：這對於維護正確的依賴管理至關重要url：套件的 URL，通常是 GitHub 或 readthedocs URLpackages：需要包含的子套件清單; find_packages() 在這裡提供幫助setup_requires：在這裡指定依賴項test_suite：測試時要執行哪個工具long_description 在此設定為 README.md 檔案的內容，這是擁有單一事實來源的最佳實踐。
setup.py 檔案也提供命令列介面來執行各種命令。例如，要執行單元測試，您可以鍵入： python setup.py test
running test running egg_info writing conman.egg-info/PKG-INFO writing top-level names to conman.egg-info/top_level.txt writing dependency_links to conman.egg-info/dependency_links.txt reading manifest file 'conman.egg-info/SOURCES.txt' reading manifest template 'MANIFEST.in' writing manifest file 'conman.egg-info/SOURCES.txt' running build_ext test_add_bad_key (conman_etcd_test.ConManEtcdTest) ... ok test_add_good_key (conman_etcd_test.ConManEtcdTest) ... ok test_dictionary_access (conman_etcd_test.ConManEtcdTest) ... ok test_initialization (conman_etcd_test.ConManEtcdTest) ... ok test_refresh (conman_etcd_test.ConManEtcdTest) ... ok test_add_config_file_from_env_var (conman_file_test.ConmanFileTest) ... ok test_add_config_file_simple_guess_file_type (conman_file_test.ConmanFileTest) ... ok test_add_config_file_simple_unknown_wrong_file_type (conman_file_test.ConmanFileTest) ... ok test_add_config_file_simple_with_file_type (conman_file_test.ConmanFileTest) ... ok test_add_config_file_simple_wrong_file_type (conman_file_test.ConmanFileTest) ... ok test_add_config_file_with_base_dir (conman_file_test.ConmanFileTest) ... ok test_dictionary_access (conman_file_test.ConmanFileTest) ... ok test_guess_file_type (conman_file_test.ConmanFileTest) ... ok test_init_no_files (conman_file_test.ConmanFileTest) ... ok test_init_some_bad_files (conman_file_test.ConmanFileTest) ... ok test_init_some_good_files (conman_file_test.ConmanFileTest) ... ok ---------------------------------------------------------------------- Ran 16 tests in 0.160s OK
setup.cfg is 是一個 ini 格式文件，其中可能包含傳遞給 setup.py 的命令的選項預設值。在這裡， setup.cfg 包含 nosetests （我們的測試運行程式）的一些選項：
[nosetests] verbose=1 nocapture=1
此檔案包含不屬於內部套件目錄的一部分，但您仍想包含的檔案。這些通常是自述文件、許可證文件等。一個重要的檔案是 requirements.txt。 pip 使用此檔案來安裝其他所需的軟體包。
這是 conman 的 MANIFEST.in 檔案：
include LICENSE include README.md include requirements.txt
您可以在 setup.py 的 install_requires 部分和 requirements.txt 檔案中指定依賴項。 Pip 將自動從 install_requires 安裝依賴項，但不會從 requirements.txt 檔案安裝。要安裝這些要求，您必須在執行 pip 時明確指定它： pip install -r requests.txt。
install_requires 选项旨在指定主要版本级别的最低和更抽象的要求。 requirements.txt 文件用于更具体的要求，通常包含固定的次要版本。
这是conman的需求文件。您可以看到所有版本都已固定，这意味着如果其中一个软件包升级并引入破坏 conman 的更改，它可能会受到负面影响。
PyYAML==3.11 python-etcd==0.4.3 urllib3==1.7 pyOpenSSL==0.15.1 psutil==4.0.0 six==1.7.3
固定让您可预测且安心。如果许多人在不同时间安装您的软件包，这一点尤其重要。如果没有固定，每个人都会根据安装时间获得不同的依赖版本组合。固定的缺点是，如果您不跟上依赖项的开发，您可能会陷入某些依赖项的旧的、性能不佳甚至易受攻击的版本。
我最初在2014年写了conman，并没有太关注它。现在，在本教程中，我升级了所有内容，并且几乎每个依赖项都进行了一些重大改进。
您可以创建源发行版或二进制发行版。我将涵盖两者。
使用以下命令创建源发行版：python setup.py sdist。这是 conman 的输出：
> python setup.py sdist running sdist running egg_info writing conman.egg-info/PKG-INFO writing top-level names to conman.egg-info/top_level.txt writing dependency_links to conman.egg-info/dependency_links.txt reading manifest file 'conman.egg-info/SOURCES.txt' reading manifest template 'MANIFEST.in' writing manifest file 'conman.egg-info/SOURCES.txt' warning: sdist: standard file not found: should have one of README, README.rst, README.txt running check creating conman-0.3 creating conman-0.3/conman creating conman-0.3/conman.egg-info making hard links in conman-0.3... hard linking LICENSE -> conman-0.3 hard linking MANIFEST.in -> conman-0.3 hard linking README.md -> conman-0.3 hard linking requirements.txt -> conman-0.3 hard linking setup.cfg -> conman-0.3 hard linking setup.py -> conman-0.3 hard linking conman/__init__.py -> conman-0.3/conman hard linking conman/conman_base.py -> conman-0.3/conman hard linking conman/conman_etcd.py -> conman-0.3/conman hard linking conman/conman_file.py -> conman-0.3/conman hard linking conman.egg-info/PKG-INFO -> conman-0.3/conman.egg-info hard linking conman.egg-info/SOURCES.txt -> conman-0.3/conman.egg-info hard linking conman.egg-info/dependency_links.txt -> conman-0.3/conman.egg-info hard linking conman.egg-info/not-zip-safe -> conman-0.3/conman.egg-info hard linking conman.egg-info/top_level.txt -> conman-0.3/conman.egg-info copying setup.cfg -> conman-0.3 Writing conman-0.3/setup.cfg creating dist Creating tar archive removing 'conman-0.3' (and everything under it)
如您所见，我收到一条关于缺少带有标准前缀之一的 README 文件的警告，因为我喜欢 Markdown，所以我有一个 README.md 。除此之外，还包括所有包源文件和附加文件。然后，在conman.egg-info目录中创建了一堆元数据。最后，创建一个名为 conman-0.3.tar.gz 的压缩 tar 存档，并将其放入 dist 子目录中。
安装这个包需要一个构建步骤（即使它是纯Python）。您可以正常使用 pip 安装它，只需传递包的路径即可。例如：
pip install dist/conman-0.3.tar.gz Processing ./dist/conman-0.3.tar.gz Installing collected packages: conman Running setup.py install for conman ... done Successfully installed conman-0.3
Conman 已安装到站点包中，可以像任何其他包一样导入：
import conman conman.__file__ '/Users/gigi/.virtualenvs/conman/lib/python2.7/site-packages/conman/__init__.pyc'
Wheels 是一种相对较新的方式来打包 Python 代码和可选的 C 扩展。它们取代了鸡蛋的形式。轮子有几种类型：纯Python轮子、平台轮子、通用轮子。纯 Python 轮子是像 conman 这样的包，没有任何 C 扩展代码。
平台轮子确实有 C 扩展代码。通用轮子是纯 Python 轮子，兼容具有相同代码库的 Python 2 和 Python 3（它们甚至不需要 2 到 3）。
如果您有一个纯 Python 包，并且希望您的包同时支持 Python 2 和 Python 3（变得越来越重要），那么您可以构建一个通用构建，而不是为 Python 2 构建一个轮子，为 Python 构建一个轮子3.
Python 3 是当前受到积极支持的 Python 版本，不断更新、改进和社区支持；建议对所有新项目和迁移使用 Python 3。如果你的包有C扩展代码，你必须为每个平台构建一个平台轮。轮子的巨大好处，特别是对于带有 C 扩展的软件包来说，是不需要在目标机器上提供编译器和支持库。该轮子已经包含一个内置包。所以你知道它不会构建失败，而且安装速度要快得多，因为它实际上只是一个副本。使用 Numpy 和 Pandas 等科学库的人可以真正体会到这一点，因为安装此类软件包过去需要很长时间，并且如果缺少某些库或编译器配置不正确，则可能会失败。
构建纯轮子或平台轮子的命令是：python setup.py bdist_wheel。
Setuptools——提供 setup() 函数的引擎——将自动检测是否需要纯轮子或平台轮子。
running bdist_wheel running build running build_py creating build creating build/lib creating build/lib/conman copying conman/__init__.py -> build/lib/conman copying conman/conman_base.py -> build/lib/conman copying conman/conman_etcd.py -> build/lib/conman copying conman/conman_file.py -> build/lib/conman installing to build/bdist.macosx-10.9-x86_64/wheel running install running install_lib creating build/bdist.macosx-10.9-x86_64 creating build/bdist.macosx-10.9-x86_64/wheel creating build/bdist.macosx-10.9-x86_64/wheel/conman copying build/lib/conman/__init__.py -> build/bdist.macosx-10.9-x86_64/wheel/conman copying build/lib/conman/conman_base.py -> build/bdist.macosx-10.9-x86_64/wheel/conman copying build/lib/conman/conman_etcd.py -> build/bdist.macosx-10.9-x86_64/wheel/conman copying build/lib/conman/conman_file.py -> build/bdist.macosx-10.9-x86_64/wheel/conman running install_egg_info running egg_info creating conman.egg-info writing conman.egg-info/PKG-INFO writing top-level names to conman.egg-info/top_level.txt writing dependency_links to conman.egg-info/dependency_links.txt writing manifest file 'conman.egg-info/SOURCES.txt' reading manifest file 'conman.egg-info/SOURCES.txt' reading manifest template 'MANIFEST.in' writing manifest file 'conman.egg-info/SOURCES.txt' Copying conman.egg-info to build/bdist.macosx-10.9-x86_64/wheel/conman-0.3-py2.7.egg-info running install_scripts creating build/bdist.macosx-10.9-x86_64/wheel/conman-0.3.dist-info/WHEEL
查看dist目录，可以看到创建了一个纯Python的轮子：
ls -la dist dist/ total 32 -rw-r--r-- 1 gigi staff 5.5K Feb 29 07:57 conman-0.3-py2-none-any.whl -rw-r--r-- 1 gigi staff 4.4K Feb 28 23:33 conman-0.3.tar.gz
名称 conman-0.3-py2-none-any.whl 有几个组件：
要构建通用包，您只需添加 --universal，如 python setup.py bdist_wheel --universal。
生成的轮子名为 conman-0.3-py2.py3-none-any.whl。
请注意，如果您创建通用包，您有责任确保您的代码实际上可以在 Python 2 和 Python 3 下运行。
Toml（Tom's Obvious Minimal Language）是一种易于使用的配置文件格式，用于配置软件应用程序。尽管 setup.py 仍然被广泛使用和支持，PEP518 建议使用 pyproject.toml 文件而不是 setup.py 进行打包和分发。
让我们使用pyproject.toml创建一个名为 apex 的简单 Python 包，用于检查电池状态并在电池充满时显示一条消息。
创建一个名为 apex 的目录结构。在 apex 内，添加一个 pyproject.toml 和一个 README.md 文件。
.apex ├── pyproject.toml └── README.md
在根 apex 目录中，创建一个名为 apex 的子目录，其中包含一个 __init__.py 文件以使其成为一个包和一个 battery.py 文件。您的项目目录现在应如下所示：
. ├── apex │ ├── battery.py │ └── __init__.py ├── pyproject.toml └── README.md
使用 pip 安装 psutil 包。
pip install psutil
Psutil（进程和系统实用程序）是一个用于 Python 中进程和系统监控的跨平台库。 Psutil 可以检索有关系统上运行的进程的信息，例如状态、CPU 使用情况和内存使用情况。它还可以操纵系统进程。
在battery.py文件中，添加检查电池是否已充满的代码。
import psutil
def check_battery():
battery = psutil.sensors_battery()
plugged = battery.power_plugged
percent = battery.percent
if percent == 100 and plugged:
print "Battery is full. Unplug your Charger"
else:
print "Battery is not yet full."
if __name__ == "__main__":
message = check_battery()
print(message)
pyproject.toml 文件包含包的元数据，包括：
构建系统名称版本项目依赖项.打开pyproject.toml并指定 setuptools 作为构建系统。
[build-system] requires = ["setuptools","wheel"] build-backend ="setuptools.build_meta"
指定包的名称、版本号和项目依赖项列表。现在 pyproject.toml 文件如下所示：
[build-system] requires = ["setuptools","wheel"] build-backend ="setuptools.build_meta" [project] name="apex" version ="1.0.0" [project-dependencies] psutil ="5.9.5"
最后，在README.md文件中添加以下内容。
# apex **apex** is a Python package that allows you to check the battery status of your laptop and display a message when the battery is full. ## Features - Retrieve battery status information - Display a message when the battery is full - Cross-platform support (Windows, macOS, Linux, etc.) ## Installation Install **apex** using `pip`: ```shell pip install apex
使用 build 命令构建包。
python -m build
您应该看到下面的输出，该输出已被我截断。
creating build/bdist.linux-x86_64/wheel/apex-1.0.0.dist-info/WHEEL creating '/home/vaati/Desktop/apex/dist/.tmp-d8_lqaaj/apex-1.0.0-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it adding 'apex/__init__.py' adding 'apex/battery.py' adding 'apex-1.0.0.dist-info/METADATA' adding 'apex-1.0.0.dist-info/WHEEL' adding 'apex-1.0.0.dist-info/top_level.txt' adding 'apex-1.0.0.dist-info/RECORD' removing build/bdist.linux-x86_64/wheel Successfully built apex-1.0.0.tar.gz and apex-1.0.0-py3-none-any.whl
构建会创建一个 dist 文件夹，其中包含包的分发文件：
构建过程还会生成一个 apex.egg-info 文件夹，其中包含有关包的元数据。
. ├── apex │ ├── battery.py │ └── __init__.py ├── apex.egg-info │ ├── dependency_links.txt │ ├── PKG-INFO │ ├── SOURCES.txt │ └── top_level.txt ├── dist │ ├── apex-1.0.0-py3-none-any.whl │ └── apex-1.0.0.tar.gz ├── pyproject.toml └── README.md
编写自己的 Python 包需要处理大量工具，指定大量元数据，并仔细考虑您的依赖项和目标受众。但回报是巨大的。
如果您编写有用的代码并正确打包它，人们将能够轻松安装它并从中受益。
以上是創建您自己的 Python 套件的詳細內容。更多資訊請關注PHP中文網其他相關文章！
