gitbolt 0.0.0.dev13__tar.gz → 0.0.0.dev14__tar.gz

{gitbolt-0.0.0.dev13 → gitbolt-0.0.0.dev14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev13
+Version: 0.0.0.dev14
 Summary: Fast, flexible and type-safe Git commands in Python.
 Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
 Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
@@ -26,7 +26,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vt-err-hndlr>=0.0.0dev5
+Requires-Dist: vt-err-hndlr>=0.0.0dev6
 Requires-Dist: vt-commons>=0.0.1.dev9
 Provides-Extra: pygit2
 Requires-Dist: pygit2; extra == "pygit2"

{gitbolt-0.0.0.dev13 → gitbolt-0.0.0.dev14}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitbolt"
-version = "0.0.0dev13"
+version = "0.0.0dev14"
 description = "Fast, flexible and type-safe Git commands in Python."
 requires-python = ">=3.12"
 readme = "README.md"
@@ -36,7 +36,7 @@ classifiers = [
   "Typing :: Typed"
 ]
 dependencies = [
-  "vt-err-hndlr >= 0.0.0dev5",
+  "vt-err-hndlr >= 0.0.0dev6",
   "vt-commons >= 0.0.1.dev9",
 ]
 

gitbolt-0.0.0.dev14/src/gitbolt/__init__.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+# coding=utf-8
+
+"""
+Git command interfaces with default implementation using subprocess calls.
+"""
+
+from pathlib import Path
+
+# region imports
+# region base related imports
+from gitbolt.base import Git as Git
+from gitbolt.base import CanOverrideGitOpts as CanOverrideGitOpts
+from gitbolt.base import HasGitUnderneath as HasGitUnderneath
+from gitbolt.base import GitSubCommand as GitSubCommand
+from gitbolt.base import LsTree as LsTree
+from gitbolt.base import Version as Version
+from gitbolt.base import Add as Add
+from gitbolt.subprocess.base import GitCommand
+# endregion
+
+
+from gitbolt.constants import GIT_DIR as GIT_DIR
+from gitbolt.subprocess.constants import GIT_CMD
+from gitbolt.subprocess.impl.simple import SimpleGitCommand as _SimpleGitCommand
+from gitbolt.subprocess.impl.simple import CLISimpleGitCommand as _CLISimpleGitCommand
+from gitbolt.subprocess.runner.simple import SimpleGitCR as _SimpleGitCR
+# endregion
+
+
+def get_git(git_root_dir: Path = Path.cwd()) -> Git:
+    """
+    Get operational and programmatic ``Git``.
+
+    Examples:
+
+    * Get git version:
+
+    >>> import subprocess
+    >>> import gitbolt
+    >>> git = gitbolt.get_git()
+    >>> assert git.version().version() == subprocess.run(['git', 'version'], capture_output=True, text=True).stdout.strip()
+
+    :param git_root_dir: Path to the git repo root directory. Defaults to current working directory.
+    :returns: The ``Git`` instance with all subcommands.
+    """
+
+    return _SimpleGitCommand(git_root_dir)
+
+
+def get_git_command(
+    git_root_dir: Path = Path.cwd(),
+    *,
+    git_prog: str | Path = GIT_CMD,
+    main_cmd_opts: list[str] | None = None,
+    main_cmd_envs: dict[str, str] | None = None,
+    prefer_cli: bool = False,
+) -> GitCommand:
+    """
+    Get operational and programmatic ``Git`` which runs as a subprocess.
+
+    Examples:
+
+    * Get git version, as base git:
+
+    >>> import subprocess
+    >>> import gitbolt
+    >>> git = gitbolt.get_git_command()
+    >>> assert git.version().version() == subprocess.run(['git', 'version'], capture_output=True, text=True).stdout.strip()
+
+    * Get git version, as a git subcommand. Runs git in subprocess:
+
+    >>> assert git.subcmd_unchecked.run(["version"], text=True).stdout.strip() == subprocess.run(['git', 'version'], capture_output=True, text=True).stdout.strip()
+
+    :param git_root_dir: Path to the git repo root directory. Defaults to current working directory.
+    :param git_prog: git program name/location. Useful when user wants to run a separate git version/git emulator.
+    :param opts: main git cli options. The main git command options like ``--no-replace-objects``, ``--no-pager``, ``-C`` etc are git main command args.
+    :param envs: main git cli env vars. Not supplying any env vars (default behavior: ``None``) simply supplies all
+        the env vars to the underlying runner.
+    :param prefer_cli: cli opts and envs will be given priority over programmatically set opts and envs. Setting
+        this param to ``True`` will make cli opts and envs appear later in the opts and envs strings which will
+        make them override previously programmatically set opts and envs.
+    :returns: ``GitCommand`` instance with all the subcommands as well as ``unchecked_subcmd``. Runs git commands in a
+        separate runner in subprocess.
+    """
+    runner = _SimpleGitCR(git_prog)
+    if main_cmd_opts is None:
+        return _SimpleGitCommand(git_root_dir, runner)
+    else:
+        return _CLISimpleGitCommand(
+            git_root_dir,
+            runner,
+            opts=main_cmd_opts,
+            envs=main_cmd_envs,
+            prefer_cli=prefer_cli,
+        )

gitbolt-0.0.0.dev14/src/gitbolt/subprocess/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+# coding=utf-8
+
+"""
+Git command interfaces with implementation using subprocess calls.
+"""
+
+# region gitbolt.subprocess.base
+from gitbolt.subprocess.base import GitCommand as GitCommand
+from gitbolt.subprocess.base import GitSubcmdCommand as GitSubcmdCommand
+from gitbolt.subprocess.base import AddCommand as AddCommand
+from gitbolt.subprocess.base import LsTreeCommand as LsTreeCommand
+from gitbolt.subprocess.base import VersionCommand as VersionCommand
+from gitbolt.subprocess.base import UncheckedSubcmd as UncheckedSubcmd
+# endregion

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/add.py

@@ -9,7 +9,7 @@ from abc import abstractmethod
 from pathlib import Path
 from typing import Protocol, Unpack, override, Literal
 
-from gitbolt.git_subprocess.constants import ADD_CMD
+from gitbolt.subprocess.constants import ADD_CMD
 from gitbolt.models import GitAddOpts
 
 

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/base.py

@@ -19,12 +19,12 @@ from vt.utils.errors.error_specs import ERR_INVALID_USAGE
 
 from gitbolt import Git, Version, LsTree, GitSubCommand, HasGitUnderneath, Add
 from gitbolt.exceptions import GitExitingException
-from gitbolt.git_subprocess.add import AddCLIArgsBuilder, IndividuallyOverridableACAB
-from gitbolt.git_subprocess.ls_tree import (
+from gitbolt.subprocess.add import AddCLIArgsBuilder, IndividuallyOverridableACAB
+from gitbolt.subprocess.ls_tree import (
     LsTreeCLIArgsBuilder,
     IndividuallyOverridableLTCAB,
 )
-from gitbolt.git_subprocess.runner import GitCommandRunner
+from gitbolt.subprocess.runner import GitCommandRunner
 from gitbolt.models import GitOpts, GitLsTreeOpts, GitAddOpts, GitEnvVars
 from gitbolt.utils import merge_git_opts, merge_git_envs
 

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/exceptions.py

@@ -22,26 +22,26 @@ class GitCmdException(GitException, VTCmdException):
 
         >>> raise GitCmdException(called_process_error=CalledProcessError(1, ['git', 'status'])) # always use `from` clause.
         Traceback (most recent call last):
-        gitbolt.git_subprocess.exceptions.GitCmdException: CalledProcessError: Command '['git', 'status']' returned non-zero exit status 1.
+        gitbolt.subprocess.exceptions.GitCmdException: CalledProcessError: Command '['git', 'status']' returned non-zero exit status 1.
 
       * raise with a message:
 
         >>> raise GitCmdException('Git failed', called_process_error=CalledProcessError(1, ['git', 'push'])) # always use `from` clause.
         Traceback (most recent call last):
-        gitbolt.git_subprocess.exceptions.GitCmdException: CalledProcessError: Git failed
+        gitbolt.subprocess.exceptions.GitCmdException: CalledProcessError: Git failed
 
       * raise with overridden exit code:
 
         >>> raise GitCmdException('Git push failed', called_process_error=CalledProcessError(1, ['git', 'push']), exit_code=42) # always use `from` clause.
         Traceback (most recent call last):
-        gitbolt.git_subprocess.exceptions.GitCmdException: CalledProcessError: Git push failed
+        gitbolt.subprocess.exceptions.GitCmdException: CalledProcessError: Git push failed
 
       * raise without message, override with stderr inside CalledProcessError:
 
         >>> err = CalledProcessError(128, ['git', 'fetch'], stderr='fatal: not a git repository')
         >>> raise GitCmdException(called_process_error=err) # always use `from` clause.
         Traceback (most recent call last):
-        gitbolt.git_subprocess.exceptions.GitCmdException: CalledProcessError: Command '['git', 'fetch']' returned non-zero exit status 128.
+        gitbolt.subprocess.exceptions.GitCmdException: CalledProcessError: Command '['git', 'fetch']' returned non-zero exit status 128.
 
       * raise exception using `from` clause (chaining):
 
@@ -50,7 +50,7 @@ class GitCmdException(GitException, VTCmdException):
         ... except CalledProcessError as e:
         ...     raise GitCmdException('Clone failed', called_process_error=e) from e
         Traceback (most recent call last):
-        gitbolt.git_subprocess.exceptions.GitCmdException: CalledProcessError: Clone failed
+        gitbolt.subprocess.exceptions.GitCmdException: CalledProcessError: Clone failed
 
       * cause reflects original CalledProcessError when chained:
 

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/impl/simple.py

@@ -15,7 +15,7 @@ from vt.utils.commons.commons.op import RootDirOp
 
 from gitbolt.base import Version
 from gitbolt.add import AddArgsValidator
-from gitbolt.git_subprocess import (
+from gitbolt.subprocess import (
     GitCommand,
     VersionCommand,
     LsTreeCommand,
@@ -23,11 +23,11 @@ from gitbolt.git_subprocess import (
     AddCommand,
     UncheckedSubcmd,
 )
-from gitbolt.git_subprocess.add import AddCLIArgsBuilder
-from gitbolt.git_subprocess.constants import VERSION_CMD
-from gitbolt.git_subprocess.ls_tree import LsTreeCLIArgsBuilder
-from gitbolt.git_subprocess.runner import GitCommandRunner
-from gitbolt.git_subprocess.runner.simple_impl import SimpleGitCR
+from gitbolt.subprocess.add import AddCLIArgsBuilder
+from gitbolt.subprocess.constants import VERSION_CMD
+from gitbolt.subprocess.ls_tree import LsTreeCLIArgsBuilder
+from gitbolt.subprocess.runner import GitCommandRunner
+from gitbolt.subprocess.runner.simple import SimpleGitCR
 from gitbolt.ls_tree import LsTreeArgsValidator
 
 

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/ls_tree.py

@@ -8,7 +8,7 @@ Helper interfaces for ``git ls-tree`` subcommand with default implementation for
 from abc import abstractmethod
 from typing import Protocol, Unpack, override
 
-from gitbolt.git_subprocess.constants import LS_TREE_CMD
+from gitbolt.subprocess.constants import LS_TREE_CMD
 from gitbolt.models import GitLsTreeOpts
 
 

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/runner/__init__.py

@@ -5,4 +5,4 @@
 Git command runners to run subprocess calls.
 """
 
-from gitbolt.git_subprocess.runner.base import GitCommandRunner as GitCommandRunner
+from gitbolt.subprocess.runner.base import GitCommandRunner as GitCommandRunner

{gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess → gitbolt-0.0.0.dev14/src/gitbolt/subprocess}/runner/base.py

@@ -7,6 +7,7 @@ Git command runner interfaces to run subprocess calls.
 
 from __future__ import annotations
 
+import pathlib
 from abc import abstractmethod
 from subprocess import CompletedProcess
 from typing import Protocol, overload, Any, Literal
@@ -62,3 +63,11 @@ class GitCommandRunner(Protocol):
         text: Literal[False] = ...,
         **subprocess_run_kwargs: Any,
     ) -> CompletedProcess[bytes]: ...
+
+    @property
+    @abstractmethod
+    def git_prog(self) -> str | pathlib.Path:
+        """
+        :returns: git path location or git program name.
+        """
+        ...

gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess/runner/simple_impl.py → gitbolt-0.0.0.dev14/src/gitbolt/subprocess/runner/simple.py

@@ -7,13 +7,14 @@ A simple and straight-forward git command subprocess runner implementation.
 
 from __future__ import annotations
 
+import pathlib
 import subprocess
 from subprocess import CompletedProcess
 from typing import overload, override, Any, Literal
 
-from gitbolt.git_subprocess.constants import GIT_CMD
-from gitbolt.git_subprocess.exceptions import GitCmdException
-from gitbolt.git_subprocess.runner import GitCommandRunner
+from gitbolt.subprocess.constants import GIT_CMD
+from gitbolt.subprocess.exceptions import GitCmdException
+from gitbolt.subprocess.runner import GitCommandRunner
 
 
 class SimpleGitCR(GitCommandRunner):
@@ -21,6 +22,12 @@ class SimpleGitCR(GitCommandRunner):
     Simple git command runner that simply runs everything `as-is` in a subprocess.
     """
 
+    def __init__(self, git_prog: str | pathlib.Path = GIT_CMD):
+        """
+        :param git_prog: git program name/location. Useful when user wants to run a separate git version/git emulator.
+        """
+        self._git_prog = git_prog
+
     @overload
     @override
     def run_git_command(
@@ -79,7 +86,7 @@ class SimpleGitCR(GitCommandRunner):
     ) -> CompletedProcess[str] | CompletedProcess[bytes]:
         try:
             return subprocess.run(
-                [GIT_CMD, *main_cmd_args, *subcommand_args],
+                [str(self.git_prog), *main_cmd_args, *subcommand_args],
                 *subprocess_run_args,
                 input=_input,
                 text=text,
@@ -89,3 +96,8 @@ class SimpleGitCR(GitCommandRunner):
             raise GitCmdException(
                 e.stderr, called_process_error=e, exit_code=e.returncode
             ) from e
+
+    @override
+    @property
+    def git_prog(self) -> str | pathlib.Path:
+        return self._git_prog

{gitbolt-0.0.0.dev13 → gitbolt-0.0.0.dev14}/src/gitbolt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev13
+Version: 0.0.0.dev14
 Summary: Fast, flexible and type-safe Git commands in Python.
 Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
 Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
@@ -26,7 +26,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vt-err-hndlr>=0.0.0dev5
+Requires-Dist: vt-err-hndlr>=0.0.0dev6
 Requires-Dist: vt-commons>=0.0.1.dev9
 Provides-Extra: pygit2
 Requires-Dist: pygit2; extra == "pygit2"

gitbolt-0.0.0.dev14/src/gitbolt.egg-info/SOURCES.txt

@@ -0,0 +1,33 @@
+LICENSE
+README.md
+pyproject.toml
+src/gitbolt/__init__.py
+src/gitbolt/_internal_init.py
+src/gitbolt/add.py
+src/gitbolt/base.py
+src/gitbolt/constants.py
+src/gitbolt/exceptions.py
+src/gitbolt/ls_tree.py
+src/gitbolt/models.py
+src/gitbolt/py.typed
+src/gitbolt/pytest_plugin.py
+src/gitbolt/utils.py
+src/gitbolt.egg-info/PKG-INFO
+src/gitbolt.egg-info/SOURCES.txt
+src/gitbolt.egg-info/dependency_links.txt
+src/gitbolt.egg-info/entry_points.txt
+src/gitbolt.egg-info/requires.txt
+src/gitbolt.egg-info/top_level.txt
+src/gitbolt/subprocess/__init__.py
+src/gitbolt/subprocess/_internal_init.py
+src/gitbolt/subprocess/add.py
+src/gitbolt/subprocess/base.py
+src/gitbolt/subprocess/constants.py
+src/gitbolt/subprocess/exceptions.py
+src/gitbolt/subprocess/ls_tree.py
+src/gitbolt/subprocess/utils.py
+src/gitbolt/subprocess/impl/__init__.py
+src/gitbolt/subprocess/impl/simple.py
+src/gitbolt/subprocess/runner/__init__.py
+src/gitbolt/subprocess/runner/base.py
+src/gitbolt/subprocess/runner/simple.py

{gitbolt-0.0.0.dev13 → gitbolt-0.0.0.dev14}/src/gitbolt.egg-info/requires.txt

@@ -1,4 +1,4 @@
-vt-err-hndlr>=0.0.0dev5
+vt-err-hndlr>=0.0.0dev6
 vt-commons>=0.0.1.dev9
 
 [pygit2]

gitbolt-0.0.0.dev13/src/gitbolt/__init__.py

@@ -1,43 +0,0 @@
-#!/usr/bin/env python3
-# coding=utf-8
-
-"""
-Git command interfaces with default implementation using subprocess calls.
-"""
-
-from pathlib import Path
-
-# region imports
-# region base related imports
-from gitbolt.base import Git as Git
-from gitbolt.base import CanOverrideGitOpts as CanOverrideGitOpts
-from gitbolt.base import HasGitUnderneath as HasGitUnderneath
-from gitbolt.base import GitSubCommand as GitSubCommand
-from gitbolt.base import LsTree as LsTree
-from gitbolt.base import Version as Version
-from gitbolt.base import Add as Add
-# endregion
-
-
-from gitbolt.constants import GIT_DIR as GIT_DIR
-# endregion
-
-
-def get_git(git_root_dir: Path = Path.cwd()) -> Git:
-    """
-    Get operational and programmatic ``Git``.
-
-    Examples:
-
-    * Get git version:
-
-    >>> import subprocess
-    >>> import gitbolt
-    >>> git = gitbolt.get_git()
-    >>> assert git.version().version() == subprocess.run(['git', 'version'], capture_output=True, text=True).stdout.strip()
-
-    :param git_root_dir: Path to the git repo root directory. Defaults to current working directory.
-    """
-    from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
-
-    return SimpleGitCommand(git_root_dir)

gitbolt-0.0.0.dev13/src/gitbolt/git_subprocess/__init__.py

@@ -1,15 +0,0 @@
-#!/usr/bin/env python3
-# coding=utf-8
-
-"""
-Git command interfaces with implementation using subprocess calls.
-"""
-
-# region gitbolt.git_subprocess.base
-from gitbolt.git_subprocess.base import GitCommand as GitCommand
-from gitbolt.git_subprocess.base import GitSubcmdCommand as GitSubcmdCommand
-from gitbolt.git_subprocess.base import AddCommand as AddCommand
-from gitbolt.git_subprocess.base import LsTreeCommand as LsTreeCommand
-from gitbolt.git_subprocess.base import VersionCommand as VersionCommand
-from gitbolt.git_subprocess.base import UncheckedSubcmd as UncheckedSubcmd
-# endregion

gitbolt-0.0.0.dev13/src/gitbolt.egg-info/SOURCES.txt

@@ -1,33 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/gitbolt/__init__.py
-src/gitbolt/_internal_init.py
-src/gitbolt/add.py
-src/gitbolt/base.py
-src/gitbolt/constants.py
-src/gitbolt/exceptions.py
-src/gitbolt/ls_tree.py
-src/gitbolt/models.py
-src/gitbolt/py.typed
-src/gitbolt/pytest_plugin.py
-src/gitbolt/utils.py
-src/gitbolt.egg-info/PKG-INFO
-src/gitbolt.egg-info/SOURCES.txt
-src/gitbolt.egg-info/dependency_links.txt
-src/gitbolt.egg-info/entry_points.txt
-src/gitbolt.egg-info/requires.txt
-src/gitbolt.egg-info/top_level.txt
-src/gitbolt/git_subprocess/__init__.py
-src/gitbolt/git_subprocess/_internal_init.py
-src/gitbolt/git_subprocess/add.py
-src/gitbolt/git_subprocess/base.py
-src/gitbolt/git_subprocess/constants.py
-src/gitbolt/git_subprocess/exceptions.py
-src/gitbolt/git_subprocess/ls_tree.py
-src/gitbolt/git_subprocess/utils.py
-src/gitbolt/git_subprocess/impl/__init__.py
-src/gitbolt/git_subprocess/impl/simple.py
-src/gitbolt/git_subprocess/runner/__init__.py
-src/gitbolt/git_subprocess/runner/base.py
-src/gitbolt/git_subprocess/runner/simple_impl.py