read_archive

Contents

read_archive#

read_archive(path: str | CloudPath | Path, regex: str | None = None, file_list: list | None = None) → _Element[source]#

Read an XML file from inside an archive (zip or tar) Convenient duplicate of files.read_archived_xml

Manages two cases:

  • complete path to an XML file stored inside an archive. In this case the filetree from inside the archive should be separated with a !. Don’t need to start with zip or tar

  • path to the archive plus a regex looking inside the archive. Duplicate behaviour to files.read_archived_xml

Parameters:

  • path (AnyPathStrType) – Path to the XML file, stored inside an archive or path to the archive itself

  • regex (str) – Optional. If specified, the path should be the archive path and the regex should be the key to find the XML file inside the archive.

  • file_list (list) – List of files contained in the archive. Optional, if not given it will be re-computed.

Returns:

XML Root

Return type:

_Element

Contents