Merge pull request #2184 from gitpython-developers/fix-output-arg

fix: reject unsafe output options in Commit.count

Author: Byron

git/objects/commit.py

@@ -269,13 +269,21 @@ def summary(self) -> Union[str, bytes]:
         else:
             return self.message.split(b"\n", 1)[0]
 
-    def count(self, paths: Union[PathLike, Sequence[PathLike]] = "", **kwargs: Any) -> int:
+    def count(
+        self,
+        paths: Union[PathLike, Sequence[PathLike]] = "",
+        allow_unsafe_options: bool = False,
+        **kwargs: Any,
+    ) -> int:
         """Count the number of commits reachable from this commit.
 
         :param paths:
             An optional path or a list of paths restricting the return value to commits
             actually containing the paths.
 
+        :param allow_unsafe_options:
+            Allow unsafe options, like ``--output``.
+
         :param kwargs:
             Additional options to be passed to :manpage:`git-rev-list(1)`. They must not
             alter the output style of the command, or parsing will yield incorrect
@@ -284,6 +292,11 @@ def count(self, paths: Union[PathLike, Sequence[PathLike]] = "", **kwargs: Any)
         :return:
             An int defining the number of reachable commits
         """
+        if not allow_unsafe_options:
+            Git.check_unsafe_options(
+                options=Git._option_candidates([], kwargs), unsafe_options=self.unsafe_git_rev_options
+            )
+
         # Yes, it makes a difference whether empty paths are given or not in our case as
         # the empty paths version will ignore merge commits for some reason.
         if paths:

test/test_commit.py

@@ -301,6 +301,11 @@ def test_iter_items_rejects_unsafe_options(self):
             with self.assertRaises(UnsafeOptionError):
                 list(Commit.iter_items(self.rorepo, "HEAD", output=marker))
 
+    def test_count_rejects_unsafe_options(self):
+        with tempfile.NamedTemporaryFile() as marker:
+            with self.assertRaises(UnsafeOptionError):
+                self.rorepo.head.commit.count(output=marker.name)
+
     def test_rev_list_bisect_all(self):
         """
         'git rev-list --bisect-all' returns additional information