XML

class compas.files.XML(filepath=None)[source]

Bases: object

Read XML files.

This class simplifies reading XML files and strings across different Python implementations.

Attributes
  • reader (XMLReader) – Reader used to process the XML file or string.

  • writer (XMLWriter) – Writer used to process the XML object to a file or string.

  • filepath (str)

Examples

>>> from compas.files import XML
>>> xml = XML.from_string("<Main><Title>Test</Title></Main>")
>>> xml.root.tag
'Main'

Methods

__init__([filepath])

Initialize self.

from_file(source)

Read XML from a file path or file-like object.

from_string(text)

Read XML from a string.

read()

Read XML from a file path or file-like object, stored in the attribute filepath.

to_file([prettify])

Writes the string representation of this XML instance, including all sub-elements, to the file path in the associated XML object.

to_string([encoding, prettify])

Generate a string representation of this XML instance, including all sub-elements.

write([prettify])

Writes the string representation of this XML instance, including all sub-elements, to the file path in the associated XML object.