Replace sketchy opener interfaces with ABCs in fiona.abc #1415
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This also adds support for GDAL VSI multi-range reads.
sgillies
commented
Jul 24, 2024
Comment on lines
+179
to
+200
| from fiona.abc import FileContainer | ||
|
|
||
| class CustomContainer: | ||
| """GDAL's VSI ReadDir() uses 5 of FileContainer's methods.""" | ||
| def isdir(self, path): | ||
| return pathlib.Path(path).is_dir() | ||
|
|
||
| def isfile(self, path): | ||
| return pathlib.Path(path).is_file() | ||
|
|
||
| def ls(self, path): | ||
| return list(pathlib.Path(path).iterdir()) | ||
|
|
||
| def mtime(self, path): | ||
| return pathlib.Path(path).stat().st_mtime | ||
|
|
||
| def size(self, path): | ||
| return pathlib.Path(path).stat().st_size | ||
|
|
||
| FileContainer.register(CustomContainer) | ||
|
|
||
| listing = fiona.listdir("tests/data", opener=CustomContainer()) |
There was a problem hiding this comment.
This is how a Fiona user creates a custom opener for their own application.
|
@vincentsarago @mwtoews @snorfalorpagus what do you think of a fiona.abc module? Vincent, I think this is what we should do for Rasterio. |
This was referenced Jul 24, 2024
Closed
| @@ -353,7 +376,7 @@ def _opener_registration(urlpath, obj): | |||
| cdef bytes prefix_bytes = f"/{namespace}/".encode("utf-8") | |||
|
|
|||
| # Might raise. | |||
| opener = _create_opener(obj) | |||
| opener = to_pyopener(obj) | |||
| def size(self, path): | ||
| return pathlib.Path(path).stat().st_size | ||
|
|
||
| FileContainer.register(CustomContainer) |
vincentsarago
approved these changes
Jul 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also adds support for GDAL VSI multi-range reads. This is an attempt to take rasterio/rasterio#3117 all the way to a stable interface and API.
io.open(), fsspec filesystems, and to a lesser degree,tiledb.VFS, are privileged openers. There are built-in adapters for these objects.Otherwise, users should implement
fiona.abc.FileContainerand register their class as a virtual subclass within their application likeFileContainer.register(NewClass).fiona.abc.MultiByteRangeResourceContainerexists for completeness, to provide a template for Rasterio, and for compatibility with future GDAL/OGR drivers that may exploit it. Currently no vectors drivers do and there is no point in implementing this interface.