Add additional ruff checks and run autofix

autofixed via:

ruff check --fix --unsafe-fixes
ruff format

Author: bboe

praw/config.py

@@ -41,7 +41,7 @@ def _config_boolean(item: bool | str) -> bool:
         return item.lower() in {"1", "yes", "true", "on"}
 
     @classmethod
-    def _load_config(cls, *, config_interpolation: str | None = None):
+    def _load_config(cls, *, config_interpolation: str | None = None) -> None:
         """Attempt to load settings from various praw.ini files."""
         if config_interpolation is not None:
             interpolator_class = cls.INTERPOLATION_LEVEL[config_interpolation]()
@@ -86,7 +86,7 @@ def __init__(
         site_name: str,
         config_interpolation: str | None = None,
         **settings: str,
-    ):
+    ) -> None:
         """Initialize a :class:`.Config` instance."""
         with Config.LOCK:
             if Config.CONFIG is None:
@@ -121,7 +121,7 @@ def _fetch_or_not_set(self, key: str) -> Any | _NotSet:
         # Environment variables have higher priority than praw.ini settings
         return env_value or ini_value or self.CONFIG_NOT_SET
 
-    def _initialize_attributes(self):
+    def _initialize_attributes(self) -> None:
         self._short_url = self._fetch_default("short_url") or self.CONFIG_NOT_SET
         self.check_for_async = self._config_boolean(self._fetch_default("check_for_async", default=True))
         self.check_for_updates = self._config_boolean(self._fetch_or_not_set("check_for_updates"))

praw/exceptions.py

@@ -48,7 +48,7 @@ def __init__(
         *,
         field: str | None = None,
         message: str | None = None,
-    ):
+    ) -> None:
         """Initialize a :class:`.RedditErrorItem` instance.
 
         :param error_type: The error type set on Reddit's end.
@@ -78,7 +78,7 @@ class ClientException(PRAWException):
 class DuplicateReplaceException(ClientException):
     """Indicate exceptions that involve the replacement of :class:`.MoreComments`."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize a :class:`.DuplicateReplaceException` instance."""
         super().__init__(
             "A duplicate comment has been detected. Are you attempting to call 'replace_more_comments' more than once?"
@@ -88,7 +88,7 @@ def __init__(self):
 class InvalidFlairTemplateID(ClientException):
     """Indicate exceptions where an invalid flair template ID is given."""
 
-    def __init__(self, template_id: str):
+    def __init__(self, template_id: str) -> None:
         """Initialize an :class:`.InvalidFlairTemplateID` instance."""
         super().__init__(
             f"The flair template ID '{template_id}' is invalid. If you are trying to"
@@ -99,15 +99,15 @@ def __init__(self, template_id: str):
 class InvalidImplicitAuth(ClientException):
     """Indicate exceptions where an implicit auth type is used incorrectly."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize an :class:`.InvalidImplicitAuth` instance."""
         super().__init__("Implicit authorization can only be used with installed apps.")
 
 
 class InvalidURL(ClientException):
     """Indicate exceptions where an invalid URL is entered."""
 
-    def __init__(self, url: str, *, message: str = "Invalid URL: {}"):
+    def __init__(self, url: str, *, message: str = "Invalid URL: {}") -> None:
         """Initialize an :class:`.InvalidURL` instance.
 
         :param url: The invalid URL.
@@ -129,7 +129,7 @@ class ReadOnlyException(ClientException):
 class TooLargeMediaException(ClientException):
     """Indicate exceptions from uploading media that's too large."""
 
-    def __init__(self, *, actual: int, maximum_size: int):
+    def __init__(self, *, actual: int, maximum_size: int) -> None:
         """Initialize a :class:`.TooLargeMediaException` instance.
 
         :param actual: The actual size of the uploaded media.
@@ -146,7 +146,7 @@ def __init__(self, *, actual: int, maximum_size: int):
 class WebSocketException(ClientException):
     """Indicate exceptions caused by use of WebSockets."""
 
-    def __init__(self, message: str):
+    def __init__(self, message: str) -> None:
         """Initialize a :class:`.WebSocketException` instance.
 
         :param message: The exception message.
@@ -158,7 +158,7 @@ def __init__(self, message: str):
 class MediaPostFailed(WebSocketException):
     """Indicate exceptions where media uploads failed.."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize a :class:`.MediaPostFailed` instance."""
         super().__init__(
             "The attempted media upload action has failed. Possible causes include the"
@@ -188,7 +188,7 @@ def parse_exception_list(
             for exception in exceptions
         ]
 
-    def __init__(self, items: list[RedditErrorItem | list[str] | str]):
+    def __init__(self, items: list[RedditErrorItem | list[str] | str]) -> None:
         """Initialize a :class:`.RedditAPIException` instance.
 
         :param items: Either a list of instances of :class:`.RedditErrorItem` or a list

praw/models/auth.py

@@ -4,7 +4,8 @@
 
 from prawcore import Authorizer, ImplicitAuthorizer, UntrustedAuthenticator, session
 
-from ..exceptions import InvalidImplicitAuth, MissingRequiredAttributeException
+from praw.exceptions import InvalidImplicitAuth, MissingRequiredAttributeException
+
 from .base import PRAWBase
 
 
@@ -48,7 +49,7 @@ def authorize(self, code: str) -> str | None:
         self._reddit._core = self._reddit._authorized_core = authorized_session
         return authorizer.refresh_token
 
-    def implicit(self, *, access_token: str, expires_in: int, scope: str):
+    def implicit(self, *, access_token: str, expires_in: int, scope: str) -> None:
         """Set the active authorization to be an implicit authorization.
 
         :param access_token: The access_token obtained from Reddit's callback.

praw/models/base.py

@@ -13,7 +13,7 @@ class PRAWBase:
     """Superclass for all models in PRAW."""
 
     @staticmethod
-    def _safely_add_arguments(*, arguments: dict[str, Any], key: str, **new_arguments: Any):
+    def _safely_add_arguments(*, arguments: dict[str, Any], key: str, **new_arguments: Any) -> None:
         """Replace arguments[key] with a deepcopy and update.
 
         This method is often called when new parameters need to be added to a request.
@@ -35,7 +35,7 @@ def parse(cls, data: dict[str, Any], reddit: praw.Reddit) -> Any:
         """
         return cls(reddit, _data=data)
 
-    def __init__(self, reddit: praw.Reddit, _data: dict[str, Any] | None):
+    def __init__(self, reddit: praw.Reddit, _data: dict[str, Any] | None) -> None:
         """Initialize a :class:`.PRAWBase` instance.
 
         :param reddit: An instance of :class:`.Reddit`.

praw/models/comment_forest.py

@@ -5,7 +5,8 @@
 from heapq import heappop, heappush
 from typing import TYPE_CHECKING
 
-from ..exceptions import DuplicateReplaceException
+from praw.exceptions import DuplicateReplaceException
+
 from .reddit.more import MoreComments
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -43,7 +44,7 @@ def __len__(self) -> int:
         """Return the number of top-level comments in the forest."""
         return len(self._comments)
 
-    def _insert_comment(self, comment: praw.models.Comment):
+    def _insert_comment(self, comment: praw.models.Comment) -> None:
         if comment.name in self._submission._comments_by_id:
             raise DuplicateReplaceException
         comment.submission = self._submission
@@ -56,7 +57,7 @@ def _insert_comment(self, comment: praw.models.Comment):
             parent = self._submission._comments_by_id[comment.parent_id]
             parent.replies._comments.append(comment)
 
-    def list(  # noqa: A003
+    def list(
         self,
     ) -> list[praw.models.Comment | praw.models.MoreComments]:
         """Return a flattened list of all comments.
@@ -100,7 +101,7 @@ def __init__(
         self,
         submission: praw.models.Submission,
         comments: list[praw.models.Comment] | None = None,
-    ):
+    ) -> None:
         """Initialize a :class:`.CommentForest` instance.
 
         :param submission: An instance of :class:`.Submission` that is the parent of the
@@ -112,7 +113,7 @@ def __init__(
         self._comments = comments
         self._submission = submission
 
-    def _update(self, comments: list[praw.models.Comment]):
+    def _update(self, comments: list[praw.models.Comment]) -> None:
         self._comments = comments
         for comment in comments:
             comment.submission = self._submission
@@ -179,7 +180,7 @@ def replace_more(self, *, limit: int | None = 32, threshold: int = 0) -> list[pr
         # Fetch largest more_comments until reaching the limit or the threshold
         while more_comments:
             item = heappop(more_comments)
-            if remaining is not None and remaining <= 0 or item.count < threshold:
+            if (remaining is not None and remaining <= 0) or item.count < threshold:
                 skipped.append(item)
                 item._remove_from.remove(item)
                 continue

praw/models/front.py

@@ -17,7 +17,7 @@
 class Front(SubredditListingMixin):
     """Front is a Listing class that represents the front page."""
 
-    def __init__(self, reddit: praw.Reddit):
+    def __init__(self, reddit: praw.Reddit) -> None:
         """Initialize a :class:`.Front` instance."""
         super().__init__(reddit, _data=None)
         self._path = "/"

praw/models/helpers.py

@@ -5,7 +5,8 @@
 from json import dumps
 from typing import TYPE_CHECKING, Any
 
-from ..const import API_PATH
+from praw.const import API_PATH
+
 from .base import PRAWBase
 from .reddit.draft import Draft
 from .reddit.live import LiveThread
@@ -156,7 +157,7 @@ def create(
         *,
         description: str | None = None,
         nsfw: bool = False,
-        resources: str = None,
+        resources: str | None = None,
     ) -> praw.models.LiveThread:
         """Create a new :class:`.LiveThread`.
 

praw/models/inbox.py

@@ -4,7 +4,8 @@
 
 from typing import TYPE_CHECKING
 
-from ..const import API_PATH
+from praw.const import API_PATH
+
 from .base import PRAWBase
 from .listing.generator import ListingGenerator
 from .util import stream_generator
@@ -18,7 +19,7 @@
 class Inbox(PRAWBase):
     """Inbox is a Listing class that represents the inbox."""
 
-    def all(  # noqa: A003
+    def all(
         self, **generator_kwargs: str | int | dict[str, str]
     ) -> Iterator[praw.models.Message | praw.models.Comment]:
         """Return a :class:`.ListingGenerator` for all inbox comments and messages.
@@ -36,7 +37,7 @@ def all(  # noqa: A003
         """
         return ListingGenerator(self._reddit, API_PATH["inbox"], **generator_kwargs)
 
-    def collapse(self, items: list[praw.models.Message]):
+    def collapse(self, items: list[praw.models.Message]) -> None:
         """Mark an inbox message as collapsed.
 
         :param items: A list containing instances of :class:`.Message`.
@@ -81,7 +82,7 @@ def comment_replies(self, **generator_kwargs: str | int | dict[str, str]) -> Ite
         """
         return ListingGenerator(self._reddit, API_PATH["comment_replies"], **generator_kwargs)
 
-    def mark_all_read(self):
+    def mark_all_read(self) -> None:
         """Mark all messages as read with just one API call.
 
         Example usage:
@@ -98,7 +99,7 @@ def mark_all_read(self):
         """
         self._reddit.post(API_PATH["read_all_messages"])
 
-    def mark_read(self, items: list[praw.models.Comment | praw.models.Message]):
+    def mark_read(self, items: list[praw.models.Comment | praw.models.Message]) -> None:
         """Mark Comments or Messages as read.
 
         :param items: A list containing instances of :class:`.Comment` and/or
@@ -130,7 +131,7 @@ def mark_read(self, items: list[praw.models.Comment | praw.models.Message]):
             self._reddit.post(API_PATH["read_message"], data=data)
             items = items[25:]
 
-    def mark_unread(self, items: list[praw.models.Comment | praw.models.Message]):
+    def mark_unread(self, items: list[praw.models.Comment | praw.models.Message]) -> None:
         """Unmark Comments or Messages as read.
 
         :param items: A list containing instances of :class:`.Comment` and/or
@@ -189,7 +190,7 @@ def message(self, message_id: str) -> praw.models.Message:
 
         """
         listing = self._reddit.get(API_PATH["message"].format(id=message_id))
-        messages = {message.fullname: message for message in [listing[0]] + listing[0].replies}
+        messages = {message.fullname: message for message in [listing[0], *listing[0].replies]}
         for _fullname, message in messages.items():
             message.parent = messages.get(message.parent_id, None)
         return messages[f"t4_{message_id.lower()}"]
@@ -262,7 +263,7 @@ def submission_replies(self, **generator_kwargs: str | int | dict[str, str]) ->
         """
         return ListingGenerator(self._reddit, API_PATH["submission_replies"], **generator_kwargs)
 
-    def uncollapse(self, items: list[praw.models.Message]):
+    def uncollapse(self, items: list[praw.models.Message]) -> None:
         """Mark an inbox message as uncollapsed.
 
         :param items: A list containing instances of :class:`.Message`.

praw/models/list/base.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING, Any
 
-from ..base import PRAWBase
+from praw.models.base import PRAWBase
 
 if TYPE_CHECKING:  # pragma: no cover
     from collections.abc import Iterator
@@ -25,7 +25,7 @@ def __getitem__(self, index: int) -> Any:
         """Return the item at position index in the list."""
         return getattr(self, self.CHILD_ATTRIBUTE)[index]
 
-    def __init__(self, reddit: praw.Reddit, _data: dict[str, Any]):
+    def __init__(self, reddit: praw.Reddit, _data: dict[str, Any]) -> None:
         """Initialize a :class:`.BaseList` instance.
 
         :param reddit: An instance of :class:`.Reddit`.

praw/models/listing/domain.py

@@ -4,7 +4,8 @@
 
 from typing import TYPE_CHECKING
 
-from ...const import API_PATH
+from praw.const import API_PATH
+
 from .mixins import BaseListingMixin, RisingListingMixin
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -14,7 +15,7 @@
 class DomainListing(BaseListingMixin, RisingListingMixin):
     """Provide a set of functions to interact with domain listings."""
 
-    def __init__(self, reddit: praw.Reddit, domain: str):
+    def __init__(self, reddit: praw.Reddit, domain: str) -> None:
         """Initialize a :class:`.DomainListing` instance.
 
         :param reddit: An instance of :class:`.Reddit`.