4. Создание дистрибутива исходного кода¶Creating a Source Distribution

4.3.1. Принцип¶Principle

Шаблон манифеста содержит одну команду на строку, где каждая команда определяет набор файлов для включения или исключения из исходного дистрибутива. Для примера рассмотрим собственный шаблон манифеста Distutils:

include *.txt
recursive-include examples *.txt *.py
prune examples/sample?/build

Значения должны быть достаточно понятны: включить все файлы в корне дистрибутива, соответствующие *.txt, все файлы в каталоге examples, соответствующие *.txt или *.py, и исключить все каталоги, соответствующие examples/sample?/build. Всё это выполняется после стандартного набора включения, поэтому можно исключить файлы из стандартного набора с помощью явных инструкций в шаблоне манифеста. (Или можно использовать опцию --no-defaults, чтобы полностью отключить стандартный набор.)

Порядок команд в шаблоне манифеста важен: изначально имеется список стандартных файлов, описанный выше, и каждая команда в шаблоне добавляет файлы в этот список или удаляет из него. После полной обработки шаблона манифеста удаляются файлы, которые не должны включаться в дистрибутив исходного кода:

• все файлы в дереве «build» Distutils (по умолчанию build/)

• все файлы в каталогах с именами RCS, CVS, .svn, .hg, .git, .bzr или _darcs

Теперь у нас есть полный список файлов, который записывается в манифест для дальнейшего использования, а затем используется для создания архивов дистрибутива исходного кода.

Стандартный набор включаемых файлов можно отключить с помощью опции --no-defaults, а стандартный набор исключаемых – с помощью --no-prune.

Следуя собственному шаблону манифеста Distutils, проследим, как команда sdist формирует список файлов для включения в дистрибутив исходного кода Distutils:

1. включить все исходные файлы Python в подкаталогах distutils и distutils/command (поскольку пакеты, соответствующие этим двум каталогам, были указаны в опции packages в скрипте настройки – см. раздел Написание скрипта настройки)

2. включить README.txt, setup.py и setup.cfg (стандартные файлы)

3. включить test/test*.py (стандартные файлы)

4. включить *.txt в корне дистрибутива (это приведёт к повторному обнаружению README.txt, но такие дубликаты будут отсеяны позже)

5. включить всё, соответствующее *.txt или *.py, в поддереве каталога examples,

6. исключить все файлы в поддеревьях, начинающихся с каталогов, соответствующих examples/sample?/build – это может исключить файлы, включённые на двух предыдущих шагах, поэтому важно, чтобы команда prune в шаблоне манифеста располагалась после команды recursive-include

7. исключить всё дерево build, а также любые каталоги RCS, CVS, .svn, .hg, .git, .bzr и _darcs

Как и в скрипте настройки, имена файлов и каталогов в шаблоне манифеста должны всегда разделяться косой чертой; Distutils позаботится о преобразовании их в стандартное представление на вашей платформе. Таким образом, шаблон манифеста переносим между операционными системами.

4.3.2. Команды¶Commands

Команды шаблона манифеста:

Здесь используются шаблоны Unix-стиля «glob»: * соответствует любой последовательности обычных символов имени файла, ? соответствует любому одному такому символу, а [range] соответствует любому из символов в диапазоне (например, a-z, a-zA-Z, a-f0-9_.). Определение «обычного символа имени файла» зависит от платформы: в Unix это любой символ, кроме косой черты; в Windows любой символ, кроме обратной косой черты или двоеточия.