gitbolt 0.0.0.dev3__py3-none-any.whl → 0.0.0.dev5__py3-none-any.whl

gitbolt/git_subprocess/__init__.py

@@ -11,4 +11,5 @@ 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/git_subprocess/base.py

@@ -9,9 +9,11 @@ from __future__ import annotations
 
 from abc import abstractmethod, ABC
 from pathlib import Path
-from typing import override, Protocol, Unpack, Self, overload, Literal
+from subprocess import CompletedProcess
+from typing import override, Protocol, Unpack, Self, overload, Literal, Any
 
 from vt.utils.commons.commons.core_py import is_unset, not_none_not_unset
+from vt.utils.commons.commons.op import RootDirOp
 
 from gitbolt import Git, Version, LsTree, GitSubCommand, HasGitUnderneath, Add
 from gitbolt.git_subprocess.add import AddCLIArgsBuilder, IndividuallyOverridableACAB
@@ -283,6 +285,14 @@ class GitCommand(Git, ABC):
     @abstractmethod
     def add_subcmd(self) -> AddCommand: ...
 
+    @property
+    @abstractmethod
+    def subcmd_unchecked(self) -> UncheckedSubcmd:
+        """
+        Run an unchecked git subcommand using subprocess.
+        """
+        ...
+
 
 class GitSubcmdCommand(GitSubCommand, HasGitUnderneath["GitCommand"], Protocol):
     """
@@ -434,3 +444,93 @@ class AddCommand(Add, GitSubcmdCommand, Protocol):
         :return: Builder the complete list of subcommand CLI arguments to be passed to ``git add`` subprocess.
         """
         return IndividuallyOverridableACAB()
+
+
+class UncheckedSubcmd(GitSubcmdCommand, RootDirOp, Protocol):
+    """
+    Unchecked git subcommand. Runs subcommands directly in subprocess.
+    """
+
+    @override
+    def _subcmd_from_git(self, git: "Git") -> Self:
+        return self
+
+    @overload
+    def run(
+        self,
+        subcommand_args: list[str],
+        *subprocess_run_args: Any,
+        _input: str,
+        text: Literal[True],
+        **subprocess_run_kwargs: Any,
+    ) -> CompletedProcess[str]: ...
+
+    @overload
+    def run(
+        self,
+        subcommand_args: list[str],
+        *subprocess_run_args: Any,
+        _input: bytes,
+        text: Literal[False],
+        **subprocess_run_kwargs: Any,
+    ) -> CompletedProcess[bytes]: ...
+
+    @overload
+    def run(
+        self,
+        subcommand_args: list[str],
+        *subprocess_run_args: Any,
+        text: Literal[True],
+        **subprocess_run_kwargs: Any,
+    ) -> CompletedProcess[str]: ...
+
+    @overload
+    def run(
+        self,
+        subcommand_args: list[str],
+        *subprocess_run_args: Any,
+        text: Literal[False] = ...,
+        **subprocess_run_kwargs: Any,
+    ) -> CompletedProcess[bytes]: ...
+
+    def run(
+        self,
+        subcommand_args: list[str],
+        *subprocess_run_args: Any,
+        _input: str | bytes | None = None,
+        text: Literal[True, False] = False,
+        **subprocess_run_kwargs,
+    ) -> CompletedProcess[str] | CompletedProcess[bytes]:
+        """
+        Run unchecked git subcommand using subprocess
+
+        :param subcommand_args: the full subcommand argument list.
+        :param subprocess_run_args: additional subprocess positionals.
+        :param _input: any stdin to be passed to the subprocess.
+        :param text: ``_input`` and returns both are str if this value is ``True``. Else, bytes are considered.
+        :param subprocess_run_kwargs: additional subprocess keyword arguments.
+
+        :return: ``CompletedProcess`` capturing all the required stdout, stderr, return-code etc.
+        """
+        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)
+        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
+        # Run the git command
+        result = self.underlying_git.runner.run_git_command(
+            main_cmd_args,
+            subcommand_args,
+            *subprocess_run_args,
+            _input=_input,
+            text=text,
+            env=envs_vars,
+            cwd=cwd,
+            capture_output=capture_output,
+            check=check,
+            **subprocess_run_kwargs
+        )
+        return result

gitbolt/git_subprocess/impl/simple.py

@@ -20,6 +20,7 @@ from gitbolt.git_subprocess import (
     LsTreeCommand,
     GitSubcmdCommand,
     AddCommand,
+    UncheckedSubcmd
 )
 from gitbolt.git_subprocess.add import AddCLIArgsBuilder
 from gitbolt.git_subprocess.constants import VERSION_CMD
@@ -131,7 +132,26 @@ class AddCommandImpl(AddCommand, GitSubcmdCommandImpl):
         return AddCommandImpl(self.root_dir, self.underlying_git)
 
 
+class UncheckedSubcmdImpl(UncheckedSubcmd, GitSubcmdCommandImpl):
+    def __init__(
+        self,
+        root_dir: Path,
+        git: GitCommand
+    ):
+        super().__init__(git)
+        self._root_dir = root_dir
+
+    @override
+    @property
+    def root_dir(self) -> Path:
+        return self._root_dir
+
+    def clone(self) -> "UncheckedSubcmdImpl":
+        return UncheckedSubcmdImpl(self.root_dir, self.underlying_git)
+
+
 class SimpleGitCommand(GitCommand, RootDirOp):
+
     def __init__(
         self,
         git_root_dir: Path = Path.cwd(),
@@ -140,12 +160,14 @@ 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
     ):
         super().__init__(runner)
         self.git_root_dir = git_root_dir
         self._version_subcmd = version_subcmd or VersionCommandImpl(self)
         self._ls_tree = ls_tree_subcmd or LsTreeCommandImpl(self.root_dir, self)
         self._add_subcmd = add_subcmd or AddCommandImpl(self.root_dir, self)
+        self._subcmd_unchecked = subcmd_unchecked or UncheckedSubcmdImpl(self.root_dir, self)
 
     @override
     @property
@@ -171,6 +193,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
         )
         # endregion
         # region clone protected members
@@ -183,3 +206,7 @@ class SimpleGitCommand(GitCommand, RootDirOp):
     @property
     def root_dir(self) -> Path:
         return self.git_root_dir
+
+    @property
+    def subcmd_unchecked(self) -> UncheckedSubcmd:
+        return self._subcmd_unchecked

gitbolt/git_subprocess/runner/simple_impl.py

@@ -86,4 +86,4 @@ class SimpleGitCR(GitCommandRunner):
                 **subprocess_run_kwargs,
             )
         except subprocess.CalledProcessError as e:
-            raise GitCmdException(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,40 @@
+#!/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.dev3.dist-info → gitbolt-0.0.0.dev5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev3
+Version: 0.0.0.dev5
 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
@@ -272,6 +273,23 @@ no_advice_reset_git = overridden_git.git_opts_override(no_advice=False)
 
 </details>
 
+### 🔄 Run unchecked commands
+
+At last, run unchecked commands in git.
+
+Introduced in `0.0.0dev4` to 
+- experiment.
+- have consistent interfaced commands run until all subcommands are provided by the library.
+
+```python
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+git = git.git_opts_override(no_advice=True)
+git.subcmd_unchecked.run(['--version']) # run the version option for git.
+git.subcmd_unchecked.run(['version']) # run the version subcommand.
+```
+
 
 ---
 

{gitbolt-0.0.0.dev3.dist-info → gitbolt-0.0.0.dev5.dist-info}/RECORD

@@ -7,22 +7,24 @@ 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=YPYqZN0Mi2kcZIXGl5bGXe-Y-NvgymnT58FpnFPiYPU,832
 gitbolt/utils.py,sha256=XftX3LIKtfzjQaUZUF3QYaFJFM-QdFjc05ZrZSMSdeM,6315
-gitbolt/git_subprocess/__init__.py,sha256=ynnsY2IDCsjzd2LU2GbXtIamNyBcME58q1yDsCBXCX8,515
+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=3DIydF-yQ7cVmT0di5cJtBVz-w68tawxk2xpq0yfcz8,14399
+gitbolt/git_subprocess/base.py,sha256=ywm_bGVt0R9ILyj5rtwYS3e-gQGIkaGSGkaPvm1JK9k,17591
 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=nMxZYp1ayX6kyigLzIfrT5kNLvTd3KjYPDUNV4iB04U,5653
+gitbolt/git_subprocess/impl/simple.py,sha256=yY7tMI4B093ssooZB4UvffVQaCrFVD1bAIrieYPajLQ,6407
 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=ov8lXamu489twQanej0lCkkjBmEXvXxqGrWI_aK3JzQ,2484
-gitbolt-0.0.0.dev3.dist-info/licenses/LICENSE,sha256=pOzr5bMWS6mHi3vro8d5vw0qW1i14rVq2XFrDuystVY,11372
-gitbolt-0.0.0.dev3.dist-info/METADATA,sha256=dY1-qsrZ06buyBvm1sk42mA6HyPE4rCeRY4W3l4LmaI,10724
-gitbolt-0.0.0.dev3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gitbolt-0.0.0.dev3.dist-info/top_level.txt,sha256=QCXclkzSPZjgamcwB6XuKJexaJ1as_TLUUSGdIDA7VY,8
-gitbolt-0.0.0.dev3.dist-info/RECORD,,
+gitbolt/git_subprocess/runner/simple_impl.py,sha256=V-6efvcQLP6gpUKSwRfnNI-Zd9nBxaN0EuAnpn-5LwU,2494
+gitbolt-0.0.0.dev5.dist-info/licenses/LICENSE,sha256=pOzr5bMWS6mHi3vro8d5vw0qW1i14rVq2XFrDuystVY,11372
+gitbolt-0.0.0.dev5.dist-info/METADATA,sha256=ddzCTnVG2oGLM46wDDrRg-kanPhsJNODJsroolpf5jM,11249
+gitbolt-0.0.0.dev5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gitbolt-0.0.0.dev5.dist-info/entry_points.txt,sha256=Q078Wjss4skreUs8hzAEJ8sUcH4Rhjc9emZ4jRXCiBM,52
+gitbolt-0.0.0.dev5.dist-info/top_level.txt,sha256=QCXclkzSPZjgamcwB6XuKJexaJ1as_TLUUSGdIDA7VY,8
+gitbolt-0.0.0.dev5.dist-info/RECORD,,

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

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