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 Document Object Model (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 that 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 are accessible only through the events.

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

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:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element
When xpath is set to a valid path, xelement points to the name of the element, with xparent, xnamespace, xprefix, xchild_name, xchild_namespace, xchild_prefix, xchild_x_text, and xtext providing other properties of the element. The attributes of the current element are provided in the attr_name, attr_namespace, attr_prefix, and attr_value properties.

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

Example. Setting XPath:

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

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:

When a valid source is found, the search stops.

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, and so on 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:

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.

build_domWhen set to True, this property creates an internal object model of the XML document.
input_dataThis property specifies the XML data to parse.
input_fileThis property specifies the file to process.
namespace_countThe number of records in the Namespace arrays.
namespace_prefixThis property contains the Prefix for the Namespace .
namespace_uriThis property contains the namespace URI associated with the corresponding Prefix .
output_dataThe output XML after processing.
output_fileThis property includes the path to a local file where the output will be written.
overwriteThis property indicates whether or not the class should overwrite files.
validateThis property controls whether documents are validated during parsing.
attr_countThe number of records in the Attr arrays.
attr_nameThe Name provides the local name (without prefix) of the attribute.
attr_namespaceThis property contains the attribute namespace.
attr_prefixThis property contains the attribute prefix (if any).
attr_valueThis property contains the attribute value.
xchild_countThe number of records in the XChild arrays.
xchild_nameThe Name property provides the local name (without a prefix) of the element.
xchild_namespaceThis property contains the namespace of the element.
xchild_prefixThis property contains the prefix of the element (if any).
xchild_x_textThis property contains the inner text of the element.
xcomment_countThe number of records in the XComment arrays.
xcomment_textThis property holds the comment text.
xelementThis property includes the name of the current element.
xml_declaration_encodingThis property specifies the XML encoding to use.
xml_declaration_standaloneThis property indicates whether the standalone attribute is present in the declaration with a value of True.
xml_declaration_versionThis property specifies the XML version.
xnamespaceThis property includes the namespace of the current element.
xparentThis property includes the parent of the current element.
xpathThis property provides a way to point to a specific element in the document.
xprefixThis property includes the prefix of the current element.
xsub_treeThis property includes a snapshot of the current element in the document.
xtextThis property includes the text of the current element.

Method List


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

configSets or retrieves a configuration setting.
end_elementThis method writes the closing tag of an open XML element.
flushThis method flushes the parser and checks its end state.
get_attrThis method returns the value of the specified attribute.
has_xpathThis method determines whether a specific element exists in the document.
load_domThis method loads the document object model (DOM) from a file.
load_schemaThis method loads the XML schema.
parseThis method parses the specified XML data.
put_attrThis method writes an XML attribute.
put_c_dataThis method writes an XML CDATA block.
put_commentThis method writes an XML comment block.
put_elementThis method writes a simple XML element with a value.
put_rawThis method writes a raw XML fragment.
put_stringThis method writes text inside an XML element.
remove_attrThis method removes an attribute.
remove_childrenThis method removes the children of the element as the specified XPath.
remove_elementThis method removes the element as the specified XPath.
resetThis method resets the parser.
saveThis method closes the class writing stream.
save_domThis method saves the DOM to a file.
start_elementThis method writes the opening tag of an XML element.
try_xpathThis method navigates to the specified XPath if it exists.

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.

on_charactersThis event is fired for plaintext segments of the input stream.
on_commentThis event is fired when a comment section is encountered.
on_end_elementThis event is fired when an end-element tag is encountered.
on_end_prefix_mappingThis event is fired when leaving the scope of a namespace declaration.
on_errorFired when information is available about errors during data delivery.
on_eval_entityThis event is fired every time an entity needs to be evaluated.
on_ignorable_whitespaceThis event is fired when a section of ignorable whitespace is encountered.
on_metaThis event fires when a meta section is encountered.
on_piThis event is fired when a processing instruction section is encountered.
on_special_sectionThis event is fired when a special section is encountered.
on_start_elementThis event is fired when a begin-element tag is encountered in the document.
on_start_prefix_mappingThis event is fired when entering the scope of a namespace declaration.
on_xmlThis event is fired as XML is written.

Config Settings


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

CacheContentIf true, the original XML is saved in a buffer.
CharsetSpecifies the charset used when encoding data.
EOLThe characters to use for separating lines.
ErrorOnEmptyAttrIf true, passing an invalid attribute to the Attr method will throw an exception.
ExtraNameCharsExtra characters for the parser to consider as name characters.
ExtraSpaceCharsExtra characters for the parser to consider as white space.
FlushOnEOLIf set, the parser flushes its text buffer after every line of text.
IgnoreBadAttributePrefixesIf true, bad (unknown) attribute prefixes are ignored.
IgnoreBadElementPrefixesIf true, bad (unknown) element prefixes are ignored.
IncludeElementPrefixWhether to include the prefix in the element name.
IncludeXMLDeclarationWhether to include the XML declaration when writing XML.
IndentThe characters to use for each indentation level.
OffsetCurrent offset of the document being parsed.
PreserveWhitespaceIf true, leading and trailing whitespace in element text is preserved.
QuoteCharQuote character to use for attribute values.
StringProcessingOptionsDefines options to use when processing string values.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

build_dom Property

When set to True, this property creates an internal object model of the XML document.

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

This property specifies 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 property may be set to a complete XML document or to 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:

When a valid source is found, the search stops.

input_file Property

This property specifies 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 that 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:

When a valid source is found, the search stops.

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:

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

namespace_prefix Property

This property contains 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

This property contains 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

This property contains the 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

This property contains the namespace URI associated with the corresponding namespace_prefix. This URL is usually 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

This property includes 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

This 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 in which 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:

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

This property contains the attribute namespace.

Syntax

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

Default Value

""

Remarks

This property contains the 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

This property contains the attribute prefix (if any).

Syntax

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

Default Value

""

Remarks

This property contains the 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

This property contains the attribute value.

Syntax

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

Default Value

""

Remarks

This property contains the 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.

xchild_count Property

The number of records in the XChild arrays.

Syntax

def get_xchild_count() -> int: ...
def set_xchild_count(value: int) -> None: ...

xchild_count = property(get_xchild_count, set_xchild_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

xchild_name Property

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

Syntax

def get_xchild_name(xchild_index: int) -> str: ...

Default Value

""

Remarks

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

The xchild_index parameter specifies the index of the item in the array. The size of the array is controlled by the xchild_count property.

This property is read-only.

xchild_namespace Property

This property contains the namespace of the element.

Syntax

def get_xchild_namespace(xchild_index: int) -> str: ...

Default Value

""

Remarks

This property contains the namespace of the element.

The xchild_index parameter specifies the index of the item in the array. The size of the array is controlled by the xchild_count property.

This property is read-only.

xchild_prefix Property

This property contains the prefix of the element (if any).

Syntax

def get_xchild_prefix(xchild_index: int) -> str: ...

Default Value

""

Remarks

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

The xchild_index parameter specifies the index of the item in the array. The size of the array is controlled by the xchild_count property.

This property is read-only.

xchild_x_text Property

This property contains the inner text of the element.

Syntax

def get_xchild_x_text(xchild_index: int) -> str: ...

Default Value

""

Remarks

This property contains the inner text of the element.

The xchild_index parameter specifies the index of the item in the array. The size of the array is controlled by the xchild_count property.

This property is read-only.

xcomment_count Property

The number of records in the XComment arrays.

Syntax

def get_xcomment_count() -> int: ...
def set_xcomment_count(value: int) -> None: ...

xcomment_count = property(get_xcomment_count, set_xcomment_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

xcomment_text Property

This property holds the comment text.

Syntax

def get_xcomment_text(xcomment_index: int) -> str: ...
def set_xcomment_text(xcomment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the comment text.

The xcomment_index parameter specifies the index of the item in the array. The size of the array is controlled by the xcomment_count property.

xelement Property

This property includes the name of the current element.

Syntax

def get_xelement() -> str: ...
def set_xelement(value: str) -> None: ...

xelement = property(get_xelement, set_xelement)

Default Value

""

Remarks

The current element is specified through 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 applicable only 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 applicable only 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 applicable only when writing XML.

xnamespace Property

This property includes the namespace of the current element.

Syntax

def get_xnamespace() -> str: ...
def set_xnamespace(value: str) -> None: ...

xnamespace = property(get_xnamespace, set_xnamespace)

Default Value

""

Remarks

The current element is specified through the xpath property.

xparent Property

This property includes the parent of the current element.

Syntax

def get_xparent() -> str: ...

xparent = property(get_xparent, None)

Default Value

""

Remarks

The current element is specified through the xpath property.

This property is read-only.

xpath Property

This 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:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element
When xpath is set to a valid path, xelement points to the name of the element, with xparent, xnamespace, xprefix, xchild_name, xchild_namespace, xchild_prefix, xchild_x_text, and xtext providing other properties of the element. The attributes of the current element are provided in the attr_name, attr_namespace, attr_prefix, and attr_value properties.

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

Example. Setting XPath:

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

xprefix Property

This property includes the prefix of the current element.

Syntax

def get_xprefix() -> str: ...
def set_xprefix(value: str) -> None: ...

xprefix = property(get_xprefix, set_xprefix)

Default Value

""

Remarks

The current element is specified through the xpath property.

xsub_tree Property

This property includes a snapshot of the current element in the document.

Syntax

def get_xsub_tree() -> str: ...

xsub_tree = property(get_xsub_tree, None)

Default Value

""

Remarks

The current element is specified through the xpath property. For this property to work, you must set the CacheContent to True.

This property is read-only.

xtext Property

This property includes the text of the current element.

Syntax

def get_xtext() -> str: ...
def set_xtext(value: str) -> None: ...

xtext = property(get_xtext, set_xtext)

Default Value

""

Remarks

The current element is specified through 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

This method writes the closing tag of an open XML element.

Syntax

def end_element() -> None: ...

Remarks

This method 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

This 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

This 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

This 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 through xpath.

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

See xpath for details on the XPath syntax.

load_dom Method

This method loads the document object model (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

This method loads 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 whether or not 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 are accessible only through the events.

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

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:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element
When xpath is set to a valid path, xelement points to the name of the element, with xparent, xnamespace, xprefix, xchild_name, xchild_namespace, xchild_prefix, xchild_x_text, and xtext providing other properties of the element. The attributes of the current element are provided in the attr_name, attr_namespace, attr_prefix, and attr_value properties.

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

Example. Setting XPath:

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

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:

When a valid source is found, the search stops.

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

put_attr Method

This method writes an XML attribute.

Syntax

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

Remarks

This method 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

This method writes an XML CDATA block.

Syntax

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

Remarks

This methods writes a new XML CDATA block with the specified text inside the current element.

put_comment Method

This method writes an XML comment block.

Syntax

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

Remarks

This method writes a new XML comment block with the specified text.

put_element Method

This method writes a simple XML element with a value.

Syntax

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

Remarks

This method 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>
Use the following code: xml.StartElement("book", "urn:loc.gov:books"); xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6"); xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen"); xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379"); xmlw.Close(); In this example, the "title" element uses the default namespace "urn:loc.gov:books" and the "number" element uses the "urn:ISBN:0-395-36341-6" namespace as defined for the "isbn" prefix.

put_raw Method

This method writes a raw XML fragment.

Syntax

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

Remarks

This method 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

This 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

This method removes an 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

This method removes the children of the element 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 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.

Example. RemoveChildren:

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

This method removes the element 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 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.

Example. RemoveElement:

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

This 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

This 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

This 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

This method writes the opening tag of an XML element.

Syntax

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

Remarks

This method 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>
Use the following code: xml.StartElement("book", "urn:loc.gov:books"); xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6"); xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen"); xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379"); xmlw.Close(); In this example, the "title" element uses the default namespace "urn:loc.gov:books" and the "number" element uses the "urn:ISBN:0-395-36341-6" namespace as defined for the "isbn" prefix.

try_xpath Method

This 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

This event is fired for plaintext 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 plaintext 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

This event is 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

This event is 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 to an empty element declaration.

on_end_prefix_mapping Event

This event is 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

This event is 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

This event is 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

This event fires 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

This event is 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

This event is 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, and the SectionId parameter provides the section identifier (e.g., CDATA).

on_start_element Event

This event is 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 to an empty element declaration.

on_start_prefix_mapping Event

This event is 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

This event is fired 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 is fired when XML is output. The Text parameter holds the data being written.

This functionality is not yet implemented.

XML Config Settings

The class accepts one or more of the following configuration settings. Configuration 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.

XML Config Settings

CacheContent:   If true, the original XML is saved in a buffer.

This configuration setting controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is True.

Charset:   Specifies the charset used when encoding data.

This configuration setting specifies the character set used when encoding data. This value will also be used when creating the xml_declaration. The default value is "utf-8".

EOL:   The characters to use for separating lines.

If specified, the class will format the output XML, using the specified characters to separate multiple lines for nested XML elements. The default value is CRLF ("\r\n") .

This option should be combined with Indent for full effect.

ErrorOnEmptyAttr:   If true, passing an invalid attribute to the Attr method will throw an exception.

If an invalid attribute name is passed into the get_attr method, the method will return with an empty string if this is set to False; otherwise, an exception is thrown.

ExtraNameChars:   Extra characters for the parser to consider as name characters.

Normally, the parser considers only the following characters as part of an XML identifier: 'A' through 'Z', 'a' through 'z', '0' through '9', and '.', '-', '_', ':'.

If you would like any other characters to be considered as name characters, you may set them as a string into this property.

ExtraSpaceChars:   Extra characters for the parser to consider as white space.

Normally, the parser considers only the following characters as white space: ' ' (space), '\t' (tab), '\ n' (newline), '\r' (carriage return), '\f' (form feed), and '\v' (vertical tab).

If you would like any other characters to be considered as white space, you may set them as a string into this property.

FlushOnEOL:   If set, the parser flushes its text buffer after every line of text.

The FlushOnEOL property controls whether or not on_characters events are fired for every line of the input text stream. Normally, lines are buffered internally and delivered in batches, but if the FlushOnEOL flag is set, then a on_characters event is fired for each line.

IgnoreBadAttributePrefixes:   If true, bad (unknown) attribute prefixes are ignored.

Normally a trappable error is generated when an unknown attribute prefix is encountered. This configuration setting suppresses the error. The default value is True.

IgnoreBadElementPrefixes:   If true, bad (unknown) element prefixes are ignored.

Normally a trappable error is generated when an unknown element prefix is encountered. This configuration setting suppresses the error. The default value is True.

IncludeElementPrefix:   Whether to include the prefix in the element name.

This configuration setting specifies whether or not to include the element prefix in the Element parameter of the on_start_element and on_end_element events.

If False (default) and validate is set to False, the prefix is included in the Element parameter (e.g., ds:DigestMethod).

If True and validate is set to False, the prefix is not included in the Element parameter (e.g., DigestMethod).

This setting is applicable only when validate is False.

IncludeXMLDeclaration:   Whether to include the XML declaration when writing XML.

This configuration setting specifies whether the XML declaration is included in the output XML when writing XML. When set to True (default), the XML declaration will be included above any user-specified XML. For instance:

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...
Indent:   The characters to use for each indentation level.

If specified, the class will format the output XML, using the specified characters to denote each indentation level for nested XML elements.

This option should be combined with EOL for full effect.

Offset:   Current offset of the document being parsed.

This property is useful for determining the location of possible XML errors in the document.

Offset values start at 1.

PreserveWhitespace:   If true, leading and trailing whitespace in element text is preserved.

Normally, the leading and trailing whitespace from an element's text is trimmed. When this property is set to True, this leading and trailing whitespace is preserved. The default value is False.

QuoteChar:   Quote character to use for attribute values.

By default, the class will use double quotes around attribute values. This property can be used to specify a different character, such as a single quote.

StringProcessingOptions:   Defines options to use when processing string values.

This configuration setting determines what additional processing is performed on string values fired through the on_characters event.

Note: This applies only when build_dom is False.

By default, no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are as follows:

0 (none - default) No additional processing is performed.
1 Strings are XML unescaped.

For instance, when set to 0, the following text may be fired through the on_characters event:

&amp;&quot;&lt;&gt;

When set to 1, the following text would be fired through the on_characters event:

&"<>

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

XML Errors

XML Errors

101   Invalid attribute index.
102   No attributes available.
103   Invalid namespace index.
104   No namespaces available.
105   Invalid element index.
106   No elements available.
107   Attribute does not exist.
201   Unbalanced element tag.
202   Unknown element prefix (cannot find namespace).
203   Unknown attribute prefix (cannot find namespace).
204   Invalid XML markup.
205   Invalid end state for parser.
206   Document contains unbalanced elements.
207   Invalid xpath.
208   No such child.
209   Top element does not match start of path.
210   DOM tree unavailable (set build_dom to True and reparse).
302   Cannot open file.
401   Invalid XML would be generated.
402   An invalid XML name has been specified.