Upgrade build system to flit, add new pre-commit hooks, switch to ruf…

…f for most linting checks, and lint and clean up code using ruff
praw-dev · Aug 31, 2023 · 3ed684d · 3ed684d
1 parent 09b168a
commit 3ed684d
Show file tree

Hide file tree

Showing 129 changed files with 1,629 additions and 1,749 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
@@ -1,11 +1,6 @@
+default_language_version:
+  python: python3.11
 repos:
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    hooks:
-      - id: end-of-file-fixer
-        exclude: .*\.txt
-    rev: v4.4.0
-
   - repo: local
     hooks:
       - id: static_word_checks
@@ -24,6 +19,38 @@ repos:
         pass_filenames: false
         types: [ python ]
 
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-toml
+      - 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
+    rev: v0.0.286
+    hooks:
+      - id: ruff
+        args: [ --exit-non-zero-on-fix, --fix ]
+        files: ^(praw/.*.py)$
+
   - repo: https://github.com/psf/black
     hooks:
       - id: black
@@ -34,27 +61,3 @@ repos:
       - id: docstrfmt
         require_serial: true
     rev: v1.5.1
-
-  - repo: https://github.com/pycqa/flake8
-    hooks:
-      - id: flake8
-    rev: 6.1.0
-
-  - repo: https://github.com/ikamensh/flynt/
-    hooks:
-      - id: flynt
-        args:
-          - '-ll'
-          - '1000'
-    rev: '1.0.1'
-
-  - repo: https://github.com/pycqa/isort
-    hooks:
-      - id: isort
-    rev: 5.12.0
-
-  - repo: https://github.com/pycqa/pydocstyle
-    hooks:
-      - id: pydocstyle
-        files: praw/.*
-    rev: 6.3.0
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