Написание файла конфигурации установки

Часто невозможно заранее записать всё необходимое для построения дистрибутива: может потребоваться получить некоторую информацию от пользователя или от системы пользователя, чтобы продолжить. Если эта информация достаточно простая — например, список каталогов для поиска файлов заголовков C или библиотек — то предоставление файла конфигурации setup.cfg, который пользователи могут редактировать, является недорогим и простым способом запроса этой информации. Файлы конфигурации также позволяют предоставлять значения по умолчанию для любого командного параметра, которые установщик затем может переопределить либо в командной строке, либо отредактировав файл конфигурации.

Файл конфигурации установки является полезной промежуточной точкой между скриптом установки — который, в идеале, был бы непрозрачным для установщиков 1 — и командной строкой скрипта установки, которая находится вне вашего контроля и полностью зависит от установщика. Фактически, setup.cfg (и любые другие файлы конфигурации Distutils, присутствующие в целевой системе) обрабатываются после содержимого скрипта установки, но перед командной строкой. Это имеет несколько полезных последствий:

• установщики могут переопределить часть того, что вы указали в setup.py, отредактировав setup.cfg
• вы можете предоставить нестандартные значения по умолчанию для параметров, которые трудно установить в setup.py
• установщики могут переопределить всё в setup.cfg с помощью параметров командной строки для setup.py

Основной синтаксис файла конфигурации прост:

[command]
option=value
...

где команда — одна из команд Distutils (например, build_py, install), а параметр — один из параметров, поддерживаемых командой. Для каждой команды можно указать любое количество параметров, и в файле можно включить любое количество разделов команд. Пустые строки игнорируются, как и комментарии, которые начинаются с символа '#' и продолжаются до конца строки. Значения длинных параметров могут быть разделены на несколько строк, просто отступив строки продолжения.

Список параметров, поддерживаемых конкретной командой, можно узнать с помощью универсального параметра --help, например:

$ python setup.py --help build_ext
[...]
Options for 'build_ext' command:
  --build-lib (-b)     directory for compiled extension modules
  --build-temp (-t)    directory for temporary files (build by-products)
  --inplace (-i)       ignore build-lib and put compiled extensions into the
                       source directory alongside your pure Python modules
  --include-dirs (-I)  list of directories to search for header files
  --define (-D)        C preprocessor macros to define
  --undef (-U)         C preprocessor macros to undefine
  --swig-opts          list of SWIG command line options
[...]

Обратите внимание, что параметр, написанный --foo-bar в командной строке, записывается как foo_bar в файлах конфигурации.

Например, предположим, что вы хотите, чтобы ваши расширения были построены «на месте» — то есть у вас есть расширение pkg.ext, и вы хотите, чтобы скомпилированный файл расширения (ext.so на Unix, например) был помещён в тот же каталог исходных файлов, что и ваши чистые модули Python pkg.mod1 и pkg.mod2. Вы всегда можете использовать параметр --inplace в командной строке, чтобы гарантировать это:

python setup.py build_ext --inplace

Но это требует, чтобы вы всегда явно указывали команду build_ext и помнили предоставить --inplace. Более простой способ — «установить и забыть» этот параметр, закодировав его в setup.cfg, файле конфигурации этого дистрибутива:

[build_ext]
inplace=1

Это повлияет на все сборки этого модульного дистрибутива, независимо от того, укажете вы явно build_ext или нет. Если вы включите setup.cfg в свой дистрибутив исходного кода, это также повлияет на сборки конечных пользователей — что, вероятно, нежелательно для этого параметра, так как постоянное построение расширений на месте нарушит установку модульного дистрибутива. Однако в определённых особых случаях модули собираются прямо в каталог установки, поэтому это, возможно, полезная возможность. (Однако распространение расширений, которые ожидают сборки в каталоге установки, почти всегда плохая идея.)

Ещё один пример: некоторые команды принимают множество параметров, которые не меняются при каждом запуске; например, bdist_rpm необходимо знать всё, что требуется для генерации файла «spec» для создания дистрибутива RPM. Часть этой информации поступает из скрипта установки, а часть автоматически генерируется Distutils (например, список установленных файлов). Но часть её нужно предоставить как параметры для bdist_rpm, что было бы очень утомительно делать в командной строке для каждого запуска. Вот фрагмент из собственного файла конфигурации Distutils setup.cfg:

[bdist_rpm]
release = 1
packager = Greg Ward <gward@python.net>
doc_files = CHANGES.txt
            README.txt
            USAGE.txt
            doc/
            examples/

Обратите внимание, что параметр doc_files — это просто строка, разделённая пробелами, разбитая на несколько строк для лучшей читабельности.

Примечания

1

Этот идеал, вероятно, не будет достигнут до тех пор, пока автоматическая настройка не будет полностью поддерживаться Distutils.