xsdata.analyzer module

xsdata.analyzer.simple_type(item)

class xsdata.analyzer.ClassAnalyzer(processed=<factory>, class_index=<factory>, substitutions_index=<factory>)

Bases: xsdata.utils.classes.ClassUtils

Class analyzer is responsible to minize the final classes footprint by merging and flattening extensions and attributes.

Also promotes the classes necessary for generation and demotes the classes to be used as common types for future runs.

processed: List = None

class_index: Dict[QName, List[Class]] = None

substitutions_index: Dict[QName, List[Attr]] = None

process(classes)

Process class list in steps.

Steps:

• Merge redefined classes

• Create a class index

• Create a substitution index

• Mark as abstract classes with the same qname

• Flatten classes

• Return a final class list for code generators.

Return type

List[Class]

fetch_classes_for_generation()

Return the qualified classes to continue for code generation. Return all if there are not primary classes.

Qualifications:

• not an abstract

• type: element | complexType | simpleType with enumerations

Return type

List[Class]

create_class_index(classes)

Group classes by their fully qualified name.

create_substitutions_index(classes)

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

find_class(qname, condition=<function simple_type>)

Return type

Optional[Class]

merge_redefined_classes(classes)

Merge original and redefined classes.

update_abstract_classes()

Explicitly update classes to mark them as abstract when it’s implied.

flatten_classes()

flatten_class(target)

Simplify class footprint by flattening class extensions, attributes and inner classes.

Steps:

• Expand attribute groups

• Flatten extensions

• Flatten attribute types

• Add substitution attributes

• Merge duplicate attributes

• Create mixed content attribute

• Flatten inner classes

flatten_extension(target, extension)

Flatten target class extension based on the extension type.

Types:

1. Native primitive type (int, str, float, etc)

2. Simple source type (simpleType, Extension)

3. Complex source type (ComplexType, Element)

flatten_extension_native(target, ext)

flatten_extension_simple(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.

flatten_extension_complex(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 depends on target class copy all attributes

expand_attribute_group(target, attr)

Expand a group attribute with the source class attributes.

Clone the attributes and apply the group restrictions as well.

flatten_attribute_types(target, attr)

Flatten attribute types by using the source attribute type.

Steps:

• Skip xsd native types

• Detect circular references if no source is found

• Skip enumeration types

• Overwrite attribute type from source

add_substitution_attrs(target, attr)

Find all the substitution attributes for the given attribute and add them to the target class.

Exclude enumerations and wildcard attributes.

class_depends_on(source, target)

Check if any source dependencies recursively match the target class.

Return type

bool

attr_depends_on(dependency, target)

Check if dependency or any of its dependencies match the target class.

Return type

bool