Merge pull request #2086 from praw-dev/clean-up

Clean up typing

Author: LilSpazJoekp

.pre-commit-config.yaml

@@ -22,17 +22,17 @@ repos:
       - id: ruff
         args: [ --exit-non-zero-on-fix, --fix ]
         files: ^(praw/.*.py)$
-    rev: v0.13.3
+    rev: v0.15.0
 
   - repo: https://github.com/LilSpazJoekp/docstrfmt
     hooks:
       - id: docstrfmt
-    rev: v1.11.1
+    rev: v2.0.2
 
   - repo: https://github.com/MarcoGorelli/auto-walrus
     hooks:
       - id: auto-walrus
-    rev: 0.3.4
+    rev: 0.4.1
 
   - repo: https://github.com/pappasam/toml-sort
     hooks:

CHANGES.rst

@@ -10,7 +10,7 @@ Unreleased
 
 - Add support for Python 3.13.
 - Add support for optional Markdown-formatted ``selftext`` when submitting link, image,
-  gallery and video posts.
+  gallery, and video posts.
 
 **Changed**
 
@@ -33,6 +33,7 @@ Unreleased
 - :meth:`.Subreddit.submit_video`, :meth:`.Subreddit.submit_gallery`, and
   :meth:`.Subreddit.submit_image` now accept an optional Markdown-formatted ``selftext``
   parameter.
+- The ``reason_id`` argument to :class:`.RemovalReason` has been renamed to ``id``.
 
 **Removed**
 

MANIFEST.in

@@ -1,7 +1,3 @@
 include CHANGES.rst LICENSE.txt README.rst
 include praw/praw.ini
 include "praw/images/PRAW logo.png"
-include docs/Makefile
-recursive-include docs *.png *.py *.rst
-recursive-include tests *.json *.py
-recursive-include tests/files *

docs/getting_started/configuration.rst

@@ -55,7 +55,6 @@ certificate without an exception from requests_, first export the certificate as
     import praw
     from requests import Session
 
-
     session = Session()
     session.verify = "/path/to/certfile.pem"
     reddit = praw.Reddit(

docs/logo/png/PRAW logo.png docs/logo/png/PRAW_logo.pngdocs/logo/png/PRAW logo.png renamed to docs/logo/png/PRAW_logo.png

@@ -14,28 +14,11 @@ Glossary
 
   Here is a list of the six different types of objects returned from Reddit:
 
-  .. _fullname_t1:
-
   - ``t1`` These objects represent :class:`.Comment`\ s.
-
-  .. _fullname_t2:
-
   - ``t2`` These objects represent :class:`.Redditor`\ s.
-
-  .. _fullname_t3:
-
   - ``t3`` These objects represent :class:`.Submission`\ s.
-
-  .. _fullname_t4:
-
   - ``t4`` These objects represent :class:`.Message`\ s.
-
-  .. _fullname_t5:
-
   - ``t5`` These objects represent :class:`.Subreddit`\ s.
-
-  .. _fullname_t6:
-
   - ``t6`` These objects represent :class:`.Trophy`\ s.
 
 .. _websocket:

docs/logo/svg/PRAW logo.svg docs/logo/svg/PRAW_logo.svgdocs/logo/svg/PRAW logo.svg renamed to docs/logo/svg/PRAW_logo.svg

@@ -3,8 +3,8 @@
 from __future__ import annotations
 
 import configparser
-import importlib.resources
 import os
+from importlib.resources import files
 from pathlib import Path
 from threading import Lock
 from types import MappingProxyType
@@ -49,7 +49,7 @@ def _load_config(cls, *, config_interpolation: str | None = None) -> None:
             interpolator_class = None
 
         config = configparser.ConfigParser(interpolation=interpolator_class)
-        with importlib.resources.files(__package__).joinpath("praw.ini").open("r") as hdl:
+        with files(__package__).joinpath("praw.ini").open("r") as hdl:
             config.read_file(hdl)
 
         if "APPDATA" in os.environ:  # Windows

docs/package_info/glossary.rst

@@ -26,7 +26,7 @@ def _safely_add_arguments(*, arguments: dict[str, Any], key: str, **new_argument
         arguments[key] = value
 
     @classmethod
-    def parse(cls, data: dict[str, Any], reddit: praw.Reddit) -> Any:
+    def parse(cls, data: dict[str, Any], reddit: praw.Reddit) -> PRAWBase:
         """Return an instance of ``cls`` from ``data``.
 
         :param data: The structured data.

praw/config.py

@@ -9,7 +9,7 @@
 from praw.models.reddit.more import MoreComments
 
 if TYPE_CHECKING:
-    import praw.models
+    from praw import models
 
 
 class CommentForest:
@@ -19,7 +19,7 @@ class CommentForest:
 
     """
 
-    def __getitem__(self, index: int) -> praw.models.Comment:
+    def __getitem__(self, index: int) -> models.Comment:
         """Return the comment at position ``index`` in the list.
 
         This method is to be used like an array access, such as:
@@ -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) -> None:
+    def _insert_comment(self, comment: models.Comment) -> None:
         if comment.name in self._submission._comments_by_id:
             raise DuplicateReplaceException
         comment.submission = self._submission
@@ -58,7 +58,7 @@ def _insert_comment(self, comment: praw.models.Comment) -> None:
 
     def list(
         self,
-    ) -> list[praw.models.Comment | praw.models.MoreComments]:
+    ) -> list[models.Comment | models.MoreComments]:
         """Return a flattened list of all comments.
 
         This list may contain :class:`.MoreComments` instances if :meth:`.replace_more`
@@ -76,9 +76,9 @@ def list(
 
     @staticmethod
     def _gather_more_comments(
-        tree: list[praw.models.MoreComments],
+        tree: list[models.MoreComments],
         *,
-        parent_tree: list[praw.models.MoreComments] | None = None,
+        parent_tree: list[models.MoreComments] | None = None,
     ) -> list[MoreComments]:
         """Return a list of :class:`.MoreComments` objects obtained from tree."""
         more_comments = []
@@ -98,8 +98,8 @@ def _gather_more_comments(
 
     def __init__(
         self,
-        submission: praw.models.Submission,
-        comments: list[praw.models.Comment] | None = None,
+        submission: models.Submission,
+        comments: list[models.Comment] | None = None,
     ) -> None:
         """Initialize a :class:`.CommentForest` instance.
 
@@ -112,12 +112,12 @@ def __init__(
         self._comments = comments
         self._submission = submission
 
-    def _update(self, comments: list[praw.models.Comment]) -> None:
+    def _update(self, comments: list[models.Comment]) -> None:
         self._comments = comments
         for comment in comments:
             comment.submission = self._submission
 
-    def replace_more(self, *, limit: int | None = 32, threshold: int = 0) -> list[praw.models.MoreComments]:
+    def replace_more(self, *, limit: int | None = 32, threshold: int = 0) -> list[models.MoreComments]:
         """Update the comment forest by resolving instances of :class:`.MoreComments`.
 
         :param limit: The maximum number of :class:`.MoreComments` instances to replace.