xsdata.models.enums module

class xsdata.models.enums.Namespace(uri, prefix)[source]

Bases: enum.Enum

Common namespaces.

Parameters
  • uri (str) –

  • prefix (str) –

XS = ('http://www.w3.org/2001/XMLSchema', 'xs')
XML = ('http://www.w3.org/XML/1998/namespace', 'xml')
XSI = ('http://www.w3.org/2001/XMLSchema-instance', 'xsi')
XHTML = ('http://www.w3.org/1999/xhtml', 'xhtml')
SOAP11 = ('http://schemas.xmlsoap.org/wsdl/soap/', 'soap')
SOAP12 = ('http://schemas.xmlsoap.org/wsdl/soap12/', 'soap12')
SOAP_ENV = ('http://schemas.xmlsoap.org/soap/envelope/', 'soap-env')
property location
Return type

Optional[str]

classmethod get_enum(uri)[source]
Parameters

uri (Optional[str]) –

Return type

Optional[Namespace]

class xsdata.models.enums.QNames[source]

Bases: object

Common qualified names.

XSI_NIL = '{http://www.w3.org/2001/XMLSchema-instance}nil'
XSI_TYPE = '{http://www.w3.org/2001/XMLSchema-instance}type'
class xsdata.models.enums.NamespaceType[source]

Bases: object

Wildcard elements/attributes namespace types.

Variables
  • ANY – elements from any namespace is allowed

  • OTHER – elements from any namespace other than the parent element’s namespace

  • LOCAL – elements must come from no namespace

  • TARGET – elements from the namespace of the parent element can be present

ANY = '##any'
OTHER = '##other'
LOCAL = '##local'
TARGET = '##targetNamespace'
class xsdata.models.enums.FormType(value)[source]

Bases: enum.Enum

Element/Attribute form types.

QUALIFIED = 'qualified'
UNQUALIFIED = 'unqualified'
class xsdata.models.enums.Mode(value)[source]

Bases: enum.Enum

OpenContent mode types.

NONE = 'none'
SUFFIX = 'suffix'
INTERLEAVE = 'interleave'
class xsdata.models.enums.DataType(code, local)[source]

Bases: enum.Enum

Xml and Schema data types to native python.

Parameters
ANY_ATOMIC_TYPE = ('anyAtomicType', <class 'str'>)
ANY_URI = ('anyURI', <class 'str'>)
ANY_SIMPLE_TYPE = ('anySimpleType', <class 'object'>)
ANY_TYPE = ('anyType', <class 'object'>)
BASE = ('base', <class 'str'>)
BASE64_BINARY = ('base64Binary', <class 'str'>)
BOOLEAN = ('boolean', <class 'bool'>)
BYTE = ('byte', <class 'int'>)
DATE = ('date', <class 'str'>)
DATE_TIME = ('dateTime', <class 'str'>)
DATE_TIMESTAMP = ('dateTimeStamp', <class 'str'>)
DAY_TIME_DURATION = ('dayTimeDuration', <class 'str'>)
YEAR_MONTH_DURATION = ('yearMonthDuration', <class 'str'>)
DECIMAL = ('decimal', <class 'decimal.Decimal'>)
DERIVATION_CONTROL = ('derivationControl', <class 'str'>)
DOUBLE = ('double', <class 'decimal.Decimal'>)
DURATION = ('duration', <class 'str'>)
ENTITIES = ('ENTITIES', <class 'str'>)
ENTITY = ('ENTITY', <class 'str'>)
ERROR = ('error', <class 'str'>)
FLOAT = ('float', <class 'float'>)
G_DAY = ('gDay', <class 'str'>)
G_MONTH = ('gMonth', <class 'str'>)
G_MONTH_DAY = ('gMonthDay', <class 'str'>)
G_YEAR = ('gYear', <class 'str'>)
G_YEAR_MONTH = ('gYearMonth', <class 'str'>)
HEX_BINARY = ('hexBinary', <class 'str'>)
ID = ('ID', <class 'str'>)
IDREF = ('IDREF', <class 'str'>)
IDREFS = ('IDREFS', <class 'str'>)
INT = ('int', <class 'int'>)
INTEGER = ('integer', <class 'int'>)
LANG = ('lang', <class 'str'>)
LANGUAGE = ('language', <class 'str'>)
LONG = ('long', <class 'int'>)
NAME = ('Name', <class 'str'>)
NCNAME = ('NCName', <class 'str'>)
NEGATIVE_INTEGER = ('negativeInteger', <class 'int'>)
NMTOKEN = ('NMTOKEN', <class 'str'>)
NMTOKENS = ('NMTOKENS', <class 'str'>)
NON_NEGATIVE_INTEGER = ('nonNegativeInteger', <class 'int'>)
NON_POSITIVE_INTEGER = ('nonPositiveInteger', <class 'int'>)
NORMALIZED_STRING = ('normalizedString', <class 'str'>)
NOTATION = ('NOTATION', <class 'str'>)
POSITIVE_INTEGER = ('positiveInteger', <class 'int'>)
QNAME = ('QName', <class 'xml.etree.ElementTree.QName'>)
SHORT = ('short', <class 'int'>)
SIMPLE_DERIVATION_SET = ('simpleDerivationSet', <class 'str'>)
STRING = ('string', <class 'str'>)
TIME = ('time', <class 'str'>)
TOKEN = ('token', <class 'str'>)
UNSIGNED_BYTE = ('unsignedByte', <class 'int'>)
UNSIGNED_INT = ('unsignedInt', <class 'int'>)
UNSIGNED_LONG = ('unsignedLong', <class 'int'>)
UNSIGNED_SHORT = ('unsignedShort', <class 'int'>)
property qname
Return type

str

property local_name
Return type

str

classmethod get_enum(code)[source]
Parameters

code (str) –

Return type

Optional[DataType]

classmethod from_value(value)[source]
Parameters

value (Any) –

Return type

DataType

classmethod from_qname(qname)[source]
Parameters

qname (str) –

Return type

Optional[DataType]

class xsdata.models.enums.EventType[source]

Bases: object

XmlParsing event types.

START = 'start'
START_NS = 'start-ns'
END = 'end'
class xsdata.models.enums.Tag[source]

Bases: object

Xml Schema tag names.

ALL = 'All'
ANNOTATION = 'Annotation'
ANY = 'Any'
ANY_ATTRIBUTE = 'AnyAttribute'
APPINFO = 'Appinfo'
ASSERTION = 'Assertion'
ALTERNATIVE = 'Alternative'
ATTRIBUTE = 'Attribute'
ATTRIBUTE_GROUP = 'AttributeGroup'
CHOICE = 'Choice'
COMPLEX_CONTENT = 'ComplexContent'
COMPLEX_TYPE = 'ComplexType'
DOCUMENTATION = 'Documentation'
ELEMENT = 'Element'
EXTENSION = 'Extension'
FIELD = 'Field'
GROUP = 'Group'
IMPORT = 'Import'
INCLUDE = 'Include'
KEY = 'Key'
KEYREF = 'Keyref'
LIST = 'List'
NOTATION = 'Notation'
OVERRIDE = 'Override'
REDEFINE = 'Redefine'
RESTRICTION = 'Restriction'
SCHEMA = 'Schema'
SELECTOR = 'Selector'
SEQUENCE = 'Sequence'
SIMPLE_CONTENT = 'SimpleContent'
SIMPLE_TYPE = 'SimpleType'
UNION = 'Union'
UNIQUE = 'Unique'
ENUMERATION = 'Enumeration'
FRACTION_DIGITS = 'FractionDigits'
LENGTH = 'Length'
MAX_EXCLUSIVE = 'MaxExclusive'
MAX_INCLUSIVE = 'MaxInclusive'
MAX_LENGTH = 'MaxLength'
MIN_EXCLUSIVE = 'MinExclusive'
MIN_INCLUSIVE = 'MinInclusive'
MIN_LENGTH = 'MinLength'
PATTERN = 'Pattern'
TOTAL_DIGITS = 'TotalDigits'
WHITE_SPACE = 'WhiteSpace'
classmethod names()[source]

Return as an iterator all the possible tag names.

Return type

Iterator[str]

class xsdata.models.enums.UseType(value)[source]

Bases: enum.Enum

Attribute use types.

OPTIONAL = 'optional'
PROHIBITED = 'prohibited'
REQUIRED = 'required'
class xsdata.models.enums.ProcessType(value)[source]

Bases: enum.Enum

Wildcard process types.

LAX = 'lax'
SKIP = 'skip'
STRICT = 'strict'
class xsdata.models.enums.BindingStyle(value)[source]

Bases: enum.Enum

An enumeration.

RPC = 'rpc'
DOCUMENT = 'document'
class xsdata.models.enums.UseChoice(value)[source]

Bases: enum.Enum

An enumeration.

LITERAL = 'literal'
ENCODED = 'encoded'