consolidate getting child models

Author: Galarzaa90

mkdocs/intro.md

@@ -69,10 +69,11 @@ The following is an example of an article being obtained from the database.
 ```python
 import tibiawikisql
 import sqlite3
+
 # Path to the previously generated database
 conn = sqlite3.connect("tibiawiki.db")
 # creature now contains all the parsed information, including loot statistics.
-creature = Creature.get_by_field(conn, "title", "Demon")
+creature = Creature.get_one_by_field(conn, "title", "Demon")
 # This would return a list of Item objects.
 # Note that when multiple objects are obtained, their child rows are not fetched.
 swords = Item.search(conn, "type", "Sword Weapons")

tests/models/test_achievement.py

@@ -48,14 +48,14 @@ def test_achievement_insert(self):
             achievement.insert(self.conn)
 
     def test_achievement_get_by_field_no_results(self):
-        achievement = Achievement.get_by_field(self.conn, "achievement_id", 57)
+        achievement = Achievement.get_one_by_field(self.conn, "achievement_id", 57)
 
         self.assertIsNone(achievement)
 
     def test_achievement_get_by_field_with_result(self):
         ACHIEVEMENT_ANNIHILATOR.insert(self.conn)
 
-        db_achievement = Achievement.get_by_field(self.conn, "achievement_id", 57)
+        db_achievement = Achievement.get_one_by_field(self.conn, "achievement_id", 57)
 
         self.assertIsInstance(db_achievement, Achievement)
         self.assertEqual(ACHIEVEMENT_ANNIHILATOR.timestamp, db_achievement.timestamp)

tests/models/test_book.py

@@ -4,7 +4,6 @@
 from polyfactory.factories.pydantic_factory import ModelFactory
 
 from tibiawikisql.models import Book, Item, ItemStoreOffer
-from tibiawikisql.models.item import ItemSound
 from tibiawikisql.schema import BookTable, ItemAttributeTable, ItemSoundTable, ItemStoreOfferTable, ItemTable
 
 
@@ -44,6 +43,6 @@ def test_book_insert(self):
         item.insert(self.conn)
 
         book.insert(self.conn)
-        inserted_book = book.table.get_by_field(self.conn, "article_id", book.article_id)
+        inserted_book = book.table.get_one_by_field(self.conn, "article_id", book.article_id)
 
         self.assertEqual(item.article_id, inserted_book["article_id"])

tests/models/test_npc.py

@@ -2,8 +2,11 @@
 import sqlite3
 import unittest
 
-from tibiawikisql.models import Npc
-from tibiawikisql.schema import NpcJobTable, NpcRaceTable, NpcSpellTable, NpcTable, SpellTable
+from tibiawikisql.models import Npc, NpcDestination, NpcOffer
+from tibiawikisql.schema import ItemTable, NpcBuyingTable, NpcDestinationTable, NpcJobTable, NpcRaceTable, \
+    NpcSellingTable, NpcSpellTable, \
+    NpcTable, \
+    SpellTable
 
 
 class TestNpc(unittest.TestCase):
@@ -13,6 +16,10 @@ def setUp(self):
         self.conn.executescript(NpcSpellTable.get_create_table_statement())
         self.conn.executescript(NpcJobTable.get_create_table_statement())
         self.conn.executescript(NpcRaceTable.get_create_table_statement())
+        self.conn.executescript(NpcBuyingTable.get_create_table_statement())
+        self.conn.executescript(NpcSellingTable.get_create_table_statement())
+        self.conn.executescript(ItemTable.get_create_table_statement())
+        self.conn.executescript(NpcDestinationTable.get_create_table_statement())
 
     def test_npc_with_spells(self):
         # Arrange
@@ -59,10 +66,10 @@ def test_npc_with_spells(self):
         )
         NpcSpellTable.insert(self.conn, npc_id=1, spell_id=1, druid=True)
 
-        npc = Npc.get_by_field(self.conn, "name", "Azalea")
+        npc = Npc.get_one_by_field(self.conn, "name", "Azalea")
 
         self.assertIsInstance(npc, Npc)
         self.assertEqual(5, len(npc.jobs))
         self.assertEqual("Human", npc.race)
         self.assertEqual(1, len(npc.teaches))
-        self.assertEqual("Food (Spell)", npc.teaches[0].spell)
+        self.assertEqual("Food (Spell)", npc.teaches[0].spell_title)

tests/tests_models.py

@@ -20,12 +20,12 @@ def test_achievement(self):
         self.assertIsInstance(achievement, models.Achievement)
 
         achievement.insert(self.conn)
-        db_achievement = models.Achievement.get_by_field(self.conn, "article_id", 1)
+        db_achievement = models.Achievement.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_achievement, models.Achievement)
         self.assertEqual(db_achievement.name, achievement.name)
 
-        db_achievement = models.Achievement.get_by_field(self.conn, "name", "demonic barkeeper", use_like=True)
+        db_achievement = models.Achievement.get_one_by_field(self.conn, "name", "demonic barkeeper", use_like=True)
         self.assertIsInstance(db_achievement, models.Achievement)
 
     def test_creature(self):
@@ -35,7 +35,7 @@ def test_creature(self):
         self.assertIsInstance(creature, models.Creature)
 
         creature.insert(self.conn)
-        db_creature: models.Creature = models.Creature.get_by_field(self.conn, "article_id", 1)
+        db_creature: models.Creature = models.Creature.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_creature, models.Creature)
         self.assertEqual(db_creature.name, creature.name)
@@ -52,7 +52,7 @@ def test_creature(self):
         self.assertEqual(50, db_creature.charm_points)
         self.assertIsNotNone(db_creature.max_damage)
 
-        db_creature = models.Creature.get_by_field(self.conn, "name", "demon", use_like=True)
+        db_creature = models.Creature.get_one_by_field(self.conn, "name", "demon", use_like=True)
         self.assertIsInstance(db_creature, models.Creature)
 
     def test_house(self):
@@ -62,12 +62,12 @@ def test_house(self):
         self.assertIsInstance(house, models.House)
 
         house.insert(self.conn)
-        db_house = models.House.get_by_field(self.conn, "article_id", 1)
+        db_house = models.House.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_house, models.House)
         self.assertEqual(db_house.name, house.name)
 
-        models.House.get_by_field(self.conn, "house_id", 55302)
+        models.House.get_one_by_field(self.conn, "house_id", 55302)
         self.assertIsInstance(db_house, models.House)
 
     def test_imbuement(self):
@@ -77,14 +77,14 @@ def test_imbuement(self):
         self.assertIsInstance(imbuement, models.Imbuement)
 
         imbuement.insert(self.conn)
-        db_imbuement = models.Imbuement.get_by_field(self.conn, "article_id", 1)
+        db_imbuement = models.Imbuement.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_imbuement, models.Imbuement)
         self.assertEqual(db_imbuement.name, imbuement.name)
         self.assertEqual(db_imbuement.tier, imbuement.tier)
         self.assertGreater(len(db_imbuement.materials), 0)
 
-        db_imbuement = models.Imbuement.get_by_field(self.conn, "name", "powerful strike", use_like=True)
+        db_imbuement = models.Imbuement.get_one_by_field(self.conn, "name", "powerful strike", use_like=True)
         self.assertIsInstance(db_imbuement, models.Imbuement)
 
     def test_item(self):
@@ -94,7 +94,7 @@ def test_item(self):
         self.assertIsInstance(item, models.Item)
 
         item.insert(self.conn)
-        db_item = models.Item.get_by_field(self.conn, "article_id", 1)
+        db_item = models.Item.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_item, models.Item)
         self.assertEqual(db_item.name, item.name)
@@ -108,7 +108,7 @@ def test_item(self):
                                 "The blade is a magic flame.")
         self.assertEqual(fire_sword_look_text, item.look_text)
 
-        db_item = models.Item.get_by_field(self.conn, "name", "fire sword", use_like=True)
+        db_item = models.Item.get_one_by_field(self.conn, "name", "fire sword", use_like=True)
         self.assertIsInstance(db_item, models.Item)
 
     def test_item_resist(self):
@@ -127,13 +127,13 @@ def test_item_resist(self):
         self.assertEqual(item.resistances["energy"], 10)
 
         item.insert(self.conn)
-        db_item = models.Item.get_by_field(self.conn, "article_id", 1)
+        db_item = models.Item.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_item, models.Item)
         self.assertEqual(db_item.name, item.name)
         self.assertGreater(len(db_item.attributes), 0)
 
-        db_item = models.Item.get_by_field(self.conn, "name", "dream shroud", use_like=True)
+        db_item = models.Item.get_one_by_field(self.conn, "name", "dream shroud", use_like=True)
         self.assertIsInstance(db_item, models.Item)
 
     def test_item_sounds(self):
@@ -144,12 +144,12 @@ def test_item_sounds(self):
         self.assertEqual(len(item.sounds), 5)
 
         item.insert(self.conn)
-        db_item = models.Item.get_by_field(self.conn, "article_id", 1)
+        db_item = models.Item.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_item, models.Item)
         self.assertEqual(db_item.name, item.name)
 
-        db_item = models.Item.get_by_field(self.conn, "name", "mini nabbot", use_like=True)
+        db_item = models.Item.get_one_by_field(self.conn, "name", "mini nabbot", use_like=True)
         self.assertEqual(len(item.sounds), len(db_item.sounds))
         self.assertIsInstance(db_item, models.Item)
 
@@ -176,12 +176,12 @@ def test_key(self):
         self.assertIsInstance(key, models.Key)
 
         key.insert(self.conn)
-        db_key = models.Key.get_by_field(self.conn, "article_id", 1)
+        db_key = models.Key.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_key, models.Key)
         self.assertEqual(db_key.name, key.name)
 
-        db_key = models.Key.get_by_field(self.conn, "number", 3940)
+        db_key = models.Key.get_one_by_field(self.conn, "number", 3940)
         self.assertIsInstance(db_key, models.Key)
 
     def test_book(self):
@@ -191,7 +191,7 @@ def test_book(self):
         self.assertIsInstance(book, models.Book)
 
         book.insert(self.conn)
-        db_book = models.Book.get_by_field(self.conn, "article_id", 1)
+        db_book = models.Book.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_book, models.Book)
         self.assertEqual(db_book.name, book.name)
@@ -208,7 +208,7 @@ def test_npc(self):
         self.assertIsInstance(npc, models.Npc)
 
         npc.insert(self.conn)
-        db_npc = models.Npc.get_by_field(self.conn, "article_id", 1)
+        db_npc = models.Npc.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_npc, models.Npc)
         self.assertEqual(db_npc.name, npc.name)
@@ -231,7 +231,7 @@ def test_quest(self):
         self.assertIsInstance(quest, models.Quest)
 
         quest.insert(self.conn)
-        db_quest = models.Quest.get_by_field(self.conn, "article_id", 1)
+        db_quest = models.Quest.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_quest, models.Quest)
         self.assertEqual(db_quest.name, quest.name)
@@ -243,7 +243,7 @@ def test_spell(self):
         self.assertIsInstance(spell, models.Spell)
 
         spell.insert(self.conn)
-        db_spell = models.Spell.get_by_field(self.conn, "article_id", 1)
+        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)
@@ -256,7 +256,7 @@ def test_world(self):
         self.assertIsInstance(world.trade_board, int)
 
         world.insert(self.conn)
-        db_world = models.World.get_by_field(self.conn, "article_id", 1)
+        db_world = models.World.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_world, models.World)
         self.assertEqual(db_world.name, world.name)
@@ -271,7 +271,7 @@ def test_mount(self):
         self.assertIsInstance(mount.buyable, int)
 
         mount.insert(self.conn)
-        db_mount = models.Mount.get_by_field(self.conn, "article_id", 1)
+        db_mount = models.Mount.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_mount, models.Mount)
         self.assertEqual(db_mount.name, mount.name)
@@ -287,7 +287,7 @@ def test_charm(self):
         self.assertEqual("11.50.6055", charm.version)
 
         charm.insert(self.conn)
-        db_charm = models.Charm.get_by_field(self.conn, "article_id", 1)
+        db_charm = models.Charm.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_charm, models.Charm)
         self.assertEqual(db_charm.name, charm.name)
@@ -301,7 +301,7 @@ def test_outfit(self):
         self.assertEqual(outfit.achievement, "Brutal Politeness")
 
         outfit.insert(self.conn)
-        db_outfit = models.Outfit.get_by_field(self.conn, "article_id", 1)
+        db_outfit = models.Outfit.get_one_by_field(self.conn, "article_id", 1)
 
         self.assertIsInstance(db_outfit, models.Outfit)
         self.assertEqual(db_outfit.name, outfit.name)

tests/tests_schema.py

@@ -51,20 +51,20 @@ def test_achievement_table_insert_wrong_type(self):
 
     def test_achievement_table_get_by_field_wrong_column(self):
         with self.assertRaises(ValueError):
-            AchievementTable.get_by_field(self.conn, "unknown", True)
+            AchievementTable.get_one_by_field(self.conn, "unknown", True)
 
     def test_achievement_table_get_by_field_no_results(self):
         self.conn.executescript(AchievementTable.get_create_table_statement())
 
-        result = AchievementTable.get_by_field(self.conn, "title", "Annihilator")
+        result = AchievementTable.get_one_by_field(self.conn, "title", "Annihilator")
 
         self.assertIsNone(result)
 
     def test_achievement_table_get_by_field_get_results(self):
         self.conn.executescript(AchievementTable.get_create_table_statement())
         AchievementTable.insert(self.conn, **SAMPLE_ACHIEVEMENT_ROW)
 
-        result = AchievementTable.get_by_field(self.conn, "title", "Annihilator")
+        result = AchievementTable.get_one_by_field(self.conn, "title", "Annihilator")
 
         self.assertIsNotNone(result)
         self.assertEqual(5, result["points"])

tibiawikisql/api.py

@@ -40,7 +40,7 @@ def __eq__(self, other: object) -> bool:
     @property
     def url(self) -> str:
         """The URL to the article's display page."""
-        return f"{BASE_URL}/wiki/{urllib.parse.quote(self.title)}"
+        return f"{BASE_URL}/wiki/{urllib.parse.quote(self.title.replace(" ","_"))}"
 
 
 class Article(WikiEntry):