Class Generator

Optional string that is stripped from the beginning of schemaLocation values before loading from them.

This applies only to the values of schemaLocation attributes in import and include elements. Its purpose is to convert absolute schema locations into relative ones to allow offline processing when all schema are available in a local directory. See schemaRoot.

Optional map to rewrite schema locations.

This applies only to the values of schemaLocation attributes in import and include elements. Its purpose is to convert remote or absolute schema locations into local or relative ones to allow offline processing when all schema are available in a local directory. See schemaRoot.

Add a rewrite entry for schema locations.

Parameters:

• prefix - A text prefix that should be removed from schema location URIs.
• substituent - The text prefix that should replace prefix as a prefix in a schema location URI.

Add a rewrite entry for schema locations.

Parameter values are strings of the form pfx=sub. The effect is that a schema location that begins with pfx is rewritten so that it instead begins with sub.

A list of locations from which entrypoint schemas are to be read.

The values in the list are either URIs, or tuples consisting of a value and a callable which, when passed the generator object and the value, will return a pyxb.xmlschema.structures.Schema instance. See addSchemaLocation.

See also addSchemaLocation and schemas.

Add the location of an entrypoint schema.

Parameters:

• schema_location - The location of the schema. This should be a URL; if the schema location does not have a URL scheme (e.g., http:), it is assumed to be a file, and if it is not an absolute path is located relative to the schemaRoot.
• converter - Optional callable that will be invoked with the generator instance and the schema location, and is expected to return a pyxb.xmlschema.structures.Schema instance. If absent, the contents of the location are converted directly.

Add the location of an entrypoint schema. The provided value should be a URL; if it does not have a URL scheme (e.g., http:), it is assumed to be a file, and if it is not an absolute path is located relative to the schemaRoot.

Schema for which bindings should be generated.

These may be Schema instances, or strings; the latter is preferred, and is parsed into a Schema instance when required.

This is the list of entrypoint schemas for binding generation. Values in schemaLocationList are read and converted into schema, then appended to this list. Values from moduleList are applied starting with the first schema in this list.

The set of namespaces for which bindings will be generated.

This is the set of namespaces read from entrypoint schema, closed under reference to namespaces defined by schema import.

Returns: set

Add a module name corresponding to an entrypoint schema.

The namespace defined by the corresponding schema will be written to a binding using the given module name, adjusted by modulePrefix.

The prefix for binding modules.

The base name for the module holding a binding is taken from the moduleList, moduleMap, or an XMLNS prefix associated with the namespace in a containing schema. This value, if present, is used as a prefix to allow a deeper module hierarchy.

A map from namespace URIs to the module to be used for the corresponding generated binding.

Module values are adjusted by modulePrefix if that has been specified.

An entry in this map for a namespace supersedes the module specified in moduleList if the namespace is defined by an entrypoint schema.

Returns:

A reference to the namespace module map.

A colon-separated list of paths from which namespace archives can be read.

The default path is the contents of the PYXB_ARCHIVE_PATH environment variable, or the standard path configured at installation time. Any file with the extension .wxs found in one of these directories is examined to see whether it is a namespace archive.

Mark that the specified namespace should not be loaded from an archive.

Use this when you are generating bindings for an application that has a restricted profile of a namespace that would otherwise be read from an archive. Be aware that this removes any knowledge of any archive in which this namespace is present as a non-private member.

Name of a file containing a stored archive from which namespaces should be read prior to processing schema.

Files to be pre-loaded are not affected by noLoadNamespace.

Optional file into which the archive of namespaces will be written.

Subsequent generation actions can read pre-parsed namespaces from this file, and therefore reference the bindings that were built earlier rather than re-generating them.

The file name should normally end with .wxs.

Indicates whether unmentioned namespaces will be public or private (default) in the archive.

A namespace is mentioned if it is the target namespace of an entrypoint schema, or appears in a namespace visibility specification. I.e., this default applies only to namespaces that are modified as a result of including some schema, which is generally a local customization of something.

Indicates whether the binding Python code should be written into a sub-module for customization.

If enabled, a module path.to.namespace will be written to the file path/to/raw/namespace.py, so that the file path/to/namespace.py can import it and override behavior.

Indicates whether the code generator is permitted to process namespace for which no module path can be determined.

Use this only when generating bindings that will not be referenced by other bindings.

Indicates whether bindings will be written for namespaces that are built-in to PyXB.

This must be enabled when building bindings for the XML, XMLSchema instance, and other built-in namespaces. Normally generation of these namespaces is inhibited lest it produce inconsistencies.

The directory path into which any content retrieved by URI will be written.

This serves as a local cache, and to give you an opportunity to inspect material retrieved from some other system.

Returns: str

A file provided to logging.config.fileConfig to control log messages.

In the absence of other configuration the Python standard logging infrastructure is used in its default configuration.

Returns: str

Create a configuration to be used for generating bindings.

Arguments are treated as additions to the schema location list after all keywords have been processed.

Parameters:

• binding_root - Invokes setBindingRoot
• schema_root - Invokes setSchemaRoot
• schema_stripped_prefix - Invokes setSchemaStrippedPrefix
• location_prefix_rewrite_map - Invokes setLocationPrefixRewriteMap
• schema_location_list - Invokes setSchemaLocationList
• module_list - Invokes _setModuleList
• module_prefix - Invokes setModulePrefix
• archive_path - Invokes setArchivePath
• no_load_namespaces - Invokes _setNoLoadNamespaces
• pre_load_archives - Invokes _setPreLoadArchives
• archive_to_file - Invokes setArchiveToFile
• public_namespace - Invokes setNamespaceVisibility
• private_namespace - Invokes setNamespaceVisibility
• default_namespace_public - Invokes setDefaultNamespacePublic
• validate_changes - Invokes setValidateChanges
• namespace_module_map - Initializes namespaceModuleMap
• schemas - Invokes setSchemas
• namespaces - Invokes setNamespaces
• write_for_customization - Invokes setWriteForCustomization
• allow_builtin_generation - Invokes setAllowBuiltinGeneration
• allow_absent_module - Invokes setAllowAbsentModule
• generate_to_files - Sets generateToFiles
• uri_content_archive_directory - Invokes setUriContentArchiveDirectory
• logging_config_file - Invokes setLoggingConfigFile

Overrides: object.__init__

A unique identifier associated with this Generator instance.

This is an instance of pyxb.utils.utility.UniqueIdentifier. Its associated objects are pyxb.namespace.archive._SchemaOrigin instances, which identify schema that contribute to the definition of a namespace.

Return an optparse.OptionParser instance tied to this configuration.

Parameters:

• reset (bool) - If False (default), a parser created in a previous invocation will be returned. If True, any previous option parser is discarded and a new one created.

Return a command line option sequence that could be used to construct an equivalent configuration.

Provide a Python module path for the module record.

This is the path by which the module bindings associated with module_record will be imported.

If a path had already been assigned to the module, it is left in place.

Parameters:

• module_record (pyxb.namespace.archive.ModuleRecord) - Information about a collection of related bindings
• module_path (str) - Default path to use

Returns:

module_record

The set of pyxb.namespace.archive.ModuleRecord instances associated with schema processed in this generation instance.

These should be in one-to-one correspondence with the namespaces for which bindings are being generated. Multiple input schemas may contribute to a single module record; all material in that record is placed in a single binding file.