Class NamespaceContext

str(x)

Overrides: object.__str__

(inherited documentation)

Make ctx the currently active namespace context.

Prior contexts are retained on a LIFO stack.

Access the currently active namespace context.

If no context is active, None is returned. This probably represents mis-use of the infrastructure (viz., failure to record the context within which a QName must be resolved).

Discard the currently active namespace context, restoring its predecessor.

The discarded context is returned.

The default namespace in effect at this node. E.g., xmlns="URN:default".

Set the default namespace for the generated document.

Even if invoked post construction, the default namespace will affect the entire document, as all namespace declarations are placed in the document root.

Parameters:

• default_namespace (pyxb.namespace.Namespace or str or unicode.) - The namespace to be defined as the default namespace in the top-level element of the document. May be provided as a real namespace, or just its URI.

The target namespace in effect at this node. Usually from the targetNamespace attribute. If no namespace is specified for the schema, an absent namespace was assigned upon creation and will be returned.

Map from prefix strings to Namespace instances associated with those prefixes. The prefix None identifies the default namespace.

Get the NamespaceContext instance that was assigned to the node.

If none has been assigned and keyword parameters are present, create one treating this as the root node and the keyword parameters as configuration information (e.g., default_namespace).

Raises:

• pyxb.LogicError - no context is available and the keywords required to create one were not provided

Record the given namespace as one to be used in this document.

Parameters:

• namespace (pyxb.namespace.Namespace) - The namespace to be associated with the document.
• prefix - Optional prefix to be used with this namespace. If not provided, a unique prefix is generated or a standard prefix is used, depending on the namespace.

Returns:

a prefix that may be used with the namespace. If prefix was None the return value may be a previously-assigned prefix.

Reset this instance to the state it was when created, exclusive of XMLNS directives passed in a constructor dom_node parameter.

This preserves parent context and constructor-specified prefix maps, but clears the namespace-prefix mapping of any additions made while processing namespace directives in DOM nodes, or manually added post-construction.

The defaultNamespace is also retained.

Determine the namespace context that should be associated with the given node and, optionally, its element children.

Primarily this class maintains a map between namespaces and prefixes used in QName instances. The initial map comprises the bound prefixes (xml and xmlns), prefixes inherited from parent_context, and prefixes passed through the in_scope_namespaces parameter to the constructor. This map is then augmented by any namespace declarations present in a passed dom_node. The initial map prior to augmentation may be restored through the reset() method.

Parameters:

• dom_node (xml.dom.Element) - The DOM node
• parent_context (NamespaceContext) - Optional value that specifies the context associated with dom_node's parent node. If not provided, only the xml namespace is in scope.
• recurse (bool) - If True (default), create namespace contexts for all element children of dom_node
• default_namespace (NamespaceContext) - Optional value to set as the default namespace. Values from parent_context would override this, as would an xmlns attribute in the dom_node.
• target_namespace (NamespaceContext) - Optional value to set as the target namespace. Values from parent_context would override this, as would a targetNamespace attribute in the dom_node
• in_scope_namespaces (dict mapping prefix string to Namespace.) - Optional value to set as the initial set of in-scope namespaces. The always-present namespaces are added to this if necessary.

Overrides: object.__init__

Convert the provided name into an ExpandedName, i.e. a tuple of Namespace and local name.

If the name includes a prefix, that prefix must map to an in-scope namespace in this context. Absence of a prefix maps to defaultNamespace(), which must be provided (or defaults to the target namespace, if that is not absent).

Parameters:

• name (str or unicode) - A QName.
• name (str or unicode) - Optional namespace to use for unqualified names when there is no default namespace. Note that a defined default namespace, even if absent, supersedes this value.
• default_no_namespace - If False (default), an NCName in a context where namespace is None and no default or fallback namespace can be identified produces an exception. If True, such an NCName is implicitly placed in no namespace.

Returns:

An ExpandedName tuple: ( Namespace, str )

Raises:

• pyxb.QNameResolutionError - The prefix is not in scope
• pyxb.QNameResolutionError - No prefix is given and the default namespace is absent