launch_xml package

Subpackages

Submodules

Module contents

Main entry point for the launch_xml package.

class launch_xml.Entity(*args: Any, **kwargs: Any)

Bases: Entity

Single item in the intermediate XML front_end representation.

assert_entity_completely_parsed()
property children: List[Entity]

Get the Entity’s children.

get_attr(name: str, *, data_type: launch.utilities.type_utils.AllowedTypesType = <class 'str'>, optional: bool = False, can_be_str: bool = True) launch.utilities.type_utils.AllowedValueType | List[Entity] | None

Access an attribute of the entity.

See launch.frontend.Entity.get_attr(). launch_xml uses type coercion. If coercion fails, ValueError will be raised.

property parent: Entity | None

Get Entity parent.

property type_name: str

Get Entity type.

class launch_xml.Parser(*args: Any, **kwargs: Any)

Bases: Parser

XML parser implementation.

classmethod get_file_extensions() Set[str]

Return the set of file extensions known to this parser.

classmethod load(file: str | ~io.TextIOBase) -> (<class 'launch_xml.entity.Entity'>, 'Parser')

Return entity loaded from XML file.