XML Class

Properties   Methods   Events   Config Settings   Errors  

The XML class can be used to both parse and create XML documents.

Syntax

class ipworks.XML

Remarks

The XML class can operate as either a parser or writer of XML.

Parsing XML

The XML class parses XML documents and verifies that they are well-formed. The results are provided through a set of events complying with the SAX2 specification.

In addition, the document structure may be queried through an xpath mechanism that supports a subset of the XPath specification.

The parser is optimized for read applications, with a very fast engine that builds internal DOM structures with close to zero heap allocations. Additionally, build_dom can be set to False which reduces the overhead of creating the DOM and offers a fast forward-only parsing implementation which fires events to provide the parsed data.

When parsing a document events will fire to provide information about the parsed data. After parse returns the document may be navigated by setting xpath if build_dom is True (default). If build_dom is False parsed data is only accessible through the events.

Events are fired only when qualifying conditions (such as, for example, the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• on_characters
• on_comment
• on_end_element
• on_end_prefix_mapping
• on_eval_entity
• on_ignorable_whitespace
• on_meta
• on_pi
• on_special_section
• on_start_element
• on_start_prefix_mapping

If build_dom is True (default), xpath may be set after this method returns. xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to True prior to parsing the document for the xpath functionality to be available.

Example (Setting XPath):

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

If parsing multiple documents call reset between documents to reset the parser.

An additional "relaxed" mode allows for lexical parsing of non-XML documents (e.g. HTML). This is enabled by setting validate to False. In this case, events will be fired as elements, entities, etc. are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built.

Writing XML

To use the class first decide whether or not to write to file, or to output_data.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• output_file
• output_data: The output data are written to this property if no other destination is specified.

To begin writing the XML document first optionally set xml_declaration. If this is not set the class will use a default XML declaration at the beginning of the document.

Next begin adding elements to your document. Calling start_element will open an element with the specified name. To create a nested structure continue calling start_element to open more child elements. To write a value within an element call put_string. To close the element that was last opened call end_element. Each time end_element is called the element at the current level is closed. Alternatively, calling put_element will write the element specified with the value specified and will also close the element.

To write an attribute of the current element, after calling start_element call put_attr. Call put_attr multiple times to add multiple attributes.

Writing comments or CDATA can be done at any time with the put_comment and put_c_data methods.

To close your XML document call save. You can call save from any location and it will close any remaining open elements automatically.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

build_dom Property

When True, an internal object model of the XML document is created.

Syntax

def get_build_dom() -> bool: ...
def set_build_dom(value: bool) -> None: ...

build_dom = property(get_build_dom, set_build_dom)

Default Value

TRUE

Remarks

Set build_dom to True when you need to browse the current document through xpath.

validate is automatically set to True when build_dom is set to True.

input_data Property

The XML data to parse.

Syntax

def get_input_data() -> str: ...
def set_input_data(value: str) -> None: ...

input_data = property(get_input_data, set_input_data)

Default Value

""

Remarks

This property specifies the XML to be processed. Set this property before calling parse.

This may be set to a complete XML document, or partial data. When setting partial data call parse after each chunk of data is set. For instance:

//Parse the following in chunks: <test>1</test> xml.InputData = "<test>" xml.Parse(); xml.InputData = "1<test>" xml.Parse();

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

input_file Property

The file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

After setting this property call parse to parse the document.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

namespace_count Property

The number of records in the Namespace arrays.

Syntax

def get_namespace_count() -> int: ...
def set_namespace_count(value: int) -> None: ...

namespace_count = property(get_namespace_count, set_namespace_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

The array indices start at 0 and end at namespace_count - 1.

namespace_prefix Property

The Prefix for the Namespace .

Syntax

def get_namespace_prefix(namespace_index: int) -> str: ...
def set_namespace_prefix(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

The namespace_prefix for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

namespace_uri Property

Namespace URI associated with the corresponding Prefix .

Syntax

def get_namespace_uri(namespace_index: int) -> str: ...
def set_namespace_uri(namespace_index: int, value: str) -> None: ...

Default Value

""

Remarks

Namespace URI associated with the corresponding namespace_prefix. This is usually a URL pointing to the XML schema for the namespace.

The namespace_index parameter specifies the index of the item in the array. The size of the array is controlled by the namespace_count property.

output_data Property

The output XML after processing.

Syntax

def get_output_data() -> str: ...
def set_output_data(value: str) -> None: ...

output_data = property(get_output_data, set_output_data)

Default Value

""

Remarks

This property will be populated with the output from the operation if output_file is not set.

output_file Property

The path to a local file where the output will be written.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• output_file
• output_data: The output data are written to this property if no other destination is specified.

overwrite Property

Indicates whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file. If overwrite is False, an error will be thrown whenever output_file exists before an operation. The default value is False.

validate Property

This property controls whether documents are validated during parsing.

Syntax

def get_validate() -> bool: ...
def set_validate(value: bool) -> None: ...

validate = property(get_validate, set_validate)

Default Value

TRUE

Remarks

When True (default) the document will be validated during parsing. To disable validation set validate to False. Disabling validation may be useful in cases where data can still be parsed even if the document is not well-formed.

attr_count Property

The number of records in the Attr arrays.

Syntax

def get_attr_count() -> int: ...
def set_attr_count(value: int) -> None: ...

attr_count = property(get_attr_count, set_attr_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• attr_name
• attr_namespace
• attr_prefix
• attr_value

The array indices start at 0 and end at attr_count - 1.

attr_name Property

The Name provides the local name (without prefix) of the attribute.

Syntax

def get_attr_name(attr_index: int) -> str: ...

Default Value

""

Remarks

The attr_name provides the local name (without prefix) of the attribute.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

attr_namespace Property

Attribute namespace.

Syntax

def get_attr_namespace(attr_index: int) -> str: ...

Default Value

""

Remarks

Attribute namespace.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

attr_prefix Property

Attribute prefix (if any).

Syntax

def get_attr_prefix(attr_index: int) -> str: ...

Default Value

""

Remarks

Attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

attr_value Property

Attribute value.

Syntax

def get_attr_value(attr_index: int) -> str: ...

Default Value

""

Remarks

Attribute value.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

This property is read-only.

x_child_count Property

The number of records in the XChild arrays.

Syntax

def get_x_child_count() -> int: ...
def set_x_child_count(value: int) -> None: ...

x_child_count = property(get_x_child_count, set_x_child_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• x_child_name
• x_child_namespace
• x_child_prefix
• x_child_x_text

The array indices start at 0 and end at x_child_count - 1.

x_child_name Property

The Name property provides the local name (without prefix) of the element.

Syntax

def get_x_child_name(x_child_index: int) -> str: ...

Default Value

""

Remarks

The x_child_name property provides the local name (without prefix) of the element.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_child_namespace Property

Namespace of the element.

Syntax

def get_x_child_namespace(x_child_index: int) -> str: ...

Default Value

""

Remarks

Namespace of the element.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_child_prefix Property

Prefix of the element (if any).

Syntax

def get_x_child_prefix(x_child_index: int) -> str: ...

Default Value

""

Remarks

Prefix of the element (if any). If the element does not have a prefix, this property is empty.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_child_x_text Property

The inner text of the element.

Syntax

def get_x_child_x_text(x_child_index: int) -> str: ...

Default Value

""

Remarks

The inner text of the element.

The x_child_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_child_count property.

This property is read-only.

x_comment_count Property

The number of records in the XComment arrays.

Syntax

def get_x_comment_count() -> int: ...
def set_x_comment_count(value: int) -> None: ...

x_comment_count = property(get_x_comment_count, set_x_comment_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• x_comment_text

The array indices start at 0 and end at x_comment_count - 1.

x_comment_text Property

This property holds the comment text.

Syntax

def get_x_comment_text(x_comment_index: int) -> str: ...
def set_x_comment_text(x_comment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the comment text.

The x_comment_index parameter specifies the index of the item in the array. The size of the array is controlled by the x_comment_count property.

x_element Property

The name of the current element.

Syntax

def get_x_element() -> str: ...
def set_x_element(value: str) -> None: ...

x_element = property(get_x_element, set_x_element)

Default Value

""

Remarks

The current element is specified via the xpath property.

xml_declaration_encoding Property

This property specifies the XML encoding to use.

Syntax

def get_xml_declaration_encoding() -> str: ...
def set_xml_declaration_encoding(value: str) -> None: ...

xml_declaration_encoding = property(get_xml_declaration_encoding, set_xml_declaration_encoding)

Default Value

"utf-8"

Remarks

This property specifies the XML encoding to use.

This may be set before writing a document. The default value is "utf-8".

This is only applicable when writing XML.

xml_declaration_standalone Property

This property indicates whether the standalone attribute is present in the declaration with a value of true.

Syntax

def get_xml_declaration_standalone() -> bool: ...
def set_xml_declaration_standalone(value: bool) -> None: ...

xml_declaration_standalone = property(get_xml_declaration_standalone, set_xml_declaration_standalone)

Default Value

TRUE

Remarks

This property indicates whether the standalone attribute is present in the declaration with a value of true.

This may be set before writing a document. The default value is "true".

This is only applicable when writing XML.

xml_declaration_version Property

This property specifies the XML version.

Syntax

def get_xml_declaration_version() -> str: ...
def set_xml_declaration_version(value: str) -> None: ...

xml_declaration_version = property(get_xml_declaration_version, set_xml_declaration_version)

Default Value

"1.0"

Remarks

This property specifies the XML version.

This may be set before writing a document. The default value is "1.0".

This is only applicable when writing XML.

x_namespace Property

The namespace of the current element.

Syntax

def get_x_namespace() -> str: ...
def set_x_namespace(value: str) -> None: ...

x_namespace = property(get_x_namespace, set_x_namespace)

Default Value

""

Remarks

The current element is specified via the xpath property.

x_parent Property

The parent of the current element.

Syntax

def get_x_parent() -> str: ...

x_parent = property(get_x_parent, None)

Default Value

""

Remarks

The current element is specified via the xpath property.

This property is read-only.

xpath Property

Provides a way to point to a specific element in the document.

Syntax

def get_xpath() -> str: ...
def set_xpath(value: str) -> None: ...

xpath = property(get_xpath, set_xpath)

Default Value

""

Remarks

xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to True prior to parsing the document for the xpath functionality to be available.

Example (Setting XPath):

x_prefix Property

The prefix of the current element.

Syntax

def get_x_prefix() -> str: ...
def set_x_prefix(value: str) -> None: ...

x_prefix = property(get_x_prefix, set_x_prefix)

Default Value

""

Remarks

The current element is specified via the xpath property.

x_sub_tree Property

A snapshot of the current element in the document.

Syntax

def get_x_sub_tree() -> str: ...

x_sub_tree = property(get_x_sub_tree, None)

Default Value

""

Remarks

The current element is specified via the xpath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

x_text Property

The text of the current element.

Syntax

def get_x_text() -> str: ...
def set_x_text(value: str) -> None: ...

x_text = property(get_x_text, set_x_text)

Default Value

""

Remarks

The current element is specified via the xpath property.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

end_element Method

Writes the closing tag of an open XML element.

Syntax

def end_element() -> None: ...

Remarks

Writes the closing tag of the XML element most recently opened using start_element.

If no elements are opened, the call fails with an error

flush Method

Flushes the parser and checks its end state.

Syntax

def flush() -> None: ...

Remarks

When flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If validate is true, the parser verifies that all open elements were closed, returning an error if not.

get_attr Method

Returns the value of the specified attribute.

Syntax

def get_attr(attr_name: str) -> str: ...

Remarks

This method returns the value of the attribute specified by the AttrName parameter.

If the attribute does not exist an empty string is returned. The behavior when an attribute does not exit is controlled by ErrorOnEmptyAttr.

Please refer to the attr_name, attr_namespace, attr_prefix, and attr_value properties for more information.

has_xpath Method

Determines whether a specific element exists in the document.

Syntax

def has_xpath(xpath: str) -> bool: ...

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via xpath.

This method returns True if the xpath exists, False if not.

See xpath for details on the XPath syntax.

load_dom Method

Loads the DOM from a file.

Syntax

def load_dom(file_name: str) -> None: ...

Remarks

The load_dom method loads a DOM structure previously saved by save_dom from the file specified in FileName.

Please refer to the save_dom method for more information.

load_schema Method

Load the XML schema.

Syntax

def load_schema(schema: str) -> None: ...

Remarks

This functionality is not yet implemented.

This method loads the schema specified in the Schema parameter. The Schema may be specified as either a string or the path to a file on disk.

The class will validate the input data during parsing to verify it adheres to the schema.

parse Method

This method parses the specified XML data.

Syntax

def parse() -> None: ...

Remarks

This method parses the specified XML data.

When parsing a document events will fire to provide information about the parsed data. After parse returns the document may be navigated by setting xpath if build_dom is True (default). If build_dom is False parsed data is only accessible through the events.

Events are fired only when qualifying conditions (such as, for example, the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• on_characters
• on_comment
• on_end_element
• on_end_prefix_mapping
• on_eval_entity
• on_ignorable_whitespace
• on_meta
• on_pi
• on_special_section
• on_start_element
• on_start_prefix_mapping

If build_dom is True (default), xpath may be set after this method returns. xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to True prior to parsing the document for the xpath functionality to be available.

Example (Setting XPath):

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

If parsing multiple documents call reset between documents to reset the parser.

put_attr Method

Writes an XML attribute.

Syntax

def put_attr(name: str, namespace_uri: str, value: str) -> None: ...

Remarks

Writes an XML attribute on the currently opened XML element. It must be called right after calling start_element and before any calls to put_string, put_comment or put_raw.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

Certain attribute names will be handled in special ways by this method. If Name is "xmlns" or uses the "xmlns" prefix, the attribute will be interpreted as a namespace declaration, regardless of the value of NamespaceURI. Similarly, any attribute using the "xml" prefix will be interpreted as a special attribute (like "xml:lang") and NamespaceURI will be ignored.

put_c_data Method

Writes an XML CDATA block.

Syntax

def put_c_data(text: str) -> None: ...

Remarks

Writes a new XML CDATA block with the specified text inside the current element.

put_comment Method

Writes an XML comment block.

Syntax

def put_comment(text: str) -> None: ...

Remarks

Writes a new XML comment block with the specified text.

put_element Method

Writes a simple XML element with a value.

Syntax

def put_element(name: str, namespace_uri: str, value: str) -> None: ...

Remarks

Writes a simple XML element with no attributes and the specified value between the opening and closing tags.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling put_element or start_element, if a NamespaceURI is not specified an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

put_raw Method

Writes a raw XML fragment.

Syntax

def put_raw(text: str) -> None: ...

Remarks

Writes a raw XML fragment to the output, without escaping and without verification. If an XML element opening tag has been written, before the raw fragment, the fragment will be written as a child of the current element.

Use of this method should be carefully considered as it can easily lead to malformed XML content.

put_string Method

Writes text inside an XML element.

Syntax

def put_string(text: str) -> None: ...

Remarks

This method will XML escape the value provided and write the resulting escaped text between the opening and closing tags of an XML element.

remove_attr Method

Remove a attribute.

Syntax

def remove_attr(attr_name: str) -> None: ...

Remarks

This method removes an attribute at the specified xpath

This functionality is not yet implemented.

remove_children Method

Removes the children of the elment as the specified XPath.

Syntax

def remove_children() -> None: ...

Remarks

This method removes the children of the element specified by xpath.

When called the class will remove the children of the element from the internal representation of the XML (the DOM). The element itself remains, with no children. This may be used at any time after parse returns, or from within the on_end_element event as a document is parsed in order to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM memory consumption is reduced and overall performance is improved.

RemoveChildren Example:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the children of the apple element while leaving the apple element in place.

xml.XPath = "/food/fruits/apple"; xml.RemoveChildren();

The XML stored in the DOM is now:

<food>
	<fruits>
		<apple>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

remove_element Method

Removes the elment as the specified XPath.

Syntax

def remove_element() -> None: ...

Remarks

This method removes the element specified by xpath.

When called the class will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after parse returns, or from within the on_end_element event as a document is parsed in order to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM memory consumption is reduced and overall performance is improved.

RemoveElement Example:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the apple element and its children.

xml.XPath = "/food/fruits/apple"; xml.RemoveElement();

The XML stored in the DOM is now:

<food>
	<fruits>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

reset Method

Resets the parser.

Syntax

def reset() -> None: ...

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

reset must also be used as signal to the parser that the current stream of text has terminated.

save Method

Closes the class writing stream.

Syntax

def save() -> None: ...

Remarks

This method will close any open XML elements, and then close the output_file if necessary.

save_dom Method

Saves the DOM to a file.

Syntax

def save_dom(file_name: str) -> None: ...

Remarks

The save_dom method saves the current DOM structure to the file specified in FileName. This enables the component to later load the DOM without incurring any parsing overhead.

Please refer to the load_dom method for more information.

start_element Method

Writes the opening tag of an XML element.

Syntax

def start_element(name: str, namespace_uri: str) -> None: ...

Remarks

Writes the opening tag of a new XML element. If an XML element is already opened, then this element is written as a child.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling put_element or start_element, if a NamespaceURI is not specified an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

try_xpath Method

Navigates to the specified XPath if it exists.

Syntax

def try_xpath(xpath: str) -> bool: ...

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists the xpath property will be updated and this method returns True.

If the XPath does not exist the xpath property is not updated and this method returns False.

on_characters Event

Fired for plain text segments of the input stream.

Syntax

class XMLCharactersEventParams(object):
  @property
  def text() -> str: ...

# In class XML:
@property
def on_characters() -> Callable[[XMLCharactersEventParams], None]: ...
@on_characters.setter
def on_characters(event_hook: Callable[[XMLCharactersEventParams], None]) -> None: ...

Remarks

The on_characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the on_ignorable_whitespace event.

on_comment Event

Fired when a comment section is encountered.

Syntax

class XMLCommentEventParams(object):
  @property
  def text() -> str: ...

# In class XML:
@property
def on_comment() -> Callable[[XMLCommentEventParams], None]: ...
@on_comment.setter
def on_comment(event_hook: Callable[[XMLCommentEventParams], None]) -> None: ...

Remarks

The on_comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

on_end_element Event

Fired when an end-element tag is encountered.

Syntax

class XMLEndElementEventParams(object):
  @property
  def namespace() -> str: ...

  @property
  def element() -> str: ...

  @property
  def q_name() -> str: ...

  @property
  def is_empty() -> bool: ...

# In class XML:
@property
def on_end_element() -> Callable[[XMLEndElementEventParams], None]: ...
@on_end_element.setter
def on_end_element(event_hook: Callable[[XMLEndElementEventParams], None]) -> None: ...

Remarks

The on_end_element event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

on_end_prefix_mapping Event

Fired when leaving the scope of a namespace declaration.

Syntax

class XMLEndPrefixMappingEventParams(object):
  @property
  def prefix() -> str: ...

# In class XML:
@property
def on_end_prefix_mapping() -> Callable[[XMLEndPrefixMappingEventParams], None]: ...
@on_end_prefix_mapping.setter
def on_end_prefix_mapping(event_hook: Callable[[XMLEndPrefixMappingEventParams], None]) -> None: ...

Remarks

The on_start_prefix_mapping event is fired when entering the scope of a namespace declaration.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class XMLErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class XML:
@property
def on_error() -> Callable[[XMLErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[XMLErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_eval_entity Event

Fired every time an entity needs to be evaluated.

Syntax

class XMLEvalEntityEventParams(object):
  @property
  def entity() -> str: ...

  @property
  def value() -> str: ...
  @value.setter
  def value(value) -> None: ...

# In class XML:
@property
def on_eval_entity() -> Callable[[XMLEvalEntityEventParams], None]: ...
@on_eval_entity.setter
def on_eval_entity(event_hook: Callable[[XMLEvalEntityEventParams], None]) -> None: ...

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

on_ignorable_whitespace Event

Fired when a section of ignorable whitespace is encountered.

Syntax

class XMLIgnorableWhitespaceEventParams(object):
  @property
  def text() -> str: ...

# In class XML:
@property
def on_ignorable_whitespace() -> Callable[[XMLIgnorableWhitespaceEventParams], None]: ...
@on_ignorable_whitespace.setter
def on_ignorable_whitespace(event_hook: Callable[[XMLIgnorableWhitespaceEventParams], None]) -> None: ...

Remarks

The ignorable whitespace section is provided by the Text parameter.

on_meta Event

Fired when a meta section is encountered.

Syntax

class XMLMetaEventParams(object):
  @property
  def text() -> str: ...

# In class XML:
@property
def on_meta() -> Callable[[XMLMetaEventParams], None]: ...
@on_meta.setter
def on_meta(event_hook: Callable[[XMLMetaEventParams], None]) -> None: ...

Remarks

The on_meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

on_pi Event

Fired when a processing instruction section is encountered.

Syntax

class XMLPIEventParams(object):
  @property
  def text() -> str: ...

# In class XML:
@property
def on_pi() -> Callable[[XMLPIEventParams], None]: ...
@on_pi.setter
def on_pi(event_hook: Callable[[XMLPIEventParams], None]) -> None: ...

Remarks

The on_pi event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

on_special_section Event

Fired when a special section is encountered.

Syntax

class XMLSpecialSectionEventParams(object):
  @property
  def section_id() -> str: ...

  @property
  def text() -> str: ...

# In class XML:
@property
def on_special_section() -> Callable[[XMLSpecialSectionEventParams], None]: ...
@on_special_section.setter
def on_special_section(event_hook: Callable[[XMLSpecialSectionEventParams], None]) -> None: ...

Remarks

The on_special_section event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, while the SectionId parameter provides the section identifier (e.g. "CDATA").

on_start_element Event

Fired when a begin-element tag is encountered in the document.

Syntax

class XMLStartElementEventParams(object):
  @property
  def namespace() -> str: ...

  @property
  def element() -> str: ...

  @property
  def q_name() -> str: ...

  @property
  def is_empty() -> bool: ...

# In class XML:
@property
def on_start_element() -> Callable[[XMLStartElementEventParams], None]: ...
@on_start_element.setter
def on_start_element(event_hook: Callable[[XMLStartElementEventParams], None]) -> None: ...

Remarks

The on_start_element event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the attr_name, attr_namespace, attr_prefix, and attr_value properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

on_start_prefix_mapping Event

Fired when entering the scope of a namespace declaration.

Syntax

class XMLStartPrefixMappingEventParams(object):
  @property
  def prefix() -> str: ...

  @property
  def uri() -> str: ...

# In class XML:
@property
def on_start_prefix_mapping() -> Callable[[XMLStartPrefixMappingEventParams], None]: ...
@on_start_prefix_mapping.setter
def on_start_prefix_mapping(event_hook: Callable[[XMLStartPrefixMappingEventParams], None]) -> None: ...

Remarks

The on_end_prefix_mapping event is fired when leaving the scope of a namespace declaration.

on_xml Event

Fires as XML is written.

Syntax

class XMLXMLEventParams(object):
  @property
  def text() -> str: ...

# In class XML:
@property
def on_xml() -> Callable[[XMLXMLEventParams], None]: ...
@on_xml.setter
def on_xml(event_hook: Callable[[XMLXMLEventParams], None]) -> None: ...

Remarks

This event fires when XML is output. The Text parameter holds the data being written.

This functionality is not yet implemented.

XML Config Settings

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

XML Errors

XML Errors