Merge pull request #369 from praw-dev/sort-code

Add and apply code sorting pre-commit hook

Author: LilSpazJoekp

.pre-commit-config.yaml

@@ -5,6 +5,12 @@ repos:
     repo: https://github.com/LilSpazJoekp/docstrfmt
     rev: 06455715c8a81e176748e036c1c945f3e80d5b8d  # frozen: v2.1.0
 
+  - hooks:
+      - id: codesorter
+        require_serial: true
+    repo: https://github.com/praw-dev/CodeSorter
+    rev: a8b600db67edfc9f71a13e97f67c10d72f87fec7  # frozen: unreleased
+
   - hooks:
       - id: auto-walrus
     repo: https://github.com/MarcoGorelli/auto-walrus

asyncpraw/config.py

@@ -57,39 +57,10 @@ def _config_boolean(*, item: bool | str | _NotSet) -> bool:
             return False
         return item.lower() in {"1", "yes", "true", "on"}
 
-    @classmethod
-    def _load_config(cls, *, config_interpolation: str | None = None) -> None:
-        """Attempt to load settings from various praw.ini files."""
-        if config_interpolation is not None:
-            interpolator_class = cls.INTERPOLATION_LEVEL[config_interpolation]()
-        else:
-            interpolator_class = None
-
-        config = configparser.ConfigParser(interpolation=interpolator_class)
-        assert __package__ is not None
-        with files(__package__).joinpath("praw.ini").open("r") as hdl:
-            config.read_file(hdl)
-
-        if "APPDATA" in os.environ:  # Windows
-            os_config_path = Path(os.environ["APPDATA"])
-        elif "XDG_CONFIG_HOME" in os.environ:  # Modern Linux
-            os_config_path = Path(os.environ["XDG_CONFIG_HOME"])
-        elif "HOME" in os.environ:  # Legacy Linux
-            os_config_path = Path(os.environ["HOME"]) / ".config"
-        else:
-            os_config_path = None
-
-        locations = ["praw.ini"]
-
-        if os_config_path is not None:
-            locations.insert(0, str(os_config_path / "praw.ini"))
-
-        cls._warn_on_endpoint_override(interpolator_class)
-        config.read(locations)
-        cls.CONFIG = config
-
     @staticmethod
-    def _warn_on_endpoint_override(interpolator_class: configparser.Interpolation | None) -> None:
+    def _warn_on_endpoint_override(
+        interpolator_class: configparser.Interpolation | None,
+    ) -> None:
         """Warn if a ``praw.ini`` in the current directory overrides OAuth endpoints.
 
         ``praw.ini`` is loaded from the current working directory, so a file planted
@@ -124,6 +95,37 @@ def _warn_on_endpoint_override(interpolator_class: configparser.Interpolation |
                 stacklevel=4,
             )
 
+    @classmethod
+    def _load_config(cls, *, config_interpolation: str | None = None) -> None:
+        """Attempt to load settings from various praw.ini files."""
+        if config_interpolation is not None:
+            interpolator_class = cls.INTERPOLATION_LEVEL[config_interpolation]()
+        else:
+            interpolator_class = None
+
+        config = configparser.ConfigParser(interpolation=interpolator_class)
+        assert __package__ is not None
+        with files(__package__).joinpath("praw.ini").open("r") as hdl:
+            config.read_file(hdl)
+
+        if "APPDATA" in os.environ:  # Windows
+            os_config_path = Path(os.environ["APPDATA"])
+        elif "XDG_CONFIG_HOME" in os.environ:  # Modern Linux
+            os_config_path = Path(os.environ["XDG_CONFIG_HOME"])
+        elif "HOME" in os.environ:  # Legacy Linux
+            os_config_path = Path(os.environ["HOME"]) / ".config"
+        else:
+            os_config_path = None
+
+        locations = ["praw.ini"]
+
+        if os_config_path is not None:
+            locations.insert(0, str(os_config_path / "praw.ini"))
+
+        cls._warn_on_endpoint_override(interpolator_class)
+        config.read(locations)
+        cls.CONFIG = config
+
     @property
     def short_url(self) -> str:
         """Return the short url.

asyncpraw/models/base.py

@@ -10,28 +10,6 @@
     import asyncpraw
 
 
-class DynamicAttributes:
-    """Mixin for objects whose attributes are populated from Reddit response data.
-
-    Reddit adds and removes fields without notice, so Async PRAW sets these attributes
-    dynamically rather than declaring them. Defining ``__getattr__`` (typed to return
-    ``Any``) tells type checkers that attribute access on such objects is permitted,
-    which is required for downstream projects to type check against Async PRAW's
-    ``py.typed`` marker. :class:`.RedditBase` provides equivalent behavior (with lazy
-    fetching) for the objects it backs; this mixin covers the :class:`.AsyncPRAWBase`
-    data classes that do not inherit it.
-
-    It does not change runtime behavior: accessing a genuinely missing attribute still
-    raises :py:class:`AttributeError`.
-
-    """
-
-    def __getattr__(self, attribute: str) -> Any:
-        """Raise :py:class:`AttributeError` for a missing dynamic attribute."""
-        msg = f"{self.__class__.__name__!r} object has no attribute {attribute!r}"
-        raise AttributeError(msg)
-
-
 class AsyncPRAWBase:
     """Superclass for all models in Async PRAW."""
 
@@ -81,3 +59,25 @@ def __init__(self, reddit: asyncpraw.Reddit, _data: dict[str, Any] | None) -> No
         if _data:
             for attribute, value in _data.items():
                 setattr(self, attribute, value)
+
+
+class DynamicAttributes:
+    """Mixin for objects whose attributes are populated from Reddit response data.
+
+    Reddit adds and removes fields without notice, so Async PRAW sets these attributes
+    dynamically rather than declaring them. Defining ``__getattr__`` (typed to return
+    ``Any``) tells type checkers that attribute access on such objects is permitted,
+    which is required for downstream projects to type check against Async PRAW's
+    ``py.typed`` marker. :class:`.RedditBase` provides equivalent behavior (with lazy
+    fetching) for the objects it backs; this mixin covers the :class:`.AsyncPRAWBase`
+    data classes that do not inherit it.
+
+    It does not change runtime behavior: accessing a genuinely missing attribute still
+    raises :py:class:`AttributeError`.
+
+    """
+
+    def __getattr__(self, attribute: str) -> Any:
+        """Raise :py:class:`AttributeError` for a missing dynamic attribute."""
+        msg = f"{self.__class__.__name__!r} object has no attribute {attribute!r}"
+        raise AttributeError(msg)

asyncpraw/models/list/base.py

@@ -17,13 +17,6 @@ class BaseList(AsyncPRAWBase):
 
     CHILD_ATTRIBUTE: ClassVar[str | None] = None
 
-    def _child_attribute(self) -> str:
-        """Return ``CHILD_ATTRIBUTE``, ensuring it has been set by a subclass."""
-        if self.CHILD_ATTRIBUTE is None:
-            msg = "BaseList must be extended."
-            raise NotImplementedError(msg)
-        return self.CHILD_ATTRIBUTE
-
     def __contains__(self, item: Any) -> bool:
         """Test if item exists in the list."""
         return item in getattr(self, self._child_attribute())
@@ -55,3 +48,10 @@ def __len__(self) -> int:
     def __str__(self) -> str:
         """Return a string representation of the list."""
         return str(getattr(self, self._child_attribute()))
+
+    def _child_attribute(self) -> str:
+        """Return ``CHILD_ATTRIBUTE``, ensuring it has been set by a subclass."""
+        if self.CHILD_ATTRIBUTE is None:
+            msg = "BaseList must be extended."
+            raise NotImplementedError(msg)
+        return self.CHILD_ATTRIBUTE

asyncpraw/models/listing/generator.py

@@ -14,17 +14,6 @@
     from asyncpraw.models.reddit.base import RedditBase
 
 
-class ListingGeneratorKwargs(TypedDict, total=False):
-    """The keyword arguments accepted by methods that return a :class:`.ListingGenerator`.
-
-    See :meth:`.ListingGenerator.__init__` for the meaning of each value.
-
-    """
-
-    limit: int | None
-    params: dict[str, str | int] | None
-
-
 class ListingGenerator(AsyncPRAWBase, AsyncIterator):
     """Instances of this class generate :class:`.RedditBase` instances.
 
@@ -118,3 +107,14 @@ async def _next_batch(self) -> None:
             self.params[self._listing.AFTER_PARAM] = self._listing.after
         else:
             self._exhausted = True
+
+
+class ListingGeneratorKwargs(TypedDict, total=False):
+    """The keyword arguments accepted by methods that return a :class:`.ListingGenerator`.
+
+    See :meth:`.ListingGenerator.__init__` for the meaning of each value.
+
+    """
+
+    limit: int | None
+    params: dict[str, str | int] | None

asyncpraw/models/media.py

@@ -42,6 +42,20 @@ class Media:
     LEASE_API_PATH: ClassVar[str]
     LEASE_RESPONSE_KEY: ClassVar[str] = "s3UploadLease"
 
+    @staticmethod
+    async def _raise_upload_error(response: ClientResponse, /) -> None:
+        raise ServerError(response)
+
+    @property
+    def _mime_type(self) -> str:
+        if self._mime_type_value is None:
+            mime_type, _ = guess_file_type(self.name)
+            if mime_type is None:
+                msg = f"Unable to determine the MIME type of {self.name!r}."
+                raise ClientException(msg)
+            self._mime_type_value = mime_type
+        return self._mime_type_value
+
     def __eq__(self, other: object) -> bool:
         """Return whether the other instance equals the current."""
         return type(other) is type(self) and self.name == other.name and self._fp == other._fp
@@ -77,15 +91,8 @@ def __repr__(self) -> str:
         """Return a string representation of the instance."""
         return f"<{self.__class__.__name__} name={self.name!r}>"
 
-    @property
-    def _mime_type(self) -> str:
-        if self._mime_type_value is None:
-            mime_type, _ = guess_file_type(self.name)
-            if mime_type is None:
-                msg = f"Unable to determine the MIME type of {self.name!r}."
-                raise ClientException(msg)
-            self._mime_type_value = mime_type
-        return self._mime_type_value
+    def _build_lease_data(self, **additional_data: str) -> dict[str, str]:
+        return {"filepath": self.name, "mimetype": self._mime_type, **additional_data}
 
     async def _build_payload(self) -> BytesIO:
         """Read the media content and wrap it in a named file-like object."""
@@ -98,9 +105,6 @@ async def _build_payload(self) -> BytesIO:
         payload.name = self.name
         return payload
 
-    def _build_lease_data(self, **additional_data: str) -> dict[str, str]:
-        return {"filepath": self.name, "mimetype": self._mime_type, **additional_data}
-
     async def _lease_and_post(
         self, lease_url: str, reddit: asyncpraw.Reddit, /, **additional_lease_data: str
     ) -> tuple[dict[str, Any], dict[str, str], str]:
@@ -125,10 +129,6 @@ async def _post_to_s3(self, reddit: asyncpraw.Reddit, upload_data: dict[str, str
             if not response.ok:
                 await self._raise_upload_error(response)
 
-    @staticmethod
-    async def _raise_upload_error(response: ClientResponse, /) -> None:
-        raise ServerError(response)
-
     async def _upload(self, subreddit: models.Subreddit, /, **additional_lease_data: str) -> str:
         """Upload the media to Reddit.
 
@@ -194,7 +194,12 @@ async def _raise_upload_error(response: ClientResponse, /) -> None:
         await Media._raise_upload_error(response)
 
     async def _upload(  # pyright: ignore[reportIncompatibleMethodOverride]  # post media is uploaded with a Reddit instance rather than a Subreddit
-        self, reddit: asyncpraw.Reddit, /, *, expected_mime_prefix: str | None = None, upload_type: str = "link"
+        self,
+        reddit: asyncpraw.Reddit,
+        /,
+        *,
+        expected_mime_prefix: str | None = None,
+        upload_type: str = "link",
     ) -> str:
         """Upload the media to Reddit (undocumented endpoint).
 

asyncpraw/models/reddit/announcement.py

@@ -38,16 +38,16 @@ class Announcement(FullnameMixin, RedditBase):
 
     STR_FIELD = "id"
 
-    @property
-    def _kind(self) -> str:
-        """Return the object's kind shortcode."""
-        return "ann"
-
     @staticmethod
     def _parse_iso8601(value: str) -> datetime:
         # ``datetime.fromisoformat`` only accepts the ``Z`` suffix on Python 3.11+.
         return datetime.fromisoformat(value.replace("Z", "+00:00")).astimezone()
 
+    @property
+    def _kind(self) -> str:
+        """Return the object's kind shortcode."""
+        return "ann"
+
     @property
     def read_datetime(self) -> datetime | None:
         """Return the time the announcement was read as a timezone-aware :class:`datetime.datetime`.

asyncpraw/models/reddit/collections.py

@@ -459,15 +459,6 @@ class Collection(CreatedMixin, RedditBase):
 
     _created_at_attribute = "created_at_utc"
 
-    @property
-    def updated_datetime(self) -> datetime.datetime:
-        """Return the last update time as a timezone-aware :class:`datetime.datetime`.
-
-        The returned object is localized to the system's timezone.
-
-        """
-        return self._to_local_datetime(self.last_update_utc)
-
     @cachedproperty
     def mod(self) -> CollectionModeration:
         """Get an instance of :class:`.CollectionModeration`.
@@ -489,6 +480,15 @@ def mod(self) -> CollectionModeration:
         """
         return CollectionModeration(self._reddit, self.collection_id)
 
+    @property
+    def updated_datetime(self) -> datetime.datetime:
+        """Return the last update time as a timezone-aware :class:`datetime.datetime`.
+
+        The returned object is localized to the system's timezone.
+
+        """
+        return self._to_local_datetime(self.last_update_utc)
+
     def __init__(
         self,
         reddit: asyncpraw.Reddit,