Merge pull request #31 from bretttolbert/typing-mood-tense

- Added typing for mood and tense using `StrEnum` (backwards-compatible with string values)
- Fixed typo in new `Language` enum
- Corrected Romanian conditional tense spelling from `conditional` to `condițional`

Author: bretttolbert

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "verbecc"
-version = "1.11.1"
+version = "1.11.2"
 dependencies = [
   "cython>=3.1.4",
   "importlib_resources==6.4.5 ; python_version < '3.13'",

tests/test_inflectors/test_inflector_es.py

@@ -590,7 +590,7 @@ def test_abolir():
     """
     Reproduce error:
 
-    >           co.template.moods[persons_mood_name].tenses[aux_tense_name].person_endings]
+    >           co.template.mood_templates[persons_mood_name].tense_templates[aux_tense_name].person_endings]
     E       KeyError: 'presente'
 
     ../../PyVEnvs/Py311/lib/python3.11/site-packages/verbecc/inflector.py:259: KeyError

tests/test_inflectors/test_inflector_fr.py

@@ -7,7 +7,7 @@
 from verbecc.src.conjugator.conjugator import Conjugator, AlternatesBehavior
 from verbecc.src.parsers.tense_template import TenseTemplate
 from verbecc.src.defs.types.exceptions import ConjugatorError
-from verbecc.src.defs.types.data_types import MoodsConjugation
+from verbecc.src.defs.types.conjugation import MoodsConjugation
 
 
 @pytest.fixture(scope="module")
@@ -235,7 +235,7 @@ def test_can_conjugate_all_verbs(cg):
     assert len(all_conjugations) == len(verbs)
 
 
-def test_inflector_fr_raser(cg):
+def test_inflector_fr_conjugate_compound_raser(cg):
     infinitive = "raser"
     co = cg._get_conj_obs(infinitive)
     ret = cg._conjugate_compound(
@@ -259,7 +259,13 @@ def test_inflector_fr_raser(cg):
     ]
 
 
-def test_inflector_fr_se_raser(cg):
+def test_inflector_fr_conjugate_compound_se_raser(cg):
+    """
+    test targeting:
+        - reflexive verb conjugation
+        - compound verb conjugation with a verb conjugated with être (inflected participle)
+        - Note: In French, all reflexive verbs are conjugated with être
+    """
     infinitive = "se raser"
     co = cg._get_conj_obs(infinitive)
     ret = cg._conjugate_compound(
@@ -281,3 +287,31 @@ def test_inflector_fr_se_raser(cg):
         ["que vous vous soyez rasés"],
         ["qu'ils se soient rasés"],
     ]
+
+
+def test_inflector_fr_conjugate_compound_parler_indicative_passé_composé(cg):
+    """
+    test targeting:
+        - compound verb conjugation with a verb not conjugated with être (non-inflected participle)
+    """
+    infinitive = "parler"
+    co = cg._get_conj_obs(infinitive)
+    ret = cg._conjugate_compound(
+        co,
+        "indicatif",
+        "passé-composé",
+        "indicatif",
+        "présent",
+        False,
+        AlternatesBehavior.All,
+        Gender.Masculine,
+        True,
+    )
+    assert ret == [
+        ["j'ai parlé"],
+        ["tu as parlé"],
+        ["il a parlé"],
+        ["nous avons parlé"],
+        ["vous avez parlé"],
+        ["ils ont parlé"],
+    ]

tests/test_inflectors/test_inflector_it.py

@@ -1,10 +1,10 @@
 import pytest
 from typing import cast
 
-from verbecc.src.defs.types.gender import Gender
-from verbecc.src.defs.types.person import Person
 from verbecc.src.conjugator.conjugator import Conjugator, MoodsConjugation
 from verbecc.src.defs.types.alternates_behavior import AlternatesBehavior
+from verbecc.src.defs.types.gender import Gender
+from verbecc.src.defs.types.person import Person
 
 
 @pytest.fixture(scope="module")
@@ -240,7 +240,7 @@ def test_inflector_it_alzarsi_indicativo_passato_prossimo(
     assert moods_conj["indicativo"]["passato-prossimo"] == expected_result
 
 
-def test_inflector_it_essere_indicativo_passato_prossimo(cg):
+def test_inflector_it_conjugate_compound_essere_indicativo_passato_prossimo(cg):
     infinitive = "essere"
     co = cg._get_conj_obs(infinitive)
     ret = cg._conjugate_compound(

tests/test_inflectors/test_inflector_ro.py

@@ -267,7 +267,7 @@ def test_all_verbs_have_templates(cg):
         ),
         (
             "avea",
-            "conditional",
+            "condițional",
             "prezent",
             AlternatesBehavior.FirstOnly,
             [
@@ -281,7 +281,7 @@ def test_all_verbs_have_templates(cg):
         ),
         (
             "avea",
-            "conditional",
+            "condițional",
             "perfect",
             AlternatesBehavior.FirstOnly,
             [
@@ -334,9 +334,9 @@ def test_inflector_ro_conjugate_mood_tense_viitor_1_popular(cg):
     )
 
 
-def test_inflector_ro_conjugate_mood_tense_conditional_perfect(cg):
+def test_inflector_ro_conjugate_mood_tense_condițional_perfect(cg):
     assert cg.conjugate_mood_tense(
-        "avea", "conditional", "perfect", AlternatesBehavior.FirstOnly
+        "avea", "condițional", "perfect", AlternatesBehavior.FirstOnly
     ) == [
         "eu aş fi avut",
         "tu ai fi avut",

verbecc/__init__.py

@@ -1,20 +1,22 @@
 from verbecc.src.conjugator.conjugator import Conjugator
 from verbecc.src.defs.types.alternates_behavior import AlternatesBehavior
-from verbecc.src.defs.types.data_types import (
+from verbecc.src.defs.types.conjugation import (
     MoodsConjugation,
     MoodConjugation,
     TenseConjugation,
     PersonConjugation,
-    VerbInfo,
+    ConjugationInfo,
     Conjugation,
 )
 from verbecc.src.defs.types.gender import Gender
 from verbecc.src.defs.types.person import Person, is_plural, is_singular
 from verbecc.src.defs.types.partiple_inflection import ParticipleInflection
-from verbecc.src.defs.types.language import Lanugage
+from verbecc.src.defs.types.language import Language
+from verbecc.src.defs.types.mood import Mood
+from verbecc.src.defs.types.tense import Tense
 import verbecc.src.defs.constants.localization as localization
 import verbecc.src.defs.constants.grammar_defines as grammar_defines
-from verbecc.src.parsers.mood import Mood
+from verbecc.src.parsers.mood_template import MoodTemplate
 from verbecc.src.parsers.verb import Verb
 from verbecc.src.defs.types.exceptions import (
     ConjugatorError,

verbecc/src/conjugator/conjugator.py

@@ -1,6 +1,9 @@
 import logging
 
 from verbecc.src.defs.types.gender import Gender
+from verbecc.src.defs.types.mood import Mood
+from verbecc.src.defs.types.tense import Tense
+from verbecc.src.defs.types.conjugation import ConjugationInfo
 from verbecc.src.defs.constants.config import DEVEL_MODE
 
 logging_level = logging.CRITICAL + 1  # effectively disables logging
@@ -29,7 +32,7 @@
     InvalidMoodError,
     InvalidTenseError,
 )
-from verbecc.src.defs.types.data_types import (
+from verbecc.src.defs.types.conjugation import (
     PersonConjugation,
     TenseConjugation,
     MoodConjugation,
@@ -54,7 +57,7 @@ def __init__(self, lang: str):
 
     def conjugate(
         self,
-        infinitive,
+        infinitive: str,
         include_alternates: bool = False,
         gender: Gender = Gender.Masculine,
         conjugate_pronouns: bool = True,
@@ -74,26 +77,26 @@ def conjugate(
             alternates_behavior = AlternatesBehavior.All
         co = self._get_conj_obs(infinitive)
         moods: MoodsConjugation = {}
-        for mood in co.template.moods:
-            moods[mood] = self._conjugate_mood(
-                co, mood, alternates_behavior, gender, conjugate_pronouns
+        for mood_name, _ in co.template.mood_templates.items():
+            moods[mood_name] = self._conjugate_mood(
+                co, mood_name, alternates_behavior, gender, conjugate_pronouns
             )
         return {
-            "verb": {
-                "infinitive": co.verb.infinitive,
-                "predicted": co.verb.predicted,
-                "pred_score": co.verb.pred_score,
-                "template": co.verb.template,
-                "translation_en": co.verb.translation_en,
-                "stem": co.verb_stem,
-            },
+            "verb": ConjugationInfo(
+                co.verb.infinitive,
+                co.verb.predicted,
+                co.verb.pred_score,
+                co.verb.template,
+                co.verb.translation_en,
+                co.verb_stem,
+            ).data,
             "moods": moods,
         }
 
     def conjugate_mood(
         self,
         infinitive: str,
-        mood_name: str,
+        mood_name: Mood,
         alternates_behavior: AlternatesBehavior = AlternatesBehavior.FirstOnly,
         gender: Gender = Gender.Masculine,
         conjugate_pronouns: bool = True,
@@ -139,8 +142,8 @@ def get_verbs_that_start_with(self, query: str, max_results: int) -> List[str]:
     def conjugate_mood_tense(
         self,
         infinitive: str,
-        mood_name: str,
-        tense_name: str,
+        mood_name: Mood,
+        tense_name: Tense,
         alternates_behavior: AlternatesBehavior = AlternatesBehavior.FirstOnly,
         gender: Gender = Gender.Masculine,
         conjugate_pronouns: bool = True,
@@ -153,12 +156,12 @@ def conjugate_mood_tense(
     def _conjugate_mood(
         self,
         co: ConjugationObjects,
-        mood_name: str,
+        mood_name: Mood,
         alternates_behavior: AlternatesBehavior,
         gender: Gender = Gender.Masculine,
         conjugate_pronouns: bool = True,
     ) -> MoodConjugation:
-        if mood_name not in co.template.moods:
+        if mood_name not in co.template.mood_templates.keys():
             raise InvalidMoodError
         ret = {}
         ret.update(
@@ -176,8 +179,8 @@ def _conjugate_mood(
     def _conjugate_mood_tense(
         self,
         co: ConjugationObjects,
-        mood_name: str,
-        tense_name: str,
+        mood_name: Mood,
+        tense_name: Tense,
         alternates_behavior: AlternatesBehavior,
         gender: Gender = Gender.Masculine,
         conjugate_pronouns: bool = True,
@@ -201,10 +204,10 @@ def _conjugate_mood_tense(
                 conjugate_pronouns=conjugate_pronouns,
             )
         else:
-            mood = co.template.moods[mood_name]
-            if tense_name not in mood.tenses:
+            mood_template = co.template.mood_templates[mood_name]
+            if tense_name not in mood_template.tense_templates:
                 raise InvalidTenseError
-            tense_template = mood.tenses[tense_name]
+            tense_template = mood_template.tense_templates[tense_name]
             return self._conjugate_simple_mood_tense(
                 co.verb_stem,
                 mood_name,
@@ -221,14 +224,14 @@ def _conjugate_mood_tense(
     def _get_simple_conjugations_for_mood(
         self,
         co: ConjugationObjects,
-        mood_name: str,
+        mood_name: Mood,
         alternates_behavior: AlternatesBehavior,
         gender: Gender = Gender.Masculine,
         conjugate_pronouns: bool = True,
     ) -> MoodConjugation:
         ret = {}
-        mood = co.template.moods[mood_name]
-        for tense_name in mood.tenses:
+        mood_template = co.template.mood_templates[mood_name]
+        for tense_name in mood_template.tense_templates:
             ret[tense_name] = self._conjugate_mood_tense(
                 co,
                 mood_name,
@@ -242,7 +245,7 @@ def _get_simple_conjugations_for_mood(
     def _get_compound_conjugations_for_mood(
         self,
         co: ConjugationObjects,
-        mood_name: str,
+        mood_name: Mood,
         alternates_behavior: AlternatesBehavior,
         gender: Gender,
         conjugate_pronouns=True,
@@ -264,10 +267,10 @@ def _get_compound_conjugations_for_mood(
     def _conjugate_compound(
         self,
         co: ConjugationObjects,
-        mood_name: str,
-        tense_name: str,
-        aux_mood_name: str,
-        aux_tense_name: str,
+        mood_name: Mood,
+        tense_name: Tense,
+        aux_mood_name: Mood,
+        aux_tense_name: Tense,
         aux_uses_alternate: bool,
         alternates_behavior: AlternatesBehavior,
         gender: Gender = Gender.Masculine,
@@ -283,18 +286,20 @@ def _conjugate_compound(
         ):
             return ret
         persons_mood_name = mood_name
-        if mood_name not in co.template.moods:
+        if mood_name not in co.template.mood_templates.keys():
             persons_mood_name = self._inflector._get_indicative_mood_name()
         persons = [
             pe.person
-            for pe in co.template.moods[persons_mood_name]
-            .tenses[aux_tense_name]
+            for pe in co.template.mood_templates[persons_mood_name]
+            .tense_templates[aux_tense_name]
             .person_endings
         ]
         aux_verb = self._inflector._get_auxilary_verb(co, mood_name, tense_name)
         aux_co = self._get_conj_obs(aux_verb)
         aux_tense_template = copy.deepcopy(
-            aux_co.template.moods[aux_mood_name].tenses[aux_tense_name]
+            aux_co.template.mood_templates[aux_mood_name].tense_templates[
+                aux_tense_name
+            ]
         )
         aux_person_endings = []
         for pe in aux_tense_template.person_endings:
@@ -347,8 +352,8 @@ def _conjugate_compound(
     def _conjugate_compound_primary_verb(
         self,
         co: ConjugationObjects,
-        mood_name: str,
-        tense_name: str,
+        mood_name: Mood,
+        tense_name: Tense,
         persons: List[Person],
         aux_verb: str,
         aux_conj: List[str],
@@ -385,7 +390,7 @@ def _conjugate_compound_primary_verb(
             p_conj = self._conjugate_simple_mood_tense(
                 co.verb_stem,
                 p_mood,
-                co.template.moods[p_mood].tenses[p_tense],
+                co.template.mood_templates[p_mood].tense_templates[p_tense],
                 False,
                 AlternatesBehavior.FirstOnly,
                 gender=gender,
@@ -502,7 +507,7 @@ def _conjugate_compound_primary_verb(
     def _conjugate_simple_mood_tense(
         self,
         verb_stem: str,
-        mood_name: str,
+        mood_name: Mood,
         tense_template: TenseTemplate,
         is_reflexive: bool = False,
         alternates_behavior: AlternatesBehavior = AlternatesBehavior.FirstOnly,