Code clean up

Author: LilSpazJoekp

.flake8

@@ -28,7 +28,7 @@ body:
   - id: credential-check
     attributes:
       description: |
-        The `Reddit()` initialization in my code example does not include the following parameters to prevent credential leakage: 
+        The `Reddit()` initialization in my code example does not include the following parameters to prevent credential leakage:
         `client_secret`, `password`, or `refresh_token`.
       label: My code does not include sensitive credentials
       options:
@@ -77,7 +77,7 @@ body:
   - id: prawcore-version
     attributes:
       description: What version of `prawcore` are you encountering this issue with? Obtain this by running `pip show prawcore`.
-      label: "`prawcore` Version"
+      label: prawcore Version
     type: input
     validations:
       required: true

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,3 @@
-prawcore is written and maintained by Bryce Boe and various contributors:
-
 Maintainers
 ===========
 

AUTHORS.rst

@@ -88,7 +88,7 @@ https://github.com/praw-dev/prawcore/tree/main/examples
 Depending on prawcore
 ---------------------
 
-prawcore follows `semantic versioning <http://semver.org/>`_ with the exception that
+prawcore follows `semantic versioning <https://semver.org/>`_ with the exception that
 deprecations will not be preceded by a minor release. In essence, expect only major
 versions to introduce breaking changes to prawcore's public interface. As a result, if
 you depend on prawcore then it is a good idea to specify not only the minimum version of

README.rst

@@ -21,15 +21,15 @@ class BaseAuthenticator(ABC):
     """Provide the base authenticator object that stores OAuth2 credentials."""
 
     @abstractmethod
-    def _auth(self):
+    def _auth(self) -> tuple[str, str]:
         pass
 
     def __init__(
         self,
         requestor: Requestor,
         client_id: str,
         redirect_uri: str | None = None,
-    ) -> None:
+    ):
         """Represent a single authentication to Reddit's API.
 
         :param requestor: An instance of :class:`.Requestor`.
@@ -60,11 +60,7 @@ def _post(
         return response
 
     def authorize_url(
-        self,
-        duration: str,
-        scopes: list[str],
-        state: str,
-        implicit: bool = False,
+        self, duration: str, scopes: list[str], state: str, implicit: bool = False
     ) -> str:
         """Return the URL used out-of-band to grant access to your application.
 
@@ -113,7 +109,7 @@ def authorize_url(
         request = Request("GET", url, params=params)
         return request.prepare().url
 
-    def revoke_token(self, token: str, token_type: str | None = None) -> None:
+    def revoke_token(self, token: str, token_type: str | None = None):
         """Ask Reddit to revoke the provided token.
 
         :param token: The access or refresh token to revoke.
@@ -134,7 +130,7 @@ class BaseAuthorizer(ABC):
 
     AUTHENTICATOR_CLASS: tuple | type = BaseAuthenticator
 
-    def __init__(self, authenticator: BaseAuthenticator) -> None:
+    def __init__(self, authenticator: BaseAuthenticator):
         """Represent a single authorization to Reddit's API.
 
         :param authenticator: An instance of :class:`.BaseAuthenticator`.
@@ -144,12 +140,12 @@ def __init__(self, authenticator: BaseAuthenticator) -> None:
         self._clear_access_token()
         self._validate_authenticator()
 
-    def _clear_access_token(self) -> None:
+    def _clear_access_token(self):
         self._expiration_timestamp: float
         self.access_token: str | None = None
         self.scopes: set[str] | None = None
 
-    def _request_token(self, **data: Any) -> None:
+    def _request_token(self, **data: Any):
         url = self._authenticator._requestor.reddit_url + const.ACCESS_TOKEN_PATH
         pre_request_time = time.time()
         response = self._authenticator._post(url=url, **data)
@@ -165,7 +161,7 @@ def _request_token(self, **data: Any) -> None:
             self.refresh_token = payload["refresh_token"]
         self.scopes = set(payload["scope"].split(" "))
 
-    def _validate_authenticator(self) -> None:
+    def _validate_authenticator(self):
         if not isinstance(self._authenticator, self.AUTHENTICATOR_CLASS):
             msg = "Must use an authenticator of type"
             if isinstance(self.AUTHENTICATOR_CLASS, type):
@@ -187,7 +183,7 @@ def is_valid(self) -> bool:
             self.access_token is not None and time.time() < self._expiration_timestamp
         )
 
-    def revoke(self) -> None:
+    def revoke(self):
         """Revoke the current Authorization."""
         if self.access_token is None:
             msg = "no token available to revoke"
@@ -208,7 +204,7 @@ def __init__(
         client_id: str,
         client_secret: str,
         redirect_uri: str | None = None,
-    ) -> None:
+    ):
         """Represent a single authentication to Reddit's API.
 
         :param requestor: An instance of :class:`.Requestor`.
@@ -245,7 +241,7 @@ def __init__(
         post_refresh_callback: Callable[[Authorizer], None] | None = None,
         pre_refresh_callback: Callable[[Authorizer], None] | None = None,
         refresh_token: str | None = None,
-    ) -> None:
+    ):
         """Represent a single authorization to Reddit's API.
 
         :param authenticator: An instance of a subclass of :class:`.BaseAuthenticator`.
@@ -267,7 +263,7 @@ def __init__(
         self._pre_refresh_callback = pre_refresh_callback
         self.refresh_token = refresh_token
 
-    def authorize(self, code: str) -> None:
+    def authorize(self, code: str):
         """Obtain and set authorization tokens based on ``code``.
 
         :param code: The code obtained by an out-of-band authorization request to
@@ -283,7 +279,7 @@ def authorize(self, code: str) -> None:
             redirect_uri=self._authenticator.redirect_uri,
         )
 
-    def refresh(self) -> None:
+    def refresh(self):
         """Obtain a new access token from the refresh_token."""
         if self._pre_refresh_callback:
             self._pre_refresh_callback(self)
@@ -296,7 +292,7 @@ def refresh(self) -> None:
         if self._post_refresh_callback:
             self._post_refresh_callback(self)
 
-    def revoke(self, only_access: bool = False) -> None:
+    def revoke(self, only_access: bool = False):
         """Revoke the current Authorization.
 
         :param only_access: When explicitly set to ``True``, do not evict the refresh
@@ -325,7 +321,7 @@ def __init__(
         access_token: str,
         expires_in: int,
         scope: str,
-    ) -> None:
+    ):
         """Represent a single implicit authorization to Reddit's API.
 
         :param authenticator: An instance of :class:`.UntrustedAuthenticator`.
@@ -360,7 +356,7 @@ def __init__(
         self,
         authenticator: BaseAuthenticator,
         scopes: list[str] | None = None,
-    ) -> None:
+    ):
         """Represent a ReadOnly authorization to Reddit's API.
 
         :param scopes: A list of OAuth scopes to request authorization for (default:
@@ -370,7 +366,7 @@ def __init__(
         super().__init__(authenticator)
         self._scopes = scopes
 
-    def refresh(self) -> None:
+    def refresh(self):
         """Obtain a new ReadOnly access token."""
         additional_kwargs = {}
         if self._scopes:
@@ -395,7 +391,7 @@ def __init__(
         password: str | None,
         two_factor_callback: Callable | None = None,
         scopes: list[str] | None = None,
-    ) -> None:
+    ):
         """Represent a single personal-use authorization to Reddit's API.
 
         :param authenticator: An instance of :class:`.TrustedAuthenticator`.
@@ -414,7 +410,7 @@ def __init__(
         self._two_factor_callback = two_factor_callback
         self._username = username
 
-    def refresh(self) -> None:
+    def refresh(self):
         """Obtain a new personal-use script type access token."""
         additional_kwargs = {}
         if self._scopes:
@@ -445,7 +441,7 @@ def __init__(
         authenticator: BaseAuthenticator,
         device_id: str | None = None,
         scopes: list[str] | None = None,
-    ) -> None:
+    ):
         """Represent an app-only OAuth2 authorization for 'installed' apps.
 
         :param authenticator: An instance of :class:`.UntrustedAuthenticator` or
@@ -464,7 +460,7 @@ def __init__(
         self._device_id = device_id
         self._scopes = scopes
 
-    def refresh(self) -> None:
+    def refresh(self):
         """Obtain a new access token."""
         additional_kwargs = {}
         if self._scopes:

prawcore/auth.py

@@ -19,9 +19,7 @@ class InvalidInvocation(PrawcoreException):
 class OAuthException(PrawcoreException):
     """Indicate that there was an OAuth2 related error with the request."""
 
-    def __init__(
-        self, response: Response, error: str, description: str | None = None
-    ) -> None:
+    def __init__(self, response: Response, error: str, description: str | None = None):
         """Initialize a OAuthException instance.
 
         :param response: A ``requests.response`` instance.
@@ -48,7 +46,7 @@ def __init__(
         request_kwargs: dict[
             str, bool | (dict[str, int] | (dict[str, str] | str)) | None
         ],
-    ) -> None:
+    ):
         """Initialize a RequestException instance.
 
         :param original_exception: The original exception that occurred.
@@ -65,7 +63,7 @@ def __init__(
 class ResponseException(PrawcoreException):
     """Indicate that there was an error with the completed HTTP request."""
 
-    def __init__(self, response: Response) -> None:
+    def __init__(self, response: Response):
         """Initialize a ResponseException instance.
 
         :param response: A ``requests.response`` instance.
@@ -111,7 +109,7 @@ class Redirect(ResponseException):
 
     """
 
-    def __init__(self, response: Response) -> None:
+    def __init__(self, response: Response):
         """Initialize a Redirect exception instance.
 
         :param response: A ``requests.response`` instance containing a location header.
@@ -137,7 +135,7 @@ class ServerError(ResponseException):
 class SpecialError(ResponseException):
     """Indicate syntax or spam-prevention issues."""
 
-    def __init__(self, response: Response) -> None:
+    def __init__(self, response: Response):
         """Initialize a SpecialError exception instance.
 
         :param response: A ``requests.response`` instance containing a message and a
@@ -160,7 +158,7 @@ class TooLarge(ResponseException):
 class TooManyRequests(ResponseException):
     """Indicate that the user has sent too many requests in a given amount of time."""
 
-    def __init__(self, response: Response) -> None:
+    def __init__(self, response: Response):
         """Initialize a TooManyRequests exception instance.
 
         :param response: A ``requests.response`` instance that may contain a retry-after

prawcore/exceptions.py

@@ -18,7 +18,7 @@ class RateLimiter:
 
     """
 
-    def __init__(self, *, window_size: int) -> None:
+    def __init__(self, *, window_size: int):
         """Create an instance of the RateLimit class."""
         self.remaining: float | None = None
         self.next_request_timestamp: float | None = None
@@ -48,7 +48,7 @@ def call(
         self.update(response.headers)
         return response
 
-    def delay(self) -> None:
+    def delay(self):
         """Sleep for an amount of time to remain under the rate limit."""
         if self.next_request_timestamp is None:
             return
@@ -59,7 +59,7 @@ def delay(self) -> None:
         log.debug(message)
         time.sleep(sleep_seconds)
 
-    def update(self, response_headers: Mapping[str, str]) -> None:
+    def update(self, response_headers: Mapping[str, str]):
         """Update the state of the rate limiter based on the response headers.
 
         This method should only be called following an HTTP request to Reddit.

prawcore/rate_limit.py

@@ -9,9 +9,7 @@
 from .exceptions import InvalidInvocation, RequestException
 
 if TYPE_CHECKING:
-    from requests.models import Response
-
-    from .sessions import Session
+    from requests.models import Response, Session
 
 
 class Requestor:
@@ -30,7 +28,7 @@ def __init__(
         reddit_url: str = "https://www.reddit.com",
         session: Session | None = None,
         timeout: float = TIMEOUT,
-    ) -> None:
+    ):
         """Create an instance of the Requestor class.
 
         :param user_agent: The user-agent for your application. Please follow Reddit's
@@ -39,7 +37,7 @@ def __init__(
             (default: ``"https://oauth.reddit.com"``).
         :param reddit_url: The URL used when obtaining access tokens (default:
             ``"https://www.reddit.com"``).
-        :param session: A session to handle requests, compatible with
+        :param session: A session instance to handle requests, compatible with
             ``requests.Session()`` (default: ``None``).
         :param timeout: How many seconds to wait for the server to send data before
             giving up (default: ``prawcore.const.TIMEOUT``).
@@ -59,9 +57,9 @@ def __init__(
         self.reddit_url = reddit_url
         self.timeout = timeout
 
-    def close(self) -> None:
+    def close(self):
         """Call close on the underlying session."""
-        return self._http.close()
+        self._http.close()
 
     def request(
         self, *args: Any, timeout: float | None = None, **kwargs: Any