linted and type checked

Author: sudoDeVinci

asyncPyGithub/User.py

@@ -14,12 +14,16 @@
 from .base import req
 
 from requests import get, patch
+from typing import Final, Literal
 
 
 UserQueryReturnable = tuple[
     int, PrivateUser | SimpleUser | list[SimpleUser] | ErrorMessage
 ]
 
+USER_ENDPOINT: Final[Literal["/user"]] = "/user"
+USERS_ENDPOINT: Final[Literal["/users"]] = "/users"
+
 
 class GitHubUserPortal(GitHubPortal):
 
@@ -41,7 +45,7 @@ async def authenticate(
                     ErrorMessage(
                         code=res.status_code,
                         message=res.json().get("message", "Unknown error"),
-                        endpoint="/user",
+                        endpoint=USER_ENDPOINT,
                     ),
                 )
 
@@ -60,15 +64,16 @@ async def update(
         This function uses the `/user` endpoint to update the user's information.
         Available: [https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#update-the-authenticated-user](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#update-the-authenticated-user)
         """
+        endpoint = USER_ENDPOINT
         try:
-            res = await req(fn=patch, url="/user", json=changes)
+            res = await req(fn=patch, url=endpoint, json=changes)
             if res.status_code != 200:
                 return (
                     res.status_code,
                     ErrorMessage(
                         code=res.status_code,
                         message=res.json().get("message", "Unknown error"),
-                        endpoint="/user",
+                        endpoint=endpoint,
                     ),
                 )
 
@@ -81,30 +86,31 @@ async def update(
             updated_self = PrivateUser(**updated_json)
 
         except Exception as e:
-            return (500, ErrorMessage(code=500, message=str(e), endpoint="/user"))
+            return (500, ErrorMessage(code=500, message=str(e), endpoint=endpoint))
 
         return (res.status_code, updated_self)
 
     @needs_authentication
     async def get_by_id(
         cls: "GitHubUserPortal", uid: int
     ) -> tuple[int, PrivateUser | ErrorMessage]:
+        endpoint = f"{USER_ENDPOINT}/{uid}"
         try:
-            res = await req(fn=get, url=f"/user/{uid}")
+            res = await req(fn=get, url=endpoint)
             if res.status_code != 200:
                 return (
                     res.status_code,
                     ErrorMessage(
                         code=res.status_code,
                         message=res.json().get("message", "Unknown error"),
-                        endpoint=f"/user/{uid}",
+                        endpoint=endpoint,
                     ),
                 )
 
         except Exception as e:
             return (
                 500,
-                ErrorMessage(code=500, message=str(e), endpoint=f"/user/{uid}"),
+                ErrorMessage(code=500, message=str(e), endpoint=endpoint),
             )
 
         return (res.status_code, PrivateUser(**res.json()))
@@ -113,23 +119,24 @@ async def get_by_id(
     async def get_by_username(
         cls: "GitHubUserPortal", username: str
     ) -> tuple[int, PrivateUser | ErrorMessage]:
+        endpoint = f"{USERS_ENDPOINT}/{username}"
         try:
-            res = await req(fn=get, url=f"/users/{username}")
+            res = await req(fn=get, url=endpoint)
             if res.status_code != 200:
                 return (
                     res.status_code,
                     ErrorMessage(
                         code=res.status_code,
                         message=res.json().get("message", "Unknown error"),
-                        endpoint=f"/users/{username}",
+                        endpoint=endpoint,
                     ),
                 )
 
             return (res.status_code, PrivateUser(**res.json()))
         except Exception as e:
             return (
                 500,
-                ErrorMessage(code=500, message=str(e), endpoint=f"/users/{username}"),
+                ErrorMessage(code=500, message=str(e), endpoint=endpoint),
             )
 
     @needs_authentication
@@ -138,20 +145,25 @@ async def all(
     ) -> tuple[int, list[SimpleUser] | ErrorMessage]:
         try:
             res = await req(
-                fn=get, url="/users", params={"since": since, "per_page": per_page}
+                fn=get,
+                url=USERS_ENDPOINT,
+                params={"since": since, "per_page": per_page},
             )
             if res.status_code != 200:
                 return (
                     res.status_code,
                     ErrorMessage(
                         code=res.status_code,
                         message=res.json().get("message", "Unknown error"),
-                        endpoint="/users",
+                        endpoint=USERS_ENDPOINT,
                     ),
                 )
 
         except Exception as e:
-            return (500, ErrorMessage(code=500, message=str(e), endpoint="/users"))
+            return (
+                500,
+                ErrorMessage(code=500, message=str(e), endpoint=USERS_ENDPOINT),
+            )
 
         return (res.status_code, [SimpleUser(**user) for user in res.json()])
 
@@ -164,16 +176,16 @@ async def get_hovercard(
         This function uses the `/users/{username}/hovercard` endpoint to get the hovercard information.
         Available: [https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#view-a-user-hovercard](https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#view-a-user-hovercard)
         """
-
+        endpoint = f"{USERS_ENDPOINT}/{username}/hovercard"
         try:
-            res = await req(fn=get, url=f"/users/{username}/hovercard")
+            res = await req(fn=get, url=endpoint)
             if res.status_code != 200:
                 return (
                     res.status_code,
                     ErrorMessage(
                         code=res.status_code,
                         message=res.json().get("message", "Unknown error"),
-                        endpoint=f"/users/{username}/hovercard",
+                        endpoint=endpoint,
                     ),
                 )
 
@@ -187,7 +199,5 @@ async def get_hovercard(
         except Exception as e:
             return (
                 500,
-                ErrorMessage(
-                    code=500, message=str(e), endpoint=f"/users/{username}/hovercard"
-                ),
+                ErrorMessage(code=500, message=str(e), endpoint=endpoint),
             )

asyncPyGithub/__init__.py

@@ -25,7 +25,6 @@
 __all__ = (
     "UserQueryReturnable",
     "ErrorMessage",
-    "UserJSON",
     "SimpleUserJSON",
     "SimpleUser",
     "UserPlanJSON",

asyncPyGithub/_types/__init__.py

@@ -32,10 +32,8 @@
     "UserPlanJSON",
     "PrivateUserJSON",
     "PrivateUser",
-    "UserJSONSchema",
     "SimpleUserJSON",
     "SimpleUser",
-    "HoverCardSchema",
     "HoverCardJSON",
     "HoverCard",
     "HoverCardContextJSON",

asyncPyGithub/_types/base.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from typing_extensions import Self, Callable, Any
 from collections.abc import Coroutine as CoroutineType
 from pydantic import EmailStr, HttpUrl, PastDatetime
@@ -62,7 +63,7 @@ def authenticated(self: Self) -> bool:
 
 def needs_authentication(
     function: Callable[..., Any],
-) -> classmethod[GitHubPortal, [Any], CoroutineType[Any, Any, Any]]:
+) -> classmethod[Any, ..., CoroutineType[Any, Any, Any]]:
     async def wrapper(cls: type[GitHubPortal], *args, **kwargs) -> Any:
         # Special case: allow authenticate() to run without being authenticated
         if function.__name__ == "authenticate":