~dkuhlman/python-training-materials/Materials

<h1>34.1. <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal">msilib</code></a> — Read and write Microsoft Installer files<a class="headerlink" href="#module-msilib" title="Permalink to this headline">¶</a></h1>

Source code: <a class="reference external" href="https://hg.python.org/cpython/file/3.5/Lib/msilib/__init__.py">Lib/msilib/__init__.py</a>

The <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal">msilib</code></a> supports the creation of Microsoft Installer (<code class="docutils literal">.msi</code>) files.

Because these files often contain an embedded “cabinet” file (<code class="docutils literal">.cab</code>), it also

100

exposes an API to create CAB files. Support for reading <code class="docutils literal">.cab</code> files is

101

currently not implemented; read support for the <code class="docutils literal">.msi</code> database is possible.

102

This package aims to provide complete access to all tables in an <code class="docutils literal">.msi</code> file,

103

therefore, it is a fairly low-level API. Two primary applications of this

104

package are the <a class="reference internal" href="distutils.html#module-distutils" title="distutils: Support for building and installing Python modules into an existing Python installation."><code class="xref py py-mod docutils literal">distutils</code></a> command <code class="docutils literal">bdist_msi</code>, and the creation of

105

Python installer package itself (although that currently uses a different

106

version of <code class="docutils literal">msilib</code>).

107

The package contents can be roughly split into four parts: low-level CAB

108

routines, low-level MSI routines, higher-level MSI routines, and standard table

109

structures.

110

111

112

<code class="descclassname">msilib.</code><code class="descname">FCICreate</code>(cabname, files)<a class="headerlink" href="#msilib.FCICreate" title="Permalink to this definition">¶</a></dt>

113

<dd>Create a new CAB file named cabname. files must be a list of tuples, each

114

containing the name of the file on disk, and the name of the file inside the CAB

115

file.

116

The files are added to the CAB file in the order they appear in the list. All

117

files are added into a single CAB file, using the MSZIP compression algorithm.

118

Callbacks to Python for the various steps of MSI creation are currently not

119

exposed.

120

</dd></dl>

121

122

123

124

<code class="descclassname">msilib.</code><code class="descname">UuidCreate</code>()<a class="headerlink" href="#msilib.UuidCreate" title="Permalink to this definition">¶</a></dt>

125

<dd>Return the string representation of a new unique identifier. This wraps the

126

Windows API functions <code class="xref c c-func docutils literal">UuidCreate()</code> and <code class="xref c c-func docutils literal">UuidToString()</code>.

127

</dd></dl>

128

129

130

131

<code class="descclassname">msilib.</code><code class="descname">OpenDatabase</code>(path, persist)<a class="headerlink" href="#msilib.OpenDatabase" title="Permalink to this definition">¶</a></dt>

132

<dd>Return a new database object by calling MsiOpenDatabase. path is the file

133

name of the MSI file; persist can be one of the constants

134

<code class="docutils literal">MSIDBOPEN_CREATEDIRECT</code>, <code class="docutils literal">MSIDBOPEN_CREATE</code>, <code class="docutils literal">MSIDBOPEN_DIRECT</code>,

135

<code class="docutils literal">MSIDBOPEN_READONLY</code>, or <code class="docutils literal">MSIDBOPEN_TRANSACT</code>, and may include the flag

136

<code class="docutils literal">MSIDBOPEN_PATCHFILE</code>. See the Microsoft documentation for the meaning of

137

these flags; depending on the flags, an existing database is opened, or a new

138

one created.

139

</dd></dl>

140

141

142

143

<code class="descclassname">msilib.</code><code class="descname">CreateRecord</code>(count)<a class="headerlink" href="#msilib.CreateRecord" title="Permalink to this definition">¶</a></dt>

144

<dd>Return a new record object by calling <code class="xref c c-func docutils literal">MSICreateRecord()</code>. count is the

145

number of fields of the record.

146

</dd></dl>

147

148

149

150

<code class="descclassname">msilib.</code><code class="descname">init_database</code>(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)<a class="headerlink" href="#msilib.init_database" title="Permalink to this definition">¶</a></dt>

151

<dd>Create and return a new database name, initialize it with schema, and set

152

the properties ProductName, ProductCode, ProductVersion, and

153

Manufacturer.

154

schema must be a module object containing <code class="docutils literal">tables</code> and

155

<code class="docutils literal">_Validation_records</code> attributes; typically, <a class="reference internal" href="#msilib.schema" title="msilib.schema"><code class="xref py py-mod docutils literal">msilib.schema</code></a> should be

156

used.

157

The database will contain just the schema and the validation records when this

158

function returns.

159

</dd></dl>

160

161

162

163

<code class="descclassname">msilib.</code><code class="descname">add_data</code>(database, table, records)<a class="headerlink" href="#msilib.add_data" title="Permalink to this definition">¶</a></dt>

164

<dd>Add all records to the table named table in database.

165

The table argument must be one of the predefined tables in the MSI schema,

166

e.g. <code class="docutils literal">'Feature'</code>, <code class="docutils literal">'File'</code>, <code class="docutils literal">'Component'</code>, <code class="docutils literal">'Dialog'</code>, <code class="docutils literal">'Control'</code>,

167

etc.

168

records should be a list of tuples, each one containing all fields of a

169

record according to the schema of the table. For optional fields,

170

<code class="docutils literal">None</code> can be passed.

171

Field values can be ints, strings, or instances of the Binary class.

172

</dd></dl>

173

174

175

176

class <code class="descclassname">msilib.</code><code class="descname">Binary</code>(filename)<a class="headerlink" href="#msilib.Binary" title="Permalink to this definition">¶</a></dt>

177

<dd>Represents entries in the Binary table; inserting such an object using

178

<a class="reference internal" href="#msilib.add_data" title="msilib.add_data"><code class="xref py py-func docutils literal">add_data()</code></a> reads the file named filename into the table.

179

</dd></dl>

180

181

182

183

<code class="descclassname">msilib.</code><code class="descname">add_tables</code>(database, module)<a class="headerlink" href="#msilib.add_tables" title="Permalink to this definition">¶</a></dt>

184

<dd>Add all table content from module to database. module must contain an

185

attribute tables listing all tables for which content should be added, and one

186

attribute per table that has the actual content.

187

This is typically used to install the sequence tables.

188

</dd></dl>

189

190

191

192

<code class="descclassname">msilib.</code><code class="descname">add_stream</code>(database, name, path)<a class="headerlink" href="#msilib.add_stream" title="Permalink to this definition">¶</a></dt>

193

<dd>Add the file path into the <code class="docutils literal">_Stream</code> table of database, with the stream

194

name name.

195

</dd></dl>

196

197

198

199

<code class="descclassname">msilib.</code><code class="descname">gen_uuid</code>()<a class="headerlink" href="#msilib.gen_uuid" title="Permalink to this definition">¶</a></dt>

200

<dd>Return a new UUID, in the format that MSI typically requires (i.e. in curly

201

braces, and with all hexdigits in upper-case).

202

</dd></dl>

203

204

205

See also

206

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/devnotes/winprog/fcicreate.asp">FCICreateFile</a>

207

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/rpc/rpc/uuidcreate.asp">UuidCreate</a>

208

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/rpc/rpc/uuidtostring.asp">UuidToString</a>

209

</div>

210

211

<h2>34.1.1. Database Objects<a class="headerlink" href="#database-objects" title="Permalink to this headline">¶</a></h2>

212

213

214

<code class="descclassname">Database.</code><code class="descname">OpenView</code>(sql)<a class="headerlink" href="#msilib.Database.OpenView" title="Permalink to this definition">¶</a></dt>

215

<dd>Return a view object, by calling <code class="xref c c-func docutils literal">MSIDatabaseOpenView()</code>. sql is the SQL

216

statement to execute.

217

</dd></dl>

218

219

220

221

<code class="descclassname">Database.</code><code class="descname">Commit</code>()<a class="headerlink" href="#msilib.Database.Commit" title="Permalink to this definition">¶</a></dt>

222

<dd>Commit the changes pending in the current transaction, by calling

223

<code class="xref c c-func docutils literal">MSIDatabaseCommit()</code>.

224

</dd></dl>

225

226

227

228

<code class="descclassname">Database.</code><code class="descname">GetSummaryInformation</code>(count)<a class="headerlink" href="#msilib.Database.GetSummaryInformation" title="Permalink to this definition">¶</a></dt>

229

<dd>Return a new summary information object, by calling

230

<code class="xref c c-func docutils literal">MsiGetSummaryInformation()</code>. count is the maximum number of updated

231

values.

232

</dd></dl>

233

234

235

See also

236

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msidatabaseopenview.asp">MSIDatabaseOpenView</a>

237

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msidatabasecommit.asp">MSIDatabaseCommit</a>

238

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msigetsummaryinformation.asp">MSIGetSummaryInformation</a>

239

</div>

240

</div>

241

242

<h2>34.1.2. View Objects<a class="headerlink" href="#view-objects" title="Permalink to this headline">¶</a></h2>

243

244

245

<code class="descclassname">View.</code><code class="descname">Execute</code>(params)<a class="headerlink" href="#msilib.View.Execute" title="Permalink to this definition">¶</a></dt>

246

<dd>Execute the SQL query of the view, through <code class="xref c c-func docutils literal">MSIViewExecute()</code>. If

247

params is not <code class="docutils literal">None</code>, it is a record describing actual values of the

248

parameter tokens in the query.

249

</dd></dl>

250

251

252

253

<code class="descclassname">View.</code><code class="descname">GetColumnInfo</code>(kind)<a class="headerlink" href="#msilib.View.GetColumnInfo" title="Permalink to this definition">¶</a></dt>

254

<dd>Return a record describing the columns of the view, through calling

255

<code class="xref c c-func docutils literal">MsiViewGetColumnInfo()</code>. kind can be either <code class="docutils literal">MSICOLINFO_NAMES</code> or

256

<code class="docutils literal">MSICOLINFO_TYPES</code>.

257

</dd></dl>

258

259

260

261

<code class="descclassname">View.</code><code class="descname">Fetch</code>()<a class="headerlink" href="#msilib.View.Fetch" title="Permalink to this definition">¶</a></dt>

262

<dd>Return a result record of the query, through calling <code class="xref c c-func docutils literal">MsiViewFetch()</code>.

263

</dd></dl>

264

265

266

267

<code class="descclassname">View.</code><code class="descname">Modify</code>(kind, data)<a class="headerlink" href="#msilib.View.Modify" title="Permalink to this definition">¶</a></dt>

268

<dd>Modify the view, by calling <code class="xref c c-func docutils literal">MsiViewModify()</code>. kind can be one of

269

<code class="docutils literal">MSIMODIFY_SEEK</code>, <code class="docutils literal">MSIMODIFY_REFRESH</code>, <code class="docutils literal">MSIMODIFY_INSERT</code>,

270

<code class="docutils literal">MSIMODIFY_UPDATE</code>, <code class="docutils literal">MSIMODIFY_ASSIGN</code>, <code class="docutils literal">MSIMODIFY_REPLACE</code>,

271

<code class="docutils literal">MSIMODIFY_MERGE</code>, <code class="docutils literal">MSIMODIFY_DELETE</code>, <code class="docutils literal">MSIMODIFY_INSERT_TEMPORARY</code>,

272

<code class="docutils literal">MSIMODIFY_VALIDATE</code>, <code class="docutils literal">MSIMODIFY_VALIDATE_NEW</code>,

273

<code class="docutils literal">MSIMODIFY_VALIDATE_FIELD</code>, or <code class="docutils literal">MSIMODIFY_VALIDATE_DELETE</code>.

274

data must be a record describing the new data.

275

</dd></dl>

276

277

278

279

<code class="descclassname">View.</code><code class="descname">Close</code>()<a class="headerlink" href="#msilib.View.Close" title="Permalink to this definition">¶</a></dt>

280

<dd>Close the view, through <code class="xref c c-func docutils literal">MsiViewClose()</code>.

281

</dd></dl>

282

283

284

See also

285

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a>

286

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewgetcolumninfo.asp">MSIViewGetColumnInfo</a>

287

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a>

288

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a>

289

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewclose.asp">MsiViewClose</a>

290

</div>

291

</div>

292

293

<h2>34.1.3. Summary Information Objects<a class="headerlink" href="#summary-information-objects" title="Permalink to this headline">¶</a></h2>

294

295

296

<code class="descclassname">SummaryInformation.</code><code class="descname">GetProperty</code>(field)<a class="headerlink" href="#msilib.SummaryInformation.GetProperty" title="Permalink to this definition">¶</a></dt>

297

<dd>Return a property of the summary, through <code class="xref c c-func docutils literal">MsiSummaryInfoGetProperty()</code>.

298

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

299

<code class="docutils literal">PID_CODEPAGE</code>, <code class="docutils literal">PID_TITLE</code>, <code class="docutils literal">PID_SUBJECT</code>, <code class="docutils literal">PID_AUTHOR</code>,

300

<code class="docutils literal">PID_KEYWORDS</code>, <code class="docutils literal">PID_COMMENTS</code>, <code class="docutils literal">PID_TEMPLATE</code>, <code class="docutils literal">PID_LASTAUTHOR</code>,

301

<code class="docutils literal">PID_REVNUMBER</code>, <code class="docutils literal">PID_LASTPRINTED</code>, <code class="docutils literal">PID_CREATE_DTM</code>,

302

<code class="docutils literal">PID_LASTSAVE_DTM</code>, <code class="docutils literal">PID_PAGECOUNT</code>, <code class="docutils literal">PID_WORDCOUNT</code>, <code class="docutils literal">PID_CHARCOUNT</code>,

303

<code class="docutils literal">PID_APPNAME</code>, or <code class="docutils literal">PID_SECURITY</code>.

304

</dd></dl>

305

306

307

308

<code class="descclassname">SummaryInformation.</code><code class="descname">GetPropertyCount</code>()<a class="headerlink" href="#msilib.SummaryInformation.GetPropertyCount" title="Permalink to this definition">¶</a></dt>

309

<dd>Return the number of summary properties, through

310

<code class="xref c c-func docutils literal">MsiSummaryInfoGetPropertyCount()</code>.

311

</dd></dl>

312

313

314

315

<code class="descclassname">SummaryInformation.</code><code class="descname">SetProperty</code>(field, value)<a class="headerlink" href="#msilib.SummaryInformation.SetProperty" title="Permalink to this definition">¶</a></dt>

316

<dd>Set a property through <code class="xref c c-func docutils literal">MsiSummaryInfoSetProperty()</code>. field can have the

317

same values as in <a class="reference internal" href="#msilib.SummaryInformation.GetProperty" title="msilib.SummaryInformation.GetProperty"><code class="xref py py-meth docutils literal">GetProperty()</code></a>, value is the new value of the property.

318

Possible value types are integer and string.

319

</dd></dl>

320

321

322

323

<code class="descclassname">SummaryInformation.</code><code class="descname">Persist</code>()<a class="headerlink" href="#msilib.SummaryInformation.Persist" title="Permalink to this definition">¶</a></dt>

324

<dd>Write the modified properties to the summary information stream, using

325

<code class="xref c c-func docutils literal">MsiSummaryInfoPersist()</code>.

326

</dd></dl>

327

328

329

See also

330

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a>

331

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfogetpropertycount.asp">MsiSummaryInfoGetPropertyCount</a>

332

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a>

333

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfopersist.asp">MsiSummaryInfoPersist</a>

334

</div>

335

</div>

336

337

<h2>34.1.4. Record Objects<a class="headerlink" href="#record-objects" title="Permalink to this headline">¶</a></h2>

338

339

340

<code class="descclassname">Record.</code><code class="descname">GetFieldCount</code>()<a class="headerlink" href="#msilib.Record.GetFieldCount" title="Permalink to this definition">¶</a></dt>

341

<dd>Return the number of fields of the record, through

342

<code class="xref c c-func docutils literal">MsiRecordGetFieldCount()</code>.

343

</dd></dl>

344

345

346

347

<code class="descclassname">Record.</code><code class="descname">GetInteger</code>(field)<a class="headerlink" href="#msilib.Record.GetInteger" title="Permalink to this definition">¶</a></dt>

348

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

349

be an integer.

350

</dd></dl>

351

352

353

354

<code class="descclassname">Record.</code><code class="descname">GetString</code>(field)<a class="headerlink" href="#msilib.Record.GetString" title="Permalink to this definition">¶</a></dt>

355

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

356

be an integer.

357

</dd></dl>

358

359

360

361

<code class="descclassname">Record.</code><code class="descname">SetString</code>(field, value)<a class="headerlink" href="#msilib.Record.SetString" title="Permalink to this definition">¶</a></dt>

362

<dd>Set field to value through <code class="xref c c-func docutils literal">MsiRecordSetString()</code>. field must be an

363

integer; value a string.

364

</dd></dl>

365

366

367

368

<code class="descclassname">Record.</code><code class="descname">SetStream</code>(field, value)<a class="headerlink" href="#msilib.Record.SetStream" title="Permalink to this definition">¶</a></dt>

369

<dd>Set field to the contents of the file named value, through

370

<code class="xref c c-func docutils literal">MsiRecordSetStream()</code>. field must be an integer; value a string.

371

</dd></dl>

372

373

374

375

<code class="descclassname">Record.</code><code class="descname">SetInteger</code>(field, value)<a class="headerlink" href="#msilib.Record.SetInteger" title="Permalink to this definition">¶</a></dt>

376

<dd>Set field to value through <code class="xref c c-func docutils literal">MsiRecordSetInteger()</code>. Both field and

377

value must be an integer.

378

</dd></dl>

379

380

381

382

<code class="descclassname">Record.</code><code class="descname">ClearData</code>()<a class="headerlink" href="#msilib.Record.ClearData" title="Permalink to this definition">¶</a></dt>

383

<dd>Set all fields of the record to 0, through <code class="xref c c-func docutils literal">MsiRecordClearData()</code>.

384

</dd></dl>

385

386

387

See also

388

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordgetfieldcount.asp">MsiRecordGetFieldCount</a>

389

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordsetstring.asp">MsiRecordSetString</a>

390

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordsetstream.asp">MsiRecordSetStream</a>

391

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordsetinteger.asp">MsiRecordSetInteger</a>

392

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordclear.asp">MsiRecordClear</a>

393

</div>

394

</div>

395

396

<h2>34.1.5. Errors<a class="headerlink" href="#errors" title="Permalink to this headline">¶</a></h2>

397

All wrappers around MSI functions raise <code class="xref py py-exc docutils literal">MsiError</code>; the string inside the

398

exception will contain more detail.

399

</div>

400

401

<h2>34.1.6. CAB Objects<a class="headerlink" href="#cab-objects" title="Permalink to this headline">¶</a></h2>

402

403

404

class <code class="descclassname">msilib.</code><code class="descname">CAB</code>(name)<a class="headerlink" href="#msilib.CAB" title="Permalink to this definition">¶</a></dt>

405

<dd>The class <a class="reference internal" href="#msilib.CAB" title="msilib.CAB"><code class="xref py py-class docutils literal">CAB</code></a> represents a CAB file. During MSI construction, files

406

will be added simultaneously to the <code class="docutils literal">Files</code> table, and to a CAB file. Then,

407

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

408

MSI file.

409

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

410

411

412

<code class="descname">append</code>(full, file, logical)<a class="headerlink" href="#msilib.CAB.append" title="Permalink to this definition">¶</a></dt>

413

<dd>Add the file with the pathname full to the CAB file, under the name

414

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

415

created.

416

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

417

inside the CAB file.

418

</dd></dl>

419

420

421

422

<code class="descname">commit</code>(database)<a class="headerlink" href="#msilib.CAB.commit" title="Permalink to this definition">¶</a></dt>

423

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

424

<code class="docutils literal">Media</code> table, and remove the generated file from the disk.

425

</dd></dl>

426

427

</dd></dl>

428

429

</div>

430

431

<h2>34.1.7. Directory Objects<a class="headerlink" href="#directory-objects" title="Permalink to this headline">¶</a></h2>

432

433

434

class <code class="descclassname">msilib.</code><code class="descname">Directory</code>(database, cab, basedir, physical, logical, default[, componentflags])<a class="headerlink" href="#msilib.Directory" title="Permalink to this definition">¶</a></dt>

435

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

436

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

437

<a class="reference internal" href="#msilib.Directory.start_component" title="msilib.Directory.start_component"><code class="xref py py-meth docutils literal">start_component()</code></a>, or implicitly when files are added for the first time.

438

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

439

directory, a base directory object needs to be specified (can be <code class="docutils literal">None</code>), the

440

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

441

specifies the DefaultDir slot in the directory table. componentflags specifies

442

the default flags that new components get.

443

444

445

<code class="descname">start_component</code>(component=None, feature=None, flags=None, keyfile=None, uuid=None)<a class="headerlink" href="#msilib.Directory.start_component" title="Permalink to this definition">¶</a></dt>

446

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

447

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

448

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

449

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

450

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

451

</dd></dl>

452

453

454

455

<code class="descname">add_file</code>(file, src=None, version=None, language=None)<a class="headerlink" href="#msilib.Directory.add_file" title="Permalink to this definition">¶</a></dt>

456

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

457

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

458

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

459

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

460

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

461

</dd></dl>

462

463

464

465

<code class="descname">glob</code>(pattern, exclude=None)<a class="headerlink" href="#msilib.Directory.glob" title="Permalink to this definition">¶</a></dt>

466

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

467

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

468

</dd></dl>

469

470

471

472

<code class="descname">remove_pyc</code>()<a class="headerlink" href="#msilib.Directory.remove_pyc" title="Permalink to this definition">¶</a></dt>

473

<dd>Remove <code class="docutils literal">.pyc</code>/<code class="docutils literal">.pyo</code> files on uninstall.

474

</dd></dl>

475

476

</dd></dl>

477

478

479

See also

480

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/directory_table.asp">Directory Table</a>

481

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/file_table.asp">File Table</a>

482

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/component_table.asp">Component Table</a>

483

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/featurecomponents_table.asp">FeatureComponents Table</a>

484

</div>

485

</div>

486

487

<h2>34.1.8. Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>

488

489

490

class <code class="descclassname">msilib.</code><code class="descname">Feature</code>(db, id, title, desc, display, level=1, parent=None, directory=None, attributes=0)<a class="headerlink" href="#msilib.Feature" title="Permalink to this definition">¶</a></dt>

491

<dd>Add a new record to the <code class="docutils literal">Feature</code> table, using the values id, parent.id,

492

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

493

resulting feature object can be passed to the <code class="xref py py-meth docutils literal">start_component()</code> method of

494

<a class="reference internal" href="#msilib.Directory" title="msilib.Directory"><code class="xref py py-class docutils literal">Directory</code></a>.

495

496

497

<code class="descname">set_current</code>()<a class="headerlink" href="#msilib.Feature.set_current" title="Permalink to this definition">¶</a></dt>

498

<dd>Make this feature the current feature of <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal">msilib</code></a>. New components are

499

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

500

specified.

501

</dd></dl>

502

503

</dd></dl>

504

505

506

See also

507

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/feature_table.asp">Feature Table</a>

508

</div>

509

</div>

510

511

<h2>34.1.9. GUI classes<a class="headerlink" href="#gui-classes" title="Permalink to this headline">¶</a></h2>

512

<a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal">msilib</code></a> provides several classes that wrap the GUI tables in an MSI

513

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

514

<a class="reference internal" href="../distutils/apiref.html#module-distutils.command.bdist_msi" title="distutils.command.bdist_msi: Build a binary distribution as a Windows MSI file"><code class="xref py py-mod docutils literal">bdist_msi</code></a> to create MSI files with a user-interface

515

for installing Python packages.

516

517

518

class <code class="descclassname">msilib.</code><code class="descname">Control</code>(dlg, name)<a class="headerlink" href="#msilib.Control" title="Permalink to this definition">¶</a></dt>

519

<dd>Base class of the dialog controls. dlg is the dialog object the control

520

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

521

522

523

<code class="descname">event</code>(event, argument, condition=1, ordering=None)<a class="headerlink" href="#msilib.Control.event" title="Permalink to this definition">¶</a></dt>

524

<dd>Make an entry into the <code class="docutils literal">ControlEvent</code> table for this control.

525

</dd></dl>

526

527

528

529

<code class="descname">mapping</code>(event, attribute)<a class="headerlink" href="#msilib.Control.mapping" title="Permalink to this definition">¶</a></dt>

530

<dd>Make an entry into the <code class="docutils literal">EventMapping</code> table for this control.

531

</dd></dl>

532

533

534

535

<code class="descname">condition</code>(action, condition)<a class="headerlink" href="#msilib.Control.condition" title="Permalink to this definition">¶</a></dt>

536

<dd>Make an entry into the <code class="docutils literal">ControlCondition</code> table for this control.

537

</dd></dl>

538

539

</dd></dl>

540

541

542

543

class <code class="descclassname">msilib.</code><code class="descname">RadioButtonGroup</code>(dlg, name, property)<a class="headerlink" href="#msilib.RadioButtonGroup" title="Permalink to this definition">¶</a></dt>

544

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

545

that gets set when a radio button is selected.

546

547

548

<code class="descname">add</code>(name, x, y, width, height, text, value=None)<a class="headerlink" href="#msilib.RadioButtonGroup.add" title="Permalink to this definition">¶</a></dt>

549

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

550

width, height, and with the label text. If value is <code class="docutils literal">None</code>, it

551

defaults to name.

552

</dd></dl>

553

554

</dd></dl>

555

556

557

558

class <code class="descclassname">msilib.</code><code class="descname">Dialog</code>(db, name, x, y, w, h, attr, title, first, default, cancel)<a class="headerlink" href="#msilib.Dialog" title="Permalink to this definition">¶</a></dt>

559

<dd>Return a new <a class="reference internal" href="#msilib.Dialog" title="msilib.Dialog"><code class="xref py py-class docutils literal">Dialog</code></a> object. An entry in the <code class="docutils literal">Dialog</code> table is made,

560

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

561

default, and cancel controls.

562

563

564

<code class="descname">control</code>(name, type, x, y, width, height, attributes, property, text, control_next, help)<a class="headerlink" href="#msilib.Dialog.control" title="Permalink to this definition">¶</a></dt>

565

<dd>Return a new <a class="reference internal" href="#msilib.Control" title="msilib.Control"><code class="xref py py-class docutils literal">Control</code></a> object. An entry in the <code class="docutils literal">Control</code> table is

566

made with the specified parameters.

567

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

568

provided.

569

</dd></dl>

570

571

572

573

<code class="descname">text</code>(name, x, y, width, height, attributes, text)<a class="headerlink" href="#msilib.Dialog.text" title="Permalink to this definition">¶</a></dt>

574

<dd>Add and return a <code class="docutils literal">Text</code> control.

575

</dd></dl>

576

577

578

579

<code class="descname">bitmap</code>(name, x, y, width, height, text)<a class="headerlink" href="#msilib.Dialog.bitmap" title="Permalink to this definition">¶</a></dt>

580

<dd>Add and return a <code class="docutils literal">Bitmap</code> control.

581

</dd></dl>

582

583

584

585

<code class="descname">line</code>(name, x, y, width, height)<a class="headerlink" href="#msilib.Dialog.line" title="Permalink to this definition">¶</a></dt>

586

<dd>Add and return a <code class="docutils literal">Line</code> control.

587

</dd></dl>

588

589

590

591

<code class="descname">pushbutton</code>(name, x, y, width, height, attributes, text, next_control)<a class="headerlink" href="#msilib.Dialog.pushbutton" title="Permalink to this definition">¶</a></dt>

592

<dd>Add and return a <code class="docutils literal">PushButton</code> control.

593

</dd></dl>

594

595

596

597

<code class="descname">radiogroup</code>(name, x, y, width, height, attributes, property, text, next_control)<a class="headerlink" href="#msilib.Dialog.radiogroup" title="Permalink to this definition">¶</a></dt>

598

<dd>Add and return a <code class="docutils literal">RadioButtonGroup</code> control.

599

</dd></dl>

600

601

602

603

<code class="descname">checkbox</code>(name, x, y, width, height, attributes, property, text, next_control)<a class="headerlink" href="#msilib.Dialog.checkbox" title="Permalink to this definition">¶</a></dt>

604

<dd>Add and return a <code class="docutils literal">CheckBox</code> control.

605

</dd></dl>

606

607

</dd></dl>

608

609

610

See also

611

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/dialog_table.asp">Dialog Table</a>

612

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/control_table.asp">Control Table</a>

613

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/controls.asp">Control Types</a>

614

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/controlcondition_table.asp">ControlCondition Table</a>

615

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/controlevent_table.asp">ControlEvent Table</a>

616

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/eventmapping_table.asp">EventMapping Table</a>

617

<a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/radiobutton_table.asp">RadioButton Table</a>

618

</div>

619

</div>

620

621

<h2>34.1.10. Precomputed tables<a class="headerlink" href="#precomputed-tables" title="Permalink to this headline">¶</a></h2>

622

623

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

624

625

626

<code class="descclassname">msilib.</code><code class="descname">schema</code><a class="headerlink" href="#msilib.schema" title="Permalink to this definition">¶</a></dt>

627

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

628

providing a list of table definitions, and _Validation_records providing the

629

data for MSI validation.

630

</dd></dl>

631

632

633

634

<code class="descclassname">msilib.</code><code class="descname">sequence</code><a class="headerlink" href="#msilib.sequence" title="Permalink to this definition">¶</a></dt>

635

<dd>This module contains table contents for the standard sequence tables:

636

AdminExecuteSequence, AdminUISequence, AdvtExecuteSequence,

637

InstallExecuteSequence, and InstallUISequence.

638

</dd></dl>

639

640

641

642

<code class="descclassname">msilib.</code><code class="descname">text</code><a class="headerlink" href="#msilib.text" title="Permalink to this definition">¶</a></dt>

643

<dd>This module contains definitions for the UIText and ActionText tables, for the

644

standard installer actions.

645

</dd></dl>

646

647

</div>

648

</div>

649

650

651

</div>

652

</div>

653

</div>

654

655

656

<h3><a href="../contents.html">Table Of Contents</a></h3>

657

<ul>

658

<li><a class="reference internal" href="#">34.1. <code class="docutils literal">msilib</code> — Read and write Microsoft Installer files</a><ul>

659

<li><a class="reference internal" href="#database-objects">34.1.1. Database Objects</a></li>

660

<li><a class="reference internal" href="#view-objects">34.1.2. View Objects</a></li>

661

<li><a class="reference internal" href="#summary-information-objects">34.1.3. Summary Information Objects</a></li>

662

<li><a class="reference internal" href="#record-objects">34.1.4. Record Objects</a></li>

663

<li><a class="reference internal" href="#errors">34.1.5. Errors</a></li>

664

<li><a class="reference internal" href="#cab-objects">34.1.6. CAB Objects</a></li>

665

<li><a class="reference internal" href="#directory-objects">34.1.7. Directory Objects</a></li>

666

<li><a class="reference internal" href="#features">34.1.8. Features</a></li>

667

<li><a class="reference internal" href="#gui-classes">34.1.9. GUI classes</a></li>

668

<li><a class="reference internal" href="#precomputed-tables">34.1.10. Precomputed tables</a></li>

669

</ul>

670

</li>

671

</ul>

672

673

<h4>Previous topic</h4>

674

<a href="windows.html"

675

title="previous chapter">34. MS Windows Specific Services</a>

676

<h4>Next topic</h4>

677

<a href="msvcrt.html"

678

title="next chapter">34.2. <code class="docutils literal">msvcrt</code> – Useful routines from the MS VC++ runtime</a>

679

680

681

682

<li><a href="../bugs.html">Report a Bug</a></li>

683

<li><a href="../_sources/library/msilib.txt"

684

rel="nofollow">Show Source</a></li>

685

</ul>

686

</div>

687

</div>

688

</div>

689

690

</div>

691

692

<h3>Navigation</h3>

693

<ul>

694

695

<a href="../genindex.html" title="General Index"

696

>index</a></li>

697

698

<a href="../py-modindex.html" title="Python Module Index"

699

>modules</a> |</li>

700

701

<a href="msvcrt.html" title="34.2. msvcrt – Useful routines from the MS VC++ runtime"

702

>next</a> |</li>

703

704

<a href="windows.html" title="34. MS Windows Specific Services"

705

>previous</a> |</li>

706

<li><img src="../_static/py.png" alt=""

707

style="vertical-align: middle; margin-top: -1px"/></li>

708

<li><a href="https://www.python.org/">Python</a> »</li>

709

<li>

710

3.5.2

711

<a href="../index.html">Documentation </a> »

712

</li>

713

714

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>

715

<li class="nav-item nav-item-2"><a href="windows.html" >34. MS Windows Specific Services</a> »</li>

716

717

718

719

720

721

722

723

724

725

</form>

726

</div>

727

728

729

</li>

730

731

</ul>

732

</div>

733

734

735

736

The Python Software Foundation is a non-profit corporation.

737

<a href="https://www.python.org/psf/donations/">Please donate.</a>

738

739

Last updated on Sep 23, 2016.

740

<a href="../bugs.html">Found a bug</a>?

741

742

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.

743

</div>

744

745

</body>

746

</html>

b'\\ No newline at end of file'

Older »