get_archived_path(archive_path: Union[str, CloudPath, Path], file_regex: str, as_list: bool = False) Union[list, CloudPath, Path][source]#

Get archived file path from inside the archive.


If as_list is False, it will only return the first file matched !

You can use this site to build your regex.

>>> arch_path = 'D:/path/to/'
>>> file_regex = '.*dir.*file_name'  # Use .* for any character
>>> path = get_archived_path(arch_path, file_regex)
  • archive_path (AnyPathStrType) – Archive path

  • file_regex (str) – File regex (used by re) as it can be found in the getmembers() list

  • as_list (bool) – If true, returns a list (including all found files). If false, returns only the first match


Path from inside the zipfile

Return type:

Union[list, str]