vsmbfs 0.1.0__py3-none-any.whl

vsmbfs/__init__.py

@@ -0,0 +1,12 @@
+"""fsspec filesystem backed by the vectorized :mod:`vsmb` client."""
+
+import fsspec
+from vfsi_fsspec import install_fsspec_blockcache_compat
+from vsmb import __version__ as __version__
+
+from ._fs import SmbFileSystem, VsmbFile, VsmbFileSystem
+
+__all__ = ["SmbFileSystem", "VsmbFile", "VsmbFileSystem"]
+
+fsspec.register_implementation("vsmbfs", VsmbFileSystem)
+install_fsspec_blockcache_compat(VsmbFileSystem)

vsmbfs/__init__.pyi

@@ -0,0 +1,6 @@
+from ._fs import SmbFileSystem as SmbFileSystem
+from ._fs import VsmbFile as VsmbFile
+from ._fs import VsmbFileSystem as VsmbFileSystem
+
+__version__: str
+__all__: list[str]

vsmbfs/_fs.py

@@ -0,0 +1,31 @@
+"""SMB-specific facade over the shared VFSI fsspec engine."""
+
+from vfsi_fsspec import VfsiFile
+from vfsi_fsspec import VfsiFileSystem as _VfsiFileSystem
+from vsmb import _native
+
+
+class VsmbFileSystem(_VfsiFileSystem):
+    """Vectorized SMB2/3 filesystem."""
+
+    protocol = "vsmbfs"
+    _native_module = _native
+    _supported_backends = frozenset({"smb"})
+
+    def __init__(self, host="127.0.0.1", root="", share=None, **kwargs):
+        backend = kwargs.pop("backend", "smb")
+        if backend != "smb":
+            raise ValueError("vsmbfs only supports backend='smb'")
+        super().__init__(
+            host=host,
+            root=root,
+            backend="smb",
+            share=share,
+            **kwargs,
+        )
+
+
+SmbFileSystem = VsmbFileSystem
+VsmbFile = VfsiFile
+
+__all__ = ["SmbFileSystem", "VsmbFile", "VsmbFileSystem"]

vsmbfs/_fs.pyi

@@ -0,0 +1,17 @@
+from typing import Any, Optional
+
+from vfsi_fsspec import VfsiFile, VfsiFileSystem
+
+VsmbFile = VfsiFile
+
+class VsmbFileSystem(VfsiFileSystem):
+    protocol: str
+    def __init__(
+        self,
+        host: str = "127.0.0.1",
+        root: str = "",
+        share: Optional[str] = None,
+        **kwargs: Any,
+    ) -> None: ...
+
+SmbFileSystem = VsmbFileSystem

vsmbfs/py.typed

@@ -0,0 +1 @@
+

vsmbfs-0.1.0.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: vsmbfs
+Version: 0.1.0
+Summary: VFSI fsspec filesystem backed by the vectorized vsmb client
+Author-email: Ming Chen <v.mingchen@gmail.com>
+License-Expression: MIT OR Apache-2.0
+Project-URL: Homepage, https://github.com/vmingchen/vnfs
+Project-URL: Documentation, https://github.com/vmingchen/vnfs/tree/main/adapters/vsmbfs
+Project-URL: Repository, https://github.com/vmingchen/vnfs
+Project-URL: Issues, https://github.com/vmingchen/vnfs/issues
+Project-URL: Changelog, https://github.com/vmingchen/vnfs/blob/main/CHANGELOG.md
+Keywords: vfsi,fsspec,smb,smb2,smb3,filesystem,vectorized-io
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: fsspec>=2024.12.0
+Requires-Dist: vfsi-fsspec<0.2,>=0.1
+Requires-Dist: vsmb<0.2,>=0.1
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# vsmbfs
+
+`vsmbfs` is the fsspec adapter for the low-level `vsmb` vector SMB2/3 client.
+
+```sh
+python -m pip install vsmbfs
+```
+
+```python
+import fsspec
+import vsmbfs
+
+fs = fsspec.filesystem(
+    "vsmbfs",
+    host="files.example",
+    share="data",
+    username="user",
+    password="secret",
+)
+print(fs.ls("/"))
+```
+
+Bulk fsspec operations and coordinated `open_files` buffering use VFSI vector
+operations so independent SMB requests can be issued in bounded batches.

vsmbfs-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+vsmbfs/__init__.py,sha256=rkOuNzWloKZ-iy0Ab3U5OIwA2VbbKWdazFF55GgSwkg,409
+vsmbfs/__init__.pyi,sha256=SPdAWDsFpwHCdO1pQpBWgq4sw1WW_7UvGcm9O_42dyM,173
+vsmbfs/_fs.py,sha256=vzLB-fIPe_2v5nYxQ2fOFvQVtEGJSOc-nbFovQK_aU8,844
+vsmbfs/_fs.pyi,sha256=pECiwWNFrAeafAQmWdsY4HdvBwfclym2BGl0Bny0ZWw,361
+vsmbfs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+vsmbfs-0.1.0.dist-info/METADATA,sha256=bx0ExpFfH3M_IM3oX9rYoSp6MGavvhVPlK_EJB8vHww,1821
+vsmbfs-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+vsmbfs-0.1.0.dist-info/entry_points.txt,sha256=Vbvk8ehtCM8uwkikwyr_VX8BDqw-zQMLKyeoXX84W0E,46
+vsmbfs-0.1.0.dist-info/top_level.txt,sha256=zO8jB-po6o9coWHM802-n9bq88IiKDi4FpiE-nF92b8,7
+vsmbfs-0.1.0.dist-info/RECORD,,

vsmbfs-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

vsmbfs-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[fsspec.specs]
+vsmbfs = vsmbfs:VsmbFileSystem

vsmbfs-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+vsmbfs