Merge pull request praw-dev#2049 from praw-dev/cleanup

Cleanup

Author: bboe

.pre-commit-config.yaml

@@ -17,6 +17,29 @@ repos:
         pass_filenames: false
         types: [ python ]
 
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    hooks:
+      - id: ruff
+        args: [ --exit-non-zero-on-fix, --fix ]
+        files: ^(praw/.*.py)$
+    rev: v0.9.4
+
+  - repo: https://github.com/LilSpazJoekp/docstrfmt
+    hooks:
+      - id: docstrfmt
+    rev: v1.9.0
+
+  - repo: https://github.com/MarcoGorelli/auto-walrus
+    hooks:
+      - id: auto-walrus
+    rev: 0.3.4
+
+  - repo: https://github.com/pappasam/toml-sort
+    hooks:
+      - id: toml-sort-fix
+        files: ^(.*\.toml)$
+    rev: v0.24.2
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
@@ -31,29 +54,7 @@ repos:
       - id: name-tests-test
         args: [ --pytest-test-first ]
         files: ^tests/integration/.*\.py|tests/unit/.*\.py$
+      - id: no-commit-to-branch
       - id: sort-simple-yaml
         files: ^(\.github/workflows/.*\.ya?ml|\.readthedocs.ya?ml)$
       - id: trailing-whitespace
-
-  - repo: https://github.com/pappasam/toml-sort
-    rev: v0.24.2
-    hooks:
-      - id: toml-sort-fix
-        files: ^(.*\.toml)$
-
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.4
-    hooks:
-      - id: ruff
-        args: [ --exit-non-zero-on-fix, --fix ]
-        files: ^(praw/.*.py)$
-
-  - repo: https://github.com/psf/black
-    hooks:
-      - id: black
-    rev: 25.1.0
-
-  - repo: https://github.com/LilSpazJoekp/docstrfmt
-    hooks:
-      - id: docstrfmt
-    rev: v1.9.0

docs/code_overview/other.rst

@@ -132,7 +132,6 @@ them bound to an attribute of one of the PRAW models.
     other/inboxablemixin
     other/listinggenerator
     other/mod_action
-    other/mod_note
     other/moderatedlist
     other/modmail
     other/modmailmessage

docs/conf.py

@@ -7,11 +7,13 @@
 
 from praw import __version__  # noqa: E402
 
+autodoc_typehints = "description"
 copyright = datetime.today().strftime("%Y, Bryce Boe")
 exclude_patterns = ["_build"]
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
+    "sphinx_autodoc_typehints",
 ]
 html_theme = "furo"
 htmlhelp_basename = "PRAW"

docs/examples/obtain_refresh_token.py

@@ -56,7 +56,7 @@ def main():
             f"State mismatch. Expected: {state} Received: {params['state']}",
         )
         return 1
-    elif "error" in params:
+    if "error" in params:
         send_message(client, params["error"])
         return 1
 

docs/examples/use_file_token_manager.py

@@ -54,14 +54,13 @@ def main():
     if scopes == {"*"}:
         print(f"{reddit.user.me()} is authenticated with all scopes")
         return None
-    elif "identity" in scopes:
+    if "identity" in scopes:
         print(
             f"{reddit.user.me()} is authenticated with the following scopes: {scopes}"
         )
         return None
-    else:
-        print(f"You are authenticated with the following scopes: {scopes}")
-        return None
+    print(f"You are authenticated with the following scopes: {scopes}")
+    return None
 
 
 if __name__ == "__main__":

docs/index.rst

@@ -62,7 +62,6 @@ application. See :ref:`oauth` for information on using **installed** application
     package_info/glossary
     package_info/praw7_migration
     package_info/references
-    package_info/sponsors
 
 .. toctree::
     :hidden:

docs/package_info/NucleiLogo.png

@@ -106,9 +106,7 @@ def _fetch(self, key: str) -> Any:
         del self.custom[key]
         return value
 
-    def _fetch_default(
-        self, key: str, *, default: bool | float | str | None = None
-    ) -> Any:
+    def _fetch_default(self, key: str, *, default: bool | float | str | None = None) -> Any:
         if key not in self.custom:
             return default
         return self._fetch(key)
@@ -125,15 +123,9 @@ def _fetch_or_not_set(self, key: str) -> Any | _NotSet:
 
     def _initialize_attributes(self):
         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(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.warn_additional_fetch_params = self._config_boolean(
             self._fetch_default("warn_additional_fetch_params", default=True)
         )

docs/package_info/sponsors.rst

@@ -43,6 +43,10 @@ def __eq__(self, other: RedditErrorItem | list[str]) -> bool:
             )
         return super().__eq__(other)
 
+    def __hash__(self) -> int:
+        """Return the hash of the current instance."""
+        return hash(self.__class__.__name__) ^ hash((self.error_type, self.message, self.field))
+
     @_deprecate_args("error_type", "message", "field")
     def __init__(
         self,
@@ -65,8 +69,7 @@ def __init__(
     def __repr__(self) -> str:
         """Return an object initialization representation of the instance."""
         return (
-            f"{self.__class__.__name__}(error_type={self.error_type!r},"
-            f" message={self.message!r}, field={self.field!r})"
+            f"{self.__class__.__name__}(error_type={self.error_type!r}, message={self.message!r}, field={self.field!r})"
         )
 
     def __str__(self) -> str:
@@ -84,8 +87,7 @@ class DuplicateReplaceException(ClientException):
     def __init__(self):
         """Initialize a :class:`.DuplicateReplaceException` instance."""
         super().__init__(
-            "A duplicate comment has been detected. Are you attempting to call"
-            " 'replace_more_comments' more than once?"
+            "A duplicate comment has been detected. Are you attempting to call 'replace_more_comments' more than once?"
         )
 
 
@@ -145,8 +147,7 @@ def __init__(self, *, actual: int, maximum_size: int):
         self.maximum_size = maximum_size
         self.actual = actual
         super().__init__(
-            f"The media that you uploaded was too large (maximum size is {maximum_size}"
-            f" bytes, uploaded {actual} bytes)"
+            f"The media that you uploaded was too large (maximum size is {maximum_size} bytes, uploaded {actual} bytes)"
         )