xsdata.codegen.models module¶

xsdata.codegen.models.qname(name, ns_map, default_namespace=None)[source]¶

Parameters

name (str) –
ns_map (Dict) –
default_namespace (Optional[str]) –

Return type

QName

class xsdata.codegen.models.Restrictions(required=None, prohibited=None, min_occurs=None, max_occurs=None, min_exclusive=None, min_inclusive=None, min_length=None, max_exclusive=None, max_inclusive=None, max_length=None, total_digits=None, fraction_digits=None, length=None, white_space=None, pattern=None, explicit_timezone=None, nillable=None, sequential=None)[source]¶

Bases: object

Parameters

required (Optional[bool]) –
prohibited (Optional[bool]) –
min_occurs (Optional[int]) –
max_occurs (Optional[int]) –
min_exclusive (Optional[float]) –
min_inclusive (Optional[float]) –
min_length (Optional[float]) –
max_exclusive (Optional[float]) –
max_inclusive (Optional[float]) –
max_length (Optional[float]) –
total_digits (Optional[int]) –
fraction_digits (Optional[int]) –
length (Optional[int]) –
white_space (Optional[str]) –
pattern (Optional[str]) –
explicit_timezone (Optional[str]) –
nillable (Optional[bool]) –
sequential (Optional[bool]) –

required: Optional[bool] = None¶

prohibited: Optional[bool] = None¶

min_occurs: Optional[int] = None¶

max_occurs: Optional[int] = None¶

min_exclusive: Optional[float] = None¶

min_inclusive: Optional[float] = None¶

min_length: Optional[float] = None¶

max_exclusive: Optional[float] = None¶

max_inclusive: Optional[float] = None¶

max_length: Optional[float] = None¶

total_digits: Optional[int] = None¶

fraction_digits: Optional[int] = None¶

length: Optional[int] = None¶

white_space: Optional[str] = None¶

pattern: Optional[str] = None¶

explicit_timezone: Optional[str] = None¶

nillable: Optional[bool] = None¶

sequential: Optional[bool] = None¶

property is_list¶

Return type: bool

property is_optional¶

Return type: bool

merge(source)[source]¶

Parameters: source (Restrictions) –

update(data)[source]¶

Parameters: data (Dict) –

asdict()[source]¶

Return type: Dict

clone()[source]¶

Return type: Restrictions

classmethod from_element(element)[source]¶

Parameters: element (ElementBase) –
Return type: Restrictions

class xsdata.codegen.models.AttrType(name, index=<factory>, alias=None, native=False, forward=False, circular=False)[source]¶

Bases: object

Parameters

name (str) –
index (int) –
alias (Optional[str]) –
native (bool) –
forward (bool) –
circular (bool) –

name: str = None¶

index: int = None¶

alias: Optional[str] = None¶

native: bool = False¶

forward: bool = False¶

circular: bool = False¶

property is_dependency¶

Return type: bool

property native_name¶

Return type: Optional[str]

property native_code¶

Return type: Optional[str]

property native_type¶

Return type: Any

clone()[source]¶

Return type: AttrType

class xsdata.codegen.models.Attr(tag, name, index, local_name=None, default=None, fixed=False, types=<factory>, display_type=None, namespace=None, help=None, restrictions=<factory>)[source]¶

Bases: object

Parameters

tag (str) –
name (str) –
index (int) –
local_name (Optional[str]) –
default (Optional[Any]) –
fixed (bool) –
types (List[AttrType]) –
display_type (Optional[str]) –
namespace (Optional[str]) –
help (Optional[str]) –
restrictions (Restrictions) –

tag: str = None¶

name: str = None¶

index: int = None¶

local_name: Optional[str] = None¶

default: Any = None¶

fixed: bool = False¶

types: List[AttrType] = None¶

display_type: Optional[str] = None¶

namespace: Optional[str] = None¶

help: Optional[str] = None¶

restrictions: Restrictions = None¶

property is_attribute¶

Return type: bool

property is_enumeration¶

Return type: bool

property is_factory¶

Return type: bool

property is_group¶

Return type: bool

property is_map¶

Return type: bool

property is_nameless¶

Return type: bool

property is_list¶

Return type: bool

property is_optional¶

Return type: bool

property is_suffix¶

Return type: bool

property is_xsi_type¶

Return type: bool

property is_wildcard¶

Return type: bool

property xml_type¶

Return type: Optional[str]

clone()[source]¶

Return type: Attr

class xsdata.codegen.models.Extension(type, restrictions)[source]¶

Bases: object

Parameters

type (AttrType) –
restrictions (Restrictions) –

type: AttrType = None¶

restrictions: Restrictions = None¶

clone()[source]¶

Return type: Extension

class xsdata.codegen.models.Status[source]¶

Bases: enum.IntEnum

An enumeration.

RAW = 0¶

PROCESSING = 1¶

PROCESSED = 2¶

class xsdata.codegen.models.Class(name, type, module, mixed, abstract, nillable, status=<Status.RAW: 0>, package=None, namespace=None, help=None, substitutions=<factory>, extensions=<factory>, attrs=<factory>, inner=<factory>, ns_map=<factory>, source_namespace=None)[source]¶

Bases: object

Parameters

name (str) –
type (Type) –
module (str) –
mixed (bool) –
abstract (bool) –
nillable (bool) –
status (Status) –
package (Optional[str]) –
namespace (Optional[str]) –
help (Optional[str]) –
substitutions (List[str]) –
extensions (List[Extension]) –
attrs (List[Attr]) –
inner (List[Class]) –
ns_map (Dict) –
source_namespace (Optional[str]) –

name: str = None¶

type: Type = None¶

module: str = None¶

mixed: bool = None¶

abstract: bool = None¶

nillable: bool = None¶

status: xsdata.codegen.models.Status = 0¶

package: Optional[str] = None¶

namespace: Optional[str] = None¶

help: Optional[str] = None¶

substitutions: List[str] = None¶

extensions: List[Extension] = None¶

attrs: List[Attr] = None¶

inner: List['Class'] = None¶

ns_map: Dict = None¶

source_namespace: Optional[str] = None¶

property has_suffix_attr¶

Return type: bool

property has_wild_attr¶

Return type: bool

property is_complex¶

Return type: bool

property is_element¶

Return type: bool

property is_enumeration¶

Return type: bool

property is_nillable¶

Return type: bool

property source_prefix¶

Return type: Optional[str]

property target_module¶

Return type: str

clone()[source]¶

Return type: Class

dependencies()[source]¶

Return a set of dependencies for the given class.

Collect:

base classes
attribute types
recursively go through the inner classes
Ignore inner class references
Ignore native types.

Return type: Iterator[QName]

source_qname(name=None)[source]¶

Parameters: name (Optional[str]) –
Return type: QName

class xsdata.codegen.models.Package(name, source, alias=None)[source]¶

Bases: object

Parameters

name (str) –
source (str) –
alias (Optional[str]) –

name: str = None¶

source: str = None¶

alias: Optional[str] = None¶