additional ruff rules to ensure clean project

Author: AbstractUmbra

mystbin/client.py

@@ -56,10 +56,10 @@ class Client:
     def __init__(self, *, session: ClientSession | None = None, root_url: str = "https://mystb.in") -> None:
         self.http: HTTPClient = HTTPClient(session=session, root_url=root_url)
 
-    async def __aenter__(self) -> Self:  # noqa: D105
+    async def __aenter__(self) -> Self:
         return self
 
-    async def __aexit__(  # noqa: D105
+    async def __aexit__(
         self,
         exc_cls: type[BaseException] | None,
         exc_value: BaseException | None,

mystbin/errors.py

@@ -29,6 +29,8 @@
 
 
 class APIException(Exception):
+    """Non-specific API error and http status code."""
+
     def __init__(self, *, response: ClientResponse, status_code: int) -> None:
         self.response = response
         self.status_code = status_code

mystbin/paste.py

@@ -44,7 +44,7 @@ class File:
     """Represents a single file within a mystb.in paste.
 
     Attributes
-    -----------
+    ----------
     filename: :class:`str`
         The file's name.
     content: :class:`str`
@@ -74,7 +74,7 @@ def lines_of_code(self) -> int:
         """The total lines of code this file has.
 
         Returns
-        --------
+        -------
         :class:`int`
         """
         return self._lines_of_code
@@ -84,7 +84,7 @@ def character_count(self) -> int:
         """The total character count of this file.
 
         Returns
-        --------
+        -------
         :class:`int`
         """
         return self._character_count
@@ -94,7 +94,7 @@ def annotation(self) -> str:
         """The files annotation.
 
         Returns
-        --------
+        -------
         :class:`str`
         """
         return self._annotation
@@ -104,13 +104,19 @@ def parent_id(self) -> str:
         """The files parent paste ID.
 
         Returns
-        --------
+        -------
         :class:`str`
         """
         return self._parent_id
 
     @classmethod
     def from_data(cls, payload: FileResponse, /) -> Self:
+        """Method to create a File from an api response.
+
+        Returns
+        -------
+        :class:`~mystbin.File`
+        """
         self = cls(
             content=payload["content"],
             filename=payload["filename"],
@@ -123,14 +129,20 @@ def from_data(cls, payload: FileResponse, /) -> Self:
         return self
 
     def to_dict(self) -> dict[str, Any]:
+        """Method to dump the File data to a serialized api payload.
+
+        Returns
+        -------
+        :class:`dict[:class:`str`, Any]`
+        """
         return {"content": self.content, "filename": self.filename}
 
 
 class Paste:
     """Represents a Paste object from mystbin instances.
 
     Attributes
-    -----------
+    ----------
     id: :class:`str`
         The ID of this paste.
     created_at: :class:`datetime.datetime`
@@ -171,7 +183,7 @@ def url(self) -> str:
         """The paste URL.
 
         Returns
-        --------
+        -------
         :class:`str`
         """
         return f"{self._http.root_url}{self.id}"
@@ -181,7 +193,7 @@ def expires(self) -> datetime.datetime | None:
         """When the paste expires, if at all.
 
         Returns
-        --------
+        -------
         Optional[:class:`datetime.datetime`]
         """
         return self._expires
@@ -191,7 +203,7 @@ def views(self) -> int | None:
         """The pastes view count, if any.
 
         Returns
-        --------
+        -------
         Optional[:class:`int`]
         """
         return self._views
@@ -201,13 +213,19 @@ def security_token(self) -> str | None:
         """The pastes security token, if any.
 
         Returns
-        --------
+        -------
         Optional[:class:`str`]
         """
         return self._security
 
     @classmethod
     def from_get(cls, payload: GetPasteResponse, /, *, http: HTTPClient) -> Self:
+        """Method to create a Paste from the api fetch response.
+
+        Returns
+        -------
+        :class:`~mystbin.Paste`
+        """
         files = [File.from_data(data) for data in payload["files"]]
         self = cls(
             http=http,
@@ -229,6 +247,12 @@ def from_get(cls, payload: GetPasteResponse, /, *, http: HTTPClient) -> Self:
 
     @classmethod
     def from_create(cls, payload: CreatePasteResponse, files: Sequence[File], *, http: HTTPClient) -> Self:
+        """Method to create a Paste from the api response.
+
+        Returns
+        -------
+        :class:`~mystbin.Paste`
+        """
         self = cls(
             http=http,
             paste_id=payload["id"],
@@ -253,7 +277,7 @@ async def delete(self) -> None:
         This method will delete this paste from the mystbin instance.
 
         Raises
-        -------
+        ------
         ValueError
             The paste requires the security token to be present.
         """

pyproject.toml

@@ -78,6 +78,8 @@ preview = true
 select = ["ALL"]
 ignore = [
     "ANN401",
+    "COM812",  # required for format
+    "D105",    # they don't need to be documented all the time
     "D400",
     "D401",
     "EM101",   # in this case this is okay
@@ -92,6 +94,7 @@ ignore = [
     "Q000",
     "RUF001",
     "RUF009",
+    "N818",    # seems overeager
     "S101",    # assert is used for type checking in this codebase
     "SIM105",
     "TRY003",  # over-eager rule