ensure_tar_xml

ensure_tar_xml(key, *subkeys, url, inner_path, name=None, force=False, download_kwargs=None, parse_kwargs=None)[source]

Download a tar file and open an inner file as an XML with lxml.

Parameters:

  • key (str) – The module name

  • subkeys (str) – A sequence of additional strings to join. If none are given, returns the directory for this module.

  • url (str) – The URL to download.

  • inner_path (str) – The relative path to the file inside the archive

  • name (Optional[str]) – Overrides the name of the file at the end of the URL, if given. Also useful for URLs that don’t have proper filenames with extensions.

  • force (bool) – Should the download be done again, even if the path already exists? Defaults to false.

  • download_kwargs (Optional[Mapping[str, Any]]) – Keyword arguments to pass through to pystow.utils.download().

  • parse_kwargs (Optional[Mapping[str, Any]]) – Keyword arguments to pass through to lxml.etree.parse().

Returns:

An ElementTree object

Warning

If you have lots of files to read in the same archive, it’s better just to unzip first.