ruff manual fixes

Author: Galarzaa90

pyproject.toml

@@ -142,10 +142,24 @@ rst-directives = [
 literal-inline-quotes = "double"
 type-checking-pydantic-enabled = true
 
+[tool.ruff]
+exclude = [
+    "__pycache__",
+    ".git/",
+    "build/",
+    ".idea/",
+    "venv/",
+    "docs/",
+    "logs/",
+    "tests/",
+]
+
+
 [tool.ruff.per-file-ignores]
-"__init__.py" = ["F401", "F403"]
-"**/builders/*" = ["D101"]
+"__init__.py" = ["D104", "F401", "F403"]
+"**/builders/*" = ["D"]
 "tests/**" = ["D101"]
+"server.py" = ["D100", "D103"]
 
 
 [tool.ruff.lint]
@@ -159,8 +173,11 @@ select = [
     # pydocstyle
     "D",
 ]
-exclude = [
-    "D105"
+ignore = [
+    # Missing docstring in magic method
+    "D105",
+    # Missing docstring in `__init__`
+    "D107",
 ]
 
 

requirements-testing.txt

@@ -1,3 +1,4 @@
 aioresponses
 asynctest
 coverage[toml]
+packaging

tibiapy/enums.py

@@ -249,6 +249,7 @@ class BazaarType(StringEnum):
 
     @property
     def subtopic(self):
+        """The subtopic argument for this Bazaar type."""
         return "currentcharactertrades" if self == self.CURRENT else "pastcharactertrades"
 
 
@@ -388,15 +389,18 @@ class NewsCategory(StringEnum):
 
     @property
     def filter_name(self):
+        """The name of the filter parameter for this value."""
         return f"filter_{self.value}"
 
     @property
     def big_icon_url(self):
+        """The URL to the big icon representing this category."""
         from tibiapy.urls import get_static_file_url
         return get_static_file_url("images", "global", "content", f"newsicon_{self.value}_big.gif")
 
     @property
     def small_icon_url(self):
+        """The URL to the small icon representing this category."""
         from tibiapy.urls import get_static_file_url
         return get_static_file_url("images", "global", "content", f"newsicon_{self.value}_small.gif")
 
@@ -410,10 +414,12 @@ class NewsType(StringEnum):
 
     @property
     def filter_name(self):
+        """The filter parameter name for this value."""
         return f"filter_{self.value.split(' ')[-1].lower()}"
 
     @property
     def filter_value(self):
+        """The filter parameter value for this value."""
         return self.value.split(" ")[-1].lower()
 
 
@@ -552,6 +558,7 @@ class Vocation(StringEnum):
 
     @property
     def base(self):
+        """The base vocation of this vocation if promoted. If not promoted, the same value is returned."""
         if self == self.ELDER_DRUID:
             return self.DRUID
         elif self == self.MASTER_SORCERER:

tibiapy/errors.py

@@ -79,8 +79,10 @@ def __init__(self, enum: Type[Enum], value: Any) -> None:
 
     @property
     def names(self):
+        """The valid names for the enum."""
         return ", ".join(e.name for e in self.enum)
 
     @property
     def values(self):
+        """The valid values for the enum."""
         return ", ".join(str(e.value) for e in self.enum)

tibiapy/models/bazaar.py

@@ -1,3 +1,4 @@
+"""Models relatd to the character bazaar."""
 import datetime
 from abc import ABC, abstractmethod
 from typing import Optional, List, Dict, TypeVar, Generic
@@ -516,6 +517,18 @@ class CharacterBazaar(PaginatedWithUrl[Auction]):
     """The currently set filtering options."""
 
     def get_page_url(self, page) -> str:
+        """Get the URL to a given page of the bazaar.
+
+        Parameters
+        ----------
+        page: :class:`int`
+            The desired page.
+
+        Returns
+        -------
+        :class:`str`
+            The URL to the desired page.
+        """
         return get_bazaar_url(self.type, page, self.filters)
 
     @property

tibiapy/models/character.py

@@ -1,3 +1,4 @@
+"""Models related to characters."""
 from __future__ import annotations
 
 import datetime

tibiapy/models/creature.py

@@ -1,3 +1,4 @@
+"""Models for creatures."""
 from typing import List, Optional
 
 from pydantic import computed_field

tibiapy/models/event.py

@@ -1,3 +1,4 @@
+"""Models related to the event schedule calendar."""
 import datetime
 from typing import List, Optional
 

tibiapy/models/forum.py

@@ -1,3 +1,4 @@
+"""Models related to the forums."""
 import datetime
 from typing import List, Optional
 
@@ -273,6 +274,7 @@ class ForumSection(BaseModel):
 
     @property
     def url(self):
+        """The URL to this forum section."""
         return get_forum_section_url(self.section_id)
 
 

tibiapy/models/guild.py

@@ -1,3 +1,4 @@
+"""Models for guilds and members."""
 import datetime
 from collections import defaultdict
 from typing import Optional, List, Dict, OrderedDict