Skip to content

Commit

Permalink
Update wording for fsspec docstring (#195)
Browse files Browse the repository at this point in the history
  • Loading branch information
kylebarron authored Jan 31, 2025
1 parent ffa3dd9 commit 373b794
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions obstore/python/obstore/fsspec.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
"""Integration with the [fsspec] library.
This integration is designed for compatibility and may not provide the same performance
as other obstore APIs.
[fsspec]: https://github.com/fsspec/filesystem_spec
The fsspec integration is **best effort** and not the primary API of `obstore`. This integration may not be as stable and may not provide the same performance as the rest of the library. Changes may be made even in patch releases to align better with fsspec expectations. If you find any bugs, please [file an issue](https://github.com/developmentseed/obstore/issues/new/choose).
The underlying `object_store` Rust crate [cautions](https://docs.rs/object_store/latest/object_store/#why-not-a-filesystem-interface) against relying too strongly on stateful filesystem representations of object stores:
> The ObjectStore interface is designed to mirror the APIs of object stores and not filesystems, and thus has stateless APIs instead of cursor based interfaces such as Read or Seek available in filesystems.
Expand Down

0 comments on commit 373b794

Please sign in to comment.