get_readable_fileobj(name_or_obj, encoding=None, cache=False, show_progress=True, remote_timeout=None, sources=None, http_headers=None)¶
Yield a readable, seekable file-like object from a file or URL.
This supports passing filenames, URLs, and readable file-like objects, any of which can be compressed in gzip, bzip2 or lzma (xz) if the appropriate compression libraries are provided by the Python installation.
- name_or_objstr or file-like object
The filename of the file to access (if given as a string), or the file-like object to access.
If a file-like object, it must be opened in binary mode.
- encodingstr, optional
None(default), returns a file-like object with a
readmethod that returns
unicode) objects, using
locale.getpreferredencodingas an encoding. This matches the default behavior of the built-in
modeargument is provided.
'binary', returns a file-like object where its
When another string, it is the name of an encoding, and the file-like object’s
readmethod will return
unicode) objects, decoded from binary using the given encoding.
- cachebool or “update”, optional
Whether to cache the contents of remote URLs. If “update”, check the remote URL for a new version but store the result in the cache.
- show_progressbool, optional
Whether to display a progress bar if the file is downloaded from a remote server. Default is
Timeout for remote requests in seconds (default is the configurable
astropy.utils.data.Conf.remote_timeout, which is 3s by default)
- sourceslist of str, optional
If provided, a list of URLs to try to obtain the file from. The result will be stored under the original URL. The original URL will not be tried unless it is in this list; this is to prevent long waits for a primary server that is known to be inaccessible at the moment.
- http_headersdict or None
HTTP request headers to pass into
urlopenif needed. (These headers are ignored if the protocol for the
sourcesentry is not a remote HTTP URL.) In the default case (None), the headers are
Accept: */*, where
some_valueis set by
- filereadable file-like object
This function is a context manager, and should be used for example as:
with get_readable_fileobj('file.dat') as f: contents = f.read()
If a URL is provided and the cache is in use, the provided URL will be the name used in the cache. The contents may already be stored in the cache under this URL provided, they may be downloaded from this URL, or they may be downloaded from one of the locations listed in