gitbolt 0.0.0.dev4__py3-none-any.whl → 0.0.0.dev6__py3-none-any.whl

gitbolt/__init__.py

@@ -4,6 +4,7 @@
 """
 Git command interfaces with default implementation using subprocess calls.
 """
+
 from pathlib import Path
 
 # region imports
@@ -38,4 +39,5 @@ def get_git(git_root_dir: Path = Path.cwd()) -> Git:
     :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/base.py

@@ -243,6 +243,18 @@ class Version(GitSubCommand, Protocol):
         """
         Require that arguments sent to the version command is valid.
 
+        Examples:
+
+        Correct:
+
+        >>> Version._require_valid_args()
+
+        Error:
+
+        >>> Version._require_valid_args(1) # type: ignore[arg-type] # required bool, supplied int
+        Traceback (most recent call last):
+        gitbolt.exceptions.GitExitingException: TypeError: build_options should be bool.
+
         :param build_options: argument to be validated.
         :raise GitExitingException: if supplied ``build_options`` is invalid.
         """

gitbolt/constants.py

@@ -4,7 +4,8 @@
 """
 Constants related to gitbolt.
 """
+
 from pathlib import Path
 
-GIT_DIR_STR = '.git'
+GIT_DIR_STR = ".git"
 GIT_DIR = Path(GIT_DIR_STR)

gitbolt/git_subprocess/base.py

@@ -340,6 +340,7 @@ class LsTreeCommand(LsTree, GitSubcmdCommand, Protocol):
         self.args_validator.validate(tree_ish, **ls_tree_opts)
         sub_cmd_args = self.cli_args_builder.build(tree_ish, **ls_tree_opts)
         main_cmd_args = self.underlying_git.build_main_cmd_args()
+        env_vars = self.underlying_git.build_git_envs()
 
         # Run the git command
         result = self.underlying_git.runner.run_git_command(
@@ -349,6 +350,7 @@ class LsTreeCommand(LsTree, GitSubcmdCommand, Protocol):
             text=True,
             capture_output=True,
             cwd=self.root_dir,
+            env=env_vars,
         )
 
         return result.stdout.strip()
@@ -420,6 +422,7 @@ class AddCommand(Add, GitSubcmdCommand, Protocol):
             **add_opts,
         )
         main_cmd_args = self.underlying_git.build_main_cmd_args()
+        env_vars = self.underlying_git.build_git_envs()
 
         # Run the git command
         result = self.underlying_git.runner.run_git_command(
@@ -430,6 +433,7 @@ class AddCommand(Add, GitSubcmdCommand, Protocol):
             text=True,
             capture_output=True,
             cwd=self.root_dir,
+            env=env_vars,
         )
 
         return result.stdout.strip()
@@ -514,12 +518,12 @@ class UncheckedSubcmd(GitSubcmdCommand, RootDirOp, Protocol):
         """
         main_cmd_args = self.underlying_git.build_main_cmd_args()
         envs_vars = self.underlying_git.build_git_envs()
-        another_supplied_env = subprocess_run_kwargs.pop('env', None)
+        another_supplied_env = subprocess_run_kwargs.pop("env", None)
         if another_supplied_env:
             envs_vars.update(another_supplied_env)
-        cwd = subprocess_run_kwargs.pop('cwd', None) or self.root_dir
-        capture_output = subprocess_run_kwargs.pop('capture_output', None) or True
-        check = subprocess_run_kwargs.pop('check', None) or True
+        cwd = subprocess_run_kwargs.pop("cwd", None) or self.root_dir
+        capture_output = subprocess_run_kwargs.pop("capture_output", None) or True
+        check = subprocess_run_kwargs.pop("check", None) or True
         # Run the git command
         result = self.underlying_git.runner.run_git_command(
             main_cmd_args,
@@ -531,6 +535,6 @@ class UncheckedSubcmd(GitSubcmdCommand, RootDirOp, Protocol):
             cwd=cwd,
             capture_output=capture_output,
             check=check,
-            **subprocess_run_kwargs
+            **subprocess_run_kwargs,
         )
         return result

gitbolt/git_subprocess/impl/simple.py

@@ -20,7 +20,7 @@ from gitbolt.git_subprocess import (
     LsTreeCommand,
     GitSubcmdCommand,
     AddCommand,
-    UncheckedSubcmd
+    UncheckedSubcmd,
 )
 from gitbolt.git_subprocess.add import AddCLIArgsBuilder
 from gitbolt.git_subprocess.constants import VERSION_CMD
@@ -48,10 +48,16 @@ class VersionCommandImpl(VersionCommand, GitSubcmdCommandImpl):
         self._require_valid_args(build_options)
         main_cmd_args = self.underlying_git.build_main_cmd_args()
         sub_cmd_args = [VERSION_CMD]
+        env_vars = self.underlying_git.build_git_envs()
         if build_options:
             sub_cmd_args.append("--build-options")
         return self.underlying_git.runner.run_git_command(
-            main_cmd_args, sub_cmd_args, check=True, text=True, capture_output=True
+            main_cmd_args,
+            sub_cmd_args,
+            check=True,
+            text=True,
+            capture_output=True,
+            env=env_vars,
         ).stdout.strip()
 
     def clone(self) -> "VersionCommandImpl":
@@ -133,11 +139,7 @@ class AddCommandImpl(AddCommand, GitSubcmdCommandImpl):
 
 
 class UncheckedSubcmdImpl(UncheckedSubcmd, GitSubcmdCommandImpl):
-    def __init__(
-        self,
-        root_dir: Path,
-        git: GitCommand
-    ):
+    def __init__(self, root_dir: Path, git: GitCommand):
         super().__init__(git)
         self._root_dir = root_dir
 
@@ -151,7 +153,6 @@ class UncheckedSubcmdImpl(UncheckedSubcmd, GitSubcmdCommandImpl):
 
 
 class SimpleGitCommand(GitCommand, RootDirOp):
-
     def __init__(
         self,
         git_root_dir: Path = Path.cwd(),
@@ -160,7 +161,7 @@ class SimpleGitCommand(GitCommand, RootDirOp):
         version_subcmd: VersionCommand | None = None,
         ls_tree_subcmd: LsTreeCommand | None = None,
         add_subcmd: AddCommand | None = None,
-        subcmd_unchecked: UncheckedSubcmd | None = None
+        subcmd_unchecked: UncheckedSubcmd | None = None,
     ):
         super().__init__(runner)
         self.git_root_dir = git_root_dir
@@ -172,17 +173,25 @@ class SimpleGitCommand(GitCommand, RootDirOp):
     @override
     @property
     def version_subcmd(self) -> VersionCommand:
-        return self._version_subcmd
+        # TODO: in all subcommand methods, find a better way to retain envs and opts rather than cloning each time
+        #   and setting the underlying git.
+        version_subcmd = self._version_subcmd.clone()
+        version_subcmd._set_underlying_git(self)
+        return version_subcmd
 
     @override
     @property
     def ls_tree_subcmd(self) -> LsTreeCommand:
-        return self._ls_tree
+        ls_tree_subcmd = self._ls_tree.clone()
+        ls_tree_subcmd._set_underlying_git(self)
+        return ls_tree_subcmd
 
     @override
     @property
     def add_subcmd(self) -> AddCommand:
-        return self._add_subcmd
+        add_subcmd = self._add_subcmd.clone()
+        add_subcmd._set_underlying_git(self)
+        return add_subcmd
 
     @override
     def clone(self) -> "SimpleGitCommand":
@@ -193,7 +202,7 @@ class SimpleGitCommand(GitCommand, RootDirOp):
             version_subcmd=self.version_subcmd,
             ls_tree_subcmd=self.ls_tree_subcmd,
             add_subcmd=self.add_subcmd,
-            subcmd_unchecked=self.subcmd_unchecked
+            subcmd_unchecked=self.subcmd_unchecked,
         )
         # endregion
         # region clone protected members
@@ -209,4 +218,6 @@ class SimpleGitCommand(GitCommand, RootDirOp):
 
     @property
     def subcmd_unchecked(self) -> UncheckedSubcmd:
-        return self._subcmd_unchecked
+        subcmd_unchecked = self._subcmd_unchecked.clone()
+        subcmd_unchecked._set_underlying_git(self)
+        return subcmd_unchecked

gitbolt/git_subprocess/runner/simple_impl.py

@@ -86,4 +86,6 @@ class SimpleGitCR(GitCommandRunner):
                 **subprocess_run_kwargs,
             )
         except subprocess.CalledProcessError as e:
-            raise GitCmdException(e.stderr, called_process_error=e, exit_code=e.returncode) from e
+            raise GitCmdException(
+                e.stderr, called_process_error=e, exit_code=e.returncode
+            ) from e

gitbolt/pytest_plugin.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+# coding=utf-8
+
+"""
+Third-party importable pytest plugins for ``gitbolt``.
+"""
+
+import subprocess
+from pathlib import Path
+
+import pytest
+
+REMOTE_DIR_NAME = "remote"
+LOCAL_DIR_NAME = "local"
+
+
+@pytest.fixture
+def repo_root(tmpdir):
+    """
+    Create a test repo root to perform tests in.
+
+    :param tmpdir: temporary directory for test.
+    :return: temporary directory
+    """
+    return tmpdir
+
+
+@pytest.fixture
+def repo_remote(repo_root) -> Path:
+    subprocess.run(
+        ["git", "init", "--bare", REMOTE_DIR_NAME], cwd=repo_root, check=True
+    )
+    return repo_root / REMOTE_DIR_NAME
+
+
+@pytest.fixture
+def repo_local(repo_root, repo_remote) -> Path:
+    subprocess.run(
+        ["git", "clone", REMOTE_DIR_NAME, LOCAL_DIR_NAME], cwd=repo_root, check=True
+    )
+    return repo_root / LOCAL_DIR_NAME

{gitbolt-0.0.0.dev4.dist-info → gitbolt-0.0.0.dev6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev4
+Version: 0.0.0.dev6
 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>
@@ -27,6 +27,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: vt-err-hndlr==0.0.0dev1
+Requires-Dist: pytest
 Provides-Extra: pygit2
 Requires-Dist: pygit2; extra == "pygit2"
 Dynamic: license-file

{gitbolt-0.0.0.dev4.dist-info → gitbolt-0.0.0.dev6.dist-info}/RECORD

@@ -1,28 +1,30 @@
-gitbolt/__init__.py,sha256=fYw-eNfs7kpowyQOqx0K8rmoMCCg4pZnxrBFrmHvIfM,1174
+gitbolt/__init__.py,sha256=SyV-PMv4Ul_k8sh7Y76Y4hUku1N5s-4ViyDpVbfRDOI,1176
 gitbolt/_internal_init.py,sha256=alSsIMgBWHmOdUo7P1ewftR12xPv8vb3ZgECuVsRMwk,485
 gitbolt/add.py,sha256=F16d0SQfLrjbpUzJIjKFwGU4KLSjqtYLOA9oZ5gdNS0,31731
-gitbolt/base.py,sha256=eUjzfu0OilCrOpxpwRyCSs7HD83OaXk6BCzxT8LKKhU,9322
-gitbolt/constants.py,sha256=5obkhMs8Og9P_xxQKEPvDx0io9mIYhZLc8Uv2WVrOHI,152
+gitbolt/base.py,sha256=Vhd4GkTu3OscngXRJVfUMxVDY5Ilu6WVZvuhNw4dgFA,9649
+gitbolt/constants.py,sha256=PyGZ8XG-OhSM7K0iHmZrTaF0-WwU5sCe8t8p7JcPu-c,153
 gitbolt/exceptions.py,sha256=7YvR7whZYM1hlWZk4GxHbeNgJ0KJXElg5VFA1Vi-fiA,989
 gitbolt/ls_tree.py,sha256=PrDSoh4Pnqh6g4AfX8kwgez_zHYaH4yqknULbFbisUY,6269
 gitbolt/models.py,sha256=iwIO-ugHYiKS57I_LPo3uDFEQlAtu2mnn5AjZHHQg04,18828
 gitbolt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitbolt/pytest_plugin.py,sha256=Gto30Ofmfz8kJ_AuBrEhqENmWoDlpMnsrpQWzHDmUi4,833
 gitbolt/utils.py,sha256=XftX3LIKtfzjQaUZUF3QYaFJFM-QdFjc05ZrZSMSdeM,6315
 gitbolt/git_subprocess/__init__.py,sha256=yEyJKH_iXFBkdgQMwE8vnHnhVTrjs2RkQUjUCF25SzU,590
 gitbolt/git_subprocess/_internal_init.py,sha256=C6jfsbjXhIFHaDH9GE-wLPAN9WMlUU57rRLWvfpZuAs,255
 gitbolt/git_subprocess/add.py,sha256=1PA9XonqFi2O941eBwIPMobSNgEJ0tgFYxlkVXSe1K4,17277
-gitbolt/git_subprocess/base.py,sha256=ywm_bGVt0R9ILyj5rtwYS3e-gQGIkaGSGkaPvm1JK9k,17591
+gitbolt/git_subprocess/base.py,sha256=iAL_aFiywqbZGuPHTqY03ve5O0bYkdyLzmdzc30mM4E,17756
 gitbolt/git_subprocess/constants.py,sha256=3qHXbNjPf_DOhTPNHi3_bcvIpvtqvgFtpGoTJLYmTWk,250
 gitbolt/git_subprocess/exceptions.py,sha256=cx4YKzxeBRSRKoF-oakZLpFUGrAHiGj1FtMIsiK5oHc,4063
 gitbolt/git_subprocess/ls_tree.py,sha256=MmM3qh-kvkD_tGQG9yliLx-reY_5TIVEArvAXJN6rP4,13200
 gitbolt/git_subprocess/utils.py,sha256=n9_kXPvDf0ACrzAm6SVVLBOFM1JyjHmXJl_99vBoPS8,4941
 gitbolt/git_subprocess/impl/__init__.py,sha256=bxYluO0B3My-10H5Z0JuEGvZe_g8i71QTpt6iM0WXoU,97
-gitbolt/git_subprocess/impl/simple.py,sha256=yY7tMI4B093ssooZB4UvffVQaCrFVD1bAIrieYPajLQ,6407
+gitbolt/git_subprocess/impl/simple.py,sha256=sjdby07SlLfdKpGlLedN9nYEAWxkGqy-rlJ1x32rbtE,7051
 gitbolt/git_subprocess/runner/__init__.py,sha256=LPxbj3AwKLXyDxxCLwAVtl5b5SKjaNDj99lkKz6VSOU,177
 gitbolt/git_subprocess/runner/base.py,sha256=Sof2WaNyYULiObRF7WjaGs7-yGrdyeHUXchE2tg1820,1562
-gitbolt/git_subprocess/runner/simple_impl.py,sha256=V-6efvcQLP6gpUKSwRfnNI-Zd9nBxaN0EuAnpn-5LwU,2494
-gitbolt-0.0.0.dev4.dist-info/licenses/LICENSE,sha256=pOzr5bMWS6mHi3vro8d5vw0qW1i14rVq2XFrDuystVY,11372
-gitbolt-0.0.0.dev4.dist-info/METADATA,sha256=JsZQi3otwuW43nJQ-Szj-lo99zBjmjYDAD7jaIYBP7M,11227
-gitbolt-0.0.0.dev4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gitbolt-0.0.0.dev4.dist-info/top_level.txt,sha256=QCXclkzSPZjgamcwB6XuKJexaJ1as_TLUUSGdIDA7VY,8
-gitbolt-0.0.0.dev4.dist-info/RECORD,,
+gitbolt/git_subprocess/runner/simple_impl.py,sha256=JvKCQ_MITguuMn3f3hVQwfAukymkIqFdli5f2fxin54,2524
+gitbolt-0.0.0.dev6.dist-info/licenses/LICENSE,sha256=pOzr5bMWS6mHi3vro8d5vw0qW1i14rVq2XFrDuystVY,11372
+gitbolt-0.0.0.dev6.dist-info/METADATA,sha256=xBJyJKj2N0cyqasfrejKd1JocGRs6KA4ObWdpAvBDDQ,11249
+gitbolt-0.0.0.dev6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gitbolt-0.0.0.dev6.dist-info/entry_points.txt,sha256=Q078Wjss4skreUs8hzAEJ8sUcH4Rhjc9emZ4jRXCiBM,52
+gitbolt-0.0.0.dev6.dist-info/top_level.txt,sha256=QCXclkzSPZjgamcwB6XuKJexaJ1as_TLUUSGdIDA7VY,8
+gitbolt-0.0.0.dev6.dist-info/RECORD,,

gitbolt-0.0.0.dev6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+gitbolt_fixtures = gitbolt.pytest_plugin