xmlschema Documentation

• Introduction
  • Features
  • Installation
  • License
  • Support
• Usage
  • Create a schema instance
  • Validation
  • Data decoding and encoding
  • Decoding to JSON
  • XML resources and documents
  • Meta-schemas and XSD sources
• Other features
  • XSD 1.0 and 1.1 support
  • CLI interface
  • XSD validation modes
  • Namespaces mapping options
  • Lazy validation
  • XML entity-based attacks protection
  • Access control on accessing resources
  • Processing limits
  • Translations of parsing/validation error messages
• Converters for XML data
  • Available converters
  • Create a custom converter
• Schema components
  • Accessing schema components
  • Component structure
  • XSD types
• Testing
  • Test scripts
  • Test cases based on files
  • Testing with the W3C XML Schema 1.1 test suite
  • Direct testing of schemas and instances
• Extra features
  • Code generation with Jinja2 templates
  • WSDL 1.1 documents

• Package API
  • Errors and exceptions
    • XMLSchemaException
    • XMLResourceError
    • XMLSchemaNamespaceError
    • XMLSchemaValidatorError
    • XMLSchemaNotBuiltError
    • XMLSchemaParseError
    • XMLSchemaModelError
    • XMLSchemaModelDepthError
    • XMLSchemaValidationError
    • XMLSchemaDecodeError
    • XMLSchemaEncodeError
    • XMLSchemaChildrenValidationError
      • XMLSchemaChildrenValidationError.invalid_tag
      • XMLSchemaChildrenValidationError.invalid_child
    • XMLSchemaStopValidation
    • XMLSchemaIncludeWarning
    • XMLSchemaImportWarning
    • XMLSchemaTypeTableWarning
  • Document level API
    • validate()
    • is_valid()
    • iter_errors()
    • iter_decode()
    • to_dict()
    • to_json()
    • to_etree()
    • from_json()
  • Schema level API
    • xmlschema.XMLSchema10
    • xmlschema.XMLSchema11
    • XMLSchema
    • XMLSchemaBase
      • XMLSchemaBase.meta_schema
      • XMLSchemaBase.root
      • XMLSchemaBase.get_text()
      • XMLSchemaBase.name
      • XMLSchemaBase.url
      • XMLSchemaBase.base_url
      • XMLSchemaBase.tag
      • XMLSchemaBase.id
      • XMLSchemaBase.version
      • XMLSchemaBase.schema_location
      • XMLSchemaBase.no_namespace_schema_location
      • XMLSchemaBase.target_prefix
      • XMLSchemaBase.default_namespace
      • XMLSchemaBase.root_elements
      • XMLSchemaBase.simple_types
      • XMLSchemaBase.complex_types
      • XMLSchemaBase.builtin_types()
      • XMLSchemaBase.create_meta_schema()
      • XMLSchemaBase.create_any_content_group()
      • XMLSchemaBase.create_any_attribute_group()
      • XMLSchemaBase.create_any_type()
      • XMLSchemaBase.get_locations()
      • XMLSchemaBase.include_schema()
      • XMLSchemaBase.import_schema()
      • XMLSchemaBase.add_schema()
      • XMLSchemaBase.export()
      • XMLSchemaBase.resolve_qname()
      • XMLSchemaBase.iter_globals()
      • XMLSchemaBase.iter_components()
      • XMLSchemaBase.build()
      • XMLSchemaBase.clear()
      • XMLSchemaBase.built
      • XMLSchemaBase.validation_attempted
      • XMLSchemaBase.validity
      • XMLSchemaBase.all_errors
      • XMLSchemaBase.get_converter()
      • XMLSchemaBase.validate()
      • XMLSchemaBase.is_valid()
      • XMLSchemaBase.iter_errors()
      • XMLSchemaBase.decode()
      • XMLSchemaBase.iter_decode()
      • XMLSchemaBase.encode()
      • XMLSchemaBase.iter_encode()
  • Global maps API
    • XsdGlobals
      • XsdGlobals.build()
      • XsdGlobals.check()
      • XsdGlobals.clear()
      • XsdGlobals.copy()
      • XsdGlobals.iter_globals()
      • XsdGlobals.iter_schemas()
      • XsdGlobals.lookup()
      • XsdGlobals.register()
      • XsdGlobals.unbuilt
  • Converters API
    • ElementData
    • XMLSchemaConverter
      • XMLSchemaConverter.lossy
      • XMLSchemaConverter.losslessly
      • XMLSchemaConverter.copy()
      • XMLSchemaConverter.map_attributes()
      • XMLSchemaConverter.map_content()
      • XMLSchemaConverter.etree_element()
      • XMLSchemaConverter.element_decode()
      • XMLSchemaConverter.element_encode()
      • XMLSchemaConverter.map_qname()
      • XMLSchemaConverter.unmap_qname()
    • UnorderedConverter
    • ParkerConverter
    • BadgerFishConverter
    • AbderaConverter
    • JsonMLConverter
    • ColumnarConverter
  • Data objects API
    • DataElement
    • DataElementConverter
    • DataBindingConverter
  • URL normalization API
    • normalize_url()
    • normalize_locations()
  • XML resources API
    • fetch_resource()
    • fetch_schema_locations()
    • fetch_schema()
    • download_schemas()
    • XMLResource
      • XMLResource.root
      • XMLResource.text
      • XMLResource.name
      • XMLResource.url
      • XMLResource.base_url
      • XMLResource.filepath
      • XMLResource.namespace
      • XMLResource.parse()
      • XMLResource.tostring()
      • XMLResource.open()
      • XMLResource.load()
      • XMLResource.is_lazy()
      • XMLResource.lazy_depth
      • XMLResource.is_remote()
      • XMLResource.is_local()
      • XMLResource.is_loaded()
      • XMLResource.iter()
      • XMLResource.iter_depth()
      • XMLResource.iterfind()
      • XMLResource.find()
      • XMLResource.findall()
      • XMLResource.iter_location_hints()
      • XMLResource.get_namespaces()
      • XMLResource.get_locations()
    • XmlDocument
  • Translation API
    • activate()
    • deactivate()
  • Namespaces API
    • NamespaceResourcesMap
    • NamespaceMapper
    • NamespaceView
  • XPath API
    • ElementPathMixin
      • ElementPathMixin.tag
      • ElementPathMixin.attrib
      • ElementPathMixin.get()
      • ElementPathMixin.iter()
      • ElementPathMixin.iterchildren()
      • ElementPathMixin.find()
      • ElementPathMixin.findall()
      • ElementPathMixin.iterfind()
  • Validation API
    • ValidationMixin
      • ValidationMixin.is_valid()
      • ValidationMixin.validate()
      • ValidationMixin.decode()
      • ValidationMixin.iter_decode()
      • ValidationMixin.iter_errors()
      • ValidationMixin.encode()
      • ValidationMixin.iter_encode()
  • Particles API
    • ParticleMixin
      • ParticleMixin.is_empty()
      • ParticleMixin.is_emptiable()
      • ParticleMixin.is_single()
      • ParticleMixin.is_multiple()
      • ParticleMixin.is_ambiguous()
      • ParticleMixin.is_univocal()
      • ParticleMixin.is_missing()
      • ParticleMixin.is_over()
  • Main XSD components
    • XsdComponent
      • XsdComponent.target_namespace
      • XsdComponent.local_name
      • XsdComponent.qualified_name
      • XsdComponent.prefixed_name
      • XsdComponent.is_global()
      • XsdComponent.is_matching()
      • XsdComponent.tostring()
    • XsdType
      • XsdType.simple_type
      • XsdType.model_group
      • XsdType.has_complex_content()
      • XsdType.has_mixed_content()
      • XsdType.has_simple_content()
      • XsdType.is_atomic()
      • XsdType.is_complex()
      • XsdType.is_datetime()
      • XsdType.is_derived()
      • XsdType.is_element_only()
      • XsdType.is_emptiable()
      • XsdType.is_empty()
      • XsdType.is_list()
      • XsdType.is_simple()
    • XsdElement
    • XsdAttribute
  • Other XSD components
    • Elements and attributes
      • Xsd11Element
      • Xsd11Attribute
    • Types
      • Xsd11ComplexType
      • XsdComplexType
        • XsdComplexType.content
      • XsdSimpleType
        • XsdSimpleType.enumeration
        • XsdSimpleType.max_value
        • XsdSimpleType.min_value
      • XsdAtomicBuiltin
      • XsdList
      • Xsd11Union
      • XsdUnion
      • Xsd11AtomicRestriction
      • XsdAtomicRestriction
    • Attribute and model groups
      • XsdAttributeGroup
      • Xsd11Group
      • XsdGroup
    • Wildcards
      • Xsd11AnyElement
      • XsdAnyElement
      • Xsd11AnyAttribute
      • XsdAnyAttribute
      • XsdOpenContent
      • XsdDefaultOpenContent
    • Identity constraints
      • XsdIdentity
      • XsdSelector
      • XsdFieldSelector
      • Xsd11Unique
      • XsdUnique
      • Xsd11Key
      • XsdKey
      • Xsd11Keyref
      • XsdKeyref
    • Facets
      • XsdFacet
      • XsdWhiteSpaceFacet
      • XsdLengthFacet
      • XsdMinLengthFacet
      • XsdMaxLengthFacet
      • XsdMinInclusiveFacet
      • XsdMinExclusiveFacet
      • XsdMaxInclusiveFacet
      • XsdMaxExclusiveFacet
      • XsdTotalDigitsFacet
      • XsdFractionDigitsFacet
      • XsdExplicitTimezoneFacet
      • XsdAssertionFacet
      • XsdEnumerationFacets
      • XsdPatternFacets
    • Others
      • XsdAssert
      • XsdAlternative
      • XsdNotation
      • XsdAnnotation
  • Extra features API
    • Code generators
      • AbstractGenerator
        • AbstractGenerator.map_type()
        • AbstractGenerator.list_templates()
        • AbstractGenerator.matching_templates()
        • AbstractGenerator.get_template()
        • AbstractGenerator.select_template()
        • AbstractGenerator.render()
        • AbstractGenerator.render_to_files()
      • PythonGenerator
    • WSDL 1.1 documents
      • Wsdl11Document
        • Wsdl11Document.messages
        • Wsdl11Document.port_types
        • Wsdl11Document.bindings
        • Wsdl11Document.services