`msilib.md`

324 строк · 24.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/library/msilib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 34.1. [`msilib`](https://python-all.ru/3.6/library/msilib.html#module-msilib) – Чтение и запись установочных файлов Microsoft Installer89**Исходный код:** [Lib/msilib/\_\_init\_\_.py](https://python-all.ru/src/3.6/Lib/msilib/__init__.py)1011---1213Модуль [`msilib`](https://python-all.ru/3.6/library/msilib.html#module-msilib) поддерживает создание файлов Microsoft Installer (`.msi`). Поскольку такие файлы часто содержат встроенный «кабинетный» файл (`.cab`), он также предоставляет API для создания CAB-файлов. Поддержка чтения `.cab` файлов на данный момент не реализована; возможно чтение базы данных `.msi`.1415Этот пакет предоставляет полный доступ ко всем таблицам в файле `.msi`, поэтому это довольно низкоуровневый API. Два основных применения этого пакета – команда [`distutils`](https://python-all.ru/3.6/library/distutils.html#module-distutils) `bdist_msi` и создание самого установочного пакета Python (хотя в нём сейчас используется другая версия `msilib`).1617Содержимое пакета можно условно разделить на четыре части: низкоуровневые процедуры CAB, низкоуровневые процедуры MSI, высокоуровневые процедуры MSI и стандартные структуры таблиц.1819#### `msilib.FCICreate(cabname, files)`2021Создаёт новый CAB-файл с именем *cabname*. *files* должен быть списком кортежей, каждый из которых содержит имя файла на диске и имя файла внутри CAB-файла.2223Файлы добавляются в CAB-файл в том порядке, в котором они указаны в списке. Все файлы добавляются в один CAB-файл с использованием алгоритма сжатия MSZIP.2425Колбэки в Python для различных этапов создания MSI в настоящее время не предоставлены.2627#### `msilib.UuidCreate()`2829Возвращает строковое представление нового уникального идентификатора. Это обёртка над функциями Windows API `UuidCreate()` и `UuidToString()`.3031#### `msilib.OpenDatabase(path, persist)`3233Возвращает новый объект базы данных вызовом MsiOpenDatabase. *path* – это имя файла MSI; *persist* может быть одной из констант `MSIDBOPEN_CREATEDIRECT`, `MSIDBOPEN_CREATE`, `MSIDBOPEN_DIRECT`, `MSIDBOPEN_READONLY` или `MSIDBOPEN_TRANSACT` и может включать флаг `MSIDBOPEN_PATCHFILE`. См. документацию Microsoft для получения информации о значении этих флагов; в зависимости от флагов открывается существующая база данных или создаётся новая.3435#### `msilib.CreateRecord(count)`3637Возвращает новый объект записи вызовом `MSICreateRecord()`. *count* – это количество полей записи.3839#### `msilib.init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)`4041Создаёт и возвращает новую базу данных *name*, инициализирует её схемой *schema* и задаёт свойства *ProductName*, *ProductCode*, *ProductVersion* и *Manufacturer*.4243*schema* должен быть объектом модуля, содержащим атрибуты `tables` и `_Validation_records`; как правило, следует использовать [`msilib.schema`](https://python-all.ru/3.6/library/msilib.html#msilib.schema).4445База данных будет содержать только схему и записи проверки, когда эта функция завершится.4647#### `msilib.add_data(database, table, records)`4849Добавляет все *records* в таблицу с именем *table* в *database*.5051Аргумент *table* должен быть одной из предопределённых таблиц в схеме MSI, например `'Feature'`, `'File'`, `'Component'`, `'Dialog'`, `'Control'` и т.д.5253*records* должен быть списком кортежей, каждый из которых содержит все поля записи в соответствии со схемой таблицы. Для необязательных полей можно передать `None`.5455Значения полей могут быть целыми числами, строками или экземплярами класса Binary.5657#### `class msilib.Binary(filename)`5859Представляет записи в таблице Binary; вставка такого объекта с помощью [`add_data()`](https://python-all.ru/3.6/library/msilib.html#msilib.add_data) считывает файл с именем *filename* в таблицу.6061#### `msilib.add_tables(database, module)`6263Добавляет всё содержимое таблиц из *module* в *database*. *module* должен содержать атрибут *tables*, перечисляющий все таблицы, для которых должно быть добавлено содержимое, и по одному атрибуту на каждую таблицу, содержащему фактические данные.6465Обычно используется для установки таблиц последовательности.6667#### `msilib.add_stream(database, name, path)`6869Добавляет файл *path* в таблицу `_Stream` базы данных *database* с именем потока *name*.7071#### `msilib.gen_uuid()`7273Возвращает новый UUID в формате, который обычно требуется для MSI (то есть в фигурных скобках, все шестнадцатеричные цифры в верхнем регистре).7475> **См. также**76>77> [FCICreate](https://python-all.ru/3.6/library/msilib.html) [UuidCreate](https://python-all.ru/3.6/library/msilib.html) [UuidToString](https://python-all.ru/3.6/library/msilib.html)7879## 34.1.1. Объекты базы данных8081#### `Database.OpenView(sql)`8283Возвращает объект представления, вызывая `MSIDatabaseOpenView()`. *sql* – это SQL-инструкция, которую нужно выполнить.8485#### `Database.Commit()`8687Фиксирует ожидающие изменения в текущей транзакции, вызывая `MSIDatabaseCommit()`.8889#### `Database.GetSummaryInformation(count)`9091Возвращает новый объект сводной информации, вызывая `MsiGetSummaryInformation()`. *count* – это максимальное количество обновлённых значений.9293> **См. также**94>95> [MSIDatabaseOpenView](https://python-all.ru/3.6/library/msilib.html) [MSIDatabaseCommit](https://python-all.ru/3.6/library/msilib.html) [MSIGetSummaryInformation](https://python-all.ru/3.6/library/msilib.html)9697## 34.1.2. Объекты представления9899#### `View.Execute(params)`100101Выполняет SQL-запрос представления через `MSIViewExecute()`. Если *params* не равен `None`, то это запись, описывающая фактические значения токенов параметров в запросе.102103#### `View.GetColumnInfo(kind)`104105Возвращает запись, описывающую столбцы представления, вызывая `MsiViewGetColumnInfo()`. *kind* может быть либо `MSICOLINFO_NAMES`, либо `MSICOLINFO_TYPES`.106107#### `View.Fetch()`108109Возвращает результирующую запись запроса, вызывая `MsiViewFetch()`.110111#### `View.Modify(kind, data)`112113Изменяет представление, вызывая `MsiViewModify()`. *kind* может быть одним из `MSIMODIFY_SEEK`, `MSIMODIFY_REFRESH`, `MSIMODIFY_INSERT`, `MSIMODIFY_UPDATE`, `MSIMODIFY_ASSIGN`, `MSIMODIFY_REPLACE`, `MSIMODIFY_MERGE`, `MSIMODIFY_DELETE`, `MSIMODIFY_INSERT_TEMPORARY`, `MSIMODIFY_VALIDATE`, `MSIMODIFY_VALIDATE_NEW`, `MSIMODIFY_VALIDATE_FIELD` или `MSIMODIFY_VALIDATE_DELETE`.114115*data* должен быть записью, описывающей новые данные.116117#### `View.Close()`118119Закрывает представление через `MsiViewClose()`.120121> **См. также**122>123> [MsiViewExecute](https://python-all.ru/3.6/library/msilib.html) [MSIViewGetColumnInfo](https://python-all.ru/3.6/library/msilib.html) [MsiViewFetch](https://python-all.ru/3.6/library/msilib.html) [MsiViewModify](https://python-all.ru/3.6/library/msilib.html) [MsiViewClose](https://python-all.ru/3.6/library/msilib.html)124125## 34.1.3. Объекты сводной информации126127#### `SummaryInformation.GetProperty(field)`128129Возвращает свойство сводки через `MsiSummaryInfoGetProperty()`. *field* – это имя свойства и может быть одной из констант `PID_CODEPAGE`, `PID_TITLE`, `PID_SUBJECT`, `PID_AUTHOR`, `PID_KEYWORDS`, `PID_COMMENTS`, `PID_TEMPLATE`, `PID_LASTAUTHOR`, `PID_REVNUMBER`, `PID_LASTPRINTED`, `PID_CREATE_DTM`, `PID_LASTSAVE_DTM`, `PID_PAGECOUNT`, `PID_WORDCOUNT`, `PID_CHARCOUNT`, `PID_APPNAME` или `PID_SECURITY`.130131#### `SummaryInformation.GetPropertyCount()`132133Возвращает количество свойств сводки через `MsiSummaryInfoGetPropertyCount()`.134135#### `SummaryInformation.SetProperty(field, value)`136137Устанавливает свойство через `MsiSummaryInfoSetProperty()`. *field* может иметь те же значения, что и в [`GetProperty()`](https://python-all.ru/3.6/library/msilib.html#msilib.SummaryInformation.GetProperty), *value* – это новое значение свойства. Возможные типы значений: целое число и строка.138139#### `SummaryInformation.Persist()`140141Записывает изменённые свойства в поток сводной информации, используя `MsiSummaryInfoPersist()`.142143> **См. также**144>145> [MsiSummaryInfoGetProperty](https://python-all.ru/3.6/library/msilib.html) [MsiSummaryInfoGetPropertyCount](https://python-all.ru/3.6/library/msilib.html) [MsiSummaryInfoSetProperty](https://python-all.ru/3.6/library/msilib.html) [MsiSummaryInfoPersist](https://python-all.ru/3.6/library/msilib.html)146147## 34.1.4. Объекты записей148149#### `Record.GetFieldCount()`150151Возвращает количество полей записи, через `MsiRecordGetFieldCount()`.152153#### `Record.GetInteger(field)`154155Возвращает значение *поля* в виде целого числа, где это возможно. *поле* должно быть целым числом.156157#### `Record.GetString(field)`158159Возвращает значение *поля* в виде строки, где это возможно. *поле* должно быть целым числом.160161#### `Record.SetString(field, value)`162163Устанавливает *поле* в *значение* через `MsiRecordSetString()`. *поле* должно быть целым числом; *значение* – строкой.164165#### `Record.SetStream(field, value)`166167Устанавливает *поле* в содержимое файла с именем *значение*, через `MsiRecordSetStream()`. *поле* должно быть целым числом; *значение* – строкой.168169#### `Record.SetInteger(field, value)`170171Устанавливает *поле* в *значение* через `MsiRecordSetInteger()`. И *поле*, и *значение* должны быть целыми числами.172173#### `Record.ClearData()`174175Устанавливает все поля записи в 0, через `MsiRecordClearData()`.176177> **См. также**178>179> [MsiRecordGetFieldCount](https://python-all.ru/3.6/library/msilib.html) [MsiRecordSetString](https://python-all.ru/3.6/library/msilib.html) [MsiRecordSetStream](https://python-all.ru/3.6/library/msilib.html) [MsiRecordSetInteger](https://python-all.ru/3.6/library/msilib.html) [MsiRecordClearData](https://python-all.ru/3.6/library/msilib.html)180181## 34.1.5. Ошибки182183Все обёртки вокруг функций MSI возбуждают `MSIError`; строка внутри исключения будет содержать больше подробностей.184185## 34.1.6. Объекты CAB186187#### `class msilib.CAB(name)`188189Класс [`CAB`](https://python-all.ru/3.6/library/msilib.html#msilib.CAB) представляет CAB-файл. Во время создания MSI файлы добавляются одновременно в таблицу `Files` и в CAB-файл. Затем, когда все файлы добавлены, CAB-файл можно записать, а затем добавить в MSI-файл.190191*Имя* – это имя CAB-файла в MSI-файле.192193#### `append(full, file, logical)`194195Добавляет файл с полным именем *полный* в CAB-файл под именем *логическое*. Если уже существует файл с именем *логическое*, создаётся новое имя файла.196197Возвращает индекс файла в CAB-файле и новое имя файла внутри CAB-файла.198199#### `commit(database)`200201Создаёт CAB-файл, добавляет его как поток в MSI-файл, помещает его в таблицу `Media` и удаляет созданный файл с диска.202203## 34.1.7. Directory Objects204205#### `class msilib.Directory(database, cab, basedir, physical, logical, default[, componentflags])`206207Создаёт новую запись в таблице Directory. В каждый момент времени для каталога существует текущий компонент; он может быть создан явно через [`start_component()`](https://python-all.ru/3.6/library/msilib.html#msilib.Directory.start_component) или неявно при первом добавлении файлов. Файлы добавляются в текущий компонент и в CAB-файл. Для создания каталога нужно указать базовый объект каталога (может быть `None`), путь к физическому каталогу и логическое имя каталога. *default* задаёт слот DefaultDir в таблице Directory. *componentflags* задаёт флаги по умолчанию для новых компонентов.208209#### `start_component(component=None, feature=None, flags=None, keyfile=None, uuid=None)`210211Добавляет запись в таблицу Component и делает этот компонент текущим для данного каталога. Если имя компонента не указано, используется имя каталога. Если не указан *feature*, используется текущий признак (feature). Если не указаны *flags*, используются флаги по умолчанию для каталога. Если не указан *keyfile*, KeyPath в таблице Component остаётся пустым.212213#### `add_file(file, src=None, version=None, language=None)`214215Добавляет файл в текущий компонент каталога, начиная новый, если текущего компонента нет. По умолчанию имя файла в исходном расположении и в таблице File совпадает. Если указан файл *src*, путь интерпретируется относительно текущего каталога. Дополнительно можно указать *version* и *language* для записи в таблице File.216217#### `glob(pattern, exclude=None)`218219Добавляет в текущий компонент файлы, соответствующие glob-шаблону. Отдельные файлы можно исключить с помощью списка *exclude*.220221#### `remove_pyc()`222223Удаляет файлы `.pyc` при удалении.224225> **См. также**226>227> [Таблица каталогов](https://python-all.ru/3.6/library/msilib.html) [Таблица файлов](https://python-all.ru/3.6/library/msilib.html) [Таблица компонентов](https://python-all.ru/3.6/library/msilib.html) [Таблица FeatureComponents](https://python-all.ru/3.6/library/msilib.html)228229## 34.1.8. Возможности230231#### `class msilib.Feature(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0)`232233Добавляет новую запись в таблицу `Feature`, используя значения *id*, *parent.id*, *title*, *desc*, *display*, *level*, *directory* и *attributes*. Полученный объект feature можно передать методу `start_component()` объекта [`Directory`](https://python-all.ru/3.6/library/msilib.html#msilib.Directory).234235#### `set_current()`236237Делает этот признак (feature) текущим для [`msilib`](https://python-all.ru/3.6/library/msilib.html#module-msilib). Новые компоненты автоматически добавляются в признак по умолчанию, если не указан явно другой признак.238239> **См. также**240>241> [Таблица функций](https://python-all.ru/3.6/library/msilib.html)242243## 34.1.9. Классы GUI244245[`msilib`](https://python-all.ru/3.6/library/msilib.html#module-msilib) предоставляет несколько классов, которые оборачивают таблицы GUI в базе данных MSI. Однако стандартный пользовательский интерфейс не предоставляется; используйте [`bdist_msi`](https://python-all.ru/3.6/distutils/apiref.html#module-distutils.command.bdist_msi) для создания MSI-файлов с пользовательским интерфейсом для установки пакетов Python.246247#### `class msilib.Control(dlg, name)`248249Базовый класс для элементов управления диалогом. *dlg* – это объект диалога, которому принадлежит элемент управления, а *name* – имя элемента управления.250251#### `event(event, argument, condition=1, ordering=None)`252253Создаёт запись в таблице `ControlEvent` для этого элемента управления.254255#### `mapping(event, attribute)`256257Создаёт запись в таблице `EventMapping` для этого элемента управления.258259#### `condition(action, condition)`260261Создаёт запись в таблице `ControlCondition` для этого элемента управления.262263#### `class msilib.RadioButtonGroup(dlg, name, property)`264265Создаёт элемент управления «переключатель» (radio button) с именем *name*. *property* – это свойство установщика, которое устанавливается при выборе переключателя.266267#### `add(name, x, y, width, height, text, value=None)`268269Добавляет переключатель с именем *name* в группу с координатами *x*, *y*, *width*, *height* и меткой *text*. Если *value* равно `None`, по умолчанию используется *name*.270271#### `class msilib.Dialog(db, name, x, y, w, h, attr, title, first, default, cancel)`272273Возвращает новый объект [`Dialog`](https://python-all.ru/3.6/library/msilib.html#msilib.Dialog). В таблицу `Dialog` добавляется запись с указанными координатами, атрибутами диалога, заголовком, именами первого, стандартного (default) и отменяющего (cancel) элементов управления.274275#### `control(name, type, x, y, width, height, attributes, property, text, control_next, help)`276277Возвращает новый объект [`Control`](https://python-all.ru/3.6/library/msilib.html#msilib.Control). Запись в таблице `Control` создаётся с указанными параметрами.278279Это универсальный метод; для конкретных типов предусмотрены специализированные методы.280281#### `text(name, x, y, width, height, attributes, text)`282283Добавляет и возвращает элемент управления `Text`.284285#### `bitmap(name, x, y, width, height, text)`286287Добавляет и возвращает элемент управления `Bitmap`.288289#### `line(name, x, y, width, height)`290291Добавляет и возвращает элемент управления `Line`.292293#### `pushbutton(name, x, y, width, height, attributes, text, next_control)`294295Добавляет и возвращает элемент управления `PushButton`.296297#### `radiogroup(name, x, y, width, height, attributes, property, text, next_control)`298299Добавляет и возвращает элемент управления `RadioButtonGroup`.300301#### `checkbox(name, x, y, width, height, attributes, property, text, next_control)`302303Добавляет и возвращает элемент управления `CheckBox`.304305> **См. также**306>307> [Диалоговая таблица](https://python-all.ru/3.6/library/msilib.html) [Таблица элементов управления](https://python-all.ru/3.6/library/msilib.html) [Типы элементов управления](https://python-all.ru/3.6/library/msilib.html) [Таблица условий элементов управления](https://python-all.ru/3.6/library/msilib.html) [Таблица событий элементов управления](https://python-all.ru/3.6/library/msilib.html) [Таблица сопоставления событий](https://python-all.ru/3.6/library/msilib.html) [Таблица переключателей](https://python-all.ru/3.6/library/msilib.html)308309## 34.1.10. Предварительно вычисленные таблицы310311[`msilib`](https://python-all.ru/3.6/library/msilib.html#module-msilib) предоставляет несколько подпакетов, содержащих только определения схем и таблиц. В настоящее время эти определения основаны на MSI версии 2.0.312313#### `msilib.schema`314315Это стандартная схема MSI для MSI 2.0, причём переменная *tables* содержит список определений таблиц, а *\_Validation\_records* предоставляет данные для проверки MSI.316317#### `msilib.sequence`318319Этот модуль содержит содержимое таблиц для стандартных таблиц последовательностей: *AdminExecuteSequence*, *AdminUISequence*, *AdvtExecuteSequence*, *InstallExecuteSequence* и *InstallUISequence*.320321#### `msilib.text`322323Этот модуль содержит определения таблиц UIText и ActionText для стандартных действий установщика.324