【原】打包一個(gè)Python庫（PyPa）

云深無際 2021-11-19

展開全文

其實(shí)今天量都夠了，但是還是想再補(bǔ)一篇：

本文的寫作環(huán)境，喜歡這種黑暗+昏暗的燈光

緣起~為什么會(huì)有這樣的一篇文章呢？因?yàn)槲易罱谧xPython的官方文檔，里面正好讀到了這里安裝Python模塊，然后我天天也在讀源碼，也在實(shí)踐中得到了一些佐證。所以記錄一下。

這一切是一個(gè)組織在維護(hù)：

https://www.pypa.io/en/latest/

Python Packaging Authority (PyPA) 是一個(gè)工作組，負(fù)責(zé)維護(hù) Python 打包中使用的一組核心軟件項(xiàng)目。

這里我找一個(gè)庫作為說明:

https://github.com/3b1b/manim

使用這個(gè)

https://docs.manim.org.cn/

https://3b1b.github.io/manim/

然后解壓，看到這些，今天就說這些

這里是打印Python的版本

https://packaging.python.org/

關(guān)于我這篇文章的參考位置

py -m pip --version

pip 21.3.1 from C:\Users\yunswj\AppData\Local\Programs\Python\Python36\lib\site-packages\pip (python 3.6)

打印PIP的版本。

https://packaging.python.org/tutorials/packaging-projects/

看這個(gè)

https://pip.pypa.io/en/stable/

https://setuptools.pypa.io/en/latest/

py -m pip install --upgrade pip

pip的源文件樣子

packaging_tutorial/└── src/ └── example_package/ ├── __init__.py └── example.py

未來寫庫應(yīng)該寫的是這樣的

我們創(chuàng)建一個(gè)

pyproject.toml告訴構(gòu)建工具（如pip和build）構(gòu)建項(xiàng)目需要什么。

給出要構(gòu)建包的依賴包

我們的manim，這里也有寫法

配置元數(shù)據(jù)

有兩種類型的元數(shù)據(jù)：靜態(tài)和動(dòng)態(tài)。

靜態(tài)元數(shù)據(jù) ( setup.cfg)：保證每次都相同。這更簡單、更易于閱讀，并避免了許多常見錯(cuò)誤，例如編碼錯(cuò)誤。
動(dòng)態(tài)元數(shù)據(jù) ( setup.py)：可能是不確定的。任何動(dòng)態(tài)的或在安裝時(shí)確定的項(xiàng)目，以及擴(kuò)展模塊或 setuptools 的擴(kuò)展，都需要進(jìn)入setup.py.

setup.cfg應(yīng)首選靜態(tài)元數(shù)據(jù) ( )。動(dòng)態(tài)元數(shù)據(jù) ( setup.py) 應(yīng)僅在絕對必要時(shí)用作逃生艙口。setup.py過去是必需的，但在較新版本的 setuptools 和 pip 中可以省略。

這個(gè)是demo的例子：

[metadata]name = example-pkg-YOUR-USERNAME-HEREversion = 0.0.1author = Example Authorauthor_email = author@example.comdescription = A small example packagelong_description = file: README.mdlong_description_content_type = text/markdownurl = https://github.com/pypa/sampleprojectproject_urls = Bug Tracker = https://github.com/pypa/sampleproject/issuesclassifiers = Programming Language :: Python :: 3 License :: OSI Approved :: MIT License Operating System :: OS Independent

[options]package_dir = = srcpackages = find:python_requires = >=3.6

[options.packages.find]where = src

setuptools的例子：

[metadata]name = my_packageversion = attr: src.VERSIONdescription = My package descriptionlong_description = file: README.rst, CHANGELOG.rst, LICENSE.rstkeywords = one, twolicense = BSD 3-Clause Licenseclassifiers = Framework :: Django License :: OSI Approved :: BSD License Programming Language :: Python :: 3 Programming Language :: Python :: 3.5

[options]zip_safe = Falseinclude_package_data = Truepackages = find:scripts = bin/first.py bin/second.pyinstall_requires = requests importlib; python_version == "2.6"

[options.package_data]* = *.txt, *.rsthello = *.msg

[options.entry_points]console_scripts = executable-name = package.module:function

[options.extras_require]pdf = ReportLab>=1.2; RXPrest = docutils>=0.3; pack ==1.1, ==1.3

[options.packages.find]exclude = src.subpackage1 src.subpackage2

相當(dāng)于教科書級別的寫法了

把我們的元文件復(fù)制進(jìn)來

https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

這個(gè)是語法，是和win ini文件一樣的配置文件

支持的 INI 文件結(jié)構(gòu)

配置文件由部分組成，每個(gè)部分由一個(gè)[section]標(biāo)題引導(dǎo)，后跟由特定字符串（=或:默認(rèn)情況下為1）分隔的鍵/值條目。默認(rèn)情況下，部分名稱區(qū)分大小寫，但鍵不是 1。從鍵和值中刪除前導(dǎo)和尾隨空格。如果解析器配置為允許它1，則可以省略值，在這種情況下，鍵/值分隔符也可以省略。值也可以跨越多行，只要它們比值的第一行縮進(jìn)得更深。根據(jù)解析器的模式，空行可能被視為多行值的一部分或被忽略。