tibiawikisql 8.0.1__tar.gz → 8.2.0__tar.gz

{tibiawikisql-8.0.1/tibiawikisql.egg-info → tibiawikisql-8.2.0}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: tibiawikisql
-Version: 8.0.1
+Version: 8.2.0
 Summary: Python script that generates a SQLite database from TibiaWiki articles
 Author-email: Allan Galarza <contact@galarzaa.com>
 Maintainer-email: Allan Galarza <contact@galarzaa.com>
 License: Apache 2.0
-Project-URL: Homepage, https://tibiawiki-sql.readthedocs.io/
-Project-URL: Documentation, https://tibiawiki-sql.readthedocs.io/
+Project-URL: Homepage, https://galarzaa90.github.io/tibiawiki-sql/
+Project-URL: Documentation, https://galarzaa90.github.io/tibiawiki-sql/
 Project-URL: Repository, https://github.com/Galarzaa90/tibiawiki-sql
-Project-URL: Changelog, https://tibiawiki-sql.readthedocs.io/en/stable/changelog/
+Project-URL: Changelog, https://galarzaa90.github.io/tibiawiki-sql/changelog/
 Project-URL: Docker Hub: Repo, https://hub.docker.com/repository/docker/galarzaa90/tibiawiki-sql
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -42,9 +42,8 @@ Requires-Dist: griffe-inherited-docstrings; extra == "docs"
 Requires-Dist: docstring-inheritance; extra == "docs"
 Requires-Dist: griffe-pydantic; extra == "docs"
 Requires-Dist: griffe-generics; extra == "docs"
-Requires-Dist: mkdocs-material; extra == "docs"
-Requires-Dist: mkdocstrings[python]; extra == "docs"
-Requires-Dist: ruff; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: zensical; extra == "docs"
 Provides-Extra: testing
 Requires-Dist: coverage; extra == "testing"
 Requires-Dist: ruff; extra == "testing"

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/pyproject.toml

@@ -42,10 +42,10 @@ classifiers = [
 ]
 
 [project.urls]
-"Homepage" = "https://tibiawiki-sql.readthedocs.io/"
-"Documentation" = "https://tibiawiki-sql.readthedocs.io/"
+"Homepage" = "https://galarzaa90.github.io/tibiawiki-sql/"
+"Documentation" = "https://galarzaa90.github.io/tibiawiki-sql/"
 "Repository" = "https://github.com/Galarzaa90/tibiawiki-sql"
-"Changelog" = "https://tibiawiki-sql.readthedocs.io/en/stable/changelog/"
+"Changelog" = "https://galarzaa90.github.io/tibiawiki-sql/changelog/"
 "Docker Hub: Repo" = "https://hub.docker.com/repository/docker/galarzaa90/tibiawiki-sql"
 
 [project.scripts]

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/requirements-docs.txt

@@ -2,6 +2,5 @@ griffe-inherited-docstrings
 docstring-inheritance
 griffe-pydantic
 griffe-generics
-mkdocs-material
-mkdocstrings[python]
-ruff
+mkdocstrings-python
+zensical

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tests/test_generation.py

@@ -8,9 +8,10 @@ from click.testing import CliRunner
 from tests import load_resource
 from tibiawikisql import __main__ as cli_module
 from tibiawikisql import generation as generation_module
-from tibiawikisql.api import Article
+from tibiawikisql.api import Article, WikiEntry
 from tibiawikisql.generation import WEAPON_PROFICIENCY_NAME_ARTICLE, WEAPON_PROFICIENCY_TABLES_ARTICLE
 from tibiawikisql.schema import ItemProficiencyPerkTable, ItemTable
+from tibiawikisql.tasks import images as image_tasks
 from tibiawikisql.tasks.item_proficiency_perks import generate_item_proficiency_perks
 from tibiawikisql.tasks.loot_statistics import generate_loot_statistics
 
@@ -197,6 +198,35 @@ class TestGeneration(unittest.TestCase):
         ).fetchall()
         self.assertEqual([(3, 1, "Club Skill Bonus", None, "+1 Club Fighting")], [tuple(row) for row in rows])
 
+    def test_save_images_includes_additional_titles(self):
+        wiki_client = Mock()
+        wiki_client.get_images_info.return_value = []
+        with (
+            patch("tibiawikisql.tasks.images.os.makedirs"),
+            patch("tibiawikisql.tasks.images.get_cache_info", return_value={}),
+            patch("tibiawikisql.tasks.images.save_cache_info"),
+        ):
+            image_tasks.save_images(
+                self.conn,
+                "items",
+                generation_module.CATEGORIES["items"],
+                additional_titles=["Old Axe"],
+                wiki_client=wiki_client,
+                progress_bar=generation_module.progress_bar,
+                img_label=generation_module.img_label,
+                timed=generation_module.timed,
+                echo=Mock(),
+            )
+
+        wiki_client.get_images_info.assert_called_once_with(["Amber Axe.gif", "Amber Cudgel.gif", "Old Axe.gif"])
+
+    def test_additional_outfit_titles_have_no_database_id(self):
+        rows = image_tasks.add_additional_outfit_names([(1, "Barbarian")], ["Demon Outfits"])
+        titles, image_info = image_tasks.generate_outfit_image_names(rows)
+
+        self.assertIn("Outfit Demon Male.gif", titles)
+        self.assertIsNone(image_info["Outfit Demon Male.gif"][0])
+
 
 class TestGenerationOrchestration(unittest.TestCase):
     def setUp(self):
@@ -252,6 +282,45 @@ class TestGenerationOrchestration(unittest.TestCase):
         messages = " ".join(call.args[0] for call in mock_echo.call_args_list if call.args)
         self.assertIn("Skipping task 'needs_items'", messages)
 
+    def test_deprecated_titles_are_retained_for_images_only(self):
+        timestamp = datetime.datetime.fromisoformat("2024-01-01T00:00:00+00:00")
+        active = WikiEntry(article_id=1, title="Amber Axe", timestamp=timestamp)
+        deprecated = WikiEntry(article_id=2, title="Old Axe", timestamp=timestamp)
+        captured_data_store = {}
+
+        def fetch_entries(category: str, _exclude_titles: set[str] | None = None) -> list[WikiEntry]:
+            if category == "Deprecated":
+                return [deprecated]
+            return [active, deprecated]
+
+        post_tasks = (
+            generation_module.PostTask(
+                "capture",
+                lambda _conn, data_store, _enabled: captured_data_store.update(data_store),
+            ),
+        )
+        with (
+            patch.dict(
+                generation_module.CATEGORIES,
+                {"items": generation_module.CATEGORIES["items"]},
+                clear=True,
+            ),
+            patch(
+                "tibiawikisql.generation.fetch_category_entries",
+                side_effect=fetch_entries,
+            ),
+            patch.object(generation_module.wiki_client, "get_articles", return_value=[]),
+            patch("tibiawikisql.generation.POST_TASKS", post_tasks),
+        ):
+            generation_module.generate(
+                self.conn,
+                skip_deprecated=True,
+                include_deprecated_images=True,
+            )
+
+        self.assertEqual([active], captured_data_store["items"])
+        self.assertEqual({"items": ["Old Axe"]}, captured_data_store["deprecated_image_titles"])
+
     def test_generate_loot_statistics_early_return_without_maps(self):
         wiki_client = Mock()
         generate_loot_statistics(
@@ -299,3 +368,30 @@ class TestGenerateCommand(unittest.TestCase):
         self.assertNotEqual(0, result.exit_code)
         self.assertIn("Invalid value", result.output)
         self.assertIn("--skip-category", result.output)
+
+    def test_include_deprecated_images_option_is_passed_to_generate(self):
+        with patch("tibiawikisql.__main__.generation.generate") as mock_generate:
+            result = self.runner.invoke(
+                cli_module.cli,
+                [
+                    "generate",
+                    "--db-name",
+                    ":memory:",
+                    "--skip-deprecated",
+                    "--include-deprecated-images",
+                ],
+            )
+
+        self.assertEqual(0, result.exit_code, result.output)
+        self.assertTrue(mock_generate.call_args.kwargs["skip_deprecated"])
+        self.assertTrue(mock_generate.call_args.kwargs["include_deprecated_images"])
+
+    def test_include_deprecated_images_short_option_is_passed_to_generate(self):
+        with patch("tibiawikisql.__main__.generation.generate") as mock_generate:
+            result = self.runner.invoke(
+                cli_module.cli,
+                ["generate", "--db-name", ":memory:", "-d", "-I"],
+            )
+
+        self.assertEqual(0, result.exit_code, result.output)
+        self.assertTrue(mock_generate.call_args.kwargs["include_deprecated_images"])

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tests/tests_models.py

@@ -241,12 +241,14 @@ class TestModels(unittest.TestCase):
                           content=load_resource("content_spell.txt"))
         spell = models.Spell.from_article(article)
         self.assertIsInstance(spell, models.Spell)
+        self.assertEqual(spell.base_power, 45)
 
         spell.insert(self.conn)
         db_spell = models.Spell.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_spell, models.Spell)
         self.assertEqual(db_spell.name, spell.name)
+        self.assertEqual(db_spell.base_power, spell.base_power)
 
     def test_world(self):
         article = Article(1, "Mortera", timestamp="2018-08-20T04:33:15Z",

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tests/tests_parsers.py

@@ -3,8 +3,8 @@ import unittest
 
 from tests import load_resource
 from tibiawikisql.api import Article
-from tibiawikisql.models import Achievement
-from tibiawikisql.parsers import AchievementParser
+from tibiawikisql.models import Achievement, Spell
+from tibiawikisql.parsers import AchievementParser, SpellParser
 
 
 class TestParsers(unittest.TestCase):
@@ -20,4 +20,17 @@ class TestParsers(unittest.TestCase):
 
         self.assertIsInstance(achievement, Achievement)
 
+    def test_spell_parser_success(self):
+        article = Article(
+            article_id=1,
+            title="Flame Strike",
+            timestamp=datetime.datetime.fromisoformat("2018-08-20T04:33:15+00:00"),
+            content=load_resource("content_spell.txt"),
+        )
+
+        spell = SpellParser.from_article(article)
+
+        self.assertIsInstance(spell, Spell)
+        self.assertEqual(spell.base_power, 45)
+
 

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/__init__.py

@@ -1,7 +1,7 @@
 """API that reads and parses information from `TibiaWiki <https://tibiawiki.fandom.com>`_."""
 
 __author__ = "Allan Galarza"
-__copyright__ = "Copyright 2025 Allan Galarza"
+__copyright__ = "Copyright 2026 Allan Galarza"
 
 __license__ = "Apache 2.0"
-__version__ = "8.0.1"
+__version__ = "8.2.0"

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/__main__.py

@@ -24,6 +24,12 @@ def cli() -> None:
 @click.option("-i", "--skip-images", help="Skip fetching and loading images to the database.", is_flag=True)
 @click.option("-o", "--db-name", help="Name for the database file.", default=DATABASE_FILE)
 @click.option("-d", "--skip-deprecated", help="Skips fetching deprecated articles and their images.", is_flag=True)
+@click.option(
+    "-I",
+    "--include-deprecated-images",
+    help="Fetch and save images for articles skipped by --skip-deprecated.",
+    is_flag=True,
+)
 @click.option(
     "--log-parsing-errors",
     help=f"Write every parsing error to {PARSING_ERRORS_FILE}.",
@@ -43,6 +49,7 @@ def generate(
     skip_images: bool,
     db_name: str,
     skip_deprecated: bool,
+    include_deprecated_images: bool,
     log_parsing_errors: bool,
     skip_categories: tuple[str, ...],
 ) -> None:
@@ -52,6 +59,7 @@ def generate(
             conn,
             skip_images=skip_images,
             skip_deprecated=skip_deprecated,
+            include_deprecated_images=include_deprecated_images,
             skip_categories=skip_categories,
             parsing_errors_file=PARSING_ERRORS_FILE if log_parsing_errors else None,
         )

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/generation.py

@@ -208,6 +208,7 @@ def _run_images(conn: sqlite3.Connection, _data_store: dict[str, Any], enabled_c
         conn,
         categories=CATEGORIES,
         enabled_categories=enabled_categories,
+        additional_titles=_data_store.get("deprecated_image_titles", {}),
         wiki_client=wiki_client,
         progress_bar=progress_bar,
         img_label=img_label,
@@ -341,6 +342,7 @@ def generate(
     conn: sqlite3.Connection,
     skip_images: bool = False,
     skip_deprecated: bool = False,
+    include_deprecated_images: bool = False,
     skip_categories: tuple[str, ...] = (),
     parsing_errors_file: str | None = None,
 ) -> None:
@@ -365,11 +367,23 @@ def generate(
     else:
         deprecated = set()
 
+    deprecated_image_titles: dict[str, list[str]] = {}
+
     for key, category in CATEGORIES.items():
         if key not in enabled_categories:
             continue
-        excluded_titles = deprecated if not category.include_deprecated else None
-        data_store[key] = fetch_category_entries(category.name, excluded_titles)
+        excludes_deprecated = skip_deprecated and not category.include_deprecated
+        category_has_images = not category.no_images or key == "outfits"
+        if include_deprecated_images and not skip_images and excludes_deprecated and category_has_images:
+            entries = fetch_category_entries(category.name)
+            data_store[key] = [entry for entry in entries if entry.title not in deprecated]
+            deprecated_image_titles[key] = [entry.title for entry in entries if entry.title in deprecated]
+        else:
+            excluded_titles = deprecated if excludes_deprecated else None
+            data_store[key] = fetch_category_entries(category.name, excluded_titles)
+
+    if deprecated_image_titles:
+        data_store["deprecated_image_titles"] = deprecated_image_titles
 
     parsing_errors_path = Path(parsing_errors_file) if parsing_errors_file else None
     if parsing_errors_path:

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/models/spell.py

@@ -24,6 +24,8 @@ class Spell(WikiEntry, WithVersion, WithStatus, WithImage, RowModel, table=Spell
     """The group of the rune created by this spell."""
     element: str | None = Field(None)
     """The element of the damage made by the spell."""
+    base_power: int | None = Field(None)
+    """The spell's base power, used to determine its damage or healing."""
     mana: int
     """The mana cost of the spell."""
     soul: int

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/parsers/spell.py

@@ -23,6 +23,7 @@ class SpellParser(BaseParser):
         "group_secondary": AttributeParser.optional("secondarygroup"),
         "group_rune": AttributeParser.optional("runegroup"),
         "element": AttributeParser.optional("damagetype"),
+        "base_power": AttributeParser.optional("basepower", parse_integer),
         "mana": AttributeParser.optional("mana", parse_integer),
         "soul": AttributeParser.optional("soul", parse_integer, 0),
         "cooldown": AttributeParser.required("cooldown"),

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/schema.py

@@ -340,6 +340,7 @@ class SpellTable(Table):
     group_secondary = Column(Text, index=True)
     group_rune = Column(Text, index=True)
     element = Column(Text, index=True)
+    base_power = Column(Integer, nullable=True)
     level = Column(Integer)
     mana = Column(Integer)
     soul = Column(Integer, default=0)

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql/tasks/images.py

@@ -57,6 +57,7 @@ def save_images(
     key: str,
     category: Any,
     *,
+    additional_titles: list[str] | None = None,
     wiki_client: Any,
     progress_bar: Any,
     img_label: Any,
@@ -69,7 +70,9 @@ def save_images(
     category_table = Table(table)
     select_query = Query.from_(category_table).select(category_table.title)
     results = conn.execute(select_query.get_sql())
-    titles = [f"{row[0]}{extension}" for row in results]
+    article_titles = [row[0] for row in results]
+    article_titles.extend(additional_titles or ())
+    titles = [f"{title}{extension}" for title in dict.fromkeys(article_titles)]
     os.makedirs(f"images/{table}", exist_ok=True)
     cache_info = get_cache_info(table)
     cache_count = 0
@@ -143,21 +146,42 @@ def save_maps(conn: sqlite3.Connection | sqlite3.Cursor) -> None:
         conn.execute(insert_query.get_sql(), (z, image))
 
 
-def generate_outfit_image_names(rows: list[tuple[int, str]]) -> tuple[list[str], dict[str, tuple[int, int, str]]]:
+def generate_outfit_image_names(
+    rows: list[tuple[int | None, str]],
+) -> tuple[list[str], dict[str, tuple[int | None, int, str]]]:
     """Generate outfit image file names and tuple metadata."""
     titles = []
-    image_info: dict[str, tuple[int, int, str]] = {}
+    image_info: dict[str, tuple[int | None, int, str]] = {}
     for article_id, name in rows:
         for i, template in enumerate(OUTFIT_NAME_TEMPLATES):
             file_name = template % name
-            image_info[file_name] = (article_id, OUTFIT_ADDON_SEQUENCE[i], OUTFIT_SEX_SEQUENCE[i])
+            image_info[file_name] = (
+                article_id,
+                OUTFIT_ADDON_SEQUENCE[i],
+                OUTFIT_SEX_SEQUENCE[i],
+            )
             titles.append(file_name)
     return titles, image_info
 
 
+def add_additional_outfit_names(
+    rows: list[tuple[int, str]],
+    additional_titles: list[str] | None,
+) -> list[tuple[int | None, str]]:
+    """Add outfit names derived from article titles without database IDs."""
+    expanded_rows: list[tuple[int | None, str]] = list(rows)
+    existing_names = {row[1] for row in rows}
+    for title in additional_titles or ():
+        name = title.removesuffix(" Outfits")
+        if name not in existing_names:
+            expanded_rows.append((None, name))
+    return expanded_rows
+
+
 def save_outfit_images(
     conn: sqlite3.Connection | sqlite3.Cursor,
     *,
+    additional_titles: list[str] | None = None,
     wiki_client: Any,
     progress_bar: Any,
     img_label: Any,
@@ -184,6 +208,7 @@ def save_outfit_images(
         results = conn.execute(query.get_sql())
     except sqlite3.Error:
         results = []
+    results = add_additional_outfit_names(list(results), additional_titles)
     if not results:
         return
 
@@ -219,7 +244,8 @@ def save_outfit_images(
                 failed.append(image.file_name)
                 continue
             article_id, addons, sex = image_info[image.file_name]
-            conn.execute(insert_query.get_sql(), (article_id, addons, sex, image_bytes))
+            if article_id is not None:
+                conn.execute(insert_query.get_sql(), (article_id, addons, sex, image_bytes))
         save_cache_info(table, cache_info)
     if failed:
         echo(f"{Style.RESET_ALL}\tCould not fetch {len(failed):,} images.{Style.RESET_ALL}")
@@ -235,6 +261,7 @@ def fetch_images(
     *,
     categories: dict[str, Any],
     enabled_categories: set[str],
+    additional_titles: dict[str, list[str]] | None = None,
     wiki_client: Any,
     progress_bar: Any,
     img_label: Any,
@@ -242,6 +269,7 @@ def fetch_images(
     echo: Any,
 ) -> None:
     """Fetch all images for enabled categories and always load map floors."""
+    additional_titles = additional_titles or {}
     with conn:
         for key, category in categories.items():
             if key not in enabled_categories or category.no_images:
@@ -250,6 +278,7 @@ def fetch_images(
                 conn,
                 key,
                 category,
+                additional_titles=additional_titles.get(key),
                 wiki_client=wiki_client,
                 progress_bar=progress_bar,
                 img_label=img_label,
@@ -259,6 +288,7 @@ def fetch_images(
         if "outfits" in enabled_categories:
             save_outfit_images(
                 conn,
+                additional_titles=additional_titles.get("outfits"),
                 wiki_client=wiki_client,
                 progress_bar=progress_bar,
                 img_label=img_label,

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0/tibiawikisql.egg-info}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: tibiawikisql
-Version: 8.0.1
+Version: 8.2.0
 Summary: Python script that generates a SQLite database from TibiaWiki articles
 Author-email: Allan Galarza <contact@galarzaa.com>
 Maintainer-email: Allan Galarza <contact@galarzaa.com>
 License: Apache 2.0
-Project-URL: Homepage, https://tibiawiki-sql.readthedocs.io/
-Project-URL: Documentation, https://tibiawiki-sql.readthedocs.io/
+Project-URL: Homepage, https://galarzaa90.github.io/tibiawiki-sql/
+Project-URL: Documentation, https://galarzaa90.github.io/tibiawiki-sql/
 Project-URL: Repository, https://github.com/Galarzaa90/tibiawiki-sql
-Project-URL: Changelog, https://tibiawiki-sql.readthedocs.io/en/stable/changelog/
+Project-URL: Changelog, https://galarzaa90.github.io/tibiawiki-sql/changelog/
 Project-URL: Docker Hub: Repo, https://hub.docker.com/repository/docker/galarzaa90/tibiawiki-sql
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -42,9 +42,8 @@ Requires-Dist: griffe-inherited-docstrings; extra == "docs"
 Requires-Dist: docstring-inheritance; extra == "docs"
 Requires-Dist: griffe-pydantic; extra == "docs"
 Requires-Dist: griffe-generics; extra == "docs"
-Requires-Dist: mkdocs-material; extra == "docs"
-Requires-Dist: mkdocstrings[python]; extra == "docs"
-Requires-Dist: ruff; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: zensical; extra == "docs"
 Provides-Extra: testing
 Requires-Dist: coverage; extra == "testing"
 Requires-Dist: ruff; extra == "testing"

{tibiawikisql-8.0.1 → tibiawikisql-8.2.0}/tibiawikisql.egg-info/requires.txt

@@ -11,9 +11,8 @@ griffe-inherited-docstrings
 docstring-inheritance
 griffe-pydantic
 griffe-generics
-mkdocs-material
-mkdocstrings[python]
-ruff
+mkdocstrings-python
+zensical
 
 [server]
 fastapi