xsdata.codegen.mappers.schema module

class xsdata.codegen.mappers.schema.SchemaMapper

Bases: object

Map a schema instance to classes, extensions and attributes.

classmethod map(schema)

Map schema children elements to classes.

Parameters

schema (Schema) –

Return type

List[Class]

classmethod root_elements(schema)

Return all valid schema elements that can be converted to classes.

Parameters

schema (Schema) –

classmethod build_class(obj, container, module, target_namespace)

Build and return a class instance.

Parameters

• obj (ElementBase) –

• container (str) –

• module (str) –

• target_namespace (Optional[str]) –

Return type

Class

classmethod build_substitutions(obj, target_namespace)

Parameters

• obj (ElementBase) –

• target_namespace (Optional[str]) –

Return type

List[str]

classmethod build_class_attributes(obj, target)

Build the target class attributes from the given ElementBase children.

Parameters

• obj (ElementBase) –

• target (Class) –

classmethod build_class_extensions(obj, target)

Build the item class extensions from the given ElementBase children.

Parameters

• obj (ElementBase) –

• target (Class) –

classmethod build_data_type(target, name, index=0, forward=False)

Create an attribute type for the target class.

Parameters

• target (Class) –

• name (str) –

• index (int) –

• forward (bool) –

Return type

AttrType

classmethod element_children(obj, restrictions)

Recursively find and return all child elements that are qualified to be class attributes.

Parameters

• obj (ElementBase) –

• restrictions (Restrictions) –

Return type

Iterator[Tuple[ElementBase, Restrictions]]

classmethod element_namespace(obj, target_namespace)

Return the target namespace for the given schema element.

In order:

• elements/attributes with specific target namespace

• prefixed elements returns the namespace from schema ns_map

• qualified elements returns the schema target namespace

• unqualified elements return an empty string

• unqualified attributes return None

Parameters

• obj (ElementBase) –

• target_namespace (Optional[str]) –

Return type

Optional[str]

classmethod children_extensions(obj, target)

Recursively find and return all target’s Extension classes.

If the initial given obj has a type attribute include it in result.

Parameters

• obj (ElementBase) –

• target (Class) –

Return type

Iterator[Extension]

classmethod build_class_extension(target, name, index, restrictions)

Create an extension for the target class.

Parameters

• target (Class) –

• name (str) –

• index (int) –

• restrictions (Dict) –

Return type

Extension

classmethod build_class_attribute(target, obj, parent_restrictions)

Generate and append an attribute field to the target class.

Parameters

• target (Class) –

• obj (ElementBase) –

• parent_restrictions (Restrictions) –

classmethod build_class_attribute_types(target, obj)

Convert real type and anonymous inner types to an attribute type list.

Parameters

• target (Class) –

• obj (ElementBase) –

Return type

List[AttrType]

classmethod build_inner_classes(obj, module, namespace)

Find and convert anonymous types to a class instances.

Parameters

• obj (ElementBase) –

• module (str) –

• namespace (Optional[str]) –

Return type

Iterator[Class]

classmethod is_class(item)

Parameters

item (ElementBase) –

Return type

bool