Merge pull request praw-dev#2053 from praw-dev/more_cleanup

Resolve a ton of additional ruff warnings

Author: bboe

.coveragerc

@@ -1,5 +1,4 @@
 [report]
 exclude_lines =
-    @abstract
     if TYPE_CHECKING:
     pragma: no cover

CHANGES.rst

@@ -12,12 +12,17 @@ Unreleased
 
 **Changed**
 
-- Bumped prawcore to 3.0.1.
+- Bumped prawcore to 3.0.2.
 - Drop support for Python 3.8, which was end-of-life on 2024-10-07.
 - Change ``Reddit.user.me`` to raise :class:`.ReadOnlyException` when called in
   :attr:`.read_only` mode.
 - The ``subreddit`` attribute of :class:`.Redditor` is a :class:`.UserSubreddit`
   instance.
+- The ``data`` argument to ``Objector.objectify`` must now be passed by keyword.
+- The ``mark_read`` argument to ``subreddit.modmail`` (:class:`.ModmailConversation`)
+  must now be passed by keyword.
+- The ``flair_type`` argument to :class:`.SubredditFlairTemplates` must be passed by
+  keyword.
 
 **Removed**
 

praw/__init__.py

@@ -9,5 +9,5 @@
 
 """
 
-from .const import __version__
-from .reddit import Reddit
+from praw.const import __version__
+from praw.reddit import Reddit

praw/config.py

@@ -8,9 +8,10 @@
 import os
 from pathlib import Path
 from threading import Lock
+from types import MappingProxyType
 from typing import Any
 
-from .exceptions import ClientException
+from praw.exceptions import ClientException
 
 
 class _NotSet:
@@ -29,19 +30,19 @@ class Config:
     CONFIG = None
     CONFIG_NOT_SET = _NotSet()  # Represents a config value that is not set.
     LOCK = Lock()
-    INTERPOLATION_LEVEL = {
+    INTERPOLATION_LEVEL = MappingProxyType({
         "basic": configparser.BasicInterpolation,
         "extended": configparser.ExtendedInterpolation,
-    }
+    })
 
     @staticmethod
-    def _config_boolean(item: bool | str) -> bool:
+    def _config_boolean(*, item: bool | str) -> bool:
         if isinstance(item, bool):
             return item
         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 +87,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,13 +122,13 @@ 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"))
-        self.warn_comment_sort = self._config_boolean(self._fetch_default("warn_comment_sort", default=True))
+        self.check_for_async = self._config_boolean(item=self._fetch_default("check_for_async", default=True))
+        self.check_for_updates = self._config_boolean(item=self._fetch_or_not_set("check_for_updates"))
+        self.warn_comment_sort = self._config_boolean(item=self._fetch_default("warn_comment_sort", default=True))
         self.warn_additional_fetch_params = self._config_boolean(
-            self._fetch_default("warn_additional_fetch_params", default=True)
+            item=self._fetch_default("warn_additional_fetch_params", default=True)
         )
         self.window_size = self._fetch_default("window_size", default=600)
         self.kinds = {

praw/const.py

@@ -1,6 +1,6 @@
 """PRAW constants."""
 
-from .endpoints import API_PATH  # noqa: F401
+from praw.endpoints import API_PATH  # noqa: F401
 
 __version__ = "7.8.2.dev0"
 

praw/exceptions.py

@@ -11,7 +11,7 @@
 from __future__ import annotations
 
 
-class PRAWException(Exception):
+class PRAWException(Exception):  # noqa: N818
     """The base PRAW Exception that all other exception classes extend."""
 
 
@@ -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/__init__.py

@@ -1,38 +1,38 @@
 """Provide the PRAW models."""
 
-from .auth import Auth
-from .front import Front
-from .helpers import DraftHelper, LiveHelper, MultiredditHelper, SubredditHelper
-from .inbox import Inbox
-from .list.draft import DraftList
-from .list.moderated import ModeratedList
-from .list.redditor import RedditorList
-from .list.trophy import TrophyList
-from .listing.domain import DomainListing
-from .listing.generator import ListingGenerator
-from .listing.listing import Listing, ModeratorListing, ModmailConversationsListing
-from .mod_action import ModAction
-from .mod_note import ModNote
-from .mod_notes import RedditModNotes, RedditorModNotes, SubredditModNotes
-from .preferences import Preferences
-from .reddit.collections import Collection
-from .reddit.comment import Comment
-from .reddit.draft import Draft
-from .reddit.emoji import Emoji
-from .reddit.inline_media import InlineGif, InlineImage, InlineMedia, InlineVideo
-from .reddit.live import LiveThread, LiveUpdate
-from .reddit.message import Message, SubredditMessage
-from .reddit.modmail import ModmailAction, ModmailConversation, ModmailMessage
-from .reddit.more import MoreComments
-from .reddit.multi import Multireddit
-from .reddit.poll import PollData, PollOption
-from .reddit.redditor import Redditor
-from .reddit.removal_reasons import RemovalReason
-from .reddit.rules import Rule
-from .reddit.submission import Submission
-from .reddit.subreddit import Subreddit
-from .reddit.user_subreddit import UserSubreddit
-from .reddit.widgets import (
+from praw.models.auth import Auth
+from praw.models.front import Front
+from praw.models.helpers import DraftHelper, LiveHelper, MultiredditHelper, SubredditHelper
+from praw.models.inbox import Inbox
+from praw.models.list.draft import DraftList
+from praw.models.list.moderated import ModeratedList
+from praw.models.list.redditor import RedditorList
+from praw.models.list.trophy import TrophyList
+from praw.models.listing.domain import DomainListing
+from praw.models.listing.generator import ListingGenerator
+from praw.models.listing.listing import Listing, ModeratorListing, ModmailConversationsListing
+from praw.models.mod_action import ModAction
+from praw.models.mod_note import ModNote
+from praw.models.mod_notes import RedditModNotes, RedditorModNotes, SubredditModNotes
+from praw.models.preferences import Preferences
+from praw.models.reddit.collections import Collection
+from praw.models.reddit.comment import Comment
+from praw.models.reddit.draft import Draft
+from praw.models.reddit.emoji import Emoji
+from praw.models.reddit.inline_media import InlineGif, InlineImage, InlineMedia, InlineVideo
+from praw.models.reddit.live import LiveThread, LiveUpdate
+from praw.models.reddit.message import Message, SubredditMessage
+from praw.models.reddit.modmail import ModmailAction, ModmailConversation, ModmailMessage
+from praw.models.reddit.more import MoreComments
+from praw.models.reddit.multi import Multireddit
+from praw.models.reddit.poll import PollData, PollOption
+from praw.models.reddit.redditor import Redditor
+from praw.models.reddit.removal_reasons import RemovalReason
+from praw.models.reddit.rules import Rule
+from praw.models.reddit.submission import Submission
+from praw.models.reddit.subreddit import Subreddit
+from praw.models.reddit.user_subreddit import UserSubreddit
+from praw.models.reddit.widgets import (
     Button,
     ButtonWidget,
     Calendar,
@@ -57,9 +57,9 @@
     Widget,
     WidgetModeration,
 )
-from .reddit.wikipage import WikiPage
-from .redditors import Redditors
-from .stylesheet import Stylesheet
-from .subreddits import Subreddits
-from .trophy import Trophy
-from .user import User
+from praw.models.reddit.wikipage import WikiPage
+from praw.models.redditors import Redditors
+from praw.models.stylesheet import Stylesheet
+from praw.models.subreddits import Subreddits
+from praw.models.trophy import Trophy
+from praw.models.user import User

praw/models/auth.py

@@ -4,8 +4,8 @@
 
 from prawcore import Authorizer, ImplicitAuthorizer, UntrustedAuthenticator, session
 
-from ..exceptions import InvalidImplicitAuth, MissingRequiredAttributeException
-from .base import PRAWBase
+from praw.exceptions import InvalidImplicitAuth, MissingRequiredAttributeException
+from praw.models.base import PRAWBase
 
 
 class Auth(PRAWBase):
@@ -48,7 +48,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

@@ -5,15 +5,15 @@
 from copy import deepcopy
 from typing import TYPE_CHECKING, Any
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     import praw
 
 
 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,10 +5,10 @@
 from heapq import heappop, heappush
 from typing import TYPE_CHECKING
 
-from ..exceptions import DuplicateReplaceException
-from .reddit.more import MoreComments
+from praw.exceptions import DuplicateReplaceException
+from praw.models.reddit.more import MoreComments
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     import praw.models
 
 
@@ -43,7 +43,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 +56,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 +100,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 +112,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 +179,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