CI: add docformatter to precommit (#2614)

.pre-commit-config.yaml

@@ -34,6 +34,13 @@ repos:
       - id: codespell
         additional_dependencies: [tomli]
 
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: ["--in-place"]
+
   - repo: https://github.com/psf/black
     rev: 23.12.0
     hooks:

github/AdvisoryCredit.py

@@ -49,7 +49,10 @@ class SimpleCredit(TypedDict):
 class AdvisoryCredit(NonCompletableGithubObject):
     """
     This class represents a credit that is assigned to a SecurityAdvisory.
-    The reference can be found here https://docs.github.com/en/rest/security-advisories/repository-advisories
+
+    The reference can be found here
+    https://docs.github.com/en/rest/security-advisories/repository-advisories
+
     """
 
     @property

github/AdvisoryCreditDetailed.py

@@ -48,7 +48,10 @@
 class AdvisoryCreditDetailed(NonCompletableGithubObject):
     """
     This class represents a credit that is assigned to a SecurityAdvisory.
-    The reference can be found here https://docs.github.com/en/rest/security-advisories/repository-advisories
+
+    The reference can be found here
+    https://docs.github.com/en/rest/security-advisories/repository-advisories
+
     """
 
     @property

github/AdvisoryVulnerability.py

@@ -63,7 +63,10 @@ class SimpleAdvisoryVulnerability(TypedDict):
 class AdvisoryVulnerability(NonCompletableGithubObject):
     """
     This class represents a package that is vulnerable to a parent SecurityAdvisory.
-    The reference can be found here https://docs.github.com/en/rest/security-advisories/repository-advisories
+
+    The reference can be found here
+    https://docs.github.com/en/rest/security-advisories/repository-advisories
+
     """
 
     @property

github/AdvisoryVulnerabilityPackage.py

@@ -49,7 +49,10 @@
 class AdvisoryVulnerabilityPackage(NonCompletableGithubObject):
     """
     This class represents an identifier for a package that is vulnerable to a parent SecurityAdvisory.
-    The reference can be found here https://docs.github.com/en/rest/security-advisories/repository-advisories
+
+    The reference can be found here
+    https://docs.github.com/en/rest/security-advisories/repository-advisories
+
     """
 
     def _initAttributes(self) -> None:

github/ApplicationOAuth.py

@@ -44,7 +44,10 @@
 class ApplicationOAuth(NonCompletableGithubObject):
     """
     This class is used for identifying and authorizing users for Github Apps.
-    The reference can be found at https://docs.github.com/en/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps
+
+    The reference can be found at
+    https://docs.github.com/en/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps
+
     """
 
     def _initAttributes(self) -> None:
@@ -85,7 +88,9 @@ def get_login_url(
         state: str | None = None,
         login: str | None = None,
     ) -> str:
-        """Return the URL you need to redirect a user to in order to authorize your App."""
+        """
+        Return the URL you need to redirect a user to in order to authorize your App.
+        """
         parameters = {"client_id": self.client_id}
         if redirect_uri is not None:
             assert isinstance(redirect_uri, str), redirect_uri

github/Artifact.py

@@ -54,7 +54,7 @@
 
 class Artifact(NonCompletableGithubObject):
     """
-    This class represents an Artifact of Github Run
+    This class represents an Artifact of Github Run.
     """
 
     def _initAttributes(self) -> None:

github/Auth.py

@@ -56,28 +56,36 @@ class Auth(abc.ABC):
     def token_type(self) -> str:
         """
         The type of the auth token as used in the HTTP Authorization header, e.g. Bearer or Basic.
+
         :return: token type
+
         """
 
     @property
     @abc.abstractmethod
     def token(self) -> str:
         """
         The auth token as used in the HTTP Authorization header.
+
         :return: token
+
         """
 
 
 class HTTPBasicAuth(Auth, abc.ABC):
     @property
     @abc.abstractmethod
     def username(self) -> str:
-        """The username."""
+        """
+        The username.
+        """
 
     @property
     @abc.abstractmethod
     def password(self) -> str:
-        """The password"""
+        """
+        The password.
+        """
 
     @property
     def token_type(self) -> str:
@@ -137,7 +145,9 @@ def token(self) -> str:
 class JWT(Auth, ABC):
     """
     This class is the base class to authenticate with a JSON Web Token (JWT).
+
     https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app
+
     """
 
     @property
@@ -148,7 +158,9 @@ def token_type(self) -> str:
 class AppAuth(JWT):
     """
     This class is used to authenticate as a GitHub App.
+
     https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app
+
     """
 
     def __init__(
@@ -193,10 +205,12 @@ def get_installation_auth(
     ) -> "AppInstallationAuth":
         """
         Creates a github.Auth.AppInstallationAuth instance for an installation.
+
         :param installation_id: installation id
         :param token_permissions: optional permissions
         :param requester: optional requester with app authentication
         :return:
+
         """
         return AppInstallationAuth(self, installation_id, token_permissions, requester)
 
@@ -227,7 +241,9 @@ def create_jwt(self, expiration: Optional[int] = None) -> str:
 class AppAuthToken(JWT):
     """
     This class is used to authenticate as a GitHub App with a single constant JWT.
+
     https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app
+
     """
 
     def __init__(self, token: str):
@@ -243,7 +259,9 @@ def token(self) -> str:
 class AppInstallationAuth(Auth, WithRequester["AppInstallationAuth"]):
     """
     This class is used to authenticate as a GitHub App Installation.
+
     https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation
+
     """
 
     # used to fetch live access token when calling self.token
@@ -323,7 +341,9 @@ def _get_installation_authorization(self) -> InstallationAuthorization:
 class AppUserAuth(Auth, WithRequester["AppUserAuth"]):
     """
     This class is used to authenticate as a GitHub App on behalf of a user.
+
     https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user
+
     """
 
     _client_id: str

github/Authorization.py

@@ -50,7 +50,11 @@
 
 class Authorization(github.GithubObject.CompletableGithubObject):
     """
-    This class represents Authorizations. The reference can be found here https://docs.github.com/en/enterprise-server@3.0/rest/reference/oauth-authorizations
+    This class represents Authorizations.
+
+    The reference can be found here
+    https://docs.github.com/en/enterprise-server@3.0/rest/reference/oauth-authorizations
+
     """
 
     def _initAttributes(self) -> None:

github/AuthorizationApplication.py

@@ -40,7 +40,7 @@
 
 class AuthorizationApplication(CompletableGithubObject):
     """
-    This class represents AuthorizationApplications
+    This class represents AuthorizationApplications.
     """
 
     def _initAttributes(self) -> None:

github/Autolink.py

@@ -44,7 +44,10 @@
 class Autolink(NonCompletableGithubObject):
     """
     This class represents Repository autolinks.
-    The reference can be found here https://docs.github.com/en/rest/repos/autolinks?apiVersion=2022-11-28
+
+    The reference can be found here
+    https://docs.github.com/en/rest/repos/autolinks?apiVersion=2022-11-28
+
     """
 
     def _initAttributes(self) -> None:

github/Branch.py

@@ -78,7 +78,11 @@
 
 class Branch(NonCompletableGithubObject):
     """
-    This class represents Branches. The reference can be found here https://docs.github.com/en/rest/reference/repos#branches
+    This class represents Branches.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/repos#branches
+
     """
 
     def __repr__(self) -> str:

github/BranchProtection.py

@@ -49,7 +49,11 @@
 
 class BranchProtection(github.GithubObject.CompletableGithubObject):
     """
-    This class represents Branch Protection. The reference can be found here https://docs.github.com/en/rest/reference/repos#get-branch-protection
+    This class represents Branch Protection.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/repos#get-branch-protection
+
     """
 
     def __repr__(self) -> str:

github/CVSS.py

@@ -45,7 +45,10 @@
 class CVSS(NonCompletableGithubObject):
     """
     This class represents a CVSS.
-    The reference can be found here <https://docs.github.com/en/rest/security-advisories/global-advisories>
+
+    The reference can be found here
+    <https://docs.github.com/en/rest/security-advisories/global-advisories>
+
     """
 
     def _initAttributes(self) -> None:

github/CWE.py

@@ -45,7 +45,10 @@
 class CWE(CompletableGithubObject):
     """
     This class represents a CWE.
-    The reference can be found here https://docs.github.com/en/rest/security-advisories/repository-advisories
+
+    The reference can be found here
+    https://docs.github.com/en/rest/security-advisories/repository-advisories
+
     """
 
     def _initAttributes(self) -> None:

github/CheckRun.py

@@ -57,7 +57,10 @@
 class CheckRun(CompletableGithubObject):
     """
     This class represents check runs.
-    The reference can be found here https://docs.github.com/en/rest/reference/checks#check-runs
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/checks#check-runs
+
     """
 
     def _initAttributes(self) -> None:

github/CheckRunAnnotation.py

@@ -32,7 +32,9 @@
 class CheckRunAnnotation(NonCompletableGithubObject):
     """
     This class represents check run annotations.
+
     The reference can be found here: https://docs.github.com/en/rest/reference/checks#list-check-run-annotations
+
     """
 
     def _initAttributes(self) -> None:

github/CheckRunOutput.py

@@ -41,7 +41,9 @@
 
 
 class CheckRunOutput(NonCompletableGithubObject):
-    """This class represents the output of check run."""
+    """
+    This class represents the output of check run.
+    """
 
     def _initAttributes(self) -> None:
         self._annotations_count: Attribute[int] = NotSet

github/CheckSuite.py

@@ -49,7 +49,11 @@
 
 class CheckSuite(CompletableGithubObject):
     """
-    This class represents check suites. The reference can be found here https://docs.github.com/en/rest/reference/checks#check-suites
+    This class represents check suites.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/checks#check-suites
+
     """
 
     def _initAttributes(self) -> None:

github/Clones.py

@@ -44,7 +44,10 @@
 class Clones(NonCompletableGithubObject):
     """
     This class represents a popular Path for a GitHub repository.
-    The reference can be found here https://docs.github.com/en/rest/reference/repos#get-repository-clones
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/repos#get-repository-clones
+
     """
 
     def _initAttributes(self) -> None:

github/CodeScanAlert.py

@@ -40,7 +40,10 @@
 class CodeScanAlert(NonCompletableGithubObject):
     """
     This class represents alerts from code scanning.
-    The reference can be found here https://docs.github.com/en/rest/reference/code-scanning.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/code-scanning.
+
     """
 
     def _initAttributes(self) -> None:
@@ -110,7 +113,10 @@ def state(self) -> str:
 
     def get_instances(self) -> PaginatedList[github.CodeScanAlertInstance.CodeScanAlertInstance]:
         """
-        :calls: `GET` on the URL for instances as provided by Github
+        Get instances.
+
+        :calls: `GET` on the URL for instances as provided by Github.
+
         """
         return PaginatedList(
             github.CodeScanAlertInstance.CodeScanAlertInstance,

github/CodeScanAlertInstance.py

@@ -37,7 +37,10 @@
 class CodeScanAlertInstance(NonCompletableGithubObject):
     """
     This class represents code scanning alert instances.
-    The reference can be found here https://docs.github.com/en/rest/reference/code-scanning.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/code-scanning.
+
     """
 
     def _initAttributes(self) -> None:

github/CodeScanAlertInstanceLocation.py

@@ -32,7 +32,10 @@
 class CodeScanAlertInstanceLocation(NonCompletableGithubObject):
     """
     This class represents code scanning alert instance locations.
-    The reference can be found here https://docs.github.com/en/rest/reference/code-scanning.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/code-scanning.
+
     """
 
     def _initAttributes(self) -> None:

github/CodeScanRule.py

@@ -46,7 +46,10 @@
 class CodeScanRule(NonCompletableGithubObject):
     """
     This class represents Alerts from code scanning.
-    The reference can be found here https://docs.github.com/en/rest/reference/code-scanning.
+
+    The reference can be found here
+    https://docs.github.com/en/rest/reference/code-scanning.
+
     """
 
     def _initAttributes(self) -> None: