apiref.md

1> **Источник:** https://python-all.ru/3.4/distutils/apiref.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 10. Справочник API89## 10.1. [`distutils.core`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.core) – Основная функциональность Distutils1011Модуль [`distutils.core`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.core) – единственный модуль, который необходимо установить для использования Distutils. Он предоставляет [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup) (которая вызывается из setup-скрипта). Косвенно предоставляет классы `distutils.dist.Distribution` и [`distutils.cmd.Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command).1213#### `distutils.core.setup(arguments)`1415Базовая универсальная функция, которая делает почти всё, что можно попросить у метода Distutils.1617Функция setup принимает большое количество аргументов. Они перечислены в следующей таблице.1819| имя аргумента | значение | тип |20| --- | --- | --- |21| *имя* | Название пакета | строка |22| *version* | Номер версии пакета; см. [`distutils.version`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.version) | строка |23| *описание* | Краткое описание пакета (одна строка) | строка |24| *long\_description* | Подробное описание пакета | строка |25| *author* | Имя автора пакета | строка |26| *author\_email* | Адрес электронной почты автора пакета | строка |27| *maintainer* | Имя текущего мейнтейнера, если оно отличается от автора. Обратите внимание: если мейнтейнер указан, distutils будет использовать его как автора в `PKG-INFO` | строка |28| *maintainer\_email* | Адрес электронной почты текущего сопровождающего, если он отличается от автора | строка |29| *url* | URL пакета (домашняя страница) | строка |30| *download\_url* | URL для загрузки пакета | строка |31| *packages* | Список пакетов Python, которыми будет управлять distutils | список строк |32| *py\_modules* | Список модулей Python, которыми будет управлять distutils | список строк |33| *сценарии* | Список отдельных файлов скриптов, которые нужно собрать и установить | список строк |34| *ext\_modules* | Список расширений Python, которые необходимо собрать | список экземпляров [`distutils.core.Extension`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Extension) |35| *classifiers* | Список категорий для пакета | список строк; допустимые классификаторы перечислены на [PyPI](https://python-all.ru/3.4/distutils/apiref.html). |36| *distclass* | класс [`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution) для использования | подкласс [`distutils.core.Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution) |37| *script\_name* | Имя скрипта setup.py – по умолчанию `sys.argv[0]` | строка |38| *script\_args* | Аргументы, передаваемые скрипту setup | список строк |39| *options* | параметры по умолчанию для скрипта setup | словарь |40| *license* | Лицензия пакета | строка |41| *keywords* | Описательные метаданные, см. [**PEP 314**](https://python-all.ru/3.4/distutils/apiref.html) | список строк или строка, разделённая запятыми |42| *platforms* |  | список строк или строка, разделённая запятыми |43| *cmdclass* | Сопоставление имён команд с подклассами [`Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Command) | словарь |44| *data\_files* | Список файлов данных для установки | список |45| *package\_dir* | Сопоставление пакетов и имён каталогов | словарь |4647#### `distutils.core.run_setup(script_name[, script_args=None, stop_after='run'])`4849Запускает сценарий установки в частично контролируемом окружении и возвращает экземпляр `distutils.dist.Distribution`, который управляет процессом. Это полезно, если нужно получить метаданные дистрибутива (передаваемые в виде именованных аргументов из *script* в [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup)) или содержимое конфигурационных файлов или командной строки.5051*script\_name* – это файл, который будет прочитан и выполнен с помощью [`exec()`](https://python-all.ru/3.4/library/functions.html#exec). `sys.argv[0]` будет заменён на *script* на время вызова. *script\_args* – это список строк; если он указан, `sys.argv[1:]` будет заменён на *script\_args* на время вызова.5253*stop\_after* указывает [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup), когда останавливать обработку; возможные значения:5455| значение | описание |56| --- | --- |57| *init* | Остановиться после того, как экземпляр [`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution) был создан и заполнен именованными аргументами [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup) |58| *config* | Остановиться после того, как конфигурационные файлы будут разобраны (а их данные сохранены в экземпляре [`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution)) |59| *commandline* | Остановиться после того, как командная строка (`sys.argv[1:]` или *script\_args*) будет разобрана (а данные сохранены в экземпляре [`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution)) |60| *run* | Остановиться после выполнения всех команд (то же самое, как если бы [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup) была вызвана обычным способом). Это значение по умолчанию. |6162Кроме того, модуль [`distutils.core`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.core) предоставляет ряд классов, которые находятся в других местах.6364- `Extension` из [`distutils.extension`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.extension)65- [`Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command) из [`distutils.cmd`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.cmd)66- `Distribution` из [`distutils.dist`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.dist)6768Краткое описание каждого из них приведено ниже, но полную справку смотрите в соответствующем модуле.6970#### `class distutils.core.Extension`7172Класс Extension описывает один модуль расширения C или C++ в сценарии установки. Его конструктор принимает следующие именованные аргументы:7374| имя аргумента | значение | тип |75| --- | --- | --- |76| *имя* | полное имя расширения, включая любые пакеты – то есть *не* имя файла или путь, а точечное имя Python | строка |77| *sources* | список имён исходных файлов, относительно корня дистрибутива, корень (где setup-скрипт находится), в Unix-формате (косая черта) для переносимости. Исходные файлы могут быть на C, C++, SWIG (.i), платформенно-зависимые файлы ресурсов или что-либо ещё распознаётся командой **build\_ext** как исходный код для расширения Python. | список строк |78| *include\_dirs* | список каталогов для поиска файлов заголовков C/C++ (в формате Unix для переносимости) | список строк |79| *define\_macros* | список макросов для определения; каждый макрос определяется с помощью кортежа из двух элементов `(name, value)`, где *value* – это либо строка для определения значения, либо `None` для определения без конкретного значения (эквивалент `#define FOO` в исходном коде или *-DFOO* в командной строке C компилятора Unix) | список кортежей |80| *undef\_macros* | список макросов, которые нужно явно отменить | список строк |81| *library\_dirs* | список каталогов для поиска библиотек C/C++ во время компоновки | список строк |82| *libraries* | список имён библиотек (не имён файлов или путей) для компоновки | список строк |83| *runtime\_library\_dirs* | список каталогов для поиска библиотек C/C++ во время выполнения (для разделяемых расширений это момент загрузки расширения) | список строк |84| *extra\_objects* | список дополнительных файлов для компоновки (например, объектные файлы, не входящие в «sources», статическая библиотека, которую нужно явно указать, бинарные ресурсные файлы и т.д.) | список строк |85| *extra\_compile\_args* | любая дополнительная информация, зависящая от платформы и компилятора, используемая при компиляции исходных файлов из «sources». Для платформ и компиляторов, где командная строка имеет смысл, это обычно список аргументов командной строки, но для других платформ это может быть что угодно. | список строк |86| *extra\_link\_args* | любая дополнительная информация, зависящая от платформы и компилятора, используемая при компоновке объектных файлов для создания расширения (или для создания нового статического интерпретатора Python). Интерпретация аналогична «extra\_compile\_args». | список строк |87| *export\_symbols* | список символов для экспорта из разделяемого расширения. Не используется на всех платформах и обычно не требуется для расширений Python, которые обычно экспортируют ровно один символ: `init` + extension\_name. | список строк |88| *зависит* | список файлов, от которых зависит расширение | список строк |89| *язык* | язык расширения (т.е. `'c'`, `'c++'`, `'objc'`). Будет определён по расширениям исходных файлов, если не указан. | строка |90| *опционально* | указывает, что при сбое сборки расширения не нужно прерывать процесс сборки, а просто пропустить это расширение. | булево значение |9192#### `class distutils.core.Distribution`9394[`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution) описывает, как собрать, установить и упаковать программный пакет Python.9596См. функцию [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup) для списка ключевых аргументов, принимаемых конструктором Distribution. [`setup()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.setup) создаёт экземпляр Distribution.9798#### `class distutils.core.Command`99100Класс [`Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Command) (а точнее, экземпляр одного из его подклассов) реализует одну команду distutils.101102## 10.2. [`distutils.ccompiler`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.ccompiler) – базовый класс CCompiler103104Этот модуль предоставляет абстрактный базовый класс для классов [`CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler). Экземпляр [`CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler) можно использовать для всех этапов компиляции и компоновки, необходимых для сборки одного проекта. Предоставляются методы для установки параметров компилятора – макроопределений, путей включения, путей компоновки, библиотек и тому подобного.105106Этот модуль предоставляет следующие функции.107108#### `distutils.ccompiler.gen_lib_options(compiler, library_dirs, runtime_library_dirs, libraries)`109110Генерирует параметры компоновщика для поиска каталогов библиотек и компоновки с конкретными библиотеками. *libraries* и *library\_dirs* – это соответственно списки имён библиотек (не имён файлов!) и каталогов поиска. Возвращает список параметров командной строки, подходящих для использования с некоторым компилятором (в зависимости от двух переданных строк формата).111112#### `distutils.ccompiler.gen_preprocess_options(macros, include_dirs)`113114Генерирует параметры препроцессора C (*-D*, *-U*, [*-I*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-I)), используемые как минимум двумя типами компиляторов: типичным Unix-компилятором и Visual C++. *macros* – это обычный список кортежей из одного или двух элементов, где `(name,)` означает отмену определения (*-U*) макроса *name*, а `(name, value)` означает определение (*-D*) макроса *name* со значением *value*. *include\_dirs* – это просто список имён каталогов, добавляемых в путь поиска заголовочных файлов ([*-I*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-I)). Возвращает список параметров командной строки, подходящих для Unix-компиляторов или Visual C++.115116#### `distutils.ccompiler.get_default_compiler(osname, platform)`117118Определяет компилятор по умолчанию для указанной платформы.119120*osname* должно быть одним из стандартных имён ОС Python (т.е. тех, что возвращаются `os.name`), а *platform* – обычным значением, возвращаемым `sys.platform` для данной платформы.121122Значения по умолчанию – `os.name` и `sys.platform`, если параметры не указаны.123124#### `distutils.ccompiler.new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0)`125126Фабричная функция для создания экземпляра некоторого подкласса CCompiler для заданной комбинации платформы/компилятора. *plat* по умолчанию равен `os.name` (например, `'posix'`, `'nt'`), а *compiler* по умолчанию равен компилятору по умолчанию для этой платформы. В настоящее время поддерживаются только `'posix'` и `'nt'`, а компиляторы по умолчанию – это «традиционный интерфейс Unix» (класс `UnixCCompiler`) и Visual C++ (класс `MSVCCompiler`). Обратите внимание, что вполне можно запросить объект компилятора Unix в Windows и объект компилятора Microsoft в Unix – если указать значение для *compiler*, *plat* игнорируется.127128#### `distutils.ccompiler.show_compilers()`129130Выводит список доступных компиляторов (используется параметрами *--help-compiler* команд **build**, **build\_ext**, **build\_clib**).131132#### `class distutils.ccompiler.CCompiler([verbose=0, dry_run=0, force=0])`133134Абстрактный базовый класс [`CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler) определяет интерфейс, который должен быть реализован реальными классами компиляторов. Класс также содержит некоторые вспомогательные методы, используемые несколькими классами компиляторов.135136Основная идея абстрактного класса компилятора заключается в том, что каждый экземпляр может использоваться для всех этапов компиляции/компоновки при сборке одного проекта. Таким образом, атрибуты, общие для всех этих этапов компиляции и компоновки – каталоги включения, определяемые макросы, библиотеки для компоновки и т.д. – являются атрибутами экземпляра компилятора. Чтобы обеспечить возможность изменения обработки отдельных файлов, большинство этих атрибутов можно изменять для каждой компиляции или каждой компоновки отдельно.137138Конструктор каждого подкласса создаёт экземпляр объекта Compiler. Флаги: *verbose* (показывать подробный вывод), *dry\_run* (не выполнять шаги фактически) и *force* (пересобрать всё, независимо от зависимостей). Все эти флаги по умолчанию равны `0` (выключены). Обратите внимание: вероятно, не следует напрямую создавать экземпляр [`CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler) или одного из его подклассов – вместо этого используйте фабричную функцию `distutils.CCompiler.new_compiler()`.139140The following methods allow you to manually alter compiler options for the instance of the Compiler class.141142#### `add_include_dir(dir)`143144Добавляет *dir* в список каталогов, в которых будет выполняться поиск заголовочных файлов. Компилятору предписывается искать каталоги в том порядке, в котором они передаются последовательными вызовами [`add_include_dir()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_include_dir).145146#### `set_include_dirs(dirs)`147148Устанавливает список каталогов для поиска равным *dirs* (список строк). Переопределяет любые предыдущие вызовы [`add_include_dir()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_include_dir); последующие вызовы [`add_include_dir()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_include_dir) добавляют к списку, переданному в [`set_include_dirs()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_include_dirs). Это не влияет на список стандартных каталогов включения, которые компилятор может искать по умолчанию.149150#### `add_library(libname)`151152Add *libname* to the list of libraries that will be included in all links driven by this compiler object. Note that *libname* should \*not\* be the name of a file containing a library, but the name of the library itself: the actual filename will be inferred by the linker, the compiler, or the compiler class (depending on the platform).153154Компоновщику будет указано компоновать с библиотеками в том порядке, в котором они были переданы в [`add_library()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_library) и/или [`set_libraries()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_libraries). Дублирование имён библиотек вполне допустимо; компоновщику будет указано компоновать с библиотеками столько раз, сколько они упомянуты.155156#### `set_libraries(libnames)`157158Set the list of libraries to be included in all links driven by this compiler object to *libnames* (a list of strings). This does not affect any standard system libraries that the linker may include by default.159160#### `add_library_dir(dir)`161162Добавляет *dir* в список каталогов, в которых будет выполняться поиск библиотек, указанных в [`add_library()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_library) и [`set_libraries()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_libraries). Компоновщику будет указано искать библиотеки в том порядке, в котором они передаются в [`add_library_dir()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_library_dir) и/или [`set_library_dirs()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_library_dirs).163164#### `set_library_dirs(dirs)`165166Set the list of library search directories to *dirs* (a list of strings). This does not affect any standard library search path that the linker may search by default.167168#### `add_runtime_library_dir(dir)`169170Add *dir* to the list of directories that will be searched for shared libraries at runtime.171172#### `set_runtime_library_dirs(dirs)`173174Set the list of directories to search for shared libraries at runtime to *dirs* (a list of strings). This does not affect any standard search path that the runtime linker may search by default.175176#### `define_macro(name[, value=None])`177178Define a preprocessor macro for all compilations driven by this compiler object. The optional parameter *value* should be a string; if it is not supplied, then the macro will be defined without an explicit value and the exact outcome depends on the compiler used.179180#### `undefine_macro(name)`181182Отменяет макрос препроцессора для всех компиляций, выполняемых данным объектом компилятора. Если один и тот же макрос определён с помощью [`define_macro()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.define_macro) и отменён с помощью [`undefine_macro()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.undefine_macro), последний вызов имеет приоритет (включая множественные переопределения или отмены). Если макрос переопределяется/отменяется для конкретной компиляции (т.е. в вызове [`compile()`](https://python-all.ru/3.4/library/functions.html#compile)), то приоритет у этого действия.183184#### `add_link_object(object)`185186Add *object* to the list of object files (or analogues, such as explicitly named library files or the output of “resource compilers”) to be included in every link driven by this compiler object.187188#### `set_link_objects(objects)`189190Set the list of object files (or analogues) to be included in every link to *objects*. This does not affect any standard object files that the linker may include by default (such as system libraries).191192Следующие методы реализуют автодетекцию параметров компилятора, предоставляя функциональность, аналогичную GNU **autoconf**.193194#### `detect_language(sources)`195196Определяет язык указанного файла или списка файлов. Для этого используются атрибуты экземпляра `language_map` (словарь) и `language_order` (список).197198#### `find_library_file(dirs, lib[, debug=0])`199200Ищет в указанном списке каталогов файл статической или динамической библиотеки *lib* и возвращает полный путь к этому файлу. Если *debug* истинно, ищет отладочную версию (если это имеет смысл на текущей платформе). Возвращает `None`, если *lib* не найден ни в одном из указанных каталогов.201202#### `has_function(funcname[, includes=None, include_dirs=None, libraries=None, library_dirs=None])`203204Возвращает логическое значение, указывающее, поддерживается ли *funcname* на текущей платформе. Необязательные аргументы можно использовать для расширения среды компиляции, предоставляя дополнительные включаемые файлы и пути, а также библиотеки и пути.205206#### `library_dir_option(dir)`207208Возвращает опцию компилятора для добавления *dir* в список каталогов, в которых выполняется поиск библиотек.209210#### `library_option(lib)`211212Возвращает опцию компилятора для добавления *lib* в список библиотек, связываемых в разделяемую библиотеку или исполняемый файл.213214#### `runtime_library_dir_option(dir)`215216Возвращает опцию компилятора для добавления *dir* в список каталогов, в которых выполняется поиск библиотек времени выполнения.217218#### `set_executables(**args)`219220Определяет исполняемые файлы (и параметры для них), которые будут запущены для выполнения различных этапов компиляции. Точный набор исполняемых файлов, которые могут быть здесь указаны, зависит от класса компилятора (через атрибут класса ‘executables’), но большинство будут иметь:221222| атрибут | описание |223| --- | --- |224| *compiler* | компилятор C/C++ |225| *linker\_so* | компоновщик, используемый для создания разделяемых объектов и библиотек |226| *linker\_exe* | компоновщик, используемый для создания двоичных исполняемых файлов |227| *archiver* | создатель статических библиотек |228229На платформах с командной строкой (Unix, DOS/Windows) каждая из этих строк разбивается на имя исполняемого файла и (необязательный) список аргументов. (Разбиение строки выполняется аналогично работе оболочек Unix: слова разделяются пробелами, но кавычки и обратная косая черта могут это переопределить. См. [`distutils.util.split_quoted()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.util.split_quoted).)230231Следующие методы вызывают этапы процесса сборки.232233#### `compile(sources[, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None])`234235Компилирует один или несколько исходных файлов. Создаёт объектные файлы (например, преобразует файл `.c` в файл `.o`).236237*sources* должен быть списком имён файлов, скорее всего C/C++ файлов, но на самом деле любых, которые может обработать конкретный компилятор и класс компилятора (например, `MSVCCompiler` может обрабатывать ресурсные файлы в *sources*). Возвращает список имён объектных файлов, по одному для каждого исходного файла в *sources*. В зависимости от реализации не все исходные файлы обязательно будут скомпилированы, но все соответствующие имена объектных файлов будут возвращены.238239Если задан *output\_dir*, объектные файлы будут помещены в этот каталог с сохранением исходного пути. То есть `foo/bar.c` обычно компилируется в `foo/bar.o` (для реализации Unix); если *output\_dir* равен *build*, то он скомпилируется в `build/foo/bar.o`.240241*macros*, если задан, должен быть списком определений макросов. Определение макроса – это либо кортеж из двух элементов `(name, value)`, либо кортеж из одного элемента `(name,)`. Первый случай определяет макрос; если значение равно `None`, макрос определяется без явного значения. Кортеж из одного элемента отменяет макрос. Последующие определения/переопределения/отмены имеют приоритет.242243*include\_dirs*, если указан, должен быть списком строк – каталогов, добавляемых к пути поиска включаемых файлов по умолчанию только для данной компиляции.244245*debug* – логическое значение; если истинно, компилятору будет дано указание выводить отладочные символы в объектный файл (или рядом с ним).246247*extra\_preargs* и *extra\_postargs* зависят от реализации. На платформах, имеющих понятие командной строки (например, Unix, DOS/Windows), они, скорее всего, представляют собой списки строк: дополнительные аргументы командной строки, добавляемые в начало/конец командной строки компилятора. На других платформах обращайтесь к документации класса реализации. В любом случае они предназначены как запасной выход для тех случаев, когда абстрактная структура компилятора не справляется.248249*depends*, если указан, представляет собой список имен файлов, от которых зависят все цели. Если исходный файл старше любого файла из depends, то исходный файл будет перекомпилирован. Это обеспечивает отслеживание зависимостей, но только с грубой зернистостью.250251В случае ошибки вызывает `CompileError`.252253#### `create_static_lib(objects, output_libname[, output_dir=None, debug=0, target_lang=None])`254255Связывает вместе набор объектов для создания файла статической библиотеки. «Набор объектов» состоит из списка объектных файлов, переданных как *objects*, дополнительных объектных файлов, переданных в [`add_link_object()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_link_object) и/или [`set_link_objects()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_link_objects), библиотек, переданных в [`add_library()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_library) и/или [`set_libraries()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_libraries), а также библиотек, переданных как *libraries* (если есть).256257*output\_libname* должно быть именем библиотеки, а не именем файла; имя файла будет выведено из имени библиотеки. *output\_dir* – это каталог, в который будет помещен файл библиотеки.258259*debug* – логическое значение; если истинно, в библиотеку будет включена отладочная информация (обратите внимание: на большинстве платформ значение имеет этап компиляции; флаг *debug* добавлен здесь лишь для единообразия).260261*target\_lang* – целевой язык, для которого компилируются указанные объекты. Это позволяет выполнять специальную обработку на этапе компоновки для некоторых языков.262263В случае ошибки вызывает `LibError`.264265#### `link(target_desc, objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])`266267Связывает всё вместе, чтобы создать исполняемый файл или файл динамической библиотеки.268269«Всё вместе» включает список объектных файлов, переданных в *objects*. *output\_filename* должно быть именем файла. Если *output\_dir* задан, *output\_filename* указывается относительно него (т.е. *output\_filename* может содержать компоненты пути).270271*libraries* – это список библиотек для линковки. Это имена библиотек, а не имена файлов, так как они преобразуются в имена файлов платформо-зависимым способом (например, *foo* становится `libfoo.a` на Unix и `foo.lib` на DOS/Windows). Однако они могут содержать компонент каталога, что означает, что линковщик будет искать в этом конкретном каталоге, а не во всех обычных местах.272273*library\_dirs*, если указано, должно быть списком каталогов для поиска библиотек, заданных как простые имена (без компонента каталога). Они добавляются к системным по умолчанию и тем, что указаны в [`add_library_dir()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_library_dir) и/или [`set_library_dirs()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.set_library_dirs). *runtime\_library\_dirs* – это список каталогов, которые будут встроены в разделяемую библиотеку и использоваться для поиска других разделяемых библиотек, от которых она зависит во время выполнения. (Это может быть актуально только на Unix.)274275*export\_symbols* – список символов, которые будет экспортировать динамическая библиотека. (Это актуально, по-видимому, только в Windows.)276277*debug* работает так же, как и в [`compile()`](https://python-all.ru/3.4/library/functions.html#compile) и [`create_static_lib()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.create_static_lib), с тем небольшим отличием, что на большинстве платформ это действительно важно (в отличие от [`create_static_lib()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.create_static_lib), которая включает флаг *debug* в основном для проформы).278279*extra\_preargs* и *extra\_postargs* аналогичны параметрам [`compile()`](https://python-all.ru/3.4/library/functions.html#compile) (за исключением, конечно, того, что они передают аргументы командной строки для конкретного используемого компоновщика).280281*target\_lang* – целевой язык, для которого компилируются указанные объекты. Это позволяет выполнять специальную обработку на этапе компоновки для некоторых языков.282283При неудаче вызывает `LinkError`.284285#### `link_executable(objects, output_progname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, target_lang=None])`286287Компоновка исполняемого файла. *output\_progname* – это имя файла исполняемого файла, а *objects* – список имён объектных файлов для компоновки. Остальные аргументы аналогичны аргументам метода [`link()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.link).288289#### `link_shared_lib(objects, output_libname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])`290291Компоновка разделяемой библиотеки. *output\_libname* – это имя выходной библиотеки, а *objects* – список имён объектных файлов для компоновки. Остальные аргументы аналогичны аргументам метода [`link()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.link).292293#### `link_shared_object(objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])`294295Компоновка разделяемого объекта. *output\_filename* – это имя создаваемого разделяемого объекта, а *objects* – список имён объектных файлов для компоновки. Остальные аргументы аналогичны аргументам метода [`link()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.link).296297#### `preprocess(source[, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None])`298299Препроцессинг одного файла исходного кода на C/C++, указанного в *source*. Результат будет записан в файл с именем *output\_file*, или в *stdout*, если *output\_file* не указан. *macros* – это список определений макросов, как в [`compile()`](https://python-all.ru/3.4/library/functions.html#compile), который дополнит макросы, заданные с помощью [`define_macro()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.define_macro) и [`undefine_macro()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.undefine_macro). *include\_dirs* – это список имён каталогов, которые будут добавлены к списку по умолчанию, так же как и в [`add_include_dir()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler.add_include_dir).300301При неудаче вызывает `PreprocessError`.302303Следующие вспомогательные методы определены в классе [`CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler) для использования конкретными подклассами.304305#### `executable_filename(basename[, strip_dir=0, output_dir=''])`306307Возвращает имя файла исполняемого файла для заданного *basename*. Обычно на платформах, отличных от Windows, это то же самое, что и базовое имя, а в Windows будет добавлено `.exe`.308309#### `library_filename(libname[, lib_type='static', strip_dir=0, output_dir=''])`310311Возвращает имя файла для заданного имени библиотеки на текущей платформе. На Unix библиотека с *lib\_type* равным `'static'` обычно будет иметь вид `liblibname.a`, а с *lib\_type* равным `'dynamic'` – вид `liblibname.so`.312313#### `object_filenames(source_filenames[, strip_dir=0, output_dir=''])`314315Возвращает имена объектных файлов для заданных исходных файлов. *source\_filenames* должен быть списком имен файлов.316317#### `shared_object_filename(basename[, strip_dir=0, output_dir=''])`318319Возвращает имя файла разделяемого объекта для заданного имени файла *basename*.320321#### `execute(func, args[, msg=None, level=1])`322323Вызывает [`distutils.util.execute()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.util.execute). Этот метод вызывает функцию Python *func* с заданными аргументами *args* после логирования и с учётом флага *dry\_run*.324325#### `spawn(cmd)`326327Вызывает `distutils.util.spawn()`. Запускает внешний процесс для выполнения заданной команды.328329#### `mkpath(name[, mode=511])`330331Вызывает [`distutils.dir_util.mkpath()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.dir_util.mkpath). Создаёт каталог и все отсутствующие родительские каталоги.332333#### `move_file(src, dst)`334335Вызывает [`distutils.file_util.move_file()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.file_util.move_file). Переименовывает *src* в *dst*.336337#### `announce(msg[, level=1])`338339Записывает сообщение с помощью `distutils.log.debug()`.340341#### `warn(msg)`342343Записывает предупреждающее сообщение *msg* в стандартный поток ошибок.344345#### `debug_print(msg)`346347Если на данном экземпляре [`CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler) установлен флаг *debug*, вывести *msg* в стандартный вывод, в противном случае ничего не делать.348349## 10.3. [`distutils.unixccompiler`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.unixccompiler) – компилятор C для Unix350351Этот модуль предоставляет класс `UnixCCompiler`, подкласс `CCompiler`, который работает с типичным Unix-стилем командной строки компилятора C:352353- макросы, определённые с помощью *-Dname\[=value\]*354- макросы, отменённые с помощью *-Uname*355- каталоги поиска заголовочных файлов, заданные с помощью *-Idir*356- библиотеки, заданные с помощью *-llib*357- каталоги поиска библиотек, заданные с помощью *-Ldir*358- компиляция выполняется исполняемым файлом **cc** (или аналогичным) с опцией [*-c*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-c): компилирует `.c` в `.o`359- компоновка статической библиотеки выполняется командой **ar** (возможно, с **ranlib**)360- компоновка разделяемой библиотеки выполняется с помощью **cc** *-shared*361362## 10.4. [`distutils.msvccompiler`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.msvccompiler) – компилятор Microsoft363364Этот модуль предоставляет `MSVCCompiler` – реализацию абстрактного класса `CCompiler` для Microsoft Visual Studio. Обычно модули расширения необходимо компилировать тем же компилятором, который использовался для компиляции Python. Для Python 2.3 и более ранних версий использовался Visual Studio 6. Для Python 2.4 и 2.5 – Visual Studio .NET 2003. Двоичные файлы для AMD64 и Itanium создаются с помощью Platform SDK.365366`MSVCCompiler` обычно сам выбирает нужный компилятор, компоновщик и т.д. Чтобы переопределить этот выбор, необходимо установить обе переменные окружения *DISTUTILS\_USE\_SDK* и *MSSdk*. *MSSdk* указывает, что текущее окружение было настроено скриптом `SetEnv.Cmd` из SDK, или что переменные окружения были зарегистрированы при установке SDK; *DISTUTILS\_USE\_SDK* указывает, что пользователь distutils явно решил переопределить выбор компилятора с помощью `MSVCCompiler`.367368## 10.5. [`distutils.bcppcompiler`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.bcppcompiler) – компилятор Borland369370Этот модуль предоставляет `BorlandCCompiler` – подкласс абстрактного класса `CCompiler` для компилятора Borland C++.371372## 10.6. `distutils.cygwincompiler` – компилятор Cygwin373374Этот модуль предоставляет класс `CygwinCCompiler`, подкласс `UnixCCompiler`, который работает с портом GNU C компилятора для Windows под Cygwin. Он также содержит класс Mingw32CCompiler, который работает с портом GCC для mingw32 (то же, что и cygwin в режиме без cygwin).375376## 10.7. [`distutils.archive_util`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.archive_util) – утилиты архивирования377378Этот модуль предоставляет несколько функций для создания архивных файлов, таких как tar-архивы или zip-файлы.379380#### `distutils.archive_util.make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=0, dry_run=0])`381382Создаёт архивный файл (например, `zip` или `tar`). *base\_name* – это имя создаваемого файла без расширения, зависящего от формата; *format* – формат архива: один из `zip`, `tar`, `ztar` или `gztar`. *root\_dir* – каталог, который будет корневым каталогом архива; то есть обычно мы выполняем `chdir` в *root\_dir* перед созданием архива. *base\_dir* – каталог, с которого начинается архивация; то есть *base\_dir* будет общим префиксом всех файлов и каталогов в архиве. *root\_dir* и *base\_dir* по умолчанию равны текущему каталогу. Возвращает имя файла архива.383384#### `distutils.archive_util.make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])`385386Создаёт (возможно, сжатый) архив в виде tar-файла из всех файлов в *base\_dir* и всех его подкаталогах. *compress* должен быть `'gzip'` (по умолчанию), `'compress'`, `'bzip2'` или `None`. И **tar**, и утилита сжатия, указанная в *compress*, должны быть доступны в стандартном пути поиска программ, поэтому это, вероятно, специфично для Unix. Выходной tar-файл будет назван `base_dir.tar`, возможно с добавлением соответствующего расширения сжатия (`.gz`, `.bz2` или `.Z`). Возвращает имя выходного файла.387388#### `distutils.archive_util.make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])`389390Создаёт zip-файл из всех файлов в *base\_dir* и его подкаталогах. Выходной zip-файл будет называться *base\_name* + `.zip`. Используется либо модуль Python [`zipfile`](https://python-all.ru/3.4/library/zipfile.html#module-zipfile) (если доступен), либо утилита InfoZIP `zip` (если установлена и найдена в стандартном пути поиска). Если ни одно средство недоступно, возбуждается `DistutilsExecError`. Возвращает имя выходного zip-файла.391392## 10.8. [`distutils.dep_util`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.dep_util) – проверка зависимостей393394Этот модуль предоставляет функции для простой проверки зависимостей файлов и групп файлов на основе временных меток; а также функции, полностью основанные на таком анализе зависимостей по временным меткам.395396#### `distutils.dep_util.newer(source, target)`397398Возвращает истину, если *source* существует и был изменён позже, чем *target*, или если *source* существует, а *target* – нет. Возвращает ложь, если оба существуют и *target* имеет тот же возраст или новее, чем *source*. Возбуждает `DistutilsFileError`, если *source* не существует.399400#### `distutils.dep_util.newer_pairwise(sources, targets)`401402Проходит два списка имён файлов параллельно, проверяя, является ли каждый исходный файл новее соответствующего целевого. Возвращает пару списков (*sources*, *targets*), где исходный файл новее целевого в соответствии с семантикой [`newer()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.dep_util.newer).403404#### `distutils.dep_util.newer_group(sources, target[, missing='error'])`405406Возвращает истину, если *target* устарел относительно любого файла из списка *sources*. Другими словами, если *target* существует и новее каждого файла из *sources*, возвращает ложь; в противном случае возвращает истину. *missing* управляет тем, что делать, если исходный файл отсутствует; значение по умолчанию (`'error'`) – завершиться с ошибкой [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError) изнутри [`os.stat()`](https://python-all.ru/3.4/library/os.html#os.stat); если это `'ignore'`, мы молча пропускаем отсутствующие исходные файлы; если это `'newer'`, то любой отсутствующий исходный файл заставляет считать, что *target* устарел (это удобно в режиме «сухого прогона»: он заставит имитировать выполнение команд, которые не сработают из-за отсутствия входных данных, но это не имеет значения, так как команды на самом деле не выполняются).407408## 10.9. [`distutils.dir_util`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.dir_util) – операции с деревом каталогов409410Этот модуль предоставляет функции для работы с каталогами и деревьями каталогов.411412#### `distutils.dir_util.mkpath(name[, mode=0o777, verbose=0, dry_run=0])`413414Создаёт каталог и все отсутствующие родительские каталоги. Если каталог уже существует (или *name* – пустая строка, означающая текущий каталог, который, разумеется, существует), то ничего не делает. Возбуждает `DistutilsFileError`, если не удаётся создать какой-либо каталог по пути (например, существует вложенный путь, но это файл, а не каталог). Если *verbose* имеет значение true, выводит в stdout по одной строке-сводке для каждого mkdir. Возвращает список фактически созданных каталогов.415416#### `distutils.dir_util.create_tree(base_dir, files[, mode=0o777, verbose=0, dry_run=0])`417418Создаёт все пустые каталоги внутри *base\_dir*, необходимые для размещения *files*. *base\_dir* – это просто имя каталога, который ещё не обязательно существует; *files* – список имён файлов, интерпретируемых относительно *base\_dir*. *base\_dir* + часть пути (каталог) каждого файла из *files* будет создан, если его ещё не существует. Флаги *mode*, *verbose* и *dry\_run* – как для [`mkpath()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.dir_util.mkpath).419420#### `distutils.dir_util.copy_tree(src, dst[, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0])`421422Копирует всё дерево каталогов *src* в новое расположение *dst*. Оба *src* и *dst* должны быть именами каталогов. Если *src* не является каталогом, возбуждается `DistutilsFileError`. Если *dst* не существует, он создаётся с помощью [`mkpath()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.dir_util.mkpath). Конечный результат копирования: каждый файл в *src* копируется в *dst*, а каталоги в *src* рекурсивно копируются в *dst*. Возвращает список файлов, которые были скопированы или могли быть скопированы, с использованием их выходного имени. Возвращаемое значение не зависит от *update* или *dry\_run*: это просто список всех файлов в *src*, с именами, изменёнными на принадлежащие *dst*.423424*preserve\_mode* и *preserve\_times* имеют то же значение, что и для [`distutils.file_util.copy_file()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.file_util.copy_file); обратите внимание, что они применяются только к обычным файлам, а не к каталогам. Если *preserve\_symlinks* имеет значение true, символические ссылки будут копироваться как символические ссылки (на платформах, которые их поддерживают!); в противном случае (по умолчанию) будет скопирован объект, на который указывает символическая ссылка. *update* и *verbose* имеют то же значение, что и для `copy_file()`.425426Файлы в *src*, имена которых начинаются с `.nfs`, пропускаются (дополнительная информация об этих файлах доступна в ответе D2 на [странице FAQ по NFS](https://python-all.ru/3.4/distutils/apiref.html)).427428Изменено в версии 3.3.1: Файлы NFS игнорируются.429430#### `distutils.dir_util.remove_tree(directory[, verbose=0, dry_run=0])`431432Рекурсивно удаляет *directory* и все файлы и каталоги внутри него. Любые ошибки игнорируются (за исключением вывода в `sys.stdout`, если *verbose* имеет значение true).433434## 10.10. [`distutils.file_util`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.file_util) – Операции с отдельными файлами435436Этот модуль содержит несколько служебных функций для работы с отдельными файлами.437438#### `distutils.file_util.copy_file(src, dst[, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0])`439440Копирует файл *src* в *dst*. Если *dst* является каталогом, то *src* копируется туда с тем же именем; в противном случае это должно быть имя файла. (Если файл существует, он будет безжалостно перезаписан.) Если *preserve\_mode* равен true (по умолчанию), то копируется режим файла (тип и биты разрешений, или что-то аналогичное на текущей платформе). Если *preserve\_times* равен true (по умолчанию), то также копируются время последнего изменения и последнего доступа. Если *update* равен true, то *src* будет скопирован только если *dst* не существует, или если *dst* существует, но старше, чем *src*.441442*link* позволяет создавать жёсткие ссылки (с помощью [`os.link()`](https://python-all.ru/3.4/library/os.html#os.link)) или символические ссылки (с помощью [`os.symlink()`](https://python-all.ru/3.4/library/os.html#os.symlink)) вместо копирования: установите его в `'hard'` или `'sym'`; если он равен `None` (по умолчанию), файлы копируются. Не устанавливайте *link* в системах, которые его не поддерживают: [`copy_file()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.file_util.copy_file) не проверяет, доступно ли создание жёстких или символических ссылок. Для копирования содержимого файлов используется `_copy_file_contents()`.443444Возвращает кортеж `(dest_name, copied)`: *dest\_name* – это фактическое имя выходного файла, а *copied* имеет значение true, если файл был скопирован (или был бы скопирован, если *dry\_run* имеет значение true).445446#### `distutils.file_util.move_file(src, dst[, verbose, dry_run])`447448Перемещает файл *src* в *dst*. Если *dst* является каталогом, файл будет перемещён в него с тем же именем; в противном случае *src* просто переименовывается в *dst*. Возвращает новое полное имя файла.449450> **Предупреждение**451>452> Обрабатывает перемещения между устройствами в Unix с помощью [`copy_file()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.file_util.copy_file). А как насчёт других систем?453454#### `distutils.file_util.write_file(filename, contents)`455456Создаёт файл с именем *filename* и записывает в него *contents* (последовательность строк без символов конца строки).457458## 10.11. [`distutils.util`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.util) – Прочие утилитарные функции459460Этот модуль содержит другие разрозненные элементы, которые не вписываются ни в один другой вспомогательный модуль.461462#### `distutils.util.get_platform()`463464Возвращает строку, идентифицирующую текущую платформу. В основном используется для различения платформозависимых каталогов сборки и платформозависимых готовых дистрибутивов. Обычно включает имя и версию ОС, а также архитектуру (как их возвращает ‘os.uname()’), хотя точный состав информации зависит от ОС; например, для IRIX архитектура не особенно важна (IRIX работает только на оборудовании SGI), а для Linux версия ядра не особенно важна.465466Примеры возвращаемых значений:467468- `linux-i586`469- `linux-alpha`470- `solaris-2.6-sun4u`471- `irix-5.3`472- `irix64-6.2`473474Для платформ, отличных от POSIX, в настоящее время просто возвращает `sys.platform`.475476Для систем Mac OS X версия OS отражает минимальную версию, на которой будут работать бинарные файлы (то есть значение `MACOSX_DEPLOYMENT_TARGET` во время сборки Python), а не версию OS текущей системы.477478Для универсальных бинарных сборок на Mac OS X значение архитектуры отражает статус универсального бинарного файла, а не архитектуру текущего процессора. Для 32-битных универсальных бинарных файлов архитектура – `fat`, для 64-битных универсальных бинарных файлов архитектура – `fat64`, и для 4-сторонних универсальных бинарных файлов архитектура – `universal`. Начиная с Python 2.7 и Python 3.2 архитектура `fat3` используется для 3-сторонней универсальной сборки (ppc, i386, x86\_64), а `intel` используется для универсальной сборки с архитектурами i386 и x86\_64479480Примеры возвращаемых значений на Mac OS X:481482- `macosx-10.3-ppc`483- `macosx-10.3-fat`484- `macosx-10.5-universal`485- `macosx-10.6-intel`486487#### `distutils.util.convert_path(pathname)`488489Возвращает 'pathname' как имя, которое будет работать в родной файловой системе, т.е. разделяет его по '/' и снова собирает, используя текущий разделитель каталогов. Это необходимо, потому что имена файлов в скрипте установки всегда указываются в стиле Unix и должны быть преобразованы в локальное соглашение, прежде чем их можно будет использовать в файловой системе. Вызывает [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError) на системах, не похожих на Unix, если *pathname* начинается или заканчивается косой чертой.490491#### `distutils.util.change_root(new_root, pathname)`492493Возвращает *pathname* с добавленным в начало *new\_root*. Если *pathname* является относительным, это эквивалентно `os.path.join(new_root,pathname)`. В противном случае требуется сделать *pathname* относительным, а затем объединить их, что сложно на DOS/Windows.494495#### `distutils.util.check_environ()`496497Гарантирует, что 'os.environ' содержит все переменные окружения, которые пользователи могут использовать в конфигурационных файлах, параметрах командной строки и т.д. В настоящее время это включает:498499- `HOME` – домашний каталог пользователя (только Unix)500- `PLAT` – описание текущей платформы, включая оборудование и ОС (см. [`get_platform()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.util.get_platform))501502#### `distutils.util.subst_vars(s, local_vars)`503504Выполняет подстановку переменных в стиле shell/Perl для *s*. Каждое вхождение `$`, за которым следует имя, считается переменной, и переменная заменяется значением из словаря *local\_vars* или из `os.environ`, если её нет в *local\_vars*. *os.environ* сначала проверяется/дополняется, чтобы гарантировать, что он содержит определённые значения: см. [`check_environ()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.util.check_environ). Вызывает [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError) для любых переменных, не найденных ни в *local\_vars*, ни в `os.environ`.505506Обратите внимание, что это не полноценная функция интерполяции строк. Допустимая `$variable` может состоять только из прописных и строчных букв, цифр и символа подчёркивания. Кавычки в стиле { } или ( ) не поддерживаются.507508#### `distutils.util.split_quoted(s)`509510Разделяет строку по правилам, похожим на оболочку Unix, для кавычек и обратной косой черты. Кратко: слова разделяются пробелами, если эти пробелы не экранированы обратной косой чертой или не находятся внутри строки в кавычках. Одинарные и двойные кавычки эквивалентны, и символы кавычек могут быть экранированы обратной косой чертой. Обратная косая черта удаляется из любой двухсимвольной escape-последовательности, оставляя только экранированный символ. Символы кавычек удаляются из любой строки в кавычках. Возвращает список слов.511512#### `distutils.util.execute(func, args[, msg=None, verbose=0, dry_run=0])`513514Выполняет некоторое действие, влияющее на внешний мир (например, запись в файловую систему). Такие действия особенны тем, что они отключаются флагом *dry\_run*. Этот метод берет на себя всю эту бюрократию; все, что нужно сделать – предоставить вызываемую функцию и кортеж аргументов для нее (чтобы воплотить выполняемое «внешнее действие») и необязательное сообщение для вывода.515516#### `distutils.util.strtobool(val)`517518Преобразует строковое представление истинности в true (1) или false (0).519520Истинные значения: `y`, `yes`, `t`, `true`, `on` и `1`; ложные значения: `n`, `no`, `f`, `false`, `off` и `0`. Вызывает [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError), если *val* – что-то другое.521522#### `distutils.util.byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None])`523524Компилирует набор исходных файлов Python в файлы `.pyc` или `.pyo` в подкаталоге `__pycache__` (см. [**PEP 3147**](https://python-all.ru/3.4/distutils/apiref.html)). *py\_files* – это список файлов для компиляции; любые файлы, не заканчивающиеся на `.py`, молча пропускаются. *optimize* должно быть одним из следующих значений:525526- `0` – не оптимизировать (создавать `.pyc`)527- `1` – обычная оптимизация (как `python -O`)528- `2` – дополнительная оптимизация (как `python -OO`)529530Если *force* равно true, все файлы перекомпилируются независимо от временных меток.531532Имя исходного файла, закодированное в каждом [*bytecode*](https://python-all.ru/3.4/glossary.html#term-bytecode) файле, по умолчанию соответствует именам файлов, перечисленным в *py\_files*; их можно изменить с помощью *prefix* и *basedir*. *prefix* – это строка, которая будет отрезана от каждого имени исходного файла, а *base\_dir* – это имя каталога, которое будет добавлено спереди (после того, как *prefix* будет отрезан). Можно указать либо *prefix*, либо *base\_dir*, или оба, или ни одного, по желанию.533534Если *dry\_run* равно true, на самом деле не выполняет никаких действий, влияющих на файловую систему.535536Байт-компиляция выполняется либо непосредственно в этом процессе интерпретатора с помощью стандартного модуля [`py_compile`](https://python-all.ru/3.4/library/py_compile.html#module-py_compile), либо косвенно – путём создания временного скрипта и его выполнения. Обычно функция [`byte_compile()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.util.byte_compile) сама определяет, использовать прямую компиляцию или нет (подробнее см. исходный код). Флаг *direct* используется скриптом, создаваемым в косвенном режиме; если вы не уверены в своих действиях, оставьте его равным `None`.537538Изменено в версии 3.2.3: Создаёт файлы `.pyc` или `.pyo` с [`import magic tag`](https://python-all.ru/3.4/library/imp.html#imp.get_tag) в имени, в подкаталоге `__pycache__`, а не файлы без тега в текущем каталоге.539540#### `distutils.util.rfc822_escape(header)`541542Возвращает версию *header* с экранированием для включения в заголовок [**RFC 822**](https://python-all.ru/3.4/distutils/apiref.html), гарантируя наличие 8 пробелов после каждого перевода строки. Обратите внимание, что никаких других изменений строки не производится.543544## 10.12. [`distutils.dist`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.dist) – Класс Distribution545546Этот модуль предоставляет класс [`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution), который представляет распространяемый модуль (сборка/установка/распространение).547548## 10.13. [`distutils.extension`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.extension) – Класс Extension549550Этот модуль предоставляет класс `Extension`, используемый для описания модулей расширения на C/C++ в скриптах установки.551552## 10.14. [`distutils.debug`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.debug) – Режим отладки Distutils553554Этот модуль предоставляет флаг DEBUG.555556## 10.15. [`distutils.errors`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.errors) – Исключения Distutils557558Предоставляет исключения, используемые модулями Distutils. Обратите внимание, что модули Distutils могут вызывать стандартные исключения; в частности, SystemExit обычно возбуждается для ошибок, которые явно являются виной конечного пользователя (например, неправильные аргументы командной строки).559560Этот модуль безопасно использовать в режиме `from ... import *`; он экспортирует только символы, чьи имена начинаются с `Distutils` и заканчиваются на `Error`.561562## 10.16. [`distutils.fancy_getopt`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.fancy_getopt) – Обёртка вокруг стандартного модуля getopt563564Этот модуль предоставляет обёртку вокруг стандартного модуля [`getopt`](https://python-all.ru/3.4/library/getopt.html#module-getopt), которая добавляет следующие возможности:565566- короткие и длинные опции привязаны друг к другу567- параметры имеют строки справки, так что [`fancy_getopt()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.fancy_getopt.fancy_getopt) может создавать полную сводку по использованию568- опции устанавливают атрибуты переданного объекта569- логические параметры могут иметь «отрицательные псевдонимы» – например, если *--quiet* является «отрицательным псевдонимом» для [*--verbose*](https://python-all.ru/3.4/library/tarfile.html#cmdoption--verbose), то *--quiet* в командной строке устанавливает *verbose* в false.570571#### `distutils.fancy_getopt.fancy_getopt(options, negative_opt, object, args)`572573Функция-обёртка. *options* – это список из `(long_option, short_option, help_string)` 3-кортежей, как описано в конструкторе [`FancyGetopt`](https://python-all.ru/3.4/distutils/apiref.html#distutils.fancy_getopt.FancyGetopt). *negative\_opt* должен быть словарём, отображающим имена опций в имена опций; и ключ, и значение должны быть в списке *options*. *object* – это объект, который будет использоваться для хранения значений (см. метод [`getopt()`](https://python-all.ru/3.4/library/getopt.html#module-getopt) класса [`FancyGetopt`](https://python-all.ru/3.4/distutils/apiref.html#distutils.fancy_getopt.FancyGetopt)). *args* – это список аргументов. Если передать `None` в качестве *args*, будет использован `sys.argv[1:]`.574575#### `distutils.fancy_getopt.wrap_text(text, width)`576577Переносит *text* до ширины менее *width*.578579#### `class distutils.fancy_getopt.FancyGetopt([option_table=None])`580581The option\_table is a list of 3-tuples: `(long_option, short_option, help_string)`582583Если опция принимает аргумент, *long\_option* должно оканчиваться на `'='`; *short\_option* должна быть одним символом, без `':'` в любом случае. *short\_option* должно быть `None`, если *long\_option* не имеет соответствующей *short\_option*. Все кортежи опций должны содержать длинные опции.584585Класс [`FancyGetopt`](https://python-all.ru/3.4/distutils/apiref.html#distutils.fancy_getopt.FancyGetopt) предоставляет следующие методы:586587#### `FancyGetopt.getopt([args=None, object=None])`588589Разбирает параметры командной строки в args. Сохраняет как атрибуты *object*.590591Если *args* равен `None` или не указан, используется `sys.argv[1:]`. Если *object* равен `None` или не указан, создаётся новый экземпляр `OptionDummy`, в него сохраняются значения опций, и возвращается кортеж `(args, object)`. Если *object* указан, он изменяется на месте, и [`getopt()`](https://python-all.ru/3.4/library/getopt.html#module-getopt) просто возвращает *args*; в обоих случаях возвращаемый *args* – это изменённая копия переданного списка *args*, который остаётся нетронутым.592593#### `FancyGetopt.get_option_order()`594595Возвращает список кортежей `(option, value)`, обработанных предыдущим вызовом [`getopt()`](https://python-all.ru/3.4/library/getopt.html#module-getopt). Вызывает [`RuntimeError`](https://python-all.ru/3.4/library/exceptions.html#RuntimeError), если [`getopt()`](https://python-all.ru/3.4/library/getopt.html#module-getopt) ещё не вызывался.596597#### `FancyGetopt.generate_help([header=None])`598599Генерирует текст справки (список строк, по одной на предполагаемую строку вывода) из таблицы опций для данного объекта [`FancyGetopt`](https://python-all.ru/3.4/distutils/apiref.html#distutils.fancy_getopt.FancyGetopt).600601Если указан, выводит переданный *header* в начале справки.602603## 10.17. [`distutils.filelist`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.filelist) – класс FileList604605Этот модуль предоставляет класс `FileList`, используемый для исследования файловой системы и составления списков файлов.606607## 10.18. [`distutils.log`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.log) – простое журналирование в стиле PEP 282608609## 10.19. [`distutils.spawn`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.spawn) – запуск подпроцесса610611Этот модуль предоставляет функцию `spawn()` – интерфейс к различным платформенно-зависимым функциям для запуска другой программы в подпроцессе. Также предоставляет `find_executable()` для поиска заданного исполняемого файла по путям.612613## 10.20. [`distutils.sysconfig`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.sysconfig) – информация о системной конфигурации614615Модуль [`distutils.sysconfig`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.sysconfig) предоставляет доступ к низкоуровневой конфигурационной информации Python. Конкретные доступные переменные конфигурации сильно зависят от платформы и настройки. Эти переменные определяются процессом сборки для конкретной версии Python; это переменные из `Makefile` и заголовочного файла конфигурации, которые устанавливаются вместе с Python в Unix-системах. Заголовочный файл конфигурации называется `pyconfig.h` для Python версий 2.2 и выше, и `config.h` для более ранних версий.616617Предоставляются некоторые дополнительные функции, выполняющие полезные операции для других частей пакета [`distutils`](https://python-all.ru/3.4/library/distutils.html#module-distutils).618619#### `distutils.sysconfig.PREFIX`620621Результат `os.path.normpath(sys.prefix)`.622623#### `distutils.sysconfig.EXEC_PREFIX`624625Результат `os.path.normpath(sys.exec_prefix)`.626627#### `distutils.sysconfig.get_config_var(name)`628629Возвращает значение одной переменной. Эквивалентно `get_config_vars().get(name)`.630631#### `distutils.sysconfig.get_config_vars(...)`632633Возвращает набор определений переменных. Если аргументы не переданы, возвращает словарь, отображающий имена переменных конфигурации в их значения. Если переданы аргументы, они должны быть строками, и возвращаемым значением будет последовательность соответствующих значений. Если для данного имени нет соответствующего значения, для этой переменной будет включено `None`.634635#### `distutils.sysconfig.get_config_h_filename()`636637Возвращает полное имя файла заголовка конфигурации. Для Unix это будет заголовок, сгенерированный сценарием **configure**; для других платформ заголовок поставляется непосредственно с дистрибутивом исходных кодов Python. Этот файл является платформозависимым текстовым файлом.638639#### `distutils.sysconfig.get_makefile_filename()`640641Возвращает полный путь к `Makefile`, используемому для сборки Python. В Unix это будет файл, сгенерированный сценарием **configure**; на других платформах смысл может отличаться. Файл является платформенно-зависимым текстовым файлом, если он существует. Эта функция полезна только на платформах POSIX.642643#### `distutils.sysconfig.get_python_inc([plat_specific[, prefix]])`644645Возвращает каталог для общих или платформозависимых C-заголовочных файлов. Если *plat\_specific* истинно, возвращается каталог платформозависимых заголовков; если ложно или опущено, возвращается каталог платформонезависимых заголовков. Если указан *prefix*, он используется либо как префикс вместо [`PREFIX`](https://python-all.ru/3.4/distutils/apiref.html#distutils.sysconfig.PREFIX), либо как exec-префикс вместо [`EXEC_PREFIX`](https://python-all.ru/3.4/distutils/apiref.html#distutils.sysconfig.EXEC_PREFIX), если *plat\_specific* истинно.646647#### `distutils.sysconfig.get_python_lib([plat_specific[, standard_lib[, prefix]]])`648649Возвращает каталог для установки общих или платформозависимых библиотек. Если *plat\_specific* истинно, возвращается каталог платформозависимых заголовков; если ложно или опущено, возвращается каталог платформонезависимых заголовков. Если указан *prefix*, он используется либо как префикс вместо [`PREFIX`](https://python-all.ru/3.4/distutils/apiref.html#distutils.sysconfig.PREFIX), либо как exec-префикс вместо [`EXEC_PREFIX`](https://python-all.ru/3.4/distutils/apiref.html#distutils.sysconfig.EXEC_PREFIX), если *plat\_specific* истинно. Если *standard\_lib* истинно, возвращается каталог стандартной библиотеки, а не каталог для установки сторонних расширений.650651Следующая функция предназначена только для использования в пакете [`distutils`](https://python-all.ru/3.4/library/distutils.html#module-distutils).652653#### `distutils.sysconfig.customize_compiler(compiler)`654655Выполняет любую платформозависимую настройку экземпляра [`distutils.ccompiler.CCompiler`](https://python-all.ru/3.4/distutils/apiref.html#distutils.ccompiler.CCompiler).656657В настоящее время эта функция необходима только в Unix, но её следует вызывать последовательно для обеспечения прямой совместимости. Она вставляет информацию, которая различается в разных версиях Unix и хранится в `Makefile` Python. Эта информация включает выбранный компилятор, параметры компилятора и компоновщика, а также расширение, используемое компоновщиком для общих объектов.658659Эта функция ещё более специализированная и должна использоваться только в процедурах сборки самого Python.660661#### `distutils.sysconfig.set_python_build()`662663Сообщает модулю [`distutils.sysconfig`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.sysconfig), что он используется в процессе сборки Python. Это меняет многие относительные расположения файлов, позволяя им находиться в рабочей области сборки, а не в установленном Python.664665## 10.21. [`distutils.text_file`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.text_file) – Класс TextFile666667Этот модуль предоставляет класс [`TextFile`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile), который предоставляет интерфейс к текстовым файлам, (опционально) обрабатывающий удаление комментариев, игнорирование пустых строк и объединение строк с обратной косой чертой.668669#### `class distutils.text_file.TextFile([filename=None, file=None, **options])`670671Этот класс предоставляет объект, подобный файлу, который заботится обо всех вещах, которые обычно нужно делать при обработке текстового файла с построчным синтаксисом: удаление комментариев (если `#` является символом комментария), пропуск пустых строк, объединение соседних строк с помощью экранирования перевода строки (т.е. обратная косая черта в конце строки), удаление начальных и/или конечных пробелов. Все эти возможности опциональны и управляются независимо.672673Класс предоставляет метод [`warn()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.warn), с помощью которого можно генерировать предупреждающие сообщения, содержащие номер физической строки, даже если рассматриваемая логическая строка охватывает несколько физических строк. Также предоставляет [`unreadline()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.unreadline) для реализации просмотра вперед по одной строке.674675Экземпляры [`TextFile`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile) создаются с помощью *filename*, *file* или обоих. Если оба равны `None`, возбуждается [`RuntimeError`](https://python-all.ru/3.4/library/exceptions.html#RuntimeError). *filename* должна быть строкой, а *file* – файловым объектом (или чем-то, что предоставляет методы [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline) и [`close()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.close)). Рекомендуется указывать хотя бы *filename*, чтобы [`TextFile`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile) мог включать его в предупреждающие сообщения. Если *file* не указан, [`TextFile`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile) создает свой собственный, используя встроенную функцию [`open()`](https://python-all.ru/3.4/library/functions.html#open).676677Все параметры имеют булевый тип и влияют на значения, возвращаемые [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline)678679| имя параметра | описание | по умолчанию |680| --- | --- | --- |681| *strip\_comments* | удалять от `'#'` до конца строки, а также все пробельные символы перед `'#'` – если только они не экранированы обратной косой чертой | истина |682| *lstrip\_ws* | удаляет начальные пробелы из каждой строки перед её возвратом | ложь |683| *rstrip\_ws* | Удаляет завершающие пробелы (включая символ конца строки!) из каждой строки перед её возвратом. | истина |684| *skip\_blanks* | Пропускает строки, которые пусты \*после\* удаления комментариев и пробелов. (Если и lstrip\_ws, и rstrip\_ws равны false, то некоторые строки могут состоять только из пробелов: они \*не\* будут пропущены, даже если *skip\_blanks* равно true.) | истина |685| *join\_lines* | если обратная косая черта – последний символ (не перевод строки) в строке после удаления комментариев и пробелов, соединить следующую строку с ней, чтобы получить одну логическую строку; если N последовательных строк заканчиваются обратной косой чертой, то N+1 физических строк будут объединены для образования одной логической строки. | ложь |686| *collapse\_join* | удалять начальные пробелы из строк, которые объединяются с предыдущей; имеет значение только если `(join_lines и не lstrip_ws)` | ложь |687688Обратите внимание, что поскольку *rstrip\_ws* может удалять завершающий символ новой строки, семантика [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline) должна отличаться от семантики метода [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline) встроенного файлового объекта! В частности, [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline) возвращает `None` при достижении конца файла: пустая строка может быть просто пустой строкой (или строкой, состоящей только из пробелов), если *rstrip\_ws* истинно, а *skip\_blanks* – нет.689690#### `open(filename)`691692Открывает новый файл *filename*. Это переопределяет любые аргументы конструктора *file* или *filename*.693694#### `close()`695696Закрывает текущий файл и забывает всю информацию о нём (включая имя файла и текущий номер строки).697698#### `warn(msg[, line=None])`699700Выводит (в stderr) предупреждение, привязанное к текущей логической строке в текущем файле. Если текущая логическая строка в файле охватывает несколько физических строк, предупреждение относится ко всему диапазону, например `"lines 3-5"`. Если указан *line*, он заменяет номер текущей строки; это может быть список или кортеж для указания диапазона физических строк, или целое число для одной физической строки.701702#### `readline()`703704Читает и возвращает одну логическую строку из текущего файла (или из внутреннего буфера, если строки ранее были «возвращены» с помощью [`unreadline()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.unreadline)). Если параметр *join\_lines* равен истине, это может включать чтение нескольких физических строк, объединённых в одну строку. Обновляет номер текущей строки, поэтому вызов [`warn()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.warn) после [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline) выводит предупреждение о только что прочитанных физических строках. Возвращает `None` при достижении конца файла, поскольку пустая строка может возникнуть, если *rstrip\_ws* равен истине, а *strip\_blanks* – ложь.705706#### `readlines()`707708Читает и возвращает список всех логических строк, оставшихся в текущем файле. Это обновляет текущий номер строки до последней строки файла.709710#### `unreadline(line)`711712Помещает *line* (строку) во внутренний буфер, который будет проверяться последующими вызовами [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline). Удобно для реализации синтаксического анализатора с просмотром вперёд по одной строке. Обратите внимание, что строки, «возвращённые» с помощью [`unreadline()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.unreadline), впоследствии не очищаются повторно (пробелы не удаляются и т.д.) при чтении через [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline). Если до вызова [`readline()`](https://python-all.ru/3.4/library/readline.html#module-readline) было несколько вызовов [`unreadline()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.text_file.TextFile.unreadline), строки будут возвращены в порядке от самой последней к самой первой.713714## 10.22. [`distutils.version`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.version) – Классы номеров версий715716## 10.23. [`distutils.cmd`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.cmd) – Абстрактный базовый класс для команд Distutils717718Этот модуль предоставляет абстрактный базовый класс [`Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command).719720#### `class distutils.cmd.Command(dist)`721722Абстрактный базовый класс для определения классов команд – «рабочих пчёл» Distutils. Полезная аналогия для классов команд – рассматривать их как подпрограммы с локальными переменными, называемыми *options*. Опции объявляются в [`initialize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.initialize_options) и определяются (получают свои окончательные значения) в [`finalize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.finalize_options), причём оба метода должны быть определены в каждом классе команды. Различие между ними необходимо, потому что значения опций могут поступать из внешнего мира (командная строка, файл конфигурации и т.д.), и любые опции, зависящие от других опций, должны вычисляться после обработки этих внешних воздействий – отсюда [`finalize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.finalize_options). Тело подпрограммы, где выполняется вся работа на основе значений опций, – это метод [`run()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.run), который также должен быть реализован в каждом классе команды.723724Конструктор класса принимает единственный аргумент *dist* – экземпляр [`Distribution`](https://python-all.ru/3.4/distutils/apiref.html#distutils.core.Distribution).725726## 10.24. Создание новой команды Distutils727728В этом разделе описываются шаги по созданию новой команды Distutils.729730Новая команда размещается в модуле внутри пакета [`distutils.command`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command). В этом каталоге есть образец шаблона с именем `command_template`. Скопируйте этот файл в новый модуль с тем же именем, что и реализуемая команда. Этот модуль должен реализовать класс с тем же именем, что и модуль (и команда). Например, чтобы создать команду `peel_banana` (чтобы пользователи могли запускать `setup.py peel_banana`), нужно скопировать `command_template` в `distutils/command/peel_banana.py`, а затем отредактировать его так, чтобы он реализовывал класс `peel_banana`, подкласс [`distutils.cmd.Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command).731732Подклассы [`Command`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command) должны определять следующие методы.733734#### `Command.initialize_options()`735736Устанавливает значения по умолчанию для всех опций, поддерживаемых этой командой. Обратите внимание, что эти значения по умолчанию могут быть переопределены другими командами, скриптом установки, файлами конфигурации или командной строкой. Поэтому здесь не место кодировать зависимости между опциями; как правило, реализации [`initialize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.initialize_options) – это просто набор присваиваний вида `self.foo = None`.737738#### `Command.finalize_options()`739740Устанавливает окончательные значения для всех опций, поддерживаемых этой командой. Этот метод всегда вызывается как можно позже, то есть после того, как были выполнены все присваивания опций из командной строки или из других команд. Поэтому это правильное место для реализации зависимостей опций: если *foo* зависит от *bar*, то можно безопасно установить *foo* из *bar* при условии, что *foo* всё ещё имеет то же значение, которое было присвоено в [`initialize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.initialize_options).741742#### `Command.run()`743744Смысл существования команды: выполнить действие, для которого она предназначена, управляемое опциями, инициализированными в [`initialize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.initialize_options), настроенными другими командами, скриптом установки, командной строкой и файлами конфигурации, и окончательно определёнными в [`finalize_options()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.finalize_options). Весь вывод в терминал и взаимодействие с файловой системой должны выполняться в [`run()`](https://python-all.ru/3.4/distutils/apiref.html#distutils.cmd.Command.run).745746#### `Command.sub_commands`747748*sub\_commands* формализует понятие «семейства» команд, например `install` в качестве родительской команды с подкомандами `install_lib`, `install_headers` и т.д. Родительская команда семейства определяет *sub\_commands* как атрибут класса; это список кортежей из двух элементов `(command_name, predicate)`, где *command\_name* – строка, а *predicate* – функция, строка или `None`. *predicate* – это метод родительской команды, который определяет, применима ли соответствующая команда в текущей ситуации. (Например, `install_headers` применима только если есть файлы заголовков C для установки.) Если *predicate* равно `None`, то команда всегда применима.749750*sub\_commands* обычно определяется в *конце* класса, потому что предикаты могут быть методами класса, а значит, они уже должны быть определены. Канонический пример – команда **install**.751752## 10.25. [`distutils.command`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command) – Отдельные команды Distutils753754## 10.26. [`distutils.command.bdist`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist) – Сборка двоичного установщика755756## 10.27. [`distutils.command.bdist_packager`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist_packager) – Абстрактный базовый класс для упаковщиков757758## 10.28. [`distutils.command.bdist_dumb`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist_dumb) – Сборка «тупого» установщика759760## 10.29. [`distutils.command.bdist_msi`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist_msi) – Сборка двоичного пакета Microsoft Installer761762#### `class distutils.command.bdist_msi.bdist_msi`763764Создаёт двоичный пакет [Windows Installer](https://python-all.ru/3.4/distutils/apiref.html) (.msi).765766В большинстве случаев установщик `bdist_msi` является лучшим выбором, чем установщик `bdist_wininst`, поскольку он обеспечивает лучшую поддержку платформ Win64, позволяет администраторам выполнять неинтерактивные установки и допускает установку через групповые политики.767768## 10.30. [`distutils.command.bdist_rpm`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist_rpm) – Сборка двоичного дистрибутива в форматах Redhat RPM и SRPM769770## 10.31. [`distutils.command.bdist_wininst`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist_wininst) – Сборка установщика для Windows771772## 10.32. [`distutils.command.sdist`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.sdist) – Сборка исходного дистрибутива773774## 10.33. [`distutils.command.build`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.build) – Сборка всех файлов пакета775776## 10.34. [`distutils.command.build_clib`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.build_clib) – Сборка библиотек C в пакете777778## 10.35. [`distutils.command.build_ext`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.build_ext) – Сборка расширений в пакете779780## 10.36. [`distutils.command.build_py`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.build_py) – Сборка .py/.pyc файлов пакета781782#### `class distutils.command.build_py.build_py`783784#### `class distutils.command.build_py.build_py_2to3`785786Альтернативная реализация build\_py, которая также запускает библиотеку преобразования 2to3 для каждого .py файла, подлежащего установке. Чтобы использовать это в файле setup.py для дистрибутива, предназначенного для работы с Python 2.x и 3.x, добавьте:787788```python789try:790   from distutils.command.build_py import build_py_2to3 as build_py791except ImportError:792   from distutils.command.build_py import build_py793```794795в файл setup.py, а затем:796797```python798cmdclass = {'build_py': build_py}799```800801в вызов setup().802803## 10.37. [`distutils.command.build_scripts`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.build_scripts) – Сборка скриптов пакета804805## 10.38. [`distutils.command.clean`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.clean) – Очистка области сборки пакета806807Эта команда удаляет временные файлы, созданные **build** и его подкомандами, например промежуточные объектные файлы. При использовании опции `--all` будет удалена вся директория сборки.808809Модули расширения, собранные [*на месте*](https://python-all.ru/3.4/distutils/configfile.html#distutils-build-ext-inplace), не будут очищены, так как они не находятся в директории сборки.810811## 10.39. [`distutils.command.config`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.config) – Выполнение конфигурации пакета812813## 10.40. [`distutils.command.install`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.install) – Установка пакета814815## 10.41. [`distutils.command.install_data`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.install_data) – Установка файлов данных из пакета816817## 10.42. [`distutils.command.install_headers`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.install_headers) – Установка заголовочных файлов C/C++ из пакета818819## 10.43. [`distutils.command.install_lib`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.install_lib) – Установка файлов библиотек из пакета820821## 10.44. [`distutils.command.install_scripts`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.install_scripts) – Установка файлов скриптов из пакета822823## 10.45. [`distutils.command.register`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.register) – Регистрация модуля в Python Package Index824825Команда `register` регистрирует пакет в Python Package Index. Подробнее это описано в [**PEP 301**](https://python-all.ru/3.4/distutils/apiref.html).826827## 10.46. [`distutils.command.check`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.check) – Проверка метаданных пакета828829Команда `check` выполняет некоторые проверки метаданных пакета. Например, она проверяет, что все обязательные метаданные переданы в качестве аргументов функции `setup()`.830