remfile
Provides a file-like object for reading a remote file over HTTP, optimized for use with h5py.
Example usage:
# See examples/example1.py
import h5py
import remfile
url = 'https://dandiarchive.s3.amazonaws.com/blobs/d86/055/d8605573-4639-4b99-a6d9-e0ac13f9a7df'
file = remfile.File(url)
with h5py.File(file, 'r') as f:
print(f['/'].keys())
See examples/example1.py for a more complete example.
Note: url can either be a string or an object that has a get_url() method. The latter is useful if the url is a presigned AWS URL that expires after a certain amount of time. However, if you implement your own get_url() method, make sure it renews the signed URL only when necessary.
Installation
pip install remfile
Why?
The conventional way of reading a remote hdf5 file is to use the fsspec library as in examples/example1_compare_fsspec.py. However, this approach is empirically much slower than using remfile. I am not familiar with the inner workings of fsspec, but it appears that it is not optimized for reading hdf5 files. Efficient access of remote hdf5 files requires reading small chunks of data to obtain meta information, and then large chunks of data, and parallelization, to obtain the larger data arrays.
See a timing comparison betweeen remfile and fsspec in the examples directory.
Furthermore, since the url can be an object with a get_url() method, it is possible to use remfile in a context where presigned URLs need to be renewed. As mentioned above, if you implement your own get_url() method, make sure it renews the signed URL only when necessary.
How?
A file-like object is created that reads the remote file in chunks using the requests library. A relatively small default chunk size is used, but when remfile detects that a large data array is being accessed, it adaptively switches to larger chunk sizes. For very large data arrays, the system will use multiple threads to read the data in parallel.
Timeouts and closing
Each HTTP request times out after 30 seconds without connecting or 60 seconds without receiving data, so that a stalled connection cannot hang forever. A request that times out is retried like any other failed request. Pass timeout to change this (a number, or a (connect, read) tuple, as accepted by requests), or timeout=None for no timeout.
A file can be used as a context manager, which closes its connections on exit:
with remfile.File(url) as file, h5py.File(file, 'r') as f:
print(f['/'].keys())
Disk caching
The following example shows how to use disk caching. It is important to note that this is not an LRU cache, so there is no cleanup operation. The cache will grow until the disk is full. Therefore, you are responsible for deleting the directory when you are done with it.
import remfile
url = 'https://dandiarchive.s3.amazonaws.com/blobs/d86/055/d8605573-4639-4b99-a6d9-e0ac13f9a7df'
cache_dirname = '/tmp/remfile_test_cache'
disk_cache = remfile.DiskCache(cache_dirname)
file = remfile.File(url, disk_cache=disk_cache)
with h5py.File(file, 'r') as f:
print(f['/'].keys())
Caveats
This library is not intended to be a general purpose library for reading remote files. It is optimized for reading hdf5 files.
Comparison with fsspec method
License
Apache 2.0
Author
Jeremy Magland, Center for Computational Mathematics, Flatiron Institute
Metadata
Release files for remfile 0.1.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| remfile-0.1.16.tar.gz | 23.5 kB | With provenance | Details for remfile-0.1.16.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| remfile-0.1.16-py3-none-any.whl | Python 3 | none | any | Details for remfile-0.1.16-py3-none-any.whl |
Total release size: 39.4 kB
Release files / remfile-0.1.16.tar.gz
| Download URL | remfile-0.1.16.tar.gz |
|---|---|
| Size | 23.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c360b1fc2dc59190cc40539c965c148a43d52e0d56377ea33ad3bd5da01b5fea
|
|
BLAKE2b-256 checksum How to use checksums |
681b485d424b2b425b631baefb173669314319a89f79fa8a2926e07e9c00f24c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.
Transparency logRelease files / remfile-0.1.16-py3-none-any.whl
| Download URL | remfile-0.1.16-py3-none-any.whl |
|---|---|
| Size | 15.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
77a22792d5ad79049fc55d95c9bac97e4e9659266907ad4a1bde276e5d6d6916
|
|
BLAKE2b-256 checksum How to use checksums |
36c3483518f6a312ba09a88fe68e5e1833ec643967ee478ecc070b6db50dedf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.
Transparency logSecurity for remfile 0.1.16
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for remfile-0.1.16.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.