gitbolt 0.0.0.dev10__tar.gz → 0.0.0.dev11__tar.gz

{gitbolt-0.0.0.dev10 → gitbolt-0.0.0.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev10
+Version: 0.0.0.dev11
 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,8 +26,8 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vt-err-hndlr>=0.0.0dev3
-Requires-Dist: vt-commons>=0.0.1.dev4
+Requires-Dist: vt-err-hndlr>=0.0.0dev5
+Requires-Dist: vt-commons>=0.0.1.dev9
 Provides-Extra: pygit2
 Requires-Dist: pygit2; extra == "pygit2"
 Provides-Extra: test
@@ -64,6 +64,7 @@ Dynamic: license-file
 * 🧪 **Terminal Functions:** Git subcommands are terminal functions.
 * 🧼 **Idiomatic Python:** Write commands in idiomatic Python at compile-time and be confident they’ll execute smoothly at runtime.
 * 🎀 **Add-ons:** Special features provided to ease programming with git. These can be added if required.
+* 💻 **CLI-cmd:** Take commands from cli and run in `gitbolt`.
 
 ---
 
@@ -340,6 +341,24 @@ git.subcmd_unchecked.run(['--version']) # run the version option for git.
 git.subcmd_unchecked.run(['version']) # run the version subcommand.
 ```
 
+#### 💻 Run commands received from CLI
+
+Introduced in `0.0.0dev11` is the ability to take commands from CLI and run it inside `gitbolt`.
+
+While making a system it may be required to run cli commands as received from cli using gitbolt. An obvious example 
+would be to make a system that receives CLI commands and does certain modifications/additions inside `gitbolt` before
+actually running them. An example:
+
+```python
+from gitbolt.git_subprocess.impl.simple import CLISimpleGitCommand
+
+opts = ["--no-pager", "--namespace", "n1"]   # options received from outside your program.
+envs = dict(GIT_AUTHOR_NAME="ss")   # env-vars received form outside your program.
+git = CLISimpleGitCommand(opts=opts, envs=envs)
+
+# these can later be overridden
+git = git.git_opts_override(namespace="n2")
+```
 
 ---
 

{gitbolt-0.0.0.dev10 → gitbolt-0.0.0.dev11}/README.md

@@ -28,6 +28,7 @@
 * 🧪 **Terminal Functions:** Git subcommands are terminal functions.
 * 🧼 **Idiomatic Python:** Write commands in idiomatic Python at compile-time and be confident they’ll execute smoothly at runtime.
 * 🎀 **Add-ons:** Special features provided to ease programming with git. These can be added if required.
+* 💻 **CLI-cmd:** Take commands from cli and run in `gitbolt`.
 
 ---
 
@@ -304,6 +305,24 @@ git.subcmd_unchecked.run(['--version']) # run the version option for git.
 git.subcmd_unchecked.run(['version']) # run the version subcommand.
 ```
 
+#### 💻 Run commands received from CLI
+
+Introduced in `0.0.0dev11` is the ability to take commands from CLI and run it inside `gitbolt`.
+
+While making a system it may be required to run cli commands as received from cli using gitbolt. An obvious example 
+would be to make a system that receives CLI commands and does certain modifications/additions inside `gitbolt` before
+actually running them. An example:
+
+```python
+from gitbolt.git_subprocess.impl.simple import CLISimpleGitCommand
+
+opts = ["--no-pager", "--namespace", "n1"]   # options received from outside your program.
+envs = dict(GIT_AUTHOR_NAME="ss")   # env-vars received form outside your program.
+git = CLISimpleGitCommand(opts=opts, envs=envs)
+
+# these can later be overridden
+git = git.git_opts_override(namespace="n2")
+```
 
 ---
 

{gitbolt-0.0.0.dev10 → gitbolt-0.0.0.dev11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitbolt"
-version = "0.0.0dev10"
+version = "0.0.0dev11"
 description = "Fast, flexible and type-safe Git commands in Python."
 requires-python = ">=3.12"
 readme = "README.md"
@@ -36,8 +36,8 @@ classifiers = [
   "Typing :: Typed"
 ]
 dependencies = [
-  "vt-err-hndlr >= 0.0.0dev3",
-  "vt-commons >= 0.0.1.dev4",
+  "vt-err-hndlr >= 0.0.0dev5",
+  "vt-commons >= 0.0.1.dev9",
 ]
 
 [project.optional-dependencies]
@@ -49,7 +49,7 @@ test = ['pytest']
 #   btw, this error doesn't show in the latest developer version. So, this error will go away with 1.17.0 relase
 dev = ["mypy==1.15.0", "ruff"]
 doc = ['sphinx', 'sphinx-argparse']
-test = ["pytest", 'pytest-cov']
+test = ["pytest", 'pytest-cov', "pytest-xdist"]
 multitest = ['tox']
 
 

{gitbolt-0.0.0.dev10 → gitbolt-0.0.0.dev11}/src/gitbolt/git_subprocess/impl/simple.py

@@ -196,9 +196,21 @@ class SimpleGitCommand(GitCommand, RootDirOp):
         return add_subcmd
 
     @override
-    def clone(self) -> "SimpleGitCommand":
+    def clone(self) -> SimpleGitCommand:
         # region obtain class instance
-        cloned = SimpleGitCommand(
+        cloned = self._subclass_clone()
+        # endregion
+        # region clone protected members
+        cloned._main_cmd_opts = self._main_cmd_opts
+        cloned._env_vars = self._env_vars
+        # endregion
+        return cloned
+
+    def _subclass_clone(self) -> SimpleGitCommand:
+        """
+        :returns: clone as defined by the subclass.
+        """
+        return SimpleGitCommand(
             self.root_dir,
             self.runner,
             version_subcmd=self.version_subcmd,
@@ -206,12 +218,6 @@ class SimpleGitCommand(GitCommand, RootDirOp):
             add_subcmd=self.add_subcmd,
             subcmd_unchecked=self.subcmd_unchecked,
         )
-        # endregion
-        # region clone protected members
-        cloned._main_cmd_opts = self._main_cmd_opts
-        cloned._env_vars = self._env_vars
-        # endregion
-        return cloned
 
     @override
     @property
@@ -223,3 +229,73 @@ class SimpleGitCommand(GitCommand, RootDirOp):
         subcmd_unchecked = self._subcmd_unchecked.clone()
         subcmd_unchecked._set_underlying_git(self)
         return subcmd_unchecked
+
+
+class CLISimpleGitCommand(SimpleGitCommand):
+    """
+    A simple git command that can run using CLI params.
+    """
+
+    def __init__(
+        self,
+        git_root_dir: Path = Path.cwd(),
+        runner: GitCommandRunner = SimpleGitCR(),
+        *,
+        opts: list[str] | None = None,
+        envs: dict[str, str] | None = None,
+        prefer_cli: bool = False,
+        version_subcmd: VersionCommand | None = None,
+        ls_tree_subcmd: LsTreeCommand | None = None,
+        add_subcmd: AddCommand | None = None,
+        subcmd_unchecked: UncheckedSubcmd | None = None,
+    ):
+        """
+        :param opts: main git cli options.
+        :param envs: main git cli env vars.
+        :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.
+        """
+        super().__init__(
+            git_root_dir,
+            runner,
+            version_subcmd=version_subcmd,
+            ls_tree_subcmd=ls_tree_subcmd,
+            add_subcmd=add_subcmd,
+            subcmd_unchecked=subcmd_unchecked,
+        )
+        self._main_cmd_cli_opts = opts
+        self._cmd_cli_envs = envs
+        self.prefer_cli = prefer_cli
+
+    @override
+    def build_main_cmd_args(self) -> list[str]:
+        if self._main_cmd_cli_opts:
+            if self.prefer_cli:
+                return super().build_main_cmd_args() + self._main_cmd_cli_opts
+            else:
+                return self._main_cmd_cli_opts + super().build_main_cmd_args()
+        return super().build_main_cmd_args()
+
+    @override
+    def build_git_envs(self) -> dict[str, str]:
+        if self._cmd_cli_envs:
+            if self.prefer_cli:
+                return super().build_git_envs() | self._cmd_cli_envs
+            else:
+                return self._cmd_cli_envs | super().build_git_envs()
+        return super().build_git_envs()
+
+    @override
+    def _subclass_clone(self) -> CLISimpleGitCommand:
+        return CLISimpleGitCommand(
+            self.root_dir,
+            self.runner,
+            opts=self._main_cmd_cli_opts,
+            envs=self._cmd_cli_envs,
+            prefer_cli=self.prefer_cli,
+            version_subcmd=self.version_subcmd,
+            ls_tree_subcmd=self.ls_tree_subcmd,
+            add_subcmd=self.add_subcmd,
+            subcmd_unchecked=self.subcmd_unchecked,
+        )

{gitbolt-0.0.0.dev10 → gitbolt-0.0.0.dev11}/src/gitbolt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev10
+Version: 0.0.0.dev11
 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,8 +26,8 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vt-err-hndlr>=0.0.0dev3
-Requires-Dist: vt-commons>=0.0.1.dev4
+Requires-Dist: vt-err-hndlr>=0.0.0dev5
+Requires-Dist: vt-commons>=0.0.1.dev9
 Provides-Extra: pygit2
 Requires-Dist: pygit2; extra == "pygit2"
 Provides-Extra: test
@@ -64,6 +64,7 @@ Dynamic: license-file
 * 🧪 **Terminal Functions:** Git subcommands are terminal functions.
 * 🧼 **Idiomatic Python:** Write commands in idiomatic Python at compile-time and be confident they’ll execute smoothly at runtime.
 * 🎀 **Add-ons:** Special features provided to ease programming with git. These can be added if required.
+* 💻 **CLI-cmd:** Take commands from cli and run in `gitbolt`.
 
 ---
 
@@ -340,6 +341,24 @@ git.subcmd_unchecked.run(['--version']) # run the version option for git.
 git.subcmd_unchecked.run(['version']) # run the version subcommand.
 ```
 
+#### 💻 Run commands received from CLI
+
+Introduced in `0.0.0dev11` is the ability to take commands from CLI and run it inside `gitbolt`.
+
+While making a system it may be required to run cli commands as received from cli using gitbolt. An obvious example 
+would be to make a system that receives CLI commands and does certain modifications/additions inside `gitbolt` before
+actually running them. An example:
+
+```python
+from gitbolt.git_subprocess.impl.simple import CLISimpleGitCommand
+
+opts = ["--no-pager", "--namespace", "n1"]   # options received from outside your program.
+envs = dict(GIT_AUTHOR_NAME="ss")   # env-vars received form outside your program.
+git = CLISimpleGitCommand(opts=opts, envs=envs)
+
+# these can later be overridden
+git = git.git_opts_override(namespace="n2")
+```
 
 ---
 

gitbolt-0.0.0.dev11/src/gitbolt.egg-info/requires.txt

@@ -0,0 +1,8 @@
+vt-err-hndlr>=0.0.0dev5
+vt-commons>=0.0.1.dev9
+
+[pygit2]
+pygit2
+
+[test]
+pytest

gitbolt-0.0.0.dev10/src/gitbolt.egg-info/requires.txt

@@ -1,8 +0,0 @@
-vt-err-hndlr>=0.0.0dev3
-vt-commons>=0.0.1.dev4
-
-[pygit2]
-pygit2
-
-[test]
-pytest