ensure_open_gz
- ensure_open_gz(key, *subkeys, url, name=None, force=False, download_kwargs=None, mode='rb', open_kwargs=None)[source]
Ensure a gzipped file is downloaded and open a file inside it.
- Parameters:
key (
str
) – The name of the module. No funny characters. The envvar <key>_HOME where key is uppercased is checked first before using the default home directory.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.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 topystow.utils.download()
.mode (
str
) – The read mode, passed togzip.open()
open_kwargs (
Optional
[Mapping
[str
,Any
]]) – Additional keyword arguments passed togzip.open()
- Yields:
An open file object
- Return type: