XML

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

Bases: object

Class for working with XML files.

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

Attributes
  • reader (compas.files.XMLReader, read-only) – Reader used to process the XML file or string.

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

  • filepath (str) – The path to the XML file.

  • root (xml.etree.ElementTree.Element) – Root element of the XML tree.

Examples

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

Methods

from_file

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

from_string

Read XML from a string.

read

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

to_file

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

to_string

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

write

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