Add GitHubPath

upath/implementations/github.py

@@ -0,0 +1,25 @@
+"""
+GitHub implementation of UPath
+"""
+
+import upath.core
+
+
+class _GitHubAccessor(upath.core._FSSpecAccessor):
+    """
+    FSSpecAccessor for GitHub
+    """
+
+    def _format_path(self, path: upath.core.UPath) -> str:
+        """
+        Remove the leading slash from the path
+        """
+        return path._path.lstrip("/")
+
+
+class GitHubPath(upath.core.UPath):
+    """
+    GitHubPath supporting the fsspec.GitHubFileSystem
+    """
+
+    _default_accessor = _GitHubAccessor

upath/registry.py

@@ -74,6 +74,7 @@ class _Registry(MutableMapping[str, "type[upath.core.UPath]"]):
         "s3a": "upath.implementations.cloud.S3Path",
         "webdav+http": "upath.implementations.webdav.WebdavPath",
         "webdav+https": "upath.implementations.webdav.WebdavPath",
+        "github": "upath.implementations.github.GitHubPath",
     }
 
     def __init__(self) -> None:

upath/tests/implementations/test_github.py

@@ -0,0 +1,26 @@
+import pytest
+
+from upath import UPath
+from upath.implementations.github import GitHubPath
+from upath.tests.cases import BaseTests
+
+
+class TestUPathGitHubPath(BaseTests):
+    """
+    Unit-tests for the GitHubPath implementation of UPath.
+    """
+
+    @pytest.fixture(autouse=True)
+    def path(self, local_testdir, hdfs):
+        """
+        Fixture for the UPath instance to be tested.
+        """
+        host, user, port = hdfs
+        path = "github://fsspec:universal_pathlib@main"
+        self.path = UPath(path)
+
+    def test_is_GitHubPath(self):
+        """
+        Test that the path is a GitHubPath instance.
+        """
+        assert isinstance(self.path, GitHubPath)

upath/tests/test_registry.py

@@ -22,6 +22,7 @@
     "s3a",
     "webdav+http",
     "webdav+https",
+    "github",
 }