Merge pull request #276 from praw-dev/update/pre-commit-hooks

Update pre-commit hooks

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
         types: [ python ]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-added-large-files
       - id: check-executables-have-shebangs
@@ -42,7 +42,7 @@ repos:
         files: ^(.*\.toml)$
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.14
+    rev: v0.3.5
     hooks:
       - id: ruff
         args: [ --exit-non-zero-on-fix, --fix ]
@@ -51,7 +51,7 @@ repos:
   - repo: https://github.com/psf/black
     hooks:
       - id: black
-    rev: 24.1.1
+    rev: 24.3.0
 
   - repo: https://github.com/LilSpazJoekp/docstrfmt
     hooks:

asyncpraw/models/reddit/base.py

@@ -35,8 +35,10 @@ def __eq__(self, other: Any | str) -> bool:
     def __getattr__(self, attribute: str) -> Any:
         """Return the value of ``attribute``."""
         if not attribute.startswith("_") and not self._fetched:
-            msg = "{0!r} object has no attribute {1!r}. {0!r} object has not been fetched, did you forget to execute '.load()'?".format(
-                self.__class__.__name__, attribute
+            msg = (
+                f"{self.__class__.__name__!r} object has no attribute {attribute!r}."
+                f" {self.__class__.__name__!r} object has not been fetched, did you"
+                " forget to execute '.load()'?"
             )
             raise AttributeError(msg)
         msg = f"{self.__class__.__name__!r} object has no attribute {attribute!r}"

asyncpraw/models/reddit/collections.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Generator
+from typing import TYPE_CHECKING, Any, Iterator
 
 from ...const import API_PATH
 from ...exceptions import ClientException
@@ -516,7 +516,7 @@ def __init__(
             "include_links": True,
         }
 
-    def __iter__(self) -> Generator[Any, None, None]:
+    def __iter__(self) -> Iterator[Any, None, None]:
         """Provide a way to iterate over the posts in this :class:`.Collection`.
 
         Example usage:

asyncpraw/models/reddit/emoji.py

@@ -221,7 +221,8 @@ async def add(
         upload_data = {item["name"]: item["value"] for item in upload_lease["fields"]}
         upload_url = f"https:{upload_lease['action']}"
 
-        with file.open("rb") as image:
+        # TODO(@LilSpazJoekp): This is a blocking operation. It should be made async.
+        with file.open("rb") as image:  # noqa: ASYNC101
             upload_data["file"] = image
             response = await self._reddit._core._requestor._http.post(
                 upload_url, data=upload_data

asyncpraw/models/reddit/subreddit.py

@@ -1814,7 +1814,8 @@ async def _upload_image(
         self, *, data: dict[str, str | Any], image_path: str
     ) -> dict[str, Any]:
         file = Path(image_path)
-        with file.open("rb") as image:
+        # TODO(@LilSpazJoekp): This is a blocking operation. It should be made async.
+        with file.open("rb") as image:  # noqa: ASYNC101
             header = image.read(len(JPEG_HEADER))
             image.seek(0)
             data["img_type"] = "jpg" if header == JPEG_HEADER else "png"
@@ -1845,7 +1846,8 @@ async def _upload_style_asset(self, *, image_path: str, image_type: str) -> str:
         upload_data = {item["name"]: item["value"] for item in upload_lease["fields"]}
         upload_url = f"https:{upload_lease['action']}"
 
-        with file.open("rb") as image:
+        # TODO(@LilSpazJoekp): This is a blocking operation. It should be made async.
+        with file.open("rb") as image:  # noqa: ASYNC101
             upload_data["file"] = image
             response = await self.subreddit._reddit._core._requestor._http.post(
                 upload_url, data=upload_data

asyncpraw/models/reddit/widgets.py

@@ -1899,7 +1899,8 @@ async def upload_image(self, file_path: str) -> str:
         upload_data = {item["name"]: item["value"] for item in upload_lease["fields"]}
         upload_url = f"https:{upload_lease['action']}"
 
-        with file.open("rb") as image:
+        # TODO(@LilSpazJoekp): This is a blocking operation. It should be made async.
+        with file.open("rb") as image:  # noqa: ASYNC101
             upload_data["file"] = image
             response = await self._reddit._core._requestor._http.post(
                 upload_url, data=upload_data

pyproject.toml

@@ -89,6 +89,8 @@ target-version = "py38"
 include = [
   "asyncpraw/**/*.py"
 ]
+
+[tool.ruff.lint]
 ignore = [
   "A002", # shadowing built-in
   "ANN101", # missing type annotation for self in method
@@ -101,7 +103,9 @@ ignore = [
   "N818", # exception name should be named with an Error suffix
   "PLR0913", # too many arguments
   "PLR2004", # Magic value used in comparison,
-  "S101" # use of assert
+  "S101", # use of assert
+  "TD003", # Missing issue link on the line following this TODO
+  "FIX002" # Line contains TODO
 ]
 select = [
   "A", # flake8-builtins
@@ -146,12 +150,12 @@ select = [
 ]
 ignore-init-module-imports = true
 
-[tool.ruff.flake8-annotations]
+[tool.ruff.lint.flake8-annotations]
 allow-star-arg-any = true
 mypy-init-return = true
 suppress-dummy-args = true
 suppress-none-returning = true
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
 "asyncpraw/models/mod_notes.py" = ["FA100"]