gws.lib.xmlx

XML-related utilities and helpers.

Source code: gws.lib.xmlx

Submodules

• gws.lib.xmlx.element
• gws.lib.xmlx.error
• gws.lib.xmlx.helper
• gws.lib.xmlx.namespace
• gws.lib.xmlx.parser
• gws.lib.xmlx.tag

Package Contents

gws.lib.xmlx.from_path(path: str, case_insensitive: bool = False, compact_whitespace: bool = False, normalize_namespaces: bool = False, remove_namespaces: bool = False) → gws.XmlElement

Creates an IXmlElement object from a .xlm file.

Parameters:

• path – Path to the .xml file.

• case_insensitive – If true tags will be written in lowercase into the IXmlElement object.

• compact_whitespace – If true all whitespaces and newlines are omitted.

• normalize_namespaces –

• remove_namespaces – Removes all occurrences of namespaces.

Returns:

The IXmlElement object.

gws.lib.xmlx.from_string(inp: str | bytes, case_insensitive: bool = False, compact_whitespace: bool = False, remove_namespaces: bool = False, normalize_namespaces: bool = False) → gws.XmlElement

Creates an IXmlElement from a string or bytes.

Parameters:

• inp – .xml file as a string or bytes.

• case_insensitive – If true tags will be written in lowercase into the IXmlElement object.

• compact_whitespace – If true all whitespaces and newlines are omitted.

• normalize_namespaces –

• remove_namespaces – Removes all occurrences of namespaces.

Returns:

The IXmlElement object.

gws.lib.xmlx.tag(name: str, *args, **kwargs) → gws.XmlElement

Build an XML element from arguments.

Parameters:

• name – A tag name or names.

• *args – A collection of args.

• **kwargs – Additional attributes.

Returns:

An XML element.

exception gws.lib.xmlx.Error

Bases: gws.Error

GWS error.

exception gws.lib.xmlx.ParseError

Bases: Error

GWS error.

exception gws.lib.xmlx.WriteError

Bases: Error

GWS error.

exception gws.lib.xmlx.BuildError

Bases: Error

GWS error.