vsmbfs 0.1.0__tar.gz

vsmbfs-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,24 @@
+# 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/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=69"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vsmbfs"
+version = "0.1.0"
+description = "VFSI fsspec filesystem backed by the vectorized vsmb client"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT OR Apache-2.0"
+authors = [{ name = "Ming Chen", email = "v.mingchen@gmail.com" }]
+keywords = ["vfsi", "fsspec", "smb", "smb2", "smb3", "filesystem", "vectorized-io"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Typing :: Typed",
+]
+dependencies = [
+  "fsspec>=2024.12.0",
+  "vfsi-fsspec>=0.1,<0.2",
+  "vsmb>=0.1,<0.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/vmingchen/vnfs"
+Documentation = "https://github.com/vmingchen/vnfs/tree/main/adapters/vsmbfs"
+Repository = "https://github.com/vmingchen/vnfs"
+Issues = "https://github.com/vmingchen/vnfs/issues"
+Changelog = "https://github.com/vmingchen/vnfs/blob/main/CHANGELOG.md"
+
+[project.entry-points."fsspec.specs"]
+vsmbfs = "vsmbfs:VsmbFileSystem"
+
+[project.optional-dependencies]
+test = ["pytest"]
+dev = ["black", "build", "mypy", "pytest", "ruff", "twine"]
+
+[tool.setuptools]
+package-dir = {"" = "python"}
+
+[tool.setuptools.packages.find]
+where = ["python"]
+
+[tool.black]
+line-length = 88
+target-version = ["py39"]
+
+[tool.ruff]
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "I"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

vsmbfs-0.1.0/python/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-0.1.0/python/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-0.1.0/python/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-0.1.0/python/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-0.1.0/python/vsmbfs/py.typed

@@ -0,0 +1 @@
+

vsmbfs-0.1.0/python/vsmbfs.egg-info/PKG-INFO

@@ -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/python/vsmbfs.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+python/vsmbfs/__init__.py
+python/vsmbfs/__init__.pyi
+python/vsmbfs/_fs.py
+python/vsmbfs/_fs.pyi
+python/vsmbfs/py.typed
+python/vsmbfs.egg-info/PKG-INFO
+python/vsmbfs.egg-info/SOURCES.txt
+python/vsmbfs.egg-info/dependency_links.txt
+python/vsmbfs.egg-info/entry_points.txt
+python/vsmbfs.egg-info/requires.txt
+python/vsmbfs.egg-info/top_level.txt
+tests/test_fsspec_abstract.py
+tests/test_package.py
+tests/test_smb_integration.py

vsmbfs-0.1.0/python/vsmbfs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

vsmbfs-0.1.0/python/vsmbfs.egg-info/entry_points.txt

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

vsmbfs-0.1.0/python/vsmbfs.egg-info/requires.txt

@@ -0,0 +1,14 @@
+fsspec>=2024.12.0
+vfsi-fsspec<0.2,>=0.1
+vsmb<0.2,>=0.1
+
+[dev]
+black
+build
+mypy
+pytest
+ruff
+twine
+
+[test]
+pytest

vsmbfs-0.1.0/python/vsmbfs.egg-info/top_level.txt

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

vsmbfs-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vsmbfs-0.1.0/tests/test_fsspec_abstract.py

@@ -0,0 +1,45 @@
+"""Run fsspec's upstream abstract contract against live vsmbfs."""
+
+import posixpath
+
+import pytest
+from fsspec.tests.abstract import AbstractFixtures
+from fsspec.tests.abstract.copy import AbstractCopyTests
+from fsspec.tests.abstract.get import AbstractGetTests
+from fsspec.tests.abstract.open import AbstractOpenTests
+from fsspec.tests.abstract.pipe import AbstractPipeTests
+from fsspec.tests.abstract.put import AbstractPutTests
+
+
+class VsmbAbstractFixtures(AbstractFixtures):
+    @pytest.fixture
+    def fs(self, smb_fs):
+        yield smb_fs
+
+    @pytest.fixture
+    def fs_join(self):
+        return posixpath.join
+
+    @pytest.fixture
+    def fs_path(self):
+        return "/"
+
+
+class TestAbstractOpen(AbstractOpenTests, VsmbAbstractFixtures):
+    pass
+
+
+class TestAbstractPipe(AbstractPipeTests, VsmbAbstractFixtures):
+    pass
+
+
+class TestAbstractCopy(AbstractCopyTests, VsmbAbstractFixtures):
+    pass
+
+
+class TestAbstractGet(AbstractGetTests, VsmbAbstractFixtures):
+    pass
+
+
+class TestAbstractPut(AbstractPutTests, VsmbAbstractFixtures):
+    pass

vsmbfs-0.1.0/tests/test_package.py

@@ -0,0 +1,15 @@
+"""Package boundary tests for the vsmbfs adapter."""
+
+import fsspec
+import pytest
+import vsmbfs
+
+
+def test_registers_dedicated_fsspec_protocol():
+    assert fsspec.get_filesystem_class("vsmbfs") is vsmbfs.VsmbFileSystem
+    assert vsmbfs.VsmbFileSystem.protocol == "vsmbfs"
+
+
+def test_rejects_non_smb_backend_before_connecting():
+    with pytest.raises(ValueError, match="only supports backend='smb'"):
+        vsmbfs.VsmbFileSystem(backend="nfs", share="data")

vsmbfs-0.1.0/tests/test_smb_integration.py

@@ -0,0 +1,15 @@
+"""Integration coverage for the Python/fsspec SMB backend."""
+
+from vsmb import _native
+
+from .common import run_correctness_suite
+
+
+def test_correctness_suite_on_smb(smb_fs):
+    run_correctness_suite(smb_fs)
+
+
+def test_smb_identity_and_capabilities(smb_fs):
+    assert 0x0202 <= smb_fs.smb_dialect() <= 0x0311
+    assert smb_fs._client.minor_version() is None
+    assert smb_fs._client.capabilities() & _native.CAP_LSTAT == 0