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

Часто невозможно заранее записать все необходимое для создания дистрибутива: вам может потребоваться получить некоторую информацию от пользователя или от системы пользователя, чтобы продолжить. Если эта информация достаточно проста — например, список каталогов для поиска файлов заголовков 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-распределения. Часть этой информации поступает из скрипта setup, а часть автоматически генерируется Distutils (например, список установленных файлов). Но некоторые данные должны быть предоставлены в виде опций для bdist_rpm, что было бы очень утомительно делать в командной строке при каждом запуске. Поэтому вот фрагмент из собственного файла setup.cfg Distutils:

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

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

Примечания

1

Вероятно, этот идеал не будет достигнут до тех пор, пока автоконфигурация не будет полностью поддержана Distutils.