xsdata.analyzer module

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.

Parameters

• processed (List) –

• class_index (Dict[QName, List[Class]]) –

• substitutions_index (Dict[QName, List[Attr]]) –

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:

• Create a class index.

• Handle duplicate types.

• Create a substitution index.

• Flatten classes.

• Return a final class list for code generators.

Parameters

classes (List[Class]) –

Return type

List[Class]

handle_duplicate_classes()

Remove if possible classes with the same qualified name.

Steps:

1. Remove classes with missing extension type.

2. Merge redefined classes.

3. Fix implied abstract flags.

remove_invalid_classes(classes)

Remove from the given class list any class with missing extension type.

Parameters

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

Parameters

classes (List[Class]) –

create_substitutions_index()

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

find_attr_type(source, attr_type)

Parameters

• source (Class) –

• attr_type (AttrType) –

Return type

Optional[Class]

attr_type_is_missing(source, attr_type)

Check if given type declaration is not native and is missing.

Parameters

• source (Class) –

• attr_type (AttrType) –

Return type

bool

find_attr_simple_type(source, attr_type)

Parameters

• source (Class) –

• attr_type (AttrType) –

Return type

Optional[Class]

find_simple_class(qname)

Parameters

qname (QName) –

Return type

Optional[Class]

find_class(qname, condition=None)

Parameters

• qname (QName) –

• condition (Optional[Callable]) –

Return type

Optional[Class]

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

Parameters

target (Class) –

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)

4. Unknown type

Parameters

• target (Class) –

• extension (Extension) –

flatten_extension_native(target, ext)

Parameters

• target (Class) –

• ext (Extension) –

Return type

None

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.

Parameters

• source (Class) –

• target (Class) –

• ext (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 or target class is abstract

Parameters

• source (Class) –

• target (Class) –

• ext (Extension) –

expand_attribute_group(target, attr)

Expand a group attribute with the source class attributes.

Clone the attributes and apply the group restrictions as well.

Parameters

• target (Class) –

• attr (Attr) –

flatten_attribute_types(target, attr)

Loop over the the given attribute types to flatten simple definitions.

Notes:

• xs:pattern is not yet supported reset all native types to xs:string.

• skip over forward references aka inner classes

Parameters

• target (Class) –

• attr (Attr) –

flatten_attribute_type(target, attr, attr_type)

Flatten attribute type if it’s a simple type otherwise check for circular reference or missing type.

Parameters

• target (Class) –

• attr (Attr) –

• attr_type (AttrType) –

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.

Parameters

• target (Class) –

• attr (Attr) –

class_depends_on(source, target)

Check if any source dependencies recursively match the target class.

Parameters

• source (Class) –

• target (Class) –

Return type

bool