scmrepo 1.4.0__tar.gz → 2.0.0__tar.gz

{scmrepo-1.4.0 → scmrepo-2.0.0}/.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/iterative/py-template",
-  "commit": "0aac03d10cbc7b2f7e144e728de5043b7a3458cb",
+  "commit": "15ee26df315020399731c6291d61bef81a3fc5d3",
   "context": {
     "cookiecutter": {
       "project_name": "scmrepo",

{scmrepo-1.4.0 → scmrepo-2.0.0}/.gitignore

@@ -136,3 +136,5 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+.DS_Store

{scmrepo-1.4.0 → scmrepo-2.0.0}/.pre-commit-config.yaml

@@ -1,10 +1,6 @@
 default_language_version:
   python: python3
 repos:
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
@@ -24,6 +20,12 @@ repos:
         args: ['--fix=lf']
       - id: sort-simple-yaml
       - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.1.5'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.5
     hooks:
@@ -34,22 +36,3 @@ repos:
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear==23.7.10
-          - flake8-comprehensions==3.14.0
-          - flake8-debugger==4.1.2
-          - flake8-string-format==0.3.0
-  - repo: https://github.com/pycqa/bandit
-    rev: 1.7.5
-    hooks:
-      - id: bandit
-        args: ["-c", "pyproject.toml"]
-        additional_dependencies: [".[toml]"]

{scmrepo-1.4.0/src/scmrepo.egg-info → scmrepo-2.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: scmrepo
-Version: 1.4.0
-Summary: SCM wrapper and fsspec filesystem for Git for use in DVC
-Home-page: https://github.com/iterative/scmrepo
-Maintainer-email: support@dvc.org
+Version: 2.0.0
+Summary: scmrepo
+Author-email: Iterative <support@dvc.org>
 License: Apache-2.0
-Platform: any
+Project-URL: Issues, https://github.com/iterative/scmrepo/issues
+Project-URL: Source, https://github.com/iterative/scmrepo
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -17,19 +17,20 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: gitpython>3
 Requires-Dist: dulwich>=0.21.6
-Requires-Dist: pygit2>=1.13.0
+Requires-Dist: pygit2>=1.13.3
 Requires-Dist: pygtrie>=2.3.2
 Requires-Dist: fsspec>=2021.7.0
 Requires-Dist: pathspec>=0.9.0
 Requires-Dist: asyncssh<3,>=2.13.1
 Requires-Dist: funcy>=1.14
 Requires-Dist: shortuuid>=0.5.0
+Requires-Dist: dvc-objects<4,>=3
+Requires-Dist: dvc-http>=2.29.0
 Provides-Extra: tests
 Requires-Dist: pytest==7.2.0; extra == "tests"
 Requires-Dist: pytest-sugar==0.9.5; extra == "tests"
 Requires-Dist: pytest-cov==3.0.0; extra == "tests"
 Requires-Dist: pytest-mock==3.8.2; extra == "tests"
-Requires-Dist: pylint==2.15.0; extra == "tests"
 Requires-Dist: mypy==0.971; extra == "tests"
 Requires-Dist: pytest-test-utils==0.0.8; extra == "tests"
 Requires-Dist: pytest-asyncio==0.18.3; extra == "tests"
@@ -40,20 +41,7 @@ Requires-Dist: types-certifi==2021.10.8.3; extra == "tests"
 Requires-Dist: types-mock==5.1.0.2; extra == "tests"
 Requires-Dist: types-paramiko==3.3.0.0; extra == "tests"
 Provides-Extra: dev
-Requires-Dist: pytest==7.2.0; extra == "dev"
-Requires-Dist: pytest-sugar==0.9.5; extra == "dev"
-Requires-Dist: pytest-cov==3.0.0; extra == "dev"
-Requires-Dist: pytest-mock==3.8.2; extra == "dev"
-Requires-Dist: pylint==2.15.0; extra == "dev"
-Requires-Dist: mypy==0.971; extra == "dev"
-Requires-Dist: pytest-test-utils==0.0.8; extra == "dev"
-Requires-Dist: pytest-asyncio==0.18.3; extra == "dev"
-Requires-Dist: pytest-docker==0.12.0; (python_version < "3.10" and implementation_name != "pypy") and extra == "dev"
-Requires-Dist: mock==5.1.0; extra == "dev"
-Requires-Dist: paramiko==3.3.1; extra == "dev"
-Requires-Dist: types-certifi==2021.10.8.3; extra == "dev"
-Requires-Dist: types-mock==5.1.0.2; extra == "dev"
-Requires-Dist: types-paramiko==3.3.0.0; extra == "dev"
+Requires-Dist: scmrepo[tests]; extra == "dev"
 
 scmrepo
 =======

{scmrepo-1.4.0 → scmrepo-2.0.0}/noxfile.py

@@ -29,7 +29,6 @@ def lint(session: nox.Session) -> None:
     args = *(session.posargs or ("--show-diff-on-failure",)), "--all-files"
     session.run("pre-commit", "run", *args)
     session.run("python", "-m", "mypy")
-    session.run("python", "-m", "pylint", *locations)
 
 
 @nox.session

scmrepo-2.0.0/pyproject.toml

@@ -0,0 +1,126 @@
+[build-system]
+requires = ["setuptools>=48", "setuptools_scm[toml]>=6.3.1"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+
+[project]
+name = "scmrepo"
+description = "scmrepo"
+readme = "README.rst"
+license = {text = "Apache-2.0"}
+authors = [{ name = "Iterative", email = "support@dvc.org" }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Development Status :: 4 - Beta",
+]
+requires-python = ">=3.8"
+dynamic = ["version"]
+dependencies = [
+    "gitpython>3",
+    "dulwich>=0.21.6",
+    "pygit2>=1.13.3",
+    "pygtrie>=2.3.2",
+    "fsspec>=2021.7.0",
+    "pathspec>=0.9.0",
+    "asyncssh>=2.13.1,<3",
+    "funcy>=1.14",
+    "shortuuid>=0.5.0",
+    "dvc-objects>=3,<4",
+    "dvc-http>=2.29.0",
+]
+
+[project.urls]
+Issues = "https://github.com/iterative/scmrepo/issues"
+Source = "https://github.com/iterative/scmrepo"
+
+[project.optional-dependencies]
+tests = [
+    "pytest==7.2.0",
+    "pytest-sugar==0.9.5",
+    "pytest-cov==3.0.0",
+    "pytest-mock==3.8.2",
+    "mypy==0.971",
+    "pytest-test-utils==0.0.8",
+    "pytest-asyncio==0.18.3",
+    # https://github.com/docker/docker-py/issues/2902
+    "pytest-docker==0.12.0; python_version < '3.10' and implementation_name != 'pypy'",
+    "mock==5.1.0",
+    "paramiko==3.3.1",
+    "types-certifi==2021.10.8.3",
+    "types-mock==5.1.0.2",
+    "types-paramiko==3.3.0.0",
+]
+dev = [
+    "scmrepo[tests]",
+]
+
+[tool.setuptools.package-data]
+dvc_objects = ["py.typed"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+markers = [
+    "skip_git_backend: skip tests for given backend",
+    "slow: mark test as slow to run",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["scmrepo", "tests"]
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+
+[tool.coverage.report]
+show_missing = true
+exclude_lines = [
+    "pragma: no cover",
+    "if __name__ == .__main__.:",
+    "if typing.TYPE_CHECKING:",
+    "if TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "raise AssertionError",
+    "@overload",
+]
+
+[tool.mypy]
+# Error output
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+show_traceback = true
+pretty = true
+check_untyped_defs = false
+# Warnings
+warn_no_return = true
+warn_redundant_casts = true
+warn_unreachable = true
+files = ["src", "tests"]
+
+[[tool.mypy.overrides]]
+module = [
+    "pygtrie",
+    "dvc_http.*",
+    "funcy",
+    "git",
+    "gitdb.*",
+    "fsspec.*",
+    "pathspec.patterns",
+    "asyncssh.*",
+    "pygit2.*",
+    "pytest_docker.plugin",
+    "urllib3.*",
+]
+ignore_missing_imports = true
+
+[tool.codespell]
+ignore-words-list = "cachable, keypair"

scmrepo-2.0.0/setup.cfg

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

{scmrepo-1.4.0 → scmrepo-2.0.0}/src/scmrepo/base.py

@@ -1,7 +1,8 @@
 """Manages source control systems (e.g. Git) in DVC."""
+from contextlib import AbstractContextManager
 
 
-class Base:
+class Base(AbstractContextManager):
     """Base class for source control management driver implementations."""
 
     def __init__(self, root_dir=None):
@@ -18,6 +19,9 @@ class Base:
             class_name=type(self).__name__, directory=self.dir
         )
 
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.close()
+
     @property
     def dir(self):
         """Path to a directory with SCM specific information."""

{scmrepo-1.4.0 → scmrepo-2.0.0}/src/scmrepo/fs.py

@@ -14,49 +14,79 @@ if TYPE_CHECKING:
     from scmrepo.git.objects import GitTrie
 
 
-class Path:
-    def __init__(self, sep, getcwd=None, realpath=None):
-        def _getcwd():
-            return ""
+def bytesio_len(obj: "BytesIO") -> Optional[int]:
+    try:
+        offset = obj.tell()
+        length = obj.seek(0, os.SEEK_END)
+        obj.seek(offset)
+    except (AttributeError, OSError):
+        return None
+    return length
 
-        self.getcwd = getcwd or _getcwd
-        self.realpath = realpath or self.abspath
 
-        assert sep == posixpath.sep
-        self.flavour = posixpath
+class GitFileSystem(AbstractFileSystem):
+    # pylint: disable=abstract-method
+    cachable = False
+    root_marker = "/"
 
-    def chdir(self, path):
-        def _getcwd():
-            return path
+    def __init__(
+        self,
+        path: str = None,
+        rev: str = None,
+        scm: "Git" = None,
+        trie: "GitTrie" = None,
+        rev_resolver: Callable[["Git", str], str] = None,
+        **kwargs,
+    ):
+        from scmrepo.git import Git
+        from scmrepo.git.objects import GitTrie
+
+        super().__init__(**kwargs)
+        if not trie:
+            scm = scm or Git(path)
+            resolver = rev_resolver or Git.resolve_rev
+            resolved = resolver(scm, rev or "HEAD")
+            tree_obj = scm.pygit2.get_tree_obj(rev=resolved)
+            trie = GitTrie(tree_obj, resolved)
+
+        self.trie = trie
+        self.rev = self.trie.rev
 
-        self.getcwd = _getcwd
+    def getcwd(self):
+        return self.root_marker
 
-    def join(self, *parts):
-        return self.flavour.join(*parts)
+    def chdir(self, path):
+        raise NotImplementedError
+
+    @classmethod
+    def join(cls, *parts):
+        return posixpath.join(*parts)
 
-    def split(self, path):
-        return self.flavour.split(path)
+    @classmethod
+    def split(cls, path):
+        return posixpath.split(path)
 
     def normpath(self, path):
-        return self.flavour.normpath(path)
+        return posixpath.normpath(path)
 
-    def isabs(self, path):
-        return self.flavour.isabs(path)
+    @classmethod
+    def isabs(cls, path):
+        return posixpath.isabs(path)
 
     def abspath(self, path):
         if not self.isabs(path):
             path = self.join(self.getcwd(), path)
         return self.normpath(path)
 
-    def commonprefix(self, path):
-        return self.flavour.commonprefix(path)
-
-    def parts(self, path):
-        drive, path = self.flavour.splitdrive(path.rstrip(self.flavour.sep))
+    @classmethod
+    def commonprefix(cls, path):
+        return posixpath.commonprefix(path)
 
+    @classmethod
+    def parts(cls, path):
         ret = []
         while True:
-            path, part = self.flavour.split(path)
+            path, part = cls.split(path)
 
             if part:
                 ret.append(part)
@@ -69,113 +99,77 @@ class Path:
 
         ret.reverse()
 
-        if drive:
-            ret = [drive] + ret
-
         return tuple(ret)
 
-    def parent(self, path):
-        return self.flavour.dirname(path)
+    @classmethod
+    def parent(cls, path):
+        return posixpath.dirname(path)
 
-    def dirname(self, path):
-        return self.parent(path)
+    @classmethod
+    def dirname(cls, path):
+        return cls.parent(path)
 
-    def parents(self, path):
-        parts = self.parts(path)
+    @classmethod
+    def parents(cls, path):
+        parts = cls.parts(path)
         return tuple(
-            self.join(*parts[:length]) for length in range(len(parts) - 1, 0, -1)
+            cls.join(*parts[:length]) for length in range(len(parts) - 1, 0, -1)
         )
 
-    def name(self, path):
-        return self.parts(path)[-1]
+    @classmethod
+    def name(cls, path):
+        return cls.parts(path)[-1]
 
-    def suffix(self, path):
-        name = self.name(path)
+    @classmethod
+    def suffix(cls, path):
+        name = cls.name(path)
         _, dot, suffix = name.partition(".")
         return dot + suffix
 
-    def with_name(self, path, name):
-        parts = list(self.parts(path))
+    @classmethod
+    def with_name(cls, path, name):
+        parts = list(cls.parts(path))
         parts[-1] = name
-        return self.join(*parts)
+        return cls.join(*parts)
 
-    def with_suffix(self, path, suffix):
-        parts = list(self.parts(path))
+    @classmethod
+    def with_suffix(cls, path, suffix):
+        parts = list(cls.parts(path))
         real_path, _, _ = parts[-1].partition(".")
         parts[-1] = real_path + suffix
-        return self.join(*parts)
+        return cls.join(*parts)
 
-    def isin(self, left, right):
-        left_parts = self.parts(left)
-        right_parts = self.parts(right)
+    @classmethod
+    def isin(cls, left, right):
+        left_parts = cls.parts(left)
+        right_parts = cls.parts(right)
         left_len = len(left_parts)
         right_len = len(right_parts)
         return left_len > right_len and left_parts[:right_len] == right_parts
 
-    def isin_or_eq(self, left, right):
-        return left == right or self.isin(left, right)
+    @classmethod
+    def isin_or_eq(cls, left, right):
+        return left == right or cls.isin(left, right)
 
-    def overlaps(self, left, right):
+    @classmethod
+    def overlaps(cls, left, right):
         # pylint: disable=arguments-out-of-order
-        return self.isin_or_eq(left, right) or self.isin(right, left)
+        return cls.isin_or_eq(left, right) or cls.isin(right, left)
 
     def relpath(self, path, start=None):
         if start is None:
             start = "."
-        return self.flavour.relpath(self.abspath(path), start=self.abspath(start))
+        return self.relpath(self.abspath(path), start=self.abspath(start))
 
     def relparts(self, path, start=None):
         return self.parts(self.relpath(path, start=start))
 
-    def as_posix(self, path):
-        return path.replace(self.flavour.sep, posixpath.sep)
-
-
-def bytesio_len(obj: "BytesIO") -> Optional[int]:
-    try:
-        offset = obj.tell()
-        length = obj.seek(0, os.SEEK_END)
-        obj.seek(offset)
-    except (AttributeError, OSError):
-        return None
-    return length
-
-
-class GitFileSystem(AbstractFileSystem):
-    # pylint: disable=abstract-method
-    cachable = False
-    root_marker = "/"
-
-    def __init__(
-        self,
-        path: str = None,
-        rev: str = None,
-        scm: "Git" = None,
-        trie: "GitTrie" = None,
-        rev_resolver: Callable[["Git", str], str] = None,
-        **kwargs,
-    ):
-        from scmrepo.git import Git
-        from scmrepo.git.objects import GitTrie
-
-        super().__init__(**kwargs)
-        if not trie:
-            scm = scm or Git(path)
-            resolver = rev_resolver or Git.resolve_rev
-            resolved = resolver(scm, rev or "HEAD")
-            tree_obj = scm.pygit2.get_tree_obj(rev=resolved)
-            trie = GitTrie(tree_obj, resolved)
-
-        self.trie = trie
-        self.rev = self.trie.rev
-
-        def _getcwd():
-            return self.root_marker
-
-        self.path = Path(self.sep, getcwd=_getcwd)
+    @classmethod
+    def as_posix(cls, path):
+        return path
 
     def _get_key(self, path: str) -> Tuple[str, ...]:
-        path = self.path.abspath(path)
+        path = self.abspath(path)
         if path == self.root_marker:
             return ()
         relparts = path.split(self.sep)
@@ -187,9 +181,10 @@ class GitFileSystem(AbstractFileSystem):
         self,
         path: str,
         mode: str = "rb",
-        block_size: int = None,
+        block_size: Optional[int] = None,
         autocommit: bool = True,
-        cache_options: Dict = None,
+        cache_options: Optional[Dict] = None,
+        raw: bool = False,
         **kwargs: Any,
     ) -> BinaryIO:
         if mode != "rb":
@@ -197,7 +192,7 @@ class GitFileSystem(AbstractFileSystem):
 
         key = self._get_key(path)
         try:
-            obj = self.trie.open(key, mode=mode)
+            obj = self.trie.open(key, mode=mode, raw=raw)
             obj.size = bytesio_len(obj)
             return obj
         except KeyError as exc:

{scmrepo-1.4.0 → scmrepo-2.0.0}/src/scmrepo/git/__init__.py

@@ -171,6 +171,13 @@ class Git(Base):
     def ignore_file(self):
         return self.GITIGNORE
 
+    @cached_property
+    def lfs_storage(self):
+        from .lfs import LFSStorage
+        from .lfs.storage import get_storage_path
+
+        return LFSStorage(get_storage_path(self))
+
     def _get_gitignore(self, path):
         ignore_file_dir = os.path.dirname(path)
 
@@ -267,6 +274,8 @@ class Git(Base):
 
     def close(self):
         self.backends.close_initialized()
+        if "lfs_storage" in self.__dict__:
+            self.lfs_storage.close()
 
     @property
     def no_commits(self):
@@ -358,6 +367,7 @@ class Git(Base):
     is_tracked = partialmethod(_backend_func, "is_tracked")
     is_dirty = partialmethod(_backend_func, "is_dirty")
     active_branch = partialmethod(_backend_func, "active_branch")
+    active_branch_remote = partialmethod(_backend_func, "active_branch_remote")
     list_branches = partialmethod(_backend_func, "list_branches")
     list_tags = partialmethod(_backend_func, "list_tags")
     list_all_commits = partialmethod(_backend_func, "list_all_commits")
@@ -383,8 +393,11 @@ class Git(Base):
     status = partialmethod(_backend_func, "status")
     merge = partialmethod(_backend_func, "merge")
     validate_git_remote = partialmethod(_backend_func, "validate_git_remote")
+    get_remote_url = partialmethod(_backend_func, "get_remote_url")
     check_ref_format = partialmethod(_backend_func, "check_ref_format")
     get_tag = partialmethod(_backend_func, "get_tag")
+    get_config = partialmethod(_backend_func, "get_config")
+    check_attr = partialmethod(_backend_func, "check_attr")
 
     get_tree_obj = partialmethod(_backend_func, "get_tree_obj")
 

{scmrepo-1.4.0 → scmrepo-2.0.0}/src/scmrepo/git/backend/base.py

@@ -10,6 +10,7 @@ from ..objects import GitObject
 if TYPE_CHECKING:
     from scmrepo.progress import GitProgressEvent
 
+    from ..config import Config
     from ..objects import GitCommit, GitTag
 
 
@@ -135,6 +136,10 @@ class BaseGitBackend(ABC):
     def active_branch(self) -> str:
         pass
 
+    @abstractmethod
+    def active_branch_remote(self) -> str:
+        """Return the fetch remote name for the current branch."""
+
     @abstractmethod
     def list_branches(self) -> Iterable[str]:
         pass
@@ -263,6 +268,9 @@ class BaseGitBackend(ABC):
                 returns True the local ref will be overwritten.
                 Callback will be of the form:
                     on_diverged(local_refname, remote_sha)
+
+        Returns:
+            Mapping of local_refname to sync status.
         """
 
     @abstractmethod
@@ -394,6 +402,10 @@ class BaseGitBackend(ABC):
     def validate_git_remote(self, url: str, **kwargs):
         """Verify that url is a valid git URL or remote name."""
 
+    @abstractmethod
+    def get_remote_url(self, remote: str) -> str:
+        """Return URL for the specified remote."""
+
     @abstractmethod
     def check_ref_format(self, refname: str) -> bool:
         """Check if a reference name is well formed."""
@@ -410,3 +422,34 @@ class BaseGitBackend(ABC):
             String SHA for the target object if the tag is a lightweight tag.
             GitTag object if the tag is an annotated tag.
         """
+
+    @abstractmethod
+    def get_config(self, path: Optional[str] = None) -> "Config":
+        """Return a Git config object.
+
+        Args:
+            path: If set, a config object for the specified config file will be
+                returned. By default, the standard Git system/global/repo config
+                stack object will be returned.
+        """
+
+    @abstractmethod
+    def check_attr(
+        self,
+        path: str,
+        attr: str,
+        source: Optional[str] = None,
+    ) -> Optional[Union[bool, str]]:
+        """Return the value of the specified attribute for a pathname.
+
+        Args:
+            path: Pathname to check.
+            attr: Attribute to check.
+            source: Optional tree-ish source to check.
+
+        Returns:
+            None when the attribute is not defined for the path (unspecified).
+            True when the attribute is defined as true (set).
+            False when the attribute is defined as false (unset).
+            The value of the attribute when a value has been assigned.
+        """