pyxb.namespace.archive

Module archive

Classes and global objects related to archiving XML Namespaces.

Classes

[hide private]

NamespaceArchive
Represent a file from which one or more namespaces can be read, or to which they will be written.

_ArchivableObject_mixin
Mix-in to any object that can be stored in a namespace within an archive.

_NamespaceArchivable_mixin
Encapsulate the operations and data relevant to archiving namespaces.

ModuleRecord

_ObjectOrigin
Marker class for objects that can serve as an origin for an object in a namespace.

_SchemaOrigin
Holds the data regarding components derived from a single schema.

NamespaceDependencies

Functions

[hide private]

GetArchivePath()
Return the archive path as defined by the PathEnvironmentVariable, or None if that variable is not defined. source code

AvailableForLoad()
Return a list of namespace URIs for which we may be able to load the namespace contents from a pre-parsed file.

source code

Variables

[hide private]

PathEnvironmentVariable = 'PYXB_ARCHIVE_PATH'
Environment variable from which default path to pre-loaded namespaces is read.

DefaultArchivePrefix = '/pyxb/PyXB-1.1.3'
The default archive prefix, substituted for & in PYXB_ARCHIVE_PATH.

__package__ = 'pyxb.namespace'

Function Details

[hide private]

AvailableForLoad()

source code

Return a list of namespace URIs for which we may be able to load the namespace contents from a pre-parsed file. The corresponding Namespace can be retrieved using NamespaceForURI, and the declared objects in that namespace loaded with Namespace.validateComponentModel.

Note that success of the load is not guaranteed if the packed file is not compatible with the schema class being used.

Variables Details

[hide private]

PathEnvironmentVariable

Environment variable from which default path to pre-loaded namespaces is read. The value should be a colon-separated list of absolute paths. The character & at the start of a member of the list is replaced by the path to the directory where the %{pyxb} modules are found, including a trailing /. For example, use &pyxb/bundles// to enable search of any archive bundled with PyXB.

Note: If you put a path separater between & and the following path, this will cause the substitution to be ignored.

Value:

'PYXB_ARCHIVE_PATH'