`msilib.md`

320 строк · 24.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.4/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.4/library/msilib.html#module-msilib) – Чтение и запись файлов Microsoft Installer89Модуль [`msilib`](https://python-all.ru/3.4/library/msilib.html#module-msilib) позволяет создавать файлы Microsoft Installer (`.msi`). Поскольку такие файлы часто содержат встроенный CAB-файл (`.cab`), он также предоставляет API для создания CAB-файлов. Поддержка чтения `.cab` файлов пока не реализована; чтение базы данных `.msi` возможно.1011Этот пакет предоставляет полный доступ ко всем таблицам в файле `.msi`, поэтому он является довольно низкоуровневым API. Два основных применения этого пакета – команда [`distutils`](https://python-all.ru/3.4/library/distutils.html#module-distutils) `bdist_msi` и создание самого установочного пакета Python (хотя в настоящее время для этого используется другая версия `msilib`).1213Содержимое пакета можно условно разделить на четыре части: низкоуровневые процедуры CAB, низкоуровневые процедуры MSI, высокоуровневые процедуры MSI и стандартные структуры таблиц.1415#### `msilib.FCICreate(cabname, files)`1617Создаёт новый CAB-файл с именем *cabname*. *files* должен быть списком кортежей, каждый из которых содержит имя файла на диске и имя файла внутри CAB-файла.1819Файлы добавляются в CAB-файл в том порядке, в котором они указаны в списке. Все файлы добавляются в один CAB-файл с использованием алгоритма сжатия MSZIP.2021Колбэки в Python для различных этапов создания MSI в настоящее время не предоставлены.2223#### `msilib.UuidCreate()`2425Возвращает строковое представление нового уникального идентификатора. Эта функция оборачивает вызовы Windows API `UuidCreate()` и `UuidToString()`.2627#### `msilib.OpenDatabase(path, persist)`2829Возвращает новый объект базы данных вызовом MsiOpenDatabase. *path* – имя файла MSI; *persist* может быть одной из констант `MSIDBOPEN_CREATEDIRECT`, `MSIDBOPEN_CREATE`, `MSIDBOPEN_DIRECT`, `MSIDBOPEN_READONLY` или `MSIDBOPEN_TRANSACT`, и может включать флаг `MSIDBOPEN_PATCHFILE`. Смотрите документацию Microsoft для описания этих флагов; в зависимости от флагов открывается существующая база данных или создаётся новая.3031#### `msilib.CreateRecord(count)`3233Возвращает новый объект записи вызовом `MSICreateRecord()`. *count* – количество полей записи.3435#### `msilib.init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)`3637Создаёт и возвращает новую базу данных *name*, инициализирует её схемой *schema* и задаёт свойства *ProductName*, *ProductCode*, *ProductVersion* и *Manufacturer*.3839*schema* должен быть объектом модуля, содержащим атрибуты `tables` и `_Validation_records`; обычно следует использовать [`msilib.schema`](https://python-all.ru/3.4/library/msilib.html#msilib.schema).4041База данных будет содержать только схему и записи проверки, когда эта функция завершится.4243#### `msilib.add_data(database, table, records)`4445Добавляет все *records* в таблицу с именем *table* в *database*.4647Аргумент *table* должен быть одной из предопределённых таблиц в схеме MSI, например `'Feature'`, `'File'`, `'Component'`, `'Dialog'`, `'Control'` и т.д.4849*records* должен быть списком кортежей, каждый из которых содержит все поля записи в соответствии со схемой таблицы. Для необязательных полей можно передать `None`.5051Значения полей могут быть целыми числами, строками или экземплярами класса Binary.5253#### `class msilib.Binary(filename)`5455Представляет записи в таблице Binary; вставка такого объекта через [`add_data()`](https://python-all.ru/3.4/library/msilib.html#msilib.add_data) считывает файл с именем *filename* в таблицу.5657#### `msilib.add_tables(database, module)`5859Добавляет всё содержимое таблиц из *module* в *database*. *module* должен содержать атрибут *tables*, перечисляющий все таблицы, для которых должно быть добавлено содержимое, и по одному атрибуту на каждую таблицу, содержащему фактические данные.6061Обычно используется для установки таблиц последовательности.6263#### `msilib.add_stream(database, name, path)`6465Добавляет файл *path* в таблицу `_Stream` базы данных *database* с именем потока *name*.6667#### `msilib.gen_uuid()`6869Возвращает новый UUID в формате, который обычно требуется для MSI (то есть в фигурных скобках, все шестнадцатеричные цифры в верхнем регистре).7071> **См. также**72>73> [FCICreateFile](https://python-all.ru/3.4/library/msilib.html) [UuidCreate](https://python-all.ru/3.4/library/msilib.html) [UuidToString](https://python-all.ru/3.4/library/msilib.html)7475## 34.1.1. Объекты базы данных7677#### `Database.OpenView(sql)`7879Возвращает объект представления вызовом `MSIDatabaseOpenView()`. *sql* – SQL-выражение для выполнения.8081#### `Database.Commit()`8283Фиксирует ожидающие изменения в текущей транзакции вызовом `MSIDatabaseCommit()`.8485#### `Database.GetSummaryInformation(count)`8687Возвращает новый объект сводной информации вызовом `MsiGetSummaryInformation()`. *count* – максимальное количество обновлённых значений.8889> **См. также**90>91> [MSIDatabaseOpenView](https://python-all.ru/3.4/library/msilib.html) [MSIDatabaseCommit](https://python-all.ru/3.4/library/msilib.html) [MSIGetSummaryInformation](https://python-all.ru/3.4/library/msilib.html)9293## 34.1.2. Объекты представления9495#### `View.Execute(params)`9697Выполняет SQL-запрос представления через `MSIViewExecute()`. Если *params* не равен `None`, это запись, описывающая фактические значения маркеров параметров в запросе.9899#### `View.GetColumnInfo(kind)`100101Возвращает запись с описанием столбцов представления через вызов `MsiViewGetColumnInfo()`. *kind* может быть `MSICOLINFO_NAMES` или `MSICOLINFO_TYPES`.102103#### `View.Fetch()`104105Возвращает результирующую запись запроса через вызов `MsiViewFetch()`.106107#### `View.Modify(kind, data)`108109Изменяет представление через вызов `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`.110111*data* должен быть записью, описывающей новые данные.112113#### `View.Close()`114115Закрывает представление через `MsiViewClose()`.116117> **См. также**118>119> [MsiViewExecute](https://python-all.ru/3.4/library/msilib.html) [MSIViewGetColumnInfo](https://python-all.ru/3.4/library/msilib.html) [MsiViewFetch](https://python-all.ru/3.4/library/msilib.html) [MsiViewModify](https://python-all.ru/3.4/library/msilib.html) [MsiViewClose](https://python-all.ru/3.4/library/msilib.html)120121## 34.1.3. Объекты сводной информации122123#### `SummaryInformation.GetProperty(field)`124125Возвращает свойство сводки через `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`.126127#### `SummaryInformation.GetPropertyCount()`128129Возвращает количество свойств сводки через `MsiSummaryInfoGetPropertyCount()`.130131#### `SummaryInformation.SetProperty(field, value)`132133Устанавливает свойство через `MsiSummaryInfoSetProperty()`. *field* может принимать те же значения, что и в [`GetProperty()`](https://python-all.ru/3.4/library/msilib.html#msilib.SummaryInformation.GetProperty). *value* – это новое значение свойства. Возможные типы значений – целое число и строка.134135#### `SummaryInformation.Persist()`136137Записывает изменённые свойства в поток сводной информации, используя `MsiSummaryInfoPersist()`.138139> **См. также**140>141> [MsiSummaryInfoGetProperty](https://python-all.ru/3.4/library/msilib.html) [MsiSummaryInfoGetPropertyCount](https://python-all.ru/3.4/library/msilib.html) [MsiSummaryInfoSetProperty](https://python-all.ru/3.4/library/msilib.html) [MsiSummaryInfoPersist](https://python-all.ru/3.4/library/msilib.html)142143## 34.1.4. Объекты записей144145#### `Record.GetFieldCount()`146147Возвращает количество полей записи через `MsiRecordGetFieldCount()`.148149#### `Record.GetInteger(field)`150151Возвращает значение *поля* в виде целого числа, где это возможно. *поле* должно быть целым числом.152153#### `Record.GetString(field)`154155Возвращает значение *поля* в виде строки, где это возможно. *поле* должно быть целым числом.156157#### `Record.SetString(field, value)`158159Устанавливает *field* в *value* через `MsiRecordSetString()`. *field* должен быть целым числом, а *value* – строкой.160161#### `Record.SetStream(field, value)`162163Устанавливает *field* в содержимое файла с именем *value* через `MsiRecordSetStream()`. *field* должен быть целым числом, а *value* – строкой.164165#### `Record.SetInteger(field, value)`166167Устанавливает *field* в *value* через `MsiRecordSetInteger()`. *field* и *value* должны быть целыми числами.168169#### `Record.ClearData()`170171Устанавливает все поля записи в 0 через `MsiRecordClearData()`.172173> **См. также**174>175> [MsiRecordGetFieldCount](https://python-all.ru/3.4/library/msilib.html) [MsiRecordSetString](https://python-all.ru/3.4/library/msilib.html) [MsiRecordSetStream](https://python-all.ru/3.4/library/msilib.html) [MsiRecordSetInteger](https://python-all.ru/3.4/library/msilib.html) [MsiRecordClear](https://python-all.ru/3.4/library/msilib.html)176177## 34.1.5. Ошибки178179Все обёртки вокруг функций MSI вызывают `MsiError`; строка внутри исключения содержит подробности.180181## 34.1.6. Объекты CAB182183#### `class msilib.CAB(name)`184185Класс [`CAB`](https://python-all.ru/3.4/library/msilib.html#msilib.CAB) представляет CAB-файл. При создании MSI-файла файлы одновременно добавляются в таблицу `Files` и в CAB-файл. Затем, когда все файлы добавлены, CAB-файл можно записать и добавить в MSI-файл.186187*Имя* – это имя CAB-файла в MSI-файле.188189#### `append(full, file, logical)`190191Добавляет файл с полным именем *полный* в CAB-файл под именем *логическое*. Если уже существует файл с именем *логическое*, создаётся новое имя файла.192193Возвращает индекс файла в CAB-файле и новое имя файла внутри CAB-файла.194195#### `commit(database)`196197Генерирует CAB-файл, добавляет его как поток данных в MSI-файл, помещает в таблицу `Media` и удаляет созданный файл с диска.198199## 34.1.7. Объекты каталогов200201#### `class msilib.Directory(database, cab, basedir, physical, logical, default[, componentflags])`202203Создаёт новый каталог в таблице Directory. Для каталога в каждый момент времени существует текущий компонент, который либо явно создаётся через [`start_component()`](https://python-all.ru/3.4/library/msilib.html#msilib.Directory.start_component), либо неявно при первом добавлении файлов. Файлы добавляются в текущий компонент и в CAB-файл. Чтобы создать каталог, необходимо указать базовый объект каталога (может быть `None`), путь к физическому каталогу и логическое имя каталога. *default* задаёт слот DefaultDir в таблице каталогов. *componentflags* задаёт флаги по умолчанию для новых компонентов.204205#### `start_component(component=None, feature=None, flags=None, keyfile=None, uuid=None)`206207Добавляет запись в таблицу Component и делает этот компонент текущим для данного каталога. Если имя компонента не указано, используется имя каталога. Если не указан *feature*, используется текущий признак (feature). Если не указаны *flags*, используются флаги по умолчанию для каталога. Если не указан *keyfile*, KeyPath в таблице Component остаётся пустым.208209#### `add_file(file, src=None, version=None, language=None)`210211Добавляет файл в текущий компонент каталога, начиная новый, если текущего компонента нет. По умолчанию имя файла в исходном расположении и в таблице File совпадает. Если указан файл *src*, путь интерпретируется относительно текущего каталога. Дополнительно можно указать *version* и *language* для записи в таблице File.212213#### `glob(pattern, exclude=None)`214215Добавляет в текущий компонент файлы, соответствующие glob-шаблону. Отдельные файлы можно исключить с помощью списка *exclude*.216217#### `remove_pyc()`218219Удаляет файлы `.pyc`/`.pyo` при удалении.220221> **См. также**222>223> [Таблица каталогов](https://python-all.ru/3.4/library/msilib.html) [Таблица файлов](https://python-all.ru/3.4/library/msilib.html) [Таблица компонентов](https://python-all.ru/3.4/library/msilib.html) [Таблица FeatureComponents](https://python-all.ru/3.4/library/msilib.html)224225## 34.1.8. Компоненты226227#### `class msilib.Feature(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0)`228229Добавляет новую запись в таблицу `Feature`, используя значения *id*, *parent.id*, *title*, *desc*, *display*, *level*, *directory* и *attributes*. Полученный объект функции можно передать методу `start_component()` объекта [`Directory`](https://python-all.ru/3.4/library/msilib.html#msilib.Directory).230231#### `set_current()`232233Делает эту функцию текущей функцией модуля [`msilib`](https://python-all.ru/3.4/library/msilib.html#module-msilib). Новые компоненты aвтоматически добавляются в функцию по умолчанию, если не указана явно другая функция.234235> **См. также**236>237> [Таблица функций](https://python-all.ru/3.4/library/msilib.html)238239## 34.1.9. Классы GUI240241Модуль [`msilib`](https://python-all.ru/3.4/library/msilib.html#module-msilib) предоставляет несколько классов, которые оборачивают таблицы графического интерфейса в базе данных MSI. Однако стандартный пользовательский интерфейс не предоставляется; используйте [`bdist_msi`](https://python-all.ru/3.4/distutils/apiref.html#module-distutils.command.bdist_msi) для создания MSI-файлов с пользовательским интерфейсом для установки пакетов Python.242243#### `class msilib.Control(dlg, name)`244245Базовый класс для элементов управления диалогом. *dlg* – это объект диалога, которому принадлежит элемент управления, а *name* – имя элемента управления.246247#### `event(event, argument, condition=1, ordering=None)`248249Создаёт запись в таблице `ControlEvent` для этого элемента управления.250251#### `mapping(event, attribute)`252253Создаёт запись в таблице `EventMapping` для этого элемента управления.254255#### `condition(action, condition)`256257Создаёт запись в таблице `ControlCondition` для этого элемента управления.258259#### `class msilib.RadioButtonGroup(dlg, name, property)`260261Создаёт элемент управления «переключатель» (radio button) с именем *name*. *property* – это свойство установщика, которое устанавливается при выборе переключателя.262263#### `add(name, x, y, width, height, text, value=None)`264265Добавляет переключатель с именем *name* в группу, с координатами *x*, *y*, *width*, *height* и меткой *text*. Если *value* равно `None`, оно по умолчанию принимает значение *name*.266267#### `class msilib.Dialog(db, name, x, y, w, h, attr, title, first, default, cancel)`268269Возвращает новый объект [`Dialog`](https://python-all.ru/3.4/library/msilib.html#msilib.Dialog). В таблицу `Dialog` добавляется запись с указанными координатами, атрибутами диалога, заголовком, именами первого, стандартного и отменяющего элементов управления.270271#### `control(name, type, x, y, width, height, attributes, property, text, control_next, help)`272273Возвращает новый объект [`Control`](https://python-all.ru/3.4/library/msilib.html#msilib.Control). В таблицу `Control` добавляется запись с указанными параметрами.274275Это универсальный метод; для конкретных типов предусмотрены специализированные методы.276277#### `text(name, x, y, width, height, attributes, text)`278279Добавляет и возвращает элемент управления `Text`.280281#### `bitmap(name, x, y, width, height, text)`282283Добавляет и возвращает элемент управления `Bitmap`.284285#### `line(name, x, y, width, height)`286287Добавляет и возвращает элемент управления `Line`.288289#### `pushbutton(name, x, y, width, height, attributes, text, next_control)`290291Добавляет и возвращает элемент управления `PushButton`.292293#### `radiogroup(name, x, y, width, height, attributes, property, text, next_control)`294295Добавляет и возвращает элемент управления `RadioButtonGroup`.296297#### `checkbox(name, x, y, width, height, attributes, property, text, next_control)`298299Добавляет и возвращает элемент управления `CheckBox`.300301> **См. также**302>303> [Диалоговая таблица](https://python-all.ru/3.4/library/msilib.html) [Таблица элементов управления](https://python-all.ru/3.4/library/msilib.html) [Типы элементов управления](https://python-all.ru/3.4/library/msilib.html) [Таблица условий элементов управления](https://python-all.ru/3.4/library/msilib.html) [Таблица событий элементов управления](https://python-all.ru/3.4/library/msilib.html) [Таблица сопоставления событий](https://python-all.ru/3.4/library/msilib.html) [Таблица переключателей](https://python-all.ru/3.4/library/msilib.html)304305## 34.1.10. Предварительно вычисленные таблицы306307[`msilib`](https://python-all.ru/3.4/library/msilib.html#module-msilib) предоставляет несколько вложенных пакетов, которые содержат только определения схемы и таблиц. В настоящее время эти определения основаны на MSI версии 2.0.308309#### `msilib.schema`310311Это стандартная схема MSI для MSI 2.0, причём переменная *tables* содержит список определений таблиц, а *\_Validation\_records* предоставляет данные для проверки MSI.312313#### `msilib.sequence`314315Этот модуль содержит содержимое таблиц для стандартных таблиц последовательностей: *AdminExecuteSequence*, *AdminUISequence*, *AdvtExecuteSequence*, *InstallExecuteSequence* и *InstallUISequence*.316317#### `msilib.text`318319Этот модуль содержит определения таблиц UIText и ActionText для стандартных действий установщика.320