gitman 3.6__tar.gz → 3.7__tar.gz

{gitman-3.6 → gitman-3.7}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.3
 Name: gitman
-Version: 3.6
+Version: 3.7
 Summary: A language-agnostic dependency manager using Git.
 License: MIT
 Keywords: git,version control,build systems,dependency management,submodules
 Author: Jace Browning
 Author-email: jacebrowning@gmail.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9,<3.15
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -26,7 +26,7 @@ Classifier: Topic :: Software Development :: Version Control
 Classifier: Topic :: System :: Software Distribution
 Requires-Dist: datafiles (>=2.3.1,<3.0.0)
 Requires-Dist: minilog (>=2.3.1,<3.0.0)
-Requires-Dist: universal-startfile (>=0.2,<0.3)
+Requires-Dist: universal-startfile (>=0.2,<0.4)
 Project-URL: Documentation, https://gitman.readthedocs.io
 Project-URL: Homepage, https://pypi.org/project/gitman
 Project-URL: Repository, https://github.com/jacebrowning/gitman
@@ -51,7 +51,7 @@ Gitman is a language-agnostic dependency manager using Git. It aims to serve as
 
 ### Requirements
 
-- Python 3.8+
+- Python 3.9+
 - Git 2.8+ (with [stored credentials](http://gitman.readthedocs.io/en/latest/setup/git/))
 
 ### Installation

{gitman-3.6 → gitman-3.7}/README.md

@@ -17,7 +17,7 @@ Gitman is a language-agnostic dependency manager using Git. It aims to serve as
 
 ### Requirements
 
-- Python 3.8+
+- Python 3.9+
 - Git 2.8+ (with [stored credentials](http://gitman.readthedocs.io/en/latest/setup/git/))
 
 ### Installation

{gitman-3.6 → gitman-3.7}/gitman/cli.py

@@ -125,6 +125,13 @@ def main(args=None, function=None):
         action="store_true",
         dest="no_scripts",
     )
+    sub.add_argument(
+        "-P",
+        "--no-patches",
+        help="skip patches after installation",
+        action="store_true",
+        dest="no_patches",
+    )
 
     # Update parser
     info = "update dependencies to the latest versions"
@@ -158,6 +165,13 @@ def main(args=None, function=None):
         action="store_true",
         dest="no_scripts",
     )
+    sub.add_argument(
+        "-P",
+        "--no-patches",
+        help="skip patches after installation",
+        action="store_true",
+        dest="no_patches",
+    )
 
     # List parser
     info = "display the current version of each dependency"
@@ -277,6 +291,7 @@ def _get_command(function, namespace):
             clean=namespace.clean,
             skip_changes=namespace.skip_changes,
             skip_scripts=namespace.no_scripts,
+            skip_patches=namespace.no_patches,
         )
         if namespace.command == "install":
             kwargs.update(
@@ -350,6 +365,8 @@ def _run_command(function, args, kwargs):
     except exceptions.ScriptFailure as exception:
         _show_error(exception)
         exit_message = "Run again with '--force' to ignore script errors"
+    except exceptions.PatchFailure as exception:
+        _show_error(exception)
     except exceptions.InvalidConfig as exception:
         _show_error(exception)
         exit_message = "Adapt config and run again"

{gitman-3.6 → gitman-3.7}/gitman/commands.py

@@ -62,6 +62,7 @@ def install(
     skip_changes=False,
     skip_default_group=False,
     skip_scripts=False,
+    skip_patches=False,
 ):
     """Install dependencies for a project.
 
@@ -70,10 +71,10 @@ def install(
     - `*names`: optional list of dependency directory names to filter on
     - `root`: specifies the path to the root working tree
     - `depth`: number of levels of dependencies to traverse
-    - `force`: indicates uncommitted changes can be overwritten and
-               script errors can be ignored
+    - `force`: indicates uncommitted changes can be overwritten,
+               script errors can be ignored and failed patches can be ignored
     - `force_interactive`: indicates uncommitted changes can be interactively
-    overwritten and script errors can be ignored
+    overwritten, script errors can be ignored and failed patches can be ignored
     - `fetch`: indicates the latest branches should always be fetched
     - `clean`: indicates untracked files should be deleted from dependencies
     - `skip_changes`: indicates dependencies with uncommitted changes
@@ -81,6 +82,7 @@ def install(
     - `skip_default_group`: indicates default_group should be skipped if
      `*names` is empty
     - `skip_scripts`: indicates scripts should be skipped
+    - `skip_patches`: indicates patches should be skipped
     """
     log.info(
         "%sInstalling dependencies: %s",
@@ -115,6 +117,10 @@ def install(
         )
         count += _count  # type: ignore
 
+        if _count and not skip_patches:
+            common.show("Applying patches...", color="message", log=False)
+            common.newline()
+            config.apply_patches(*names, depth=depth, force=force)
         if _count and not skip_scripts:
             label = "nested scripts" if index else "scripts"
             common.show(f"Running {label}...", color="message", log=False)
@@ -137,6 +143,7 @@ def update(
     skip_changes=False,
     skip_default_group=False,
     skip_scripts=False,
+    skip_patches=False,
 ):
     """Update dependencies for a project.
 
@@ -157,6 +164,7 @@ def update(
     - `skip_default_group`: indicates default_group should be skipped if
      `*names` is empty
     - `skip_scripts`: indicates scripts should be skipped
+    - `skip_patches`: indicates patches should be skipped
     """
     log.info(
         "%s dependencies%s: %s",
@@ -201,6 +209,10 @@ def update(
                 skip_changes=skip_changes or force_interactive,
             )
 
+        if _count and not skip_patches:
+            common.show("Applying patches...", color="message", log=False)
+            common.newline()
+            config.apply_patches(*names, depth=depth, force=force)
         if _count and not skip_scripts:
             label = "nested scripts" if index else "scripts"
             common.show(f"Running {label}...", color="message", log=False)

{gitman-3.6 → gitman-3.7}/gitman/exceptions.py

@@ -24,3 +24,7 @@ class UncommittedChanges(RuntimeError):
 
 class ScriptFailure(ShellError):
     """Raised when post-install script has a non-zero exit code."""
+
+
+class PatchFailure(ShellError):
+    """Raised when applying a patch has a non-zero exit code."""

{gitman-3.6 → gitman-3.7}/gitman/git.py

@@ -37,7 +37,7 @@ def clone(
         user_params = []
 
     if type == "git-svn":
-        # just the preperation for the svn deep clone / checkout here
+        # just the preparation for the svn deep clone / checkout here
         # clone will be made in update function to simplify source.py).
         os.makedirs(path)
         return
@@ -78,6 +78,38 @@ def clone(
         git("clone", "--reference-if-able", reference, repo, normpath, *user_params)
 
 
+def create_branch_local(type, name: str, base_ref: str = "HEAD", recreate: bool = True):
+    """Create a local branch.
+
+    :param recreate: delete and create if already exists
+    """
+    if type == "git-svn":
+        return  # ignore creating branch in case of git-svn
+
+    assert type == "git"
+
+    # Check if branch exists and delete
+    if recreate and _local_branch_exists(name):
+        git("branch", "-D", name, _show=False)
+
+    # Create branch
+    git("branch", name, base_ref, _show=False)
+
+
+def checkout(type, branch_name: str):
+    """Checkout a specific branch.
+
+    :param branch_name: branch name for the checkout
+    """
+    if type == "git-svn":
+        return  # ignore checkout in the case of git-svn
+
+    assert type == "git"
+
+    # Checkout branch
+    git("checkout", branch_name)
+
+
 def is_sha(rev):
     """Heuristically determine whether a revision corresponds to a commit SHA.
 
@@ -152,7 +184,7 @@ def rebuild(type, repo):  # pylint: disable=unused-argument
 
     assert type == "git"
 
-    common.show("Rebuilding mising git repo...", color="message")
+    common.show("Rebuilding missing git repo...", color="message")
     git("init", _show=True)
     git("remote", "add", "origin", repo, _show=True)
     common.show("Rebuilt git repo...", color="message")
@@ -163,8 +195,7 @@ def changes(type, include_untracked=False, display_status=True, _show=False):
     status = False
 
     if type == "git-svn":
-        # ignore changes in case of git-svn
-        return status
+        return status  # ignore changes in case of git-svn
 
     assert type == "git"
 
@@ -194,6 +225,26 @@ def changes(type, include_untracked=False, display_status=True, _show=False):
     return status
 
 
+def am(patch, _skip=False):
+    """Apply a patch.
+
+    :param patch: the patch to be applied
+    :param _skip: skip patch if applying fails
+    """
+    try:
+        git("am", "--3way", patch, _show=True)
+    except ShellError as e:
+        if _skip:
+            # Check if current git am is stuck
+            rebase_dir = git("rev-parse", "--git-path", "rebase-apply", _show=False)
+            if rebase_dir and os.path.isdir(rebase_dir[0]):
+                try:
+                    git("am", "--skip", _show=True, _ignore=True)
+                except ShellError:
+                    pass
+        raise ShellError from e
+
+
 def update(
     type, repo, path, *, clean=True, fetch=False, rev=None
 ):  # pylint: disable=redefined-outer-name,unused-argument
@@ -241,14 +292,17 @@ def get_url(type):
     return git("config", "--get", "remote.origin.url", _show=False)[0]
 
 
-def get_hash(type, _show=False):
+def get_hash(type, short=False, _show=False):
     """Get the current working tree's hash."""
     if type == "git-svn":
         return "".join(filter(str.isdigit, gitsvn("info", _show=_show)[4]))
 
     assert type == "git"
-
-    return git("rev-parse", "HEAD", _show=_show, _stream=False)[0]
+    args = ["rev-parse"]
+    if short:
+        args.append("--short")
+    args.append("HEAD")
+    return git(*args, _show=_show, _stream=False)[0]
 
 
 def get_tag():
@@ -283,6 +337,15 @@ def get_object_rev(object_name):
     return commit_sha
 
 
+def _local_branch_exists(name) -> bool:
+    """Check if a local branch exists."""
+    try:
+        git("rev-parse", "--verify", name, _show=False)
+        return True
+    except ShellError:
+        return False
+
+
 def _get_sha_from_rev(rev):
     """Get a rev-parse string's hash."""
     if "@{" in rev:

{gitman-3.6 → gitman-3.7}/gitman/models/config.py

@@ -1,5 +1,4 @@
 import os
-import sys
 from typing import Iterator, List, Optional
 
 import log
@@ -188,6 +187,52 @@ class Config:
 
         return count
 
+    @preserve_cwd
+    def apply_patches(
+        self,
+        *names: str,
+        depth: Optional[int] = None,
+        force: bool = False,
+    ) -> int:
+        """Apply patches for the specified dependencies."""
+        if depth == 0:
+            log.info("Skipped directory: %s", self.location_path)
+            return 0
+
+        sources = self._get_sources()
+        sources_filter = self._get_sources_filter(
+            *names, sources=sources, skip_default_group=False
+        )
+
+        shell.cd(self.location_path)
+        common.newline()
+        common.indent()
+
+        count = 0
+        for source in sources:
+            if source.name in sources_filter:
+                shell.cd(source.name)
+
+                config = load_config(search=False)
+                if config:
+                    common.indent()
+                    remaining_depth = None if depth is None else max(0, depth - 1)
+                    if remaining_depth:
+                        common.newline()
+                    count += config.apply_patches(depth=remaining_depth, force=force)
+                    common.dedent()
+
+                source.apply_patches(
+                    topdir=os.path.normpath(self.location_path), skip=force
+                )
+                count += 1
+
+                shell.cd(self.location_path, _show=False)
+
+        common.dedent()
+
+        return count
+
     @classmethod
     def _split_name_and_rev(cls, name_rev):
         true_name = name_rev
@@ -450,12 +495,8 @@ def find_nested_configs(
 
 
 def _resolve_current_directory():
-    start = os.getcwd()
-    if sys.version_info < (3, 8) and os.name == "nt":
-        log.warn("Python 3.8+ is required to resolve virtual drives on Windows")
-    else:
-        start = os.path.realpath(start)
-        os.chdir(start)
+    start = os.path.realpath(os.getcwd())
+    os.chdir(start)
     return start
 
 

{gitman-3.6 → gitman-3.7}/gitman/models/source.py

@@ -30,6 +30,7 @@ class Source:
     | `sparse_paths` | Controls partial checkout | No | `[]` |
     | `links` | Creates symlinks within a project | No | `[]` |
     | `scripts` | Shell commands to run after checkout | No | `[]` |
+    | `patches` | patches to be applied after checkout | No | `[]` |
 
     ### Params
 
@@ -62,6 +63,17 @@ class Source:
       - cabal install
     ```
 
+    ### Patches
+
+    Patches that are applied after checkout. For example:
+
+    ```
+    repo: "https://github.com/koalaman/shellcheck"
+    patches:
+      - patchdir/0001-add-something.patch
+      - patchdir/0002-add-more.patch
+    ```
+
     """
 
     repo: str = ""
@@ -74,6 +86,7 @@ class Source:
     links: List[Link] = field(default_factory=list)
 
     scripts: List[str] = field(default_factory=list)
+    patches: List[str] = field(default_factory=list)
 
     DIRTY = "<dirty>"
     UNKNOWN = "<unknown>"
@@ -235,6 +248,46 @@ class Source:
                     raise exceptions.ScriptFailure(msg)
         common.newline()
 
+    def apply_patches(self, topdir: str, skip: bool = False):
+        log.info("Applying patches...")
+
+        # Enter the working tree
+        if not git.valid():
+            raise self._invalid_repository
+
+        # Check for patches
+        if not self.patches or not self.patches[0]:
+            common.show("(no patches to apply)", color="shell_info")
+            common.newline()
+            return
+
+        # Create a branch from the current hash to apply patches
+        try:
+            hash = git.get_hash(self.type, short=True, _show=False)
+            patched_branch = hash + "-patched"
+            git.create_branch_local(self.type, patched_branch)
+            git.checkout(self.type, patched_branch)
+            log.info("Working on local branch{} for patching.".format(patched_branch))
+        except exceptions.ShellError as exc:
+            msg = "Patch preparation failed! Could not create branch {}".format(
+                patched_branch
+            )
+            raise exceptions.PatchFailure(msg) from exc
+
+        # Apply all patches
+        for patch in self.patches:
+            try:
+                # Convert patch to absolute path
+                patch_path = os.path.abspath(os.path.join(topdir, patch))
+                git.am(patch_path, skip)
+            except exceptions.ShellError as exc:
+                if skip:
+                    log.debug("Ignored error from patch '%s'", patch)
+                else:
+                    msg = "Failed to apply patch '{}' in {}".format(patch, os.getcwd())
+                    raise exceptions.PatchFailure(msg) from exc
+        common.newline()
+
     def identify(
         self,
         allow_dirty: bool = True,
@@ -318,6 +371,7 @@ class Source:
             rev=rev,
             links=self.links,
             scripts=self.scripts,
+            patches=self.patches,
             sparse_paths=self.sparse_paths,
         )
         return source

{gitman-3.6 → gitman-3.7}/gitman/plugin.py

@@ -69,6 +69,13 @@ def main(args=None):
         action="store_true",
         dest="no_scripts",
     )
+    parser.add_argument(
+        "-P",
+        "--no-patches",
+        help="skip patches after installation",
+        action="store_true",
+        dest="no_patches",
+    )
 
     # Update option
     group.add_argument(

{gitman-3.6 → gitman-3.7}/gitman/tests/test_cli.py

@@ -78,6 +78,7 @@ class TestInstall:
             clean=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -95,6 +96,7 @@ class TestInstall:
             clean=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -112,6 +114,7 @@ class TestInstall:
             clean=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -129,6 +132,7 @@ class TestInstall:
             clean=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -146,6 +150,7 @@ class TestInstall:
             clean=True,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -165,6 +170,7 @@ class TestInstall:
             clean=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -182,6 +188,7 @@ class TestInstall:
             clean=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
             skip_default_group=False,
         )
 
@@ -212,6 +219,7 @@ class TestUpdate:
             lock=None,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -229,6 +237,7 @@ class TestUpdate:
             lock=None,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -246,6 +255,7 @@ class TestUpdate:
             lock=False,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -263,6 +273,7 @@ class TestUpdate:
             lock=None,
             skip_changes=True,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -280,6 +291,7 @@ class TestUpdate:
             lock=None,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -297,6 +309,7 @@ class TestUpdate:
             lock=None,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -316,6 +329,7 @@ class TestUpdate:
             lock=None,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
     @patch("gitman.commands.update")
@@ -333,6 +347,7 @@ class TestUpdate:
             lock=None,
             skip_changes=False,
             skip_scripts=False,
+            skip_patches=False,
         )
 
 

{gitman-3.6 → gitman-3.7}/gitman/tests/test_plugin.py

@@ -23,6 +23,7 @@ class TestMain:
                 force_interactive=False,
                 skip_changes=False,
                 skip_scripts=False,
+                skip_patches=False,
                 skip_default_group=False,
             ),
             call.install().__bool__(),  # command status check
@@ -46,6 +47,7 @@ class TestMain:
                 lock=True,
                 skip_changes=False,
                 skip_scripts=False,
+                skip_patches=False,
             ),
             call.update().__bool__(),  # command status check
         ] == mock_commands.mock_calls
@@ -68,6 +70,7 @@ class TestMain:
                 lock=True,
                 skip_changes=False,
                 skip_scripts=False,
+                skip_patches=False,
             ),
             call.update().__bool__(),  # command status check
         ] == mock_commands.mock_calls
@@ -90,6 +93,7 @@ class TestMain:
                 lock=False,
                 skip_changes=False,
                 skip_scripts=False,
+                skip_patches=False,
             ),
             call.update().__bool__(),  # command status check
         ] == mock_commands.mock_calls
@@ -112,6 +116,7 @@ class TestMain:
                 lock=True,
                 skip_changes=True,
                 skip_scripts=False,
+                skip_patches=False,
             ),
             call.update().__bool__(),  # command status check
         ] == mock_commands.mock_calls

{gitman-3.6 → gitman-3.7}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "gitman"
-version = "3.6"
+version = "3.7"
 description = "A language-agnostic dependency manager using Git."
 
 license = "MIT"
@@ -43,17 +43,17 @@ classifiers = [
 
 [tool.poetry.dependencies]
 
-python = "^3.9"
+python = "^3.9,<3.15"
 
 datafiles = "^2.3.1"
 minilog = "^2.3.1"
-universal-startfile = "~0.2"
+universal-startfile = ">=0.2,<0.4"
 
 [tool.poetry.group.dev.dependencies]
 
 # Formatters
-black = "^24.8"
-isort = "^5.13"
+black = ">=24.8,<26.0"
+isort = ">=5.13,<7.0"
 
 # Linters
 mypy = "^1.3"
@@ -64,7 +64,7 @@ types-setuptools = "*"
 
 # Testing
 pytest = "^8.3"
-pytest-cov = "^5.0"
+pytest-cov = ">=5,<8"
 pytest-describe = "^2.2"
 pytest-expecter = "^3.0"
 pytest-random = "*"
@@ -75,16 +75,16 @@ coveragespace = "^6.1"
 
 # Documentation
 mkdocs = "^1.2.3"
-mkdocstrings = "^0.18.1"
+mkdocstrings = ">=0.18.1,<0.31.0"
 pygments = "^2.15.0"
 jinja2 = "~3.1.6"
 
 # Tooling
-pyinstaller = "^4.0"
+pyinstaller = "^6.15"
 sniffer = "*"
 macfsevents = { version = "*", platform = "darwin" }
 pync = { version = "*", platform = "darwin" }
-rope = "^0.14"
+rope = ">=0.14,<1.15"
 
 [tool.poetry.requires-plugins]