xsdata.codegen.handlers package

Submodules

• xsdata.codegen.handlers.attribute_enum_union module
• xsdata.codegen.handlers.attribute_group module
• xsdata.codegen.handlers.attribute_implied module
• xsdata.codegen.handlers.attribute_merge module
• xsdata.codegen.handlers.attribute_mismatch module
• xsdata.codegen.handlers.attribute_substitution module
• xsdata.codegen.handlers.attribute_type module
• xsdata.codegen.handlers.class_extension module

Module contents

class xsdata.codegen.handlers.AttributeGroupHandler(container)

Bases: xsdata.codegen.mixins.HandlerInterface

Replace attribute groups with the source class attributes.

Parameters

container (ContainerInterface) –

container: ContainerInterface

process(target)

Iterate over all group attributes and apply handler logic.

Group attributes can refer to attributes or other group attributes, repeat until there is no group attribute left.

Parameters

target (Class) –

process_attribute(target, attr)

Find the source class the attribute refers to and copy its attributes to the target class.

Raises

AnalyzerValueError – if source class is not found.

Parameters

• target (Class) –

• attr (Attr) –

class xsdata.codegen.handlers.AttributeTypeHandler(container, dependencies=<factory>)

Bases: xsdata.codegen.mixins.HandlerInterface

Minimize class attributes complexity by filtering and flattening types.

Parameters

• container (ContainerInterface) –

• dependencies (Dict) –

container: ContainerInterface

dependencies: Dict

process(target)

Process the given class attributes and their types.

Ensure all types are unique.

Parameters

target (Class) –

process_type(target, attr, attr_type)

Process attribute type, split process for xml schema and user defined types.

Ignore forward references to inner classes.

Parameters

• target (Class) –

• attr (Attr) –

• attr_type (AttrType) –

classmethod process_native_type(attr, attr_type)

Reset attribute type if the attribute has a pattern restriction as they are not yet supported.

Parameters

• attr (Attr) –

• attr_type (AttrType) –

find_dependency(target, attr_type)

Find dependency for the given attribute.

Avoid conflicts by search in order:

1. Non element/complexType

2. Non abstract

3. anything

Parameters

• target (Class) –

• attr_type (AttrType) –

Return type

Optional[Class]

process_dependency_type(target, attr, attr_type)

Process user defined attribute types, split process between complex and simple types.

Reset absent attribute types with a warning.

Complex Type: xs:Element and xs:ComplexType Simple stype: the rest

Parameters

• target (Class) –

• attr (Attr) –

• attr_type (AttrType) –

classmethod process_simple_dependency(source, target, attr, attr_type)

Replace the given attribute type with the types of the single field source class.

Ignore enumerations and gracefully handle dump types with no attributes.

Raises

AnalyzerValueError if the source class has more than one attributes

Parameters

• source (Class) –

• target (Class) –

• attr (Attr) –

• attr_type (AttrType) –

process_complex_dependency(source, target, attr_type)

Update circular reference flag.

Parameters

• source (Class) –

• target (Class) –

• attr_type (AttrType) –

is_circular_dependency(source, target, seen)

Check if any source dependencies recursively match the target class.

Parameters

• source (Class) –

• target (Class) –

• seen (Set) –

Return type

bool

cached_dependencies(source)

Returns from cache the source class dependencies as a collection of qualified names.

Parameters

source (Class) –

Return type

Tuple[QName]

classmethod reset_attribute_type(attr_type)

Reset the attribute type to native string.

Parameters

attr_type (AttrType) –

class xsdata.codegen.handlers.AttributeMergeHandler

Bases: xsdata.codegen.mixins.HandlerInterface

Merge same type attributes and their restrictions.

classmethod process(target)

Detect same type attributes in order to merge them together with their restrictions.

Two attributes are considered equal if they have the same name, types and namespace.

Parameters

target (Class) –

class xsdata.codegen.handlers.AttributeEnumUnionHandler(container)

Bases: xsdata.codegen.mixins.HandlerInterface

Convert classes with a single attribute derived from xs:union where all types are enumerations to standalone enumeration.

Parameters

container (ContainerInterface) –

container: ContainerInterface

process(target)

Merge enumeration unions attributes.

Lookup for the source class in the local namespace or inner class list.

Parameters

target (Class) –

class xsdata.codegen.handlers.ClassExtensionHandler(container)

Bases: xsdata.codegen.mixins.HandlerInterface

Reduce class extensions by copying or creating new attributes.

Parameters

container (ContainerInterface) –

INCLUDES_NONE = 0

INCLUDES_SOME = 1

INCLUDES_ALL = 2

container: ContainerInterface

process(target)

Iterate and process the target class’s extensions in reverser order.

The reverse order is necessary in order to maintain the correct attributes ordering during cloning.

Parameters

target (Class) –

process_extension(target, extension)

Slit the process of extension into schema data types and user defined types.

Parameters

• target (Class) –

• extension (Extension) –

classmethod process_native_extension(target, extension)

Native type flatten handler.

In case of enumerations copy the native data type to all enum members, otherwise create a default text value with the extension attributes.

Parameters

• target (Class) –

• extension (Extension) –

process_dependency_extension(target, extension)

User defined type flatten handler.

Parameters

• target (Class) –

• extension (Extension) –

classmethod process_simple_extension(source, target, ext)

Simple flatten extension handler for common classes eg SimpleType, Restriction.

Steps:

1. If target is source: drop the extension.

2. If source is enumeration and target isn’t create default value attribute.

3. If both source and target are enumerations copy all attributes.

4. If both source and target are not enumerations copy all attributes.

5. If target is enumeration: drop the extension.

Parameters

• source (Class) –

• target (Class) –

• ext (Extension) –

classmethod process_complex_extension(source, target, ext)

Complex flatten extension handler for primary classes eg ComplexType, Element.

Drop extension when:

• source includes all target attributes

Copy all attributes when:

• source includes some of the target attributes

• source has suffix attribute and target has at least one attribute

• target has at least one suffix attribute

• source is marked as strict type

Parameters

• source (Class) –

• target (Class) –

• ext (Extension) –

find_dependency(target, attr_type)

Find dependency for the given extension type with priority.

Search priority: xs:SimpleType > xs:ComplexType

Parameters

• target (Class) –

• attr_type (AttrType) –

Return type

Optional[Class]

classmethod compare_attributes(source, target)

Compare the attributes of the two classes and return whether the source includes all, some or none of the target attributes.

Parameters

• source (Class) –

• target (Class) –

Return type

int

classmethod copy_extension_type(target, extension)

Add the given extension type to all target attributes types and remove it from the target class extensions.

Parameters

• target (Class) –

• extension (Extension) –

classmethod create_default_attribute(item, extension)

Add a default value field to the given class based on the extension type.

Parameters

• item (Class) –

• extension (Extension) –

class xsdata.codegen.handlers.AttributeImpliedHandler

Bases: xsdata.codegen.mixins.HandlerInterface

Add attributes to classes that are implied from the class other properties.

classmethod process(target)

Add an xs:anyType attribute to the given class if it supports mixed content and doesn’t have a wildcard attribute yet.

Parameters

target (Class) –

class xsdata.codegen.handlers.AttributeMismatchHandler

Bases: xsdata.codegen.mixins.HandlerInterface

Normalize attributes that can not coexist together in the same class by moving them to an existing inner class or to a new one.

classmethod process(target)

Process classes that contain attributes derived from xs:enumeration and any other xs element.

Parameters

target (Class) –

class xsdata.codegen.handlers.AttributeSubstitutionHandler(container)

Bases: xsdata.codegen.mixins.HandlerInterface

Apply substitution attributes to the given class recursively.

Parameters

container (ContainerInterface) –

container: ContainerInterface

substitutions: Optional[Dict[lxml.etree.QName, List[xsdata.codegen.models.Attr]]] = None

process(target)

Search and process attributes not derived from xs:enumeration or xs:any.

Build the substitutions map if it’s not initialized yet.

Parameters

target (Class) –

process_attribute(target, attr)

Check if the given attribute matches any substitution class in order to clone it’s attributes to the target class.

The cloned attributes are placed below the attribute the are supposed to substitute.

Parameters

• target (Class) –

• attr (Attr) –

create_substitutions()

Create reference attributes for all the classes substitutions and group them by their fully qualified name.

classmethod create_substitution(source, qname)

Create an attribute with type that refers to the given source class and namespaced qualified name.

Parameters

• source (Class) –

• qname (QName) –

Return type

Attr