Add new pre-commit hooks, switch to ruff for most linting checks, lin…

…t and clean up code using ruff
praw-dev · Aug 28, 2023 · 92fc197 · 92fc197
1 parent 7d0612c
commit 92fc197
Show file tree

Hide file tree

Showing 135 changed files with 1,504 additions and 1,726 deletions.
diff --git a/.flake8 b/.flake8
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -28,7 +28,7 @@ body:
   - id: credential-check
     attributes:
       label: |
-        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`.
       options:
         - label: "Yes"

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,4 +6,4 @@ This pull request provides ...
 
 ## References
 
-- 
+-
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,27 +23,32 @@ repos:
     rev: v4.4.0
     hooks:
       - id: check-added-large-files
-        args: [ --maxkb=64 ]
       - id: check-executables-have-shebangs
       - id: check-shebang-scripts-are-executable
-      - id: check-symlinks
       - id: check-toml
-      - id: check-vcs-permalinks
       - id: check-yaml
       - id: end-of-file-fixer
       - id: mixed-line-ending
-        args: [ --fix=no ]
       - 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.23.1
+    hooks:
+      - id: toml-sort-fix
+        files: ^(.*\.toml)$
+
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
     rev: v0.0.286
     hooks:
       - id: ruff
-        args: [ --fix, --exit-non-zero-on-fix ]
+        args: [ --exit-non-zero-on-fix, --fix ]
+        files: ^(praw/.*.py)$
 
   - repo: https://github.com/psf/black
     hooks:

diff --git a/.pylintrc b/.pylintrc
diff --git a/SECURITY.md b/SECURITY.md
@@ -2,7 +2,7 @@
 
 ## Supported Versions
 
-The supported versions of PRAW include the previous major release. 
+The supported versions of PRAW include the previous major release.
 This means that if PRAW is on 6.5.0, PRAW versions 5.0.0 and greater are supported.
 
 ## Reporting a Vulnerability

diff --git a/docs/code_overview/models/awards.txt b/docs/code_overview/models/awards.txt
@@ -162,4 +162,4 @@ Ternion All-Powerful        .. image:: https://www.redditstatic.com/gold/awards/
                                                                                                                                                                                                                                                                 heart, mind, and soul. Some might call it
                                                                                                                                                                                                                                                                 unachievanium. Gives 5,000 Reddit Coins and six
                                                                                                                                                                                                                                                                 months of r/lounge access and ad-free browsing.
-==========================  ======================================================================================================================================================================================  ==========================================  ==================================================  ======
+==========================  ======================================================================================================================================================================================  ==========================================  ==================================================  ======
diff --git a/docs/code_overview/other.rst b/docs/code_overview/other.rst
@@ -148,6 +148,7 @@ them bound to an attribute of one of the PRAW models.
     other/rule
     other/stylesheet
     other/sublisting
+    other/subredditlistingmixin
     other/subredditmessage
     other/token_manager
     other/trophy

diff --git a/docs/code_overview/other/button.rst b/docs/code_overview/other/button.rst
diff --git a/docs/code_overview/other/buttonwidget.rst b/docs/code_overview/other/buttonwidget.rst
diff --git a/docs/code_overview/other/calendar.rst b/docs/code_overview/other/calendar.rst
diff --git a/docs/code_overview/other/communitylist.rst b/docs/code_overview/other/communitylist.rst
diff --git a/docs/code_overview/other/customwidget.rst b/docs/code_overview/other/customwidget.rst
diff --git a/docs/code_overview/other/draftlist.rst b/docs/code_overview/other/draftlist.rst
diff --git a/docs/code_overview/other/idcard.rst b/docs/code_overview/other/idcard.rst
diff --git a/docs/code_overview/other/image.rst b/docs/code_overview/other/image.rst
diff --git a/docs/code_overview/other/imagedata.rst b/docs/code_overview/other/imagedata.rst
diff --git a/docs/code_overview/other/imagewidget.rst b/docs/code_overview/other/imagewidget.rst
diff --git a/docs/code_overview/other/menu.rst b/docs/code_overview/other/menu.rst
diff --git a/docs/code_overview/other/menulink.rst b/docs/code_overview/other/menulink.rst
diff --git a/docs/code_overview/other/mod_action.rst b/docs/code_overview/other/mod_action.rst
diff --git a/docs/code_overview/other/moderatorswidget.rst b/docs/code_overview/other/moderatorswidget.rst
diff --git a/docs/code_overview/other/postflairwidget.rst b/docs/code_overview/other/postflairwidget.rst
diff --git a/docs/code_overview/other/prawbase.rst b/docs/code_overview/other/prawbase.rst
diff --git a/docs/code_overview/other/ruleswidget.rst b/docs/code_overview/other/ruleswidget.rst
diff --git a/docs/code_overview/other/submenu.rst b/docs/code_overview/other/submenu.rst
diff --git a/docs/code_overview/other/subredditlistingmixin.rst b/docs/code_overview/other/subredditlistingmixin.rst
@@ -0,0 +1,5 @@
+SubredditListingMixin
+=====================
+
+.. autoclass:: praw.models.listing.mixins.subreddit.SubredditListingMixin
+    :inherited-members:
diff --git a/docs/code_overview/other/subredditwidgets.rst b/docs/code_overview/other/subredditwidgets.rst
diff --git a/docs/code_overview/other/textarea.rst b/docs/code_overview/other/textarea.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,6 +20,7 @@
 nitpick_ignore = [
     ("py:class", "IO"),
     ("py:class", "prawcore.requestor.Requestor"),
+    ("py:class", "prawcore.auth.BaseAuthorizer"),
     ("py:class", "praw.models.redditors.PartialRedditor"),
 ]
 nitpicky = True

diff --git a/docs/examples/obtain_refresh_token.py b/docs/examples/obtain_refresh_token.py
@@ -48,9 +48,7 @@ def main():
     client = receive_connection()
     data = client.recv(1024).decode("utf-8")
     param_tokens = data.split(" ", 2)[1].split("?", 1)[1].split("&")
-    params = {
-        key: value for (key, value) in [token.split("=") for token in param_tokens]
-    }
+    params = dict([token.split("=") for token in param_tokens])
 
     if state != params["state"]:
         send_message(
@@ -85,7 +83,7 @@ def receive_connection():
 def send_message(client, message):
     """Send message to client and close the connection."""
     print(message)
-    client.send(f"HTTP/1.1 200 OK\r\n\r\n{message}".encode("utf-8"))
+    client.send(f"HTTP/1.1 200 OK\r\n\r\n{message}".encode())
     client.close()
 
 

diff --git a/docs/examples/use_file_token_manager.py b/docs/examples/use_file_token_manager.py
@@ -53,12 +53,15 @@ def main():
     scopes = reddit.auth.scopes()
     if scopes == {"*"}:
         print(f"{reddit.user.me()} is authenticated with all scopes")
+        return None
     elif "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
 
 
 if __name__ == "__main__":

diff --git a/docs/getting_started/authentication_flow_table.txt b/docs/getting_started/authentication_flow_table.txt
@@ -10,4 +10,4 @@
 |Alternative Flows|:ref:`application_only_client_credentials_flow`|                                               |                               |
 +                 +-----------------------------------------------+-----------------------------------------------+-------------------------------+
 |                 |                                         :ref:`application_only_installed_client_flow`                                         |
-+-----------------+-------------------------------------------------------------------------------------------------------------------------------+
++-----------------+-------------------------------------------------------------------------------------------------------------------------------+
diff --git a/praw/__init__.py b/praw/__init__.py
@@ -9,5 +9,5 @@
 
 """
 
-from .const import __version__  # NOQA
-from .reddit import Reddit  # NOQA
+from .const import __version__
+from .reddit import Reddit