Rename AsyncFsspecStore to FsspecStore (#297)

kylebarron · web-flow · commit 1e3162bcbf46 · 2025-03-03T14:25:18.000-05:00
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -69,7 +69,7 @@ File-like object support is also provided:
 
 - [`open_reader`][obstore.open_reader]: Open a remote object as a readable file-like object, similar to a Python [`BufferedReader`](https://docs.python.org/3/library/io.html#io.BufferedReader).
 - [`open_writer`][obstore.open_writer]: Open a remote object as a writable file-like object, similar to a Python [`BufferedWriter`](https://docs.python.org/3/library/io.html#io.BufferedWriter)
-- [`AsyncFsspecStore`][obstore.fsspec.AsyncFsspecStore] adapter for use with [`fsspec`](https://github.com/fsspec/filesystem_spec).
+- [`FsspecStore`][obstore.fsspec.FsspecStore] adapter for use with [`fsspec`](https://github.com/fsspec/filesystem_spec).
 
 **All operations have a comparable async method** with the same name plus an `_async` suffix.
 
diff --git a/obstore/python/obstore/fsspec.py b/obstore/python/obstore/fsspec.py
@@ -82,7 +82,7 @@
 }
 
 
-class AsyncFsspecStore(fsspec.asyn.AsyncFileSystem):
+class FsspecStore(fsspec.asyn.AsyncFileSystem):
     """An fsspec implementation based on a obstore Store.
 
     You should be able to pass an instance of this class into any API that expects an
@@ -151,7 +151,7 @@ def __init__(  # noqa: PLR0913
         loop: Any = None,
         batch_size: int | None = None,
     ) -> None:
-        """Construct a new AsyncFsspecStore.
+        """Construct a new FsspecStore.
 
         Args:
             protocol: The storage protocol to use, such as "s3",
@@ -183,9 +183,9 @@ def __init__(  # noqa: PLR0913
         **Examples:**
 
         ```py
-        from obstore.fsspec import AsyncFsspecStore
+        from obstore.fsspec import FsspecStore
 
-        store = AsyncFsspecStore(protocol="https")
+        store = FsspecStore(protocol="https")
         resp = store.cat("https://example.com")
         assert resp.startswith(b"<!doctype html>")
         ```
@@ -535,7 +535,7 @@ class BufferedFile(fsspec.spec.AbstractBufferedFile):
     @overload
     def __init__(
         self,
-        fs: AsyncFsspecStore,
+        fs: FsspecStore,
         path: str,
         mode: Literal["rb"] = "rb",
         *,
@@ -545,7 +545,7 @@ def __init__(
     @overload
     def __init__(
         self,
-        fs: AsyncFsspecStore,
+        fs: FsspecStore,
         path: str,
         mode: Literal["wb"],
         *,
@@ -556,7 +556,7 @@ def __init__(
     ) -> None: ...
     def __init__(  # noqa: PLR0913
         self,
-        fs: AsyncFsspecStore,
+        fs: FsspecStore,
         path: str,
         mode: Literal["rb", "wb"] = "rb",
         *,
@@ -748,15 +748,15 @@ def loc(self, value: int) -> None:
 
 
 def register(protocol: str | Iterable[str], *, asynchronous: bool = False) -> None:
-    """Dynamically register a subclass of AsyncFsspecStore for the given protocol(s).
+    """Dynamically register a subclass of FsspecStore for the given protocol(s).
 
-    This function creates a new subclass of AsyncFsspecStore with the specified
+    This function creates a new subclass of FsspecStore with the specified
     protocol and registers it with fsspec. If multiple protocols are provided,
     the function registers each one individually.
 
     Args:
         protocol (str | list[str]): A single protocol (e.g., "s3", "gcs", "abfs") or
-            a list of protocols to register AsyncFsspecStore for.
+            a list of protocols to register FsspecStore for.
         asynchronous (bool, optional): If True, the registered store will support
             asynchronous operations. Defaults to False.
 
@@ -769,8 +769,8 @@ def register(protocol: str | Iterable[str], *, asynchronous: bool = False) -> No
 
     Notes:
         - Each protocol gets a dynamically generated subclass named
-          `AsyncFsspecStore_<protocol>`. This avoids modifying the original
-          AsyncFsspecStore class.
+          `FsspecStore_<protocol>`. This avoids modifying the original
+          FsspecStore class.
 
     """
     if isinstance(protocol, str):
@@ -785,8 +785,8 @@ def _register(protocol: str, *, asynchronous: bool) -> None:
     fsspec.register_implementation(
         protocol,
         type(
-            f"AsyncFsspecStore_{protocol}",  # Unique class name
-            (AsyncFsspecStore,),  # Base class
+            f"FsspecStore_{protocol}",  # Unique class name
+            (FsspecStore,),  # Base class
             {
                 "protocol": protocol,
                 "asynchronous": asynchronous,
diff --git a/tests/test_fsspec.py b/tests/test_fsspec.py
@@ -10,7 +10,7 @@
 import pytest
 from fsspec.registry import _registry
 
-from obstore.fsspec import AsyncFsspecStore, register
+from obstore.fsspec import FsspecStore, register
 from tests.conftest import TEST_BUCKET_NAME
 
 if TYPE_CHECKING:
@@ -45,8 +45,8 @@ def test_register():
 
     assert issubclass(
         fs_class,
-        AsyncFsspecStore,
-    ), "Registered class should be a subclass of AsyncFsspecStore"
+        FsspecStore,
+    ), "Registered class should be a subclass of FsspecStore"
     assert fs_class.protocol == "s3", (
         "Registered class should have the correct protocol"
     )
@@ -55,7 +55,7 @@ def test_register():
     fs_instance = fs_class()
     assert isinstance(
         fs_instance,
-        AsyncFsspecStore,
+        FsspecStore,
     ), "Registered class should be instantiable"
 
     # test register asynchronous
@@ -65,13 +65,13 @@ def test_register():
 
     # test multiple registrations
     register(["file", "abfs"])
-    assert issubclass(fsspec.get_filesystem_class("file"), AsyncFsspecStore)
-    assert issubclass(fsspec.get_filesystem_class("abfs"), AsyncFsspecStore)
+    assert issubclass(fsspec.get_filesystem_class("file"), FsspecStore)
+    assert issubclass(fsspec.get_filesystem_class("abfs"), FsspecStore)
 
 
 def test_construct_store_cache_diff_bucket_name(s3_store_config: S3Config):
     register("s3")
-    fs: AsyncFsspecStore = fsspec.filesystem(
+    fs: FsspecStore = fsspec.filesystem(
         "s3",
         config=s3_store_config,
         client_options={"allow_http": True},
@@ -167,7 +167,7 @@ def test_fsspec_filesystem_cache(s3_store_config: S3Config):
     )
 
 
-def test_split_path(fs: AsyncFsspecStore):
+def test_split_path(fs: FsspecStore):
     # in url format, with bucket
     assert fs._split_path("s3://mybucket/path/to/file") == ("mybucket", "path/to/file")
     assert fs._split_path("s3://data-bucket/") == ("data-bucket", "")
@@ -193,7 +193,7 @@ def test_split_path(fs: AsyncFsspecStore):
     assert fs._split_path("/data-bucket/") == ("", "/data-bucket/")
 
 
-def test_list(fs: AsyncFsspecStore):
+def test_list(fs: FsspecStore):
     out = fs.ls(f"{TEST_BUCKET_NAME}", detail=False)
     assert out == [f"{TEST_BUCKET_NAME}/afile"]
     fs.pipe_file(f"{TEST_BUCKET_NAME}/dir/bfile", b"data")
@@ -258,7 +258,7 @@ def test_remote_parquet(s3_store_config: S3Config):
     )
 
 
-def test_multi_file_ops(fs: AsyncFsspecStore):
+def test_multi_file_ops(fs: FsspecStore):
     data = {
         f"{TEST_BUCKET_NAME}/dir/test1": b"test data1",
         f"{TEST_BUCKET_NAME}/dir/test2": b"test data2",
@@ -282,7 +282,7 @@ def test_multi_file_ops(fs: AsyncFsspecStore):
     assert out == [f"{TEST_BUCKET_NAME}/afile"]
 
 
-def test_cat_ranges_one(fs: AsyncFsspecStore):
+def test_cat_ranges_one(fs: FsspecStore):
     data1 = os.urandom(10000)
     fs.pipe_file(f"{TEST_BUCKET_NAME}/data1", data1)
 
@@ -327,7 +327,7 @@ def test_cat_ranges_one(fs: AsyncFsspecStore):
     assert out == [data1[10:20], data1[0:60]]
 
 
-def test_cat_ranges_two(fs: AsyncFsspecStore):
+def test_cat_ranges_two(fs: FsspecStore):
     data1 = os.urandom(10000)
     data2 = os.urandom(10000)
     fs.pipe({f"{TEST_BUCKET_NAME}/data1": data1, f"{TEST_BUCKET_NAME}/data2": data2})
@@ -342,7 +342,7 @@ def test_cat_ranges_two(fs: AsyncFsspecStore):
 
 
 @pytest.mark.xfail(reason="negative and mixed ranges not implemented")
-def test_cat_ranges_mixed(fs: AsyncFsspecStore):
+def test_cat_ranges_mixed(fs: FsspecStore):
     data1 = os.urandom(10000)
     data2 = os.urandom(10000)
     fs.pipe({"data1": data1, "data2": data2})
@@ -353,13 +353,13 @@ def test_cat_ranges_mixed(fs: AsyncFsspecStore):
 
 
 @pytest.mark.xfail(reason="atomic writes not working on moto")
-def test_atomic_write(fs: AsyncFsspecStore):
+def test_atomic_write(fs: FsspecStore):
     fs.pipe_file("data1", b"data1")
     fs.pipe_file("data1", b"data1", mode="overwrite")
     with pytest.raises(ValueError):  # noqa: PT011
         fs.pipe_file("data1", b"data1", mode="create")
 
 
-def test_cat_ranges_error(fs: AsyncFsspecStore):
+def test_cat_ranges_error(fs: FsspecStore):
     with pytest.raises(ValueError):  # noqa: PT011
         fs.cat_ranges([f"{TEST_BUCKET_NAME}/path"], [], [])
