PyGithub 2.6.0__tar.gz → 2.6.1__tar.gz

{pygithub-2.6.0/PyGithub.egg-info → pygithub-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyGithub
-Version: 2.6.0
+Version: 2.6.1
 Summary: Use the full Github API v3
 Author-email: Vincent Jacques <vincent@vincent-jacques.net>
 Project-URL: Documentation, https://pygithub.readthedocs.io/en/stable/

{pygithub-2.6.0 → pygithub-2.6.1/PyGithub.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyGithub
-Version: 2.6.0
+Version: 2.6.1
 Summary: Use the full Github API v3
 Author-email: Vincent Jacques <vincent@vincent-jacques.net>
 Project-URL: Documentation, https://pygithub.readthedocs.io/en/stable/

{pygithub-2.6.0 → pygithub-2.6.1}/PyGithub.egg-info/SOURCES.txt

@@ -75,6 +75,7 @@ github/CodeScanAlertInstanceLocation.py
 github/CodeScanRule.py
 github/CodeScanTool.py
 github/CodeSecurityConfig.py
+github/CodeSecurityConfigRepository.py
 github/Commit.py
 github/CommitCombinedStatus.py
 github/CommitComment.py

{pygithub-2.6.0 → pygithub-2.6.1}/doc/changes.rst

@@ -4,6 +4,21 @@ Change log
 Stable versions
 ~~~~~~~~~~~~~~~
 
+Version 2.6.1 (February 21, 2025)
+---------------------------------
+
+Bug Fixes
+^^^^^^^^^
+* Fix broken pickle support for ``Auth`` classes (`#3211 <https://github.com/PyGithub/PyGithub/pull/3211>`_) (`f975552a <https://github.com/PyGithub/PyGithub/commit/f975552a>`_)
+* Remove schema from ``Deployment``, remove ``message`` attribute (`#3223 <https://github.com/PyGithub/PyGithub/pull/3223>`_) (`d12e7d4c <https://github.com/PyGithub/PyGithub/commit/d12e7d4c>`_)
+* Fix incorrect deprecated import (`#3225 <https://github.com/PyGithub/PyGithub/pull/3225>`_) (`93297440 <https://github.com/PyGithub/PyGithub/commit/93297440>`_)
+* Add ``CodeSecurityConfigRepository`` returned by ``get_repos_for_code_security_config`` (`#3219 <https://github.com/PyGithub/PyGithub/pull/3219>`_) (`f997a2f6 <https://github.com/PyGithub/PyGithub/commit/f997a2f6>`_)
+* Make ``GitTag.verification`` return ``GitCommitVerification`` (`#3226 <https://github.com/PyGithub/PyGithub/pull/3226>`_) (`048a1a38 <https://github.com/PyGithub/PyGithub/commit/048a1a38>`_)
+
+Maintenance
+^^^^^^^^^^^
+* Mention removal of ``AppAuth.private_key`` in changelog (`#3212 <https://github.com/PyGithub/PyGithub/pull/3212>`_) (`f5dc1c76 <https://github.com/PyGithub/PyGithub/commit/f5dc1c76>`_)
+
 Version 2.6.0 (February 15, 2025)
 ---------------------------------
 
@@ -29,6 +44,26 @@ 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>`_):
 
   Property ``OrganizationCustomProperty.respository_id`` renamed to ``OrganizationCustomProperty.repository_id``.

{pygithub-2.6.0 → pygithub-2.6.1}/github/Auth.py

@@ -186,6 +186,19 @@ class JWT(Auth, ABC):
         return "Bearer"
 
 
+class JwtSigner:
+    def __init__(self, private_key_or_func: Union[str, PrivateKeyGenerator], jwt_algorithm: str):
+        self._private_key_or_func = private_key_or_func
+        self._jwt_algorithm = jwt_algorithm
+
+    def jwt_sign(self, payload: dict) -> Union[str, bytes]:
+        if callable(self._private_key_or_func):
+            private_key = self._private_key_or_func()
+        else:
+            private_key = self._private_key_or_func
+        return jwt.encode(payload, key=private_key, algorithm=self._jwt_algorithm)
+
+
 class AppAuth(JWT):
     """
     This class is used to authenticate as a GitHub App.
@@ -196,14 +209,7 @@ class AppAuth(JWT):
 
     @staticmethod
     def create_jwt_sign(private_key_or_func: Union[str, PrivateKeyGenerator], jwt_algorithm: str) -> DictSignFunction:
-        def jwt_sign(payload: dict) -> Union[str, bytes]:
-            if callable(private_key_or_func):
-                private_key = private_key_or_func()
-            else:
-                private_key = private_key_or_func
-            return jwt.encode(payload, key=private_key, algorithm=jwt_algorithm)
-
-        return jwt_sign
+        return JwtSigner(private_key_or_func, jwt_algorithm).jwt_sign
 
     # v3: move * above private_key
     def __init__(

{pygithub-2.6.0 → pygithub-2.6.1}/github/CheckRun.py

@@ -34,7 +34,7 @@ from __future__ import annotations
 from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
-from typing_extensions import deprecated
+import deprecated
 
 import github.CheckRunAnnotation
 import github.CheckRunOutput
@@ -109,7 +109,7 @@ class CheckRun(CompletableGithubObject):
         return self._check_suite.value
 
     @property
-    @deprecated("Use property check_suite.id instead")
+    @deprecated.deprecated("Use property check_suite.id instead")
     def check_suite_id(self) -> int:
         self._completeIfNotSet(self._check_suite_id)
         return self._check_suite_id.value

pygithub-2.6.1/github/CodeSecurityConfigRepository.py

@@ -0,0 +1,68 @@
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2024 Enrico Minack <github@enrico.minack.dev>                      #
+# Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com>        #
+# Copyright 2024 Thomas Cooper <coopernetes@proton.me>                         #
+# Copyright 2025 Enrico Minack <github@enrico.minack.dev>                      #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+import github.Repository
+from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
+
+if TYPE_CHECKING:
+    from github.Repository import Repository
+
+
+class CodeSecurityConfigRepository(NonCompletableGithubObject):
+    """
+    This class represents CodeSecurityConfigRepository.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/code-security/configurations
+
+    The OpenAPI schema can be found at
+    - /components/schemas/code-security-configuration-repositories
+
+    """
+
+    def _initAttributes(self) -> None:
+        self._repository: Attribute[Repository] = NotSet
+        self._status: Attribute[str] = NotSet
+
+    def __repr__(self) -> str:
+        return self.repository.__repr__()
+
+    @property
+    def repository(self) -> Repository:
+        return self._repository.value
+
+    @property
+    def status(self) -> str:
+        return self._status.value
+
+    def _useAttributes(self, attributes: dict[str, Any]) -> None:
+        if "repository" in attributes:  # pragma no branch
+            self._repository = self._makeClassAttribute(github.Repository.Repository, attributes["repository"])
+        if "status" in attributes:  # pragma no branch
+            self._status = self._makeStringAttribute(attributes["status"])

{pygithub-2.6.0 → pygithub-2.6.1}/github/Deployment.py

@@ -70,7 +70,6 @@ class Deployment(CompletableGithubObject):
     The OpenAPI schema can be found at
     - /components/schemas/deployment
     - /components/schemas/deployment-simple
-    - /paths/"/repos/{owner}/{repo}/deployments"/post/responses/202/content/"application/json"/schema
 
     """
 
@@ -80,7 +79,6 @@ class Deployment(CompletableGithubObject):
         self._description: Attribute[str] = NotSet
         self._environment: Attribute[str] = NotSet
         self._id: Attribute[int] = NotSet
-        self._message: Attribute[str] = NotSet
         self._node_id: Attribute[str] = NotSet
         self._original_environment: Attribute[str] = NotSet
         self._payload: Attribute[dict[str, Any]] = NotSet
@@ -123,11 +121,6 @@ class Deployment(CompletableGithubObject):
         self._completeIfNotSet(self._id)
         return self._id.value
 
-    @property
-    def message(self) -> str:
-        self._completeIfNotSet(self._message)
-        return self._message.value
-
     @property
     def node_id(self) -> str:
         self._completeIfNotSet(self._node_id)
@@ -275,8 +268,6 @@ class Deployment(CompletableGithubObject):
             self._environment = self._makeStringAttribute(attributes["environment"])
         if "id" in attributes:  # pragma no branch
             self._id = self._makeIntAttribute(attributes["id"])
-        if "message" in attributes:  # pragma no branch
-            self._message = self._makeStringAttribute(attributes["message"])
         if "node_id" in attributes:  # pragma no branch
             self._node_id = self._makeStringAttribute(attributes["node_id"])
         if "original_environment" in attributes:  # pragma no branch

{pygithub-2.6.0 → pygithub-2.6.1}/github/GitTag.py

@@ -43,6 +43,7 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any
 
 import github.GitAuthor
+import github.GitCommitVerification
 import github.GithubObject
 import github.GitObject
 import github.GitTreeElement
@@ -50,6 +51,7 @@ 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 @@ class GitTag(CompletableGithubObject):
         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 @@ class GitTag(CompletableGithubObject):
         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 @@ class GitTag(CompletableGithubObject):
         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"]
+            )

{pygithub-2.6.0 → pygithub-2.6.1}/github/Organization.py

@@ -90,6 +90,7 @@ from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
 import github.CodeSecurityConfig
+import github.CodeSecurityConfigRepository
 import github.Copilot
 import github.DefaultCodeSecurityConfig
 import github.Event
@@ -119,6 +120,7 @@ from github.PaginatedList import PaginatedList
 
 if TYPE_CHECKING:
     from github.CodeSecurityConfig import CodeSecurityConfig
+    from github.CodeSecurityConfigRepository import CodeSecurityConfigRepository
     from github.Copilot import Copilot
     from github.DefaultCodeSecurityConfig import DefaultCodeSecurityConfig
     from github.Event import Event
@@ -1820,7 +1822,9 @@ class Organization(CompletableGithubObject):
             headers={"Accept": Consts.repoVisibilityPreview},
         )
 
-    def get_repos_for_code_security_config(self, id: int, status: Opt[str] = NotSet) -> PaginatedList[Repository]:
+    def get_repos_for_code_security_config(
+        self, id: int, status: Opt[str] = NotSet
+    ) -> PaginatedList[CodeSecurityConfigRepository]:
         """
         :calls: `GET /orgs/{org}/code-security/configurations/{configuration_id}/repositories <https://docs.github.com/en/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration>`_
         """
@@ -1830,7 +1834,7 @@ class Organization(CompletableGithubObject):
         url_parameters = NotSet.remove_unset_items({"status": status})
 
         return PaginatedList(
-            github.Repository.Repository,
+            github.CodeSecurityConfigRepository.CodeSecurityConfigRepository,
             self._requester,
             f"{self.url}/code-security/configurations/{id}/repositories",
             url_parameters,

{pygithub-2.6.0 → pygithub-2.6.1}/tests/Deployment.py

@@ -53,7 +53,6 @@ class Deployment(Framework.TestCase):
         self.assertEqual(self.deployment.description, "Test deployment")
         self.assertEqual(self.deployment.environment, "test")
         self.assertEqual(self.deployment.id, 263877258)
-        self.assertIsNone(self.deployment.message)
         self.assertEqual(self.deployment.node_id, "MDEwOkRlcGxveW1lbnQyNjIzNTE3NzY=")
         self.assertEqual(self.deployment.original_environment, "test")
         self.assertEqual(self.deployment.payload, {"test": True})

{pygithub-2.6.0 → pygithub-2.6.1}/tests/GitCommitVerification.py

@@ -2,6 +2,7 @@
 #                                                                              #
 # Copyright 2021 Claire Johns <42869556+johnsc1@users.noreply.github.com>      #
 # Copyright 2023 Enrico Minack <github@enrico.minack.dev>                      #
+# Copyright 2025 Enrico Minack <github@enrico.minack.dev>                      #
 # Copyright 2025 Tim Gates <tim.gates@iress.com>                               #
 #                                                                              #
 # This file is part of PyGithub.                                               #

{pygithub-2.6.0 → pygithub-2.6.1}/tests/GitTag.py

@@ -65,7 +65,4 @@ class GitTag(Framework.TestCase):
             "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")

{pygithub-2.6.0 → pygithub-2.6.1}/tests/Pickle.py

@@ -24,9 +24,13 @@
 #                                                                              #
 ################################################################################
 
+import inspect
 import pickle
+import sys
+from abc import ABC
 
 import github
+from github.Auth import AppAuth, AppAuthToken, AppInstallationAuth, AppUserAuth, Auth, Login, NetrcAuth, Token
 from github.PaginatedList import PaginatedList
 from github.Repository import Repository
 
@@ -59,3 +63,30 @@ class Pickle(Framework.TestCase):
         branches = repo.get_branches()
         branches2 = pickle.loads(pickle.dumps(branches))
         self.assertIsInstance(branches2, PaginatedList)
+
+    auths = [
+        Login("login", "password"),
+        Token("token"),
+        AppAuth("id", "key"),
+        AppAuthToken("token"),
+        AppInstallationAuth(AppAuth("id", "key"), 123),
+        AppUserAuth("client_id", "client_secret", "access_token"),
+        NetrcAuth(),
+    ]
+
+    def testPickleAuthSetup(self):
+        # check we are testing *all* exiting auth classes
+        auth_module = sys.modules[github.Auth.__name__]
+        existing_auths = [
+            clazz_type.__name__
+            for clazz, clazz_type in inspect.getmembers(auth_module, inspect.isclass)
+            if Auth in clazz_type.mro() and ABC not in clazz_type.__bases__
+        ]
+        tested_auths = [type(auth).__name__ for auth in self.auths]
+        self.assertSequenceEqual(sorted(existing_auths), sorted(tested_auths))
+
+    def testPickleAuth(self):
+        for auth in self.auths:
+            with self.subTest(auth=type(auth).__name__):
+                auth2 = pickle.loads(pickle.dumps(auth))
+                self.assertIsInstance(auth2, type(auth))