feat(npc): replace flaky faker with mimesis (#100)

pynpc/console.py

@@ -78,7 +78,7 @@ def __init__(self, param: str = "") -> None:
             self.param = param
             super()
 
-        def filter(self, _: logging.LogRecord) -> bool:
+        def filter(self, _: logging.LogRecord) -> bool:  # pyright: ignore [reportIncompatibleMethodOverride]
             # We have no choice in the method's name.
             # We do not care about record thus mark it as _.
             #

pynpc/npc.py

@@ -7,7 +7,7 @@
 
 import orjson
 import structlog
-from faker import Faker
+from mimesis import Gender, Locale, Person
 
 from pynpc.name_corruptor import NameCorruptor, parse_patterns
 from pynpc.skills import get_skill_value
@@ -75,8 +75,7 @@ def __init__(self, what: str = "fantasy") -> None:
             # so an extra dir can override core behaviour
             self._resources[jobj["resource"]] = ResourceObject(source=jobj)
 
-        # Faker, for names.
-        self._fake = Faker(["en_GB"])
+        # Name corruption.
         data = Path(Path(__file__).resolve().parent.parent, "pynpc", "data", "name-corruption-pattern.json")
         patterns = parse_patterns(orjson.loads(data.read_text()))
         self._corruptor = NameCorruptor(patterns)
@@ -108,9 +107,10 @@ def reading(self) -> Reading:
 
     def generate(self) -> None:
         """Generate an NPC."""
-        self.name_fem = self._get_name(self._fake.name_female())  # Female
-        self.name_mal = self._get_name(self._fake.name_male())  # Male
-        self.name_non = self._get_name(self._fake.name_nonbinary())  # Non-binary
+        person = Person(Locale.EN)
+        self.name_fem = person.full_name(gender=Gender.FEMALE)
+        self.name_mal = person.full_name(gender=Gender.MALE)
+        self.name_non = person.full_name()
         _arc = self._resources["archetypes"].get_value()
         self.nature = Trait(_arc["name"], _arc["description"])
         self.demeanour = self.nature
@@ -164,7 +164,7 @@ def to_markdown(self) -> str:
 
 | **Abilities** |   **Name**    | **Rank** |
 | --- | --- | --- |
-| **Primary**   | | {self.skill_primary.name}   | {self.skill_primary.rank} |
+| **Primary**   | {self.skill_primary.name}   | {self.skill_primary.rank} |
 | **Secondary** | {self.skill_secondary.name} | {self.skill_secondary.rank} |
 | **Hobby**     | {self.skill_hobby.name}     | {self.skill_hobby.rank} |
 

pyproject.toml

@@ -21,7 +21,7 @@ structlog = ">=23.3,<25.0"
 requests = "^2.31.0"
 types-requests = "^2.31.0.20240125"
 orjson = "^3.9.12"
-faker = "^22.6.0"
+mimesis = "^14.0.0"
 
 [tool.poetry.group.dev.dependencies]
 black = ">=23.12.1,<25.0.0"

tests/test_npc.py

@@ -10,12 +10,10 @@
 
 @pytest.fixture(autouse=True, scope="package")
 def random() -> Any:
-    with patch("pynpc.npc.Faker") as mock_faker:
-        mock_fake = Mock()
-        mock_fake.name_female.return_value = "Ferro Maljinn"
-        mock_fake.name_male.return_value = "Logen Ninefingers"
-        mock_fake.name_nonbinary.return_value = "R2D2"
-        mock_faker.return_value = mock_fake
+    with patch("pynpc.npc.Person") as mock_fake:
+        mock_person = Mock()
+        mock_person.full_name.side_effect = ["Ferro Maljinn", "Logen Ninefingers", "R2D2"]
+        mock_fake.return_value = mock_person
         return NPC()