PythonmsilibReadandwriteMicrosoftInstallerfiles

Database Objects¶

Database.OpenView(sql)¶

Return a view object, by calling MSIDatabaseOpenView(). sql is the SQL

statement to execute.

Database.Commit()¶

Commit the changes pending in the current transaction, by calling

MSIDatabaseCommit().

Database.GetSummaryInformation(count)¶

Return a new summary information object, by calling

MsiGetSummaryInformation(). count is the maximum number of updated

values.

Database.Close()¶

Close the database object, through MsiCloseHandle().

3.7 新版功能.

View Objects¶

View.Execute(params)¶

Execute the SQL query of the view, through MSIViewExecute(). If

params is not None, it is a record describing actual values of the

parameter tokens in the query.

View.GetColumnInfo(kind)¶

Return a record describing the columns of the view, through calling

MsiViewGetColumnInfo(). kind can be either MSICOLINFO_NAMES or

MSICOLINFO_TYPES.

View.Fetch()¶

Return a result record of the query, through calling MsiViewFetch().

View.Modify(kind, data)¶

Modify the view, by calling MsiViewModify(). kind can be one of

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, or MSIMODIFY_VALIDATE_DELETE.

data must be a record describing the new data.

View.Close()¶

Close the view, through MsiViewClose().

Summary Information Objects¶

SummaryInformation.GetProperty(field)¶

Return a property of the summary, through MsiSummaryInfoGetProperty().

field is the name of the property, and can be one of the constants

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, or PID_SECURITY.

SummaryInformation.GetPropertyCount()¶

Return the number of summary properties, through

MsiSummaryInfoGetPropertyCount().

SummaryInformation.SetProperty(field, value)¶

Set a property through MsiSummaryInfoSetProperty(). field can have the

same values as in GetProperty(), value is the new value of the property.

Possible value types are integer and string.

SummaryInformation.Persist()¶

Write the modified properties to the summary information stream, using

MsiSummaryInfoPersist().

Record Objects¶

Record.GetFieldCount()¶

Return the number of fields of the record, through

MsiRecordGetFieldCount().

Record.GetInteger(field)¶

Return the value of field as an integer where possible. field must

be an integer.

Record.GetString(field)¶

Return the value of field as a string where possible. field must

be an integer.

Record.SetString(field, value)¶

Set field to value through MsiRecordSetString(). field must be an

integer; value a string.

Record.SetStream(field, value)¶

Set field to the contents of the file named value, through

MsiRecordSetStream(). field must be an integer; value a string.

Record.SetInteger(field, value)¶

Set field to value through MsiRecordSetInteger(). Both field and

value must be an integer.

Record.ClearData()¶

Set all fields of the record to 0, through MsiRecordClearData().

Errors¶

All wrappers around MSI functions raise MSIError; the string inside the

exception will contain more detail.

CAB Objects¶

class msilib.CAB(name)¶

The class CAB represents a CAB file. During MSI construction, files

will be added simultaneously to the Files table, and to a CAB file. Then,

when all files have been added, the CAB file can be written, then added to the

MSI file.

name is the name of the CAB file in the MSI file.

append(full, file, logical)¶

Add the file with the pathname full to the CAB file, under the name

logical. If there is already a file named logical, a new file name is

created.

Return the index of the file in the CAB file, and the new name of the file

inside the CAB file.

commit(database)¶

Generate a CAB file, add it as a stream to the MSI file, put it into the

Media table, and remove the generated file from the disk.

Directory Objects¶

class msilib.Directory(database, cab, basedir, physical, logical, default[, componentflags])¶

Create a new directory in the Directory table. There is a current component at

each point in time for the directory, which is either explicitly created through

start_component(), or implicitly when files are added for the first time.

Files are added into the current component, and into the cab file. To create a

directory, a base directory object needs to be specified (can be None), the

path to the physical directory, and a logical directory name. default

specifies the DefaultDir slot in the directory table. componentflags specifies

the default flags that new components get.

start_component(component=None, feature=None, flags=None, keyfile=None, uuid=None)¶

Add an entry to the Component table, and make this component the current

component for this directory. If no component name is given, the directory

name is used. If no feature is given, the current feature is used. If no

flags are given, the directory's default flags are used. If no keyfile

is given, the KeyPath is left null in the Component table.

add_file(file, src=None, version=None, language=None)¶

Add a file to the current component of the directory, starting a new one

if there is no current component. By default, the file name in the source

and the file table will be identical. If the src file is specified, it

is interpreted relative to the current directory. Optionally, a version

and a language can be specified for the entry in the File table.

glob(pattern, exclude=None)¶

Add a list of files to the current component as specified in the glob

pattern. Individual files can be excluded in the exclude list.

remove_pyc()¶

Remove .pyc files on uninstall.

相关特性¶

class msilib.Feature(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0)¶

Add a new record to the Feature table, using the values id, parent.id,

title, desc, display, level, directory, and attributes. The

resulting feature object can be passed to the start_component() method of

Directory.

set_current()¶

Make this feature the current feature of msilib. New components are

automatically added to the default feature, unless a feature is explicitly

specified.

GUI classes¶

msilib provides several classes that wrap the GUI tables in an MSI

database. However, no standard user interface is provided; use

bdist_msi to create MSI files with a user-interface

for installing Python packages.

class msilib.Control(dlg, name)¶

Base class of the dialog controls. dlg is the dialog object the control

belongs to, and name is the control's name.

event(event, argument, condition=1, ordering=None)¶

Make an entry into the ControlEvent table for this control.

mapping(event, attribute)¶

Make an entry into the EventMapping table for this control.

condition(action, condition)¶

Make an entry into the ControlCondition table for this control.

class msilib.RadioButtonGroup(dlg, name, property)¶

Create a radio button control named name. property is the installer property

that gets set when a radio button is selected.

add(name, x, y, width, height, text, value=None)¶

Add a radio button named name to the group, at the coordinates x, y,

width, height, and with the label text. If value is None, it

defaults to name.

class msilib.Dialog(db, name, x, y, w, h, attr, title, first, default, cancel)¶

Return a new Dialog object. An entry in the Dialog table is made,

with the specified coordinates, dialog attributes, title, name of the first,

default, and cancel controls.

control(name, type, x, y, width, height, attributes, property, text, control_next, help)¶

Return a new Control object. An entry in the Control table is

made with the specified parameters.

This is a generic method; for specific types, specialized methods are

provided.

text(name, x, y, width, height, attributes, text)¶

Add and return a Text control.

bitmap(name, x, y, width, height, text)¶

Add and return a Bitmap control.

line(name, x, y, width, height)¶

Add and return a Line control.

pushbutton(name, x, y, width, height, attributes, text, next_control)¶

Add and return a PushButton control.

radiogroup(name, x, y, width, height, attributes, property, text, next_control)¶

Add and return a RadioButtonGroup control.

checkbox(name, x, y, width, height, attributes, property, text, next_control)¶

Add and return a CheckBox control.

Precomputed tables¶

msilib provides a few subpackages that contain only schema and table

definitions. Currently, these definitions are based on MSI version 2.0.

msilib.schema¶

This is the standard MSI schema for MSI 2.0, with the tables variable

providing a list of table definitions, and _Validation_records providing the

data for MSI validation.

msilib.sequence¶

This module contains table contents for the standard sequence tables:

AdminExecuteSequence, AdminUISequence, AdvtExecuteSequence,

InstallExecuteSequence, and InstallUISequence.

msilib.text¶

This module contains definitions for the UIText and ActionText tables, for the

standard installer actions.