gitbolt 0.0.0.dev22__tar.gz → 0.0.0.dev24__tar.gz

{gitbolt-0.0.0.dev22 → gitbolt-0.0.0.dev24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev22
+Version: 0.0.0.dev24
 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>
@@ -116,8 +116,8 @@ Gitbolt lets you pass subcommands around as typed objects. This enables highly f
 import gitbolt
 
 git = gitbolt.get_git()
-version_subcmd = git.version_subcmd
-add_subcmd = git.add_subcmd
+version_subcmd = git.version_subcmd()
+add_subcmd = git.add_subcmd()
 
 def method_which_only_adds_a_file(add_subcmd: gitbolt.base.Add):
     """
@@ -138,7 +138,7 @@ git subcommands are modeled as terminal functions that return stdout.
 import gitbolt
 
 git = gitbolt.get_git()
-version_stdout = git.version_subcmd.version().version()
+version_stdout = git.version_subcmd().version().version()
 print(version_stdout)
 ```
 
@@ -153,8 +153,8 @@ particular commands.
 from gitbolt import get_git
 
 git = get_git() # get git object for the current working directory
-add_subcmd = git.add_subcmd
-ls_tree_subcmd = git.ls_tree_subcmd
+add_subcmd = git.add_subcmd()
+ls_tree_subcmd = git.ls_tree_subcmd()
 
 # now, functions can be written to accept only the required subcommands and nothing more than that.
 ```
@@ -338,8 +338,8 @@ import gitbolt
 
 git = gitbolt.get_git_command()
 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.
+git.subcmd_unchecked().run(['--version']) # run the version option for git.
+git.subcmd_unchecked().run(['version']) # run the version subcommand.
 ```
 
 #### 🖥️ Run one long-running process and communicate with it
@@ -354,7 +354,7 @@ import gitbolt
 import sys
 
 git = gitbolt.get_git_command()
-with git.subcmd_unchecked.popen(["cat-file", "--batch-command"]) as cf:
+with git.subcmd_unchecked().popen(["cat-file", "--batch-command"]) as cf:
     cf.stdin.write(b"contents HEAD\n")
     cf.stdin.flush()
     header = cf.stdout.readline().strip()
@@ -384,7 +384,7 @@ git = gitbolt.get_git_command()
 with git.session(
         cat_file1=["cat-file", "--batch"],
         cat_file2=["cat-file", "--batch"],
-        cat_file3=lambda: git.subcmd_unchecked.popen(["cat-file", "--batch"]),  # pass your own git subcmd Popen(s)
+        cat_file3=lambda: git.subcmd_unchecked().popen(["cat-file", "--batch"]),  # pass your own git subcmd Popen(s)
         mktree=["mktree", "--batch", "-z"]
 ) as ses:   # reusable and reentrant session
     tree_data: list[bytes] = []
@@ -430,6 +430,13 @@ Transformers for formatting/parsing can be added later.
 
 ---
 
+## Notes
+
+
+- 0.0.0.dev24: `worktree` implementations are not stable yet. Use `subcmd_unchecked` directly.
+
+---
+
 ## ✅ Benefits Out-of-the-Box
 
 * 🔄 Composable Git commands.

{gitbolt-0.0.0.dev22 → gitbolt-0.0.0.dev24}/README.md

@@ -80,8 +80,8 @@ Gitbolt lets you pass subcommands around as typed objects. This enables highly f
 import gitbolt
 
 git = gitbolt.get_git()
-version_subcmd = git.version_subcmd
-add_subcmd = git.add_subcmd
+version_subcmd = git.version_subcmd()
+add_subcmd = git.add_subcmd()
 
 def method_which_only_adds_a_file(add_subcmd: gitbolt.base.Add):
     """
@@ -102,7 +102,7 @@ git subcommands are modeled as terminal functions that return stdout.
 import gitbolt
 
 git = gitbolt.get_git()
-version_stdout = git.version_subcmd.version().version()
+version_stdout = git.version_subcmd().version().version()
 print(version_stdout)
 ```
 
@@ -117,8 +117,8 @@ particular commands.
 from gitbolt import get_git
 
 git = get_git() # get git object for the current working directory
-add_subcmd = git.add_subcmd
-ls_tree_subcmd = git.ls_tree_subcmd
+add_subcmd = git.add_subcmd()
+ls_tree_subcmd = git.ls_tree_subcmd()
 
 # now, functions can be written to accept only the required subcommands and nothing more than that.
 ```
@@ -302,8 +302,8 @@ import gitbolt
 
 git = gitbolt.get_git_command()
 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.
+git.subcmd_unchecked().run(['--version']) # run the version option for git.
+git.subcmd_unchecked().run(['version']) # run the version subcommand.
 ```
 
 #### 🖥️ Run one long-running process and communicate with it
@@ -318,7 +318,7 @@ import gitbolt
 import sys
 
 git = gitbolt.get_git_command()
-with git.subcmd_unchecked.popen(["cat-file", "--batch-command"]) as cf:
+with git.subcmd_unchecked().popen(["cat-file", "--batch-command"]) as cf:
     cf.stdin.write(b"contents HEAD\n")
     cf.stdin.flush()
     header = cf.stdout.readline().strip()
@@ -348,7 +348,7 @@ git = gitbolt.get_git_command()
 with git.session(
         cat_file1=["cat-file", "--batch"],
         cat_file2=["cat-file", "--batch"],
-        cat_file3=lambda: git.subcmd_unchecked.popen(["cat-file", "--batch"]),  # pass your own git subcmd Popen(s)
+        cat_file3=lambda: git.subcmd_unchecked().popen(["cat-file", "--batch"]),  # pass your own git subcmd Popen(s)
         mktree=["mktree", "--batch", "-z"]
 ) as ses:   # reusable and reentrant session
     tree_data: list[bytes] = []
@@ -394,6 +394,13 @@ Transformers for formatting/parsing can be added later.
 
 ---
 
+## Notes
+
+
+- 0.0.0.dev24: `worktree` implementations are not stable yet. Use `subcmd_unchecked` directly.
+
+---
+
 ## ✅ Benefits Out-of-the-Box
 
 * 🔄 Composable Git commands.

{gitbolt-0.0.0.dev22 → gitbolt-0.0.0.dev24}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitbolt"
-version = "0.0.0.dev22"
+version = "0.0.0.dev24"
 description = "Fast, flexible and type-safe Git commands in Python."
 requires-python = ">=3.12"
 readme = "README.md"

{gitbolt-0.0.0.dev22 → gitbolt-0.0.0.dev24}/src/gitbolt/__init__.py

@@ -71,7 +71,7 @@ def get_git_command(
 
     * 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()
+    >>> 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.

{gitbolt-0.0.0.dev22 → gitbolt-0.0.0.dev24}/src/gitbolt/base.py

@@ -131,7 +131,7 @@ class LsTree(GitSubCommand, RootDirOp, Protocol):
 
     @override
     def _subcmd_from_git(self, git: "Git") -> "LsTree":
-        return git.ls_tree_subcmd
+        return git.ls_tree_subcmd()
 
     @property
     def args_validator(self) -> LsTreeArgsValidator:
@@ -216,7 +216,7 @@ class Add(GitSubCommand, RootDirOp, Protocol):
 
     @override
     def _subcmd_from_git(self, git: "Git") -> "Add":
-        return git.add_subcmd
+        return git.add_subcmd()
 
 
 class Version(GitSubCommand, Protocol):
@@ -283,7 +283,7 @@ class Version(GitSubCommand, Protocol):
 
     @override
     def _subcmd_from_git(self, git: "Git") -> "Version":
-        return git.version_subcmd
+        return git.version_subcmd()
 
 
 class Worktree(GitSubCommand, RootDirOp, Protocol):
@@ -304,6 +304,22 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
+        @abstractmethod
+        def clone(self) -> "Worktree.WorktreeSubcmd":
+            """
+            :return: a clone of the underlying worktree subcommand.
+            """
+            ...
+
+        @abstractmethod
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> "Worktree.WorktreeSubcmd":
+            """
+            Protected. Intended for inheritance only.
+
+            :return: specific implementation of subcommand from ``worktree``.
+            """
+            ...
+
     # region worktree list subcommands
     class List(WorktreeSubcmd, Protocol):
         """
@@ -341,7 +357,10 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
-    @property
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.List:
+            return worktree.list_subcmd()
+
     @abstractmethod
     def list_subcmd(self) -> Worktree.List:
         """
@@ -372,7 +391,10 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
-    @property
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.Lock:
+            return worktree.lock_subcmd()
+
     @abstractmethod
     def lock_subcmd(self) -> Worktree.Lock:
         """
@@ -401,7 +423,10 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
-    @property
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.UnLock:
+            return worktree.unlock_subcmd()
+
     @abstractmethod
     def unlock_subcmd(self) -> Worktree.UnLock:
         """
@@ -432,8 +457,12 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             :param relative_paths: `use relative paths for worktree <https://git-scm.com/docs/git-worktree#Documentation/git-worktree.txt---no-relative-paths>`_.
             :return: output of ``git worktree move``.
             """
+            ...
+
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.Move:
+            return worktree.move_subcmd()
 
-    @property
     @abstractmethod
     def move_subcmd(self) -> Worktree.Move:
         """
@@ -467,7 +496,10 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
-    @property
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.Prune:
+            return worktree.prune_subcmd()
+
     @abstractmethod
     def prune_subcmd(self) -> Worktree.Prune:
         """
@@ -497,7 +529,10 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
-    @property
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.Remove:
+            return worktree.remove_subcmd()
+
     @abstractmethod
     def remove_subcmd(self) -> Worktree.Remove:
         """
@@ -526,7 +561,10 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
-    @property
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.Repair:
+            return worktree.repair_subcmd()
+
     @abstractmethod
     def repair_subcmd(self) -> Worktree.Repair:
         """
@@ -586,8 +624,11 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
             """
             ...
 
+        @override
+        def _subcmd_from_worktree(self, worktree: "Worktree") -> Worktree.Add:
+            return worktree.add_subcmd()
+
 
-    @property
     @abstractmethod
     def add_subcmd(self) -> Worktree.Add:
         """
@@ -598,7 +639,7 @@ class Worktree(GitSubCommand, RootDirOp, Protocol):
 
     @override
     def _subcmd_from_git(self, git: "Git") -> "Worktree":
-        return git.worktree_subcmd
+        return git.worktree_subcmd()
 
 
 class Git(CanOverrideGitOpts, CanOverrideGitEnvs, Protocol):
@@ -610,7 +651,7 @@ class Git(CanOverrideGitOpts, CanOverrideGitEnvs, Protocol):
         """
         :return: current git version.
         """
-        return self.version_subcmd.version()
+        return self.version_subcmd().version()
 
     @abstractmethod
     def exec_path(self) -> Path:
@@ -640,7 +681,6 @@ class Git(CanOverrideGitOpts, CanOverrideGitEnvs, Protocol):
         """
         ...
 
-    @property
     @abstractmethod
     def version_subcmd(self) -> Version:
         """
@@ -648,7 +688,6 @@ class Git(CanOverrideGitOpts, CanOverrideGitEnvs, Protocol):
         """
         ...
 
-    @property
     @abstractmethod
     def ls_tree_subcmd(self) -> LsTree:
         """
@@ -656,7 +695,6 @@ class Git(CanOverrideGitOpts, CanOverrideGitEnvs, Protocol):
         """
         ...
 
-    @property
     @abstractmethod
     def add_subcmd(self) -> Add:
         """
@@ -664,7 +702,6 @@ class Git(CanOverrideGitOpts, CanOverrideGitEnvs, Protocol):
         """
         ...
 
-    @property
     @abstractmethod
     def worktree_subcmd(self) -> Worktree:
         """