Package xmlschema_acue :: Package validators :: Module assertions :: Class XsdAssert

Class XsdAssert

source code



Class for XSD 'assert' constraint declaration.

<assert
  id = ID
  test = an XPath expression
  xpathDefaultNamespace = (anyURI | (##defaultNamespace | ##targetNamespace | ##local))
  {any attributes with non-schema namespace . . .}>
  Content: (annotation?)
</assert>

Instance Methods
 
parse(self) source code
 
__call__(self, elem) source code

Inherited from xsdbase.XsdComponent: __repr__, __setattr__, get_global, match, tostring

Inherited from xsdbase.XsdValidator: __copy__, __str__, __unicode__, copy

Inherited from xpath.ElementPathMixin: __getitem__, __len__, __reversed__

Class Variables
  token = None

Inherited from xsdbase.XsdComponent: name, parent, qualified

Inherited from xpath.ElementPathMixin: tail, text, xpath_default_namespace

Method Details

__init__(self, elem, schema, parent, base_type)
(Constructor)

source code 
Decorators:
Overrides: xsdbase.XsdValidator.__init__

built(self)

source code 

Property that is ``True`` if schema validator has been fully parsed and built, ``False`` otherwise.

Decorators:
  • @property
Overrides: xsdbase.XsdValidator.built
(inherited documentation)

__iter__(self)

source code 
Decorators:
Overrides: xpath.ElementPathMixin.__iter__

attrib(self)

source code 

Returns the Element attributes. For compatibility with the ElementTree API.

Decorators:
  • @property
Overrides: xpath.ElementPathMixin.attrib
(inherited documentation)

all_errors(self)

source code 

A list with all the building errors of the XSD validator and its components.

Decorators:
  • @property

default_namespace(self)

source code 

Property that references to schema's default namespaces.

Decorators:
  • @property

find(self, path, namespaces=None)

source code 

Finds the first XSD subelement matching the path.

:param path: an XPath expression that considers the XSD component as the root element. :param namespaces: an optional mapping from namespace prefix to full name. :return: The first matching XSD subelement or ``None`` if there is not match.

Decorators:

findall(self, path, namespaces=None)

source code 

Finds all XSD subelements matching the path.

:param path: an XPath expression that considers the XSD component as the root element. :param namespaces: an optional mapping from namespace prefix to full name. :return: a list containing all matching XSD subelements in document order, an empty list is returned if there is no match.

Decorators:

get(self, key, default=None)

source code 

Gets an Element attribute. For compatibility with the ElementTree API.

Decorators:

id(self)

source code 

The ``'id'`` attribute of the component tag, ``None`` if missing.

Decorators:
  • @property

is_global(self)

source code 

Is `True` if the instance is a global component, `False` if it's local.

Decorators:
  • @property

is_matching(self, name, default_namespace=None)

source code 

Returns `True` if the component name is matching the name provided as argument, `False` otherwise.

:param name: a local or fully-qualified name. :param default_namespace: used if it's not None and not empty for completing the name argument in case it's a local name.

Decorators:

iter(self, tag=None)

source code 

Creates an iterator for the XSD element and its subelements. If tag is not `None` or '*', only XSD elements whose matches tag are returned from the iterator. Local elements are expanded without repetitions. Element references are not expanded because the global elements are not descendants of other elements.

Decorators:

iter_ancestors(self, xsd_classes=None)

source code 

Creates an iterator for XSD ancestor components, schema excluded. Stops when the component is global or if the ancestor is not an instance of the specified class/classes.

:param xsd_classes: provide a class or a tuple of classes to iterates over only a specific classes of components.

Decorators:

iter_components(self, xsd_classes=None)

source code 

Creates an iterator for XSD subcomponents.

:param xsd_classes: provide a class or a tuple of classes to iterates over only a specific classes of components.

Decorators:
Overrides: XsdValidator.iter_components

iterchildren(self, tag=None)

source code 

Creates an iterator for the child elements of the XSD component. If *tag* is not `None` or '*', only XSD elements whose name matches tag are returned from the iterator.

Decorators:

iterfind(self, path, namespaces=None)

source code 

Creates and iterator for all XSD subelements matching the path.

:param path: an XPath expression that considers the XSD component as the root element. :param namespaces: is an optional mapping from namespace prefix to full name. :return: an iterable yielding all matching XSD subelements in document order.

Decorators:

local_name(self)

source code 
Decorators:
  • @property

maps(self)

source code 

Property that references to schema's global maps.

Decorators:
  • @property

namespaces(self)

source code 

Property that references to schema's namespace mapping.

Decorators:
  • @property

parse_error(self, error, elem=None)

source code 

Helper method for registering parse errors. Does nothing if validation mode is 'skip'. Il validation mode is 'lax' collects the error, otherwise raise the error.

:param error: can be a parse error or an error message. :param elem: the Element instance related to the error, for default uses the 'elem' attribute of the validator, if it's present.

Decorators:

prefixed_name(self)

source code 
Decorators:
  • @property

qualified_name(self)

source code 
Decorators:
  • @property

schema_elem(self)

source code 

The reference element of the schema for the component instance.

Decorators:
  • @property

source(self)

source code 

Property that references to schema source.

Decorators:
  • @property

tag(self)

source code 

Alias of the *name* attribute. For compatibility with the ElementTree API.

Decorators:
  • @property

target_namespace(self)

source code 

Property that references to schema's targetNamespace.

Decorators:
  • @property

validation_attempted(self)

source code 

Property that returns the *validation status* of the XSD validator. It can be 'full', 'partial' or 'none'.

| https://www.w3.org/TR/xmlschema-1/#e-validation_attempted | https://www.w3.org/TR/2012/REC-xmlschema11-1-20120405/#e-validation_attempted

Decorators:
  • @property
Overrides: XsdValidator.validation_attempted
(inherited documentation)

validity(self)

source code 

Property that returns the XSD validator's validity. It can be ‘valid’, ‘invalid’ or ‘notKnown’.

| https://www.w3.org/TR/xmlschema-1/#e-validity | https://www.w3.org/TR/2012/REC-xmlschema11-1-20120405/#e-validity

Decorators:
  • @property