msilib
— 读写 Microsoft Installer 文件
¶
msilib
支持创建 Microsoft 安装程序 (
.msi
) 文件。因为这些文件经常包含嵌入式 cabinet (柜子) 文件 (
.cab
)，它还暴露 API 以创建 CAB 文件。支持读取
.cab
文件目前未实现；读取支持
.msi
数据库是可能的。
此包旨在提供完整访问对所有表格在
.msi
文件，因此，它是相当低级的 API。此包的 2 个首要应用程序是
distutils
command
bdist_msi
，和 Python 安装程序包本身的创建 (虽然目前使用的是不同版本的
msilib
).
包内容大致可分为 4 部分：低级 CAB 例程、低级 MSI 例程、高级 MSI 例程及标准表格结构。
msilib.
FCICreate
(
cabname
,
文件
)
¶
创建新 CAB 文件名为 cabname . 文件 must be a list of tuples, each containing the name of the file on disk, and the name of the file inside the CAB file.
The files are added to the CAB file in the order they appear in the list. All files are added into a single CAB file, using the MSZIP compression algorithm.
Callbacks to Python for the various steps of MSI creation are currently not exposed.
msilib.
UuidCreate
(
)
¶
Return the string representation of a new unique identifier. This wraps the Windows API functions
UuidCreate()
and
UuidToString()
.
msilib.
OpenDatabase
(
path
,
persist
)
¶
返回新的数据库对象通过调用 MsiOpenDatabase。
path
is the file name of the MSI file;
persist
can be one of the constants
MSIDBOPEN_CREATEDIRECT
,
MSIDBOPEN_CREATE
,
MSIDBOPEN_DIRECT
,
MSIDBOPEN_READONLY
，或
MSIDBOPEN_TRANSACT
, and may include the flag
MSIDBOPEN_PATCHFILE
. See the Microsoft documentation for the meaning of these flags; depending on the flags, an existing database is opened, or a new one created.
msilib.
CreateRecord
(
count
)
¶
Return a new record object by calling
MSICreateRecord()
.
count
is the number of fields of the record.
msilib.
init_database
(
name
,
schema
,
ProductName
,
ProductCode
,
ProductVersion
,
Manufacturer
)
¶
Create and return a new database name , initialize it with schema , and set the properties ProductName , ProductCode , ProductVersion ，和 Manufacturer .
schema
must be a module object containing
tables
and
_Validation_records
attributes; typically,
msilib.schema
should be used.
The database will contain just the schema and the validation records when this function returns.
msilib.
add_data
(
database
,
table
,
records
)
¶
添加所有 records to the table named table in database .
table
argument must be one of the predefined tables in the MSI schema, e.g.
'Feature'
,
'File'
,
'Component'
,
'Dialog'
,
'Control'
，等。
records
should be a list of tuples, each one containing all fields of a record according to the schema of the table. For optional fields,
None
can be passed.
Field values can be ints, strings, or instances of the Binary class.
msilib.
Binary
(
filename
)
¶
Represents entries in the Binary table; inserting such an object using
add_data()
reads the file named
filename
into the table.
msilib.
add_tables
(
database
,
模块
)
¶
添加所有表格内容从 模块 to database . 模块 must contain an attribute tables listing all tables for which content should be added, and one attribute per table that has the actual content.
这通常用于安装序列表格。
msilib.
add_stream
(
database
,
name
,
path
)
¶
添加文件
path
into the
_Stream
table of
database
, with the stream name
name
.
msilib.
gen_uuid
(
)
¶
Return a new UUID, in the format that MSI typically requires (i.e. in curly braces, and with all hexdigits in upper-case).
Database.
OpenView
(
sql
)
¶
返回视图对象，通过调用
MSIDatabaseOpenView()
.
sql
是要执行的 SQL 语句。
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.
View.
Execute
(
params
)
¶
执行视图 SQL 查询，透过
MSIViewExecute()
。若
params
不是
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
可以是
MSICOLINFO_NAMES
or
MSICOLINFO_TYPES
.
View.
Fetch
(
)
¶
Return a result record of the query, through calling
MsiViewFetch()
.
View.
修改
(
kind
,
data
)
¶
修改视图，通过调用
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
，或
MSIMODIFY_VALIDATE_DELETE
.
data 必须是描述新数据的记录。
View.
Close
(
)
¶
关闭视图，透过
MsiViewClose()
.
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
，或
PID_SECURITY
.
SummaryInformation.
GetPropertyCount
(
)
¶
返回汇总特性数，透过
MsiSummaryInfoGetPropertyCount()
.
SummaryInformation.
SetProperty
(
field
,
value
)
¶
设置特性透过
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.
GetFieldCount
(
)
¶
返回记录字段数，透过
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()
.
All wrappers around MSI functions raise
MSIError
; the string inside the exception will contain more detail.
msilib.
CAB
(
name
)
¶
类
CAB
represents a CAB file. During MSI construction, files will be added simultaneously to the
文件
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.
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 和 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
(
)
¶
移除
.pyc
文件当卸载时。
另请参阅
msilib.
Feature
(
db
,
id
,
title
,
desc
,
display
,
level=1
,
parent=None
,
directory=None
,
attributes=0
)
¶
把新记录添加到
Feature
table, using the values
id
,
parent.id
,
title
,
desc
,
display
,
level
,
directory
，和
attributes
. The resulting feature object can be passed to the
start_component()
方法的
Directory
.
另请参阅
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.
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.
映射
(
event
,
属性
)
¶
Make an entry into the
EventMapping
table for this control.
condition
(
action
,
condition
)
¶
Make an entry into the
ControlCondition
table for this control.
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
。若
value
is
None
, it defaults to
name
.
msilib.
Dialog
(
db
,
name
,
x
,
y
,
w
,
h
,
attr
,
title
,
first
,
default
,
cancel
)
¶
返回新
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
)
¶
返回新
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
)
¶
添加并返回
Text
控件。
bitmap
(
name
,
x
,
y
,
width
,
height
,
text
)
¶
添加并返回
Bitmap
控件。
line
(
name
,
x
,
y
,
width
,
height
)
¶
添加并返回
Line
控件。
添加并返回
PushButton
控件。
radiogroup
(
name
,
x
,
y
,
width
,
height
,
attributes
,
property
,
text
,
next_control
)
¶
添加并返回
RadioButtonGroup
控件。
checkbox
(
name
,
x
,
y
,
width
,
height
,
attributes
,
property
,
text
,
next_control
)
¶
添加并返回
CheckBox
控件。
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 ，和 InstallUISequence .
msilib.
text
¶
This module contains definitions for the UIText and ActionText tables, for the standard installer actions.