Helper enums for
sphobjinv is a toolkit for manipulation and inspection of
Sphinx objects.inv files.
Brian Skinn (email@example.com)
- File Created
4 May 2019
(c) Brian Skinn 2016-2020
- Source Repository
The MIT License; see LICENSE.txt for full license terms
Enumfor various inventory-level data items.
Number of objects contained in the inventory
strvalue of this
Enummember is accepted as a root-level key in a
dictto be imported into an
Inventory. The corresponding value in the
dictmay contain any arbitrary data. Its possible presence is accounted for in
The data associated with this key are ignored during import into an
Project name associated with an inventory
Project version associated with an inventory
Enumkeys iterate in definition order, the definition order here defines the order in which
Inventoryobjects attempt to parse a source object passed to
Inventory.__init__()either as a positional argument or via the generic source keyword argument.
This order DIFFERS from the documentation order, which is alphabetical.
Instantiation from a plaintext objects.inv file on disk.
Instantiation from a zlib-compressed objects.inv file on disk.
Instantiation from a zlib-compressed objects.inv file downloaded from a URL.