sourcedist.md

1> **Источник:** https://python-all.ru/3.10/distutils/sourcedist.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 4. Создание дистрибутива исходного кода89> **Примечание**10>11> Этот документ сохраняется только до тех пор, пока `setuptools` документация по адресу [https://setuptools.readthedocs.io/en/latest/setuptools.html](https://python-all.ru/3.10/distutils/sourcedist.html) не станет самостоятельно охватывать всю актуальную информацию, приведённую здесь.1213Как показано в разделе [Простой пример](https://python-all.ru/3.10/distutils/introduction.html#distutils-simple-example), для создания дистрибутива исходного кода используется команда **sdist**. В простейшем случае1415```python16python setup.py sdist17```1819(при условии, что в скрипте установки или файле конфигурации не были указаны параметры **sdist**), **sdist** создаёт архив в формате, принятом по умолчанию для текущей платформы. По умолчанию на Unix это сжатый gzip tar-файл (`.tar.gz`), а на Windows – ZIP-файл.2021Можно указать любое количество форматов с помощью параметра `--formats`, например:2223```python24python setup.py sdist --formats=gztar,zip25```2627чтобы создать tar-архив, сжатый gzip, и zip-архив. Доступны следующие форматы:2829| Формат | Описание | Примечания |30| --- | --- | --- |31| `zip` | zip-файл (`.zip`) | (1),(3) |32| `gztar` | сжатый gzip tar-файл (`.tar.gz`) | (2) |33| `bztar` | сжатый bzip2 tar-файл (`.tar.bz2`) | (5) |34| `xztar` | сжатый xz tar-файл (`.tar.xz`) | (5) |35| `ztar` | сжатый tar-файл (`.tar.Z`) | (4),(5) |36| `tar` | tar-файл (`.tar`) | (5) |3738Изменено в версии 3.5: Добавлена поддержка формата `xztar`.3940Примечания:41421. по умолчанию на Windows432. по умолчанию на Unix443. требуется внешняя утилита **zip** или модуль [`zipfile`](https://python-all.ru/3.10/library/zipfile.html#module-zipfile) (входит в стандартную библиотеку Python начиная с Python 1.6)454. требуется программа **compress**. Обратите внимание, что этот формат теперь ожидает устаревания и будет удалён в будущих версиях Python.465. устарело согласно [PEP 527](https://python-all.ru/3.10/distutils/sourcedist.html); [PyPI](https://python-all.ru/3.10/distutils/sourcedist.html) принимает только файлы `.zip` и `.tar.gz`.4748При использовании любого формата `tar` (`gztar`, `bztar`, `xztar`, `ztar` или `tar`) в Unix можно указать имена `owner` и `group`, которые будут установлены для каждого элемента архива.4950Например, чтобы все файлы архива принадлежали пользователю root:5152```python53python setup.py sdist --owner=root --group=root54```5556## 4.1. Указание файлов для распространения5758Если не указан явный список файлов (или инструкции по его генерации), команда **sdist** помещает в дистрибутив исходного кода минимальный набор по умолчанию:5960- все исходные файлы Python, подразумеваемые параметрами `py_modules` и `packages`61- все исходные файлы C, упомянутые в параметрах `ext_modules` или `libraries`62- Скрипты, указанные с помощью опции `scripts`. См. [Установка скриптов](https://python-all.ru/3.10/distutils/setupscript.html#distutils-installing-scripts).63- всё, что похоже на тестовый скрипт: `test/test*.py` (в настоящее время Distutils ничего не делает с тестовыми скриптами, кроме как включает их в дистрибутивы исходного кода, но в будущем появится стандарт для тестирования дистрибутивов модулей Python)64- Любой из стандартных файлов README (`README`, `README.txt`, или `README.rst`), `setup.py` (или как вы назвали свой скрипт настройки) и `setup.cfg`.65- все файлы, соответствующие метаданным `package_data`. См. [Установка данных пакета](https://python-all.ru/3.10/distutils/setupscript.html#distutils-installing-package-data).66- все файлы, соответствующие метаданным `data_files`. См. [Установка дополнительных файлов](https://python-all.ru/3.10/distutils/setupscript.html#distutils-additional-files).6768Иногда этого достаточно, но обычно требуется указать дополнительные файлы для распространения. Типичный способ – написать *шаблон манифеста*, по умолчанию называемый `MANIFEST.in`. Шаблон манифеста – это просто список инструкций для создания файла манифеста, `MANIFEST`, который содержит точный перечень файлов, включаемых в дистрибутив исходного кода. Команда **sdist** обрабатывает этот шаблон и формирует манифест на основе его инструкций и того, что она находит в файловой системе.6970Если вы предпочитаете создать собственный файл манифеста, его формат прост: одно имя файла на строку, только обычные файлы (или симлинки на них). Если вы указываете свой собственный `MANIFEST`, необходимо указать всё: описанный выше стандартный набор файлов в этом случае не применяется.7172Изменено в версии 3.1: Существующий сгенерированный `MANIFEST` будет перегенерирован без сравнения его времени модификации со временем `MANIFEST.in` или `setup.py` командой **sdist**.7374Изменено в версии 3.1.3: Файлы `MANIFEST` начинаются с комментария, указывающего, что они сгенерированы. Файлы без этого комментария не перезаписываются и не удаляются.7576Изменено в версии 3.2.2: **sdist** будет читать файл `MANIFEST`, если файл `MANIFEST.in` не существует, как это делалось раньше.7778Изменено в версии 3.7: `README.rst` теперь включён в список стандартных файлов README в distutils.7980Шаблон манифеста содержит одну команду на строку, где каждая команда задаёт набор файлов для включения или исключения из дистрибутива исходного кода. В качестве примера снова обратимся к собственному шаблону манифеста Distutils:8182```text83include *.txt84recursive-include examples *.txt *.py85prune examples/sample?/build86```8788Значения должны быть довольно очевидны: включить все файлы в корне дистрибутива, соответствующие `*.txt`, все файлы в любом месте каталога `examples`, соответствующие `*.txt` или `*.py`, и исключить все каталоги, соответствующие `examples/sample?/build`. Всё это делается *после* стандартного набора включения, поэтому можно исключить файлы из стандартного набора с помощью явных инструкций в шаблоне манифеста. (Или можно использовать опцию `--no-defaults`, чтобы полностью отключить стандартный набор.) В мини-языке шаблона манифеста доступны и другие команды; см. раздел [Создание дистрибутива исходного кода: команда sdist](https://python-all.ru/3.10/distutils/commandref.html#sdist-cmd).8990Порядок команд в шаблоне манифеста важен: изначально имеется список стандартных файлов, описанный выше, и каждая команда в шаблоне добавляет файлы в этот список или удаляет из него. После полной обработки шаблона манифеста удаляются файлы, которые не должны включаться в дистрибутив исходного кода:9192- все файлы в дереве «build» Distutils (по умолчанию `build/`)93- все файлы в каталогах с именами `RCS`, `CVS`, `.svn`, `.hg`, `.git`, `.bzr` или `_darcs`9495Теперь у нас есть полный список файлов, который записывается в манифест для дальнейшего использования, а затем используется для создания архивов дистрибутива исходного кода.9697Стандартный набор включаемых файлов можно отключить с помощью опции `--no-defaults`, а стандартный набор исключаемых – с помощью `--no-prune`.9899Следуя собственному шаблону манифеста Distutils, проследим, как команда **sdist** формирует список файлов для включения в дистрибутив исходного кода Distutils:1001011. включить все исходные файлы Python в подкаталогах `distutils` и `distutils/command` (поскольку пакеты, соответствующие этим двум каталогам, были указаны в опции `packages` в скрипте настройки – см. раздел [Написание скрипта настройки](https://python-all.ru/3.10/distutils/setupscript.html#setup-script))1022. включить `README.txt`, `setup.py` и `setup.cfg` (стандартные файлы)1033. включить `test/test*.py` (стандартные файлы)1044. включить `*.txt` в корне дистрибутива (это приведёт к повторному обнаружению `README.txt`, но такие дубликаты будут отсеяны позже)1055. включить всё, соответствующее `*.txt` или `*.py`, в поддереве каталога `examples`,1066. исключить все файлы в поддеревьях, начинающихся с каталогов, соответствующих `examples/sample?/build` – это может исключить файлы, включённые на двух предыдущих шагах, поэтому важно, чтобы команда `prune` в шаблоне манифеста располагалась после команды `recursive-include`1077. исключить всё дерево `build`, а также любые каталоги `RCS`, `CVS`, `.svn`, `.hg`, `.git`, `.bzr` и `_darcs`108109Как и в скрипте настройки, имена файлов и каталогов в шаблоне манифеста должны всегда разделяться косой чертой; Distutils позаботится о преобразовании их в стандартное представление на вашей платформе. Таким образом, шаблон манифеста переносим между операционными системами.110111## 4.2. Параметры, связанные с манифестом112113Обычный порядок действий для команды **sdist** следующий:114115- если файл манифеста (по умолчанию `MANIFEST`) существует и первая строка не содержит комментария, указывающего, что он сгенерирован из `MANIFEST.in`, то он используется как есть, без изменений116- если файл манифеста не существует или был ранее автоматически сгенерирован, прочитать `MANIFEST.in` и создать манифест117- если не существует ни `MANIFEST`, ни `MANIFEST.in`, создать манифест только с набором стандартных файлов118- Для создания архива(ов) исходного дистрибутива используется список файлов, находящихся в `MANIFEST` (только что созданных или прочитанных\\n)119120Есть несколько опций, изменяющих это поведение. Во-первых, используйте\\n`--no-defaults` и `--no-prune` для отключения стандартных\\nнаборов «include» и «exclude».121122Во-вторых, можно просто (заново) сгенерировать манифест, но не создавать исходный\\nдистрибутив:123124```python125python setup.py sdist --manifest-only126```127128`-o` – это сокращение для `--manifest-only`.129