Make GitTag.verification return GitCommitVerification (#3226)

EnricoMi · EnricoMi · commit 048a1a3837e8 · 2025-02-21T14:13:33.000+01:00
Turns the return value of `GitTag.verification` from `dict` into a proper class. Completes #3028.
diff --git a/doc/changes.rst b/doc/changes.rst
@@ -29,6 +29,24 @@ should be replaced with
   repo.get_views_traffic().views.timestamp
   repo.get_clones_traffic().clones.timestamp
 
+* Add ``GitCommitVerification`` class (`#3028 <https://github.com/PyGithub/PyGithub/pull/3028>`_) (`822e6d71 <https://github.com/PyGithub/PyGithub/commit/822e6d71>`_):
+
+  Changes the return value of ``GitTag.verification`` and ``GitCommit.verification`` from ``dict`` to ``GitCommitVerification``.
+
+  Code like
+
+  .. code-block:: python
+
+    tag.verification["reason"]
+    commit.verification["reason"]
+
+  should be replaced with
+
+  .. code-block:: python
+
+    tag.verification.reason
+    commit.verification.reason
+
 * Property ``AppAuth.private_key`` has been removed (`#3065 <https://github.com/PyGithub/PyGithub/pull/3065>`_) (`36697b22 <https://github.com/PyGithub/PyGithub/commit/36697b22>`_)
 
 * Fix typos (`#3086 <https://github.com/PyGithub/PyGithub/pull/3086>`_) (`a50ae51b <https://github.com/PyGithub/PyGithub/commit/a50ae51b>`_):
diff --git a/github/GitTag.py b/github/GitTag.py
@@ -43,13 +43,15 @@
 from typing import TYPE_CHECKING, Any
 
 import github.GitAuthor
+import github.GitCommitVerification
 import github.GithubObject
 import github.GitObject
 import github.GitTreeElement
 from github.GithubObject import Attribute, CompletableGithubObject, NotSet
 
 if TYPE_CHECKING:
     from github.GitAuthor import GitAuthor
+    from github.GitCommitVerification import GitCommitVerification
     from github.GitObject import GitObject
 
 
@@ -73,7 +75,7 @@ def _initAttributes(self) -> None:
         self._tag: Attribute[str] = NotSet
         self._tagger: Attribute[GitAuthor] = NotSet
         self._url: Attribute[str] = NotSet
-        self._verification: Attribute[dict[str, Any]] = NotSet
+        self._verification: Attribute[GitCommitVerification] = NotSet
 
     def __repr__(self) -> str:
         return self.get__repr__({"sha": self._sha.value, "tag": self._tag.value})
@@ -114,7 +116,7 @@ def url(self) -> str:
         return self._url.value
 
     @property
-    def verification(self) -> dict[str, Any]:
+    def verification(self) -> GitCommitVerification:
         self._completeIfNotSet(self._verification)
         return self._verification.value
 
@@ -134,4 +136,6 @@ def _useAttributes(self, attributes: dict[str, Any]) -> None:
         if "url" in attributes:  # pragma no branch
             self._url = self._makeStringAttribute(attributes["url"])
         if "verification" in attributes:  # pragma no branch
-            self._verification = self._makeDictAttribute(attributes["verification"])
+            self._verification = self._makeClassAttribute(
+                github.GitCommitVerification.GitCommitVerification, attributes["verification"]
+            )
diff --git a/tests/GitTag.py b/tests/GitTag.py
@@ -65,7 +65,4 @@ def testAttributes(self):
             "https://api.github.com/repos/PyGithub/PyGithub/git/tags/f5f37322407b02a80de4526ad88d5f188977bc3c",
         )
         self.assertEqual(repr(self.tag), 'GitTag(tag="v0.6", sha="f5f37322407b02a80de4526ad88d5f188977bc3c")')
-        self.assertEqual(
-            self.tag.verification,
-            {"verified": False, "reason": "unsigned", "signature": None, "payload": None, "verified_at": None},
-        )
+        self.assertEqual(self.tag.verification.reason, "unsigned")

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,4 @@ def testAttributes(self):`
`65`	`65`	`"https://api.github.com/repos/PyGithub/PyGithub/git/tags/f5f37322407b02a80de4526ad88d5f188977bc3c",`
`66`	`66`	`)`
`67`	`67`	`self.assertEqual(repr(self.tag), 'GitTag(tag="v0.6", sha="f5f37322407b02a80de4526ad88d5f188977bc3c")')`
`68`		`- self.assertEqual(`
`69`		`- self.tag.verification,`
`70`		`- {"verified": False, "reason": "unsigned", "signature": None, "payload": None, "verified_at": None},`
`71`		`- )`
	`68`	`+ self.assertEqual(self.tag.verification.reason, "unsigned")`