add ruff and apply automatic fixes

Author: Galarzaa90

pyproject.toml

@@ -142,3 +142,30 @@ rst-directives = [
 literal-inline-quotes = "double"
 type-checking-pydantic-enabled = true
 
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401", "F403"]
+"**/builders/*" = ["D101"]
+"tests/**" = ["D101"]
+
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E", "W293",
+    # Pyflakes
+    "F",
+    # pep8-naming
+    "N",
+    # pydocstyle
+    "D",
+]
+exclude = [
+    "D105"
+]
+
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120
+
+[tool.ruff.lint.pep8-naming]
+extend-ignore-names = ["assert*"]

requirements-linting.txt

@@ -19,4 +19,4 @@ flake8-simplify
 flake8-type-checking
 flake8-use-fstring
 flake8-secure-coding-standard
-
+ruff

server.py

@@ -408,8 +408,10 @@ async def get_auctions_history(
 @app.get("/auctions/{auction_id}", tags=["Char Bazaar"])
 async def get_auction(
         auction_id: int = Path(...),
-        skip_details: bool = Query(False,
-                                   description="Whether to skip the auction details and only fetch the basic information."),
+        skip_details: bool = Query(
+            False,
+            description="Whether to skip the auction details and only fetch the basic information."
+        ),
         fetch_items: bool = Query(False, description="Whether to fetch additional item pages (if available)."),
         fetch_mounts: bool = Query(False, description="Whether to fetch additional mounts pages (if available)."),
         fetch_outfits: bool = Query(False, description="Whether to fetch additional outfits pages (if available)."),

tests/tests_enums.py

@@ -1,12 +1,12 @@
+import tibiapy.enums
 from tests.tests_tibiapy import TestCommons
-from tibiapy.enums import *
 from tibiapy.models import AuctionFilters
 
 
 class TestEnums(TestCommons):
 
     def test_numeric_enum_serialization(self):
-        filters = AuctionFilters(battleye=AuctionBattlEyeFilter.INITIALLY_PROTECTED)
+        filters = AuctionFilters(battleye=tibiapy.enums.AuctionBattlEyeFilter.INITIALLY_PROTECTED)
 
         json_filters = filters.model_dump_json()
 
@@ -17,12 +17,16 @@ def test_numeric_enum_deserialization(self):
 
         filters = AuctionFilters.model_validate_json(json_filters)
 
-        self.assertEqual(filters.battleye, AuctionBattlEyeFilter.INITIALLY_PROTECTED)
+        self.assertEqual(filters.battleye, tibiapy.enums.AuctionBattlEyeFilter.INITIALLY_PROTECTED)
 
     def test_vocation_filter_from_name(self):
         """Testing getting a HighscoresProfession entry from a vocation's name"""
-        self.assertEqual(HighscoresProfession.KNIGHTS, HighscoresProfession.from_name("elite knight"))
-        self.assertEqual(HighscoresProfession.KNIGHTS, HighscoresProfession.from_name("knight"))
-        self.assertEqual(HighscoresProfession.KNIGHTS, HighscoresProfession.from_name("knights"))
-        self.assertEqual(HighscoresProfession.ALL, HighscoresProfession.from_name("anything"))
-        self.assertIsNone(HighscoresProfession.from_name("anything", all_fallback=False))
+        self.assertEqual(tibiapy.enums.HighscoresProfession.KNIGHTS,
+                         tibiapy.enums.HighscoresProfession.from_name("elite knight"))
+        self.assertEqual(tibiapy.enums.HighscoresProfession.KNIGHTS,
+                         tibiapy.enums.HighscoresProfession.from_name("knight"))
+        self.assertEqual(tibiapy.enums.HighscoresProfession.KNIGHTS,
+                         tibiapy.enums.HighscoresProfession.from_name("knights"))
+        self.assertEqual(tibiapy.enums.HighscoresProfession.ALL,
+                         tibiapy.enums.HighscoresProfession.from_name("anything"))
+        self.assertIsNone(tibiapy.enums.HighscoresProfession.from_name("anything", all_fallback=False))

tests/tests_spell.py

@@ -14,7 +14,7 @@
 
 class TestSpell(TestCommons,):
     # region Spells Section Tests
-    
+
     def test_spells_section_parser_from_content(self):
         """Testing parsing a boosted creature"""
         content = self.load_resource(FILE_SPELLS_SECTION)
@@ -40,9 +40,9 @@ def test_spells_section_parser_from_content_unrelated_section(self):
 
         with self.assertRaises(tibiapy.InvalidContent):
             SpellsSectionParser.from_content(content)
-            
+
     # endregion
-    
+
     # region Spells Tests
 
     def test_spell_parser_from_content(self):
@@ -123,7 +123,8 @@ def test_spell_parser_from_content_revelation_perk(self):
     def test_spells_from_content_unknown_spell(self):
         """Testing parsing an unknown spell
 
-        When trying to fetch a spell that doesn't exist, the website will just show the spells section."""
+        When trying to fetch a spell that doesn't exist, the website will just show the spells section.
+        """
         content = self.load_resource(FILE_SPELLS_SECTION)
         spell = SpellParser.from_content(content)
 

tibiapy/errors.py

@@ -73,7 +73,8 @@ class EnumValueError(ValueError):
     def __init__(self, enum: Type[Enum], value: Any) -> None:
         self.enum = enum
         super().__init__(
-            f"{value!r} is not a valid value for {enum.__name__}. Expected names ({self.names}) or values ({self.values})",
+            f"{value!r} is not a valid value for {enum.__name__}."
+            f"Expected names ({self.names}) or values ({self.values})",
         )
 
     @property

tibiapy/parsers/guild.py

@@ -111,11 +111,11 @@ def from_content(cls, content: str) -> Optional[Guild]:
         """Create an instance of the class from the HTML content of the guild's page.
 
         Parameters
-        -----------
+        ----------
             The HTML content of the page.
 
         Returns
-        ----------
+        -------
             The guild contained in the page or None if it doesn't exist.
 
         Raises
@@ -172,8 +172,7 @@ def _parse_current_member(cls, builder, previous_rank, values):
 
     @classmethod
     def _parse_application_info(cls, builder, info_container):
-        """
-        Parse the guild's application info.
+        """Parse the guild's application info.
 
         Parameters
         ----------
@@ -187,8 +186,7 @@ def _parse_application_info(cls, builder, info_container):
 
     @classmethod
     def _parse_guild_disband_info(cls, builder: GuildBuilder, info_container: bs4.Tag):
-        """
-        Parse the guild's disband info, if available.
+        """Parse the guild's disband info, if available.
 
         Parameters
         ----------
@@ -201,8 +199,7 @@ def _parse_guild_disband_info(cls, builder: GuildBuilder, info_container: bs4.Ta
 
     @classmethod
     def _parse_guild_guildhall(cls, builder, info_container):
-        """
-        Parse the guild's guildhall info.
+        """Parse the guild's guildhall info.
 
         Parameters
         ----------
@@ -234,8 +231,7 @@ def _parse_guild_homepage(cls, builder, info_container):
 
     @classmethod
     def _parse_guild_info(cls, builder, info_container):
-        """
-        Parse the guild's general information and applies the found values.
+        """Parse the guild's general information and applies the found values.
 
         Parameters
         ----------
@@ -271,8 +267,7 @@ def _parse_logo(cls, builder: GuildBuilder, parsed_content):
 
     @classmethod
     def _parse_guild_members(cls, builder, parsed_content):
-        """
-        Parse the guild's member and invited list.
+        """Parse the guild's member and invited list.
 
         Parameters
         ----------

tibiapy/parsers/highscores.py

@@ -99,8 +99,7 @@ def _parse_entries_table(cls, builder: HighscoresBuilder, table):
 
     @classmethod
     def _parse_filters_table(cls, builder, form):
-        """
-        Parse the filters table found in a highscores page.
+        """Parse the filters table found in a highscores page.
 
         Parameters
         ----------
@@ -118,8 +117,7 @@ def _parse_filters_table(cls, builder, form):
 
     @classmethod
     def _parse_tables(cls, parsed_content):
-        """
-        Parse the information tables found in a highscores page.
+        """Parse the information tables found in a highscores page.
 
         Parameters
         ----------

tibiapy/parsers/house.py

@@ -115,8 +115,7 @@ def _parse_filters(cls, builder: HousesSectionBuilder, form: bs4.Tag):
 
     @classmethod
     def _parse_status(cls, builder: HouseEntryBuilder, status):
-        """
-        Parse the status string found in the table and applies the corresponding values.
+        """Parse the status string found in the table and applies the corresponding values.
 
         Parameters
         ----------

tibiapy/parsers/kill_statistics.py

@@ -19,12 +19,12 @@ def from_content(cls, content: str) -> Optional[KillStatistics]:
         """Create an instance of the class from the HTML content of the kill statistics' page.
 
         Parameters
-        -----------
+        ----------
         content:
             The HTML content of the page.
 
         Returns
-        ----------
+        -------
             The kill statistics contained in the page or None if it doesn't exist.
 
         Raises