refactor personending

Author: bretttolbert

verbecc/src/defs/types/data/person_ending.py

@@ -0,0 +1,38 @@
+from typing import List
+from verbecc.src.defs.types.person import Person
+from verbecc.src.defs.types.data.element import Element
+
+
+class PersonEnding(Element):
+    """
+    Ending for a specific verb template, mood, tense and grammatical person
+    May also have one or more alternate endings for an alternative spellings
+    or regional variations.
+    E.g. Endings for aim:er indicatif présent 2nd Person Plural = ['ez']
+    E.g. Endings for pa:yer indicatif présent 1st Person Singular = ['ie', 'ye']
+    Explanation: 'ye' is an alternate spelling (je paie, je paye)
+    person
+    A grammar_defines.PERSONS value indicating which person
+    this PersonEnding is for, e.g. for aim:er, "ez" is '2p' (second person plural)
+    """
+
+    def __init__(self, person: Person, endings: List[str]) -> None:
+        self.person = person
+        self.endings = endings
+
+    def get_person(self) -> Person:
+        return self.person
+
+    def get_endings(self) -> List[str]:
+        return self.endings
+
+    def get_ending(self) -> str:
+        return self.endings[0]
+
+    def get_alternate_ending_if_available(self) -> str:
+        if len(self.endings) > 1:
+            return self.endings[1]
+        return self.endings[0]
+
+    def __repr__(self) -> str:
+        return "person={} endings={}".format(self.person, self.endings)

verbecc/src/inflectors/inflector.py

@@ -4,7 +4,7 @@
 from verbecc.src.defs.types.lang_code import LangCodeISO639_1
 from verbecc.src.defs.types.mood import MoodEn as Mood
 from verbecc.src.defs.types.tense import TenseEn as Tense
-from verbecc.src.parsers.person_ending import PersonEnding
+from verbecc.src.defs.types.data.person_ending import PersonEnding
 
 
 logging_level = logging.CRITICAL + 1  # effectively disables logging

verbecc/src/inflectors/lang/inflector_es.py

@@ -13,10 +13,10 @@
     LangSpecificOptionsEs,
 )
 from verbecc.src.defs.types.lang.es.voseo_options import VoseoOptions
+from verbecc.src.defs.types.data.person_ending import PersonEnding
 from verbecc.src.inflectors.inflector import Inflector
 from verbecc.src.conjugator.conjugation_object import ConjugationObjects
 from verbecc.src.parsers.tense_template import TenseTemplate
-from verbecc.src.parsers.person_ending import PersonEnding
 from verbecc.src.utils.string_utils import strip_accents
 
 

verbecc/src/parsers/person_ending.py …becc/src/parsers/person_ending_parser.pyverbecc/src/parsers/person_ending.py renamed to verbecc/src/parsers/person_ending_parser.py verbecc/src/parsers/person_ending.py renamed to verbecc/src/parsers/person_ending_parser.py

@@ -1,10 +1,12 @@
 from lxml import etree
 from typing import List
 
+from verbecc.src.parsers.parser import Parser
+from verbecc.src.defs.types.data.person_ending import PersonEnding
 from verbecc.src.defs.types.person import Person
 
 
-class PersonEnding:
+class PersonEndingParser(Parser):
     """
     p_elem
     aka <p>
@@ -24,28 +26,21 @@ class PersonEnding:
     this PersonEnding is for, e.g. for aim:er, "ez" is '2p' (second person plural)
     """
 
-    def __init__(self, p_elem: etree._Element, person: Person) -> None:
-        self.person = person
-        self.endings: List[str] = []
-        for i_elem in p_elem.findall("i", None):
+    def __init__(self) -> None:
+        pass
+
+    def parse(self, elem: etree._Element, person: Person) -> PersonEnding:
+        """
+        elem: a single <p> element
+        Example:
+            <p><i>ez</i></p>
+            <p><i>eoir</i><i>oir</i></p>
+            <p></p>
+        """
+        endings: List[str] = []
+        for i_elem in elem.findall("i", None):
             ending = str("")
             if i_elem.text is not None:
                 ending += str(i_elem.text)
-            self.endings.append(ending)
-
-    def get_person(self) -> Person:
-        return self.person
-
-    def get_endings(self) -> List[str]:
-        return self.endings
-
-    def get_ending(self) -> str:
-        return self.endings[0]
-
-    def get_alternate_ending_if_available(self) -> str:
-        if len(self.endings) > 1:
-            return self.endings[1]
-        return self.endings[0]
-
-    def __repr__(self) -> str:
-        return "person={} endings={}".format(self.person, self.endings)
+            endings.append(ending)
+        return PersonEnding(person, endings)

verbecc/src/parsers/tense_template.py

@@ -1,7 +1,8 @@
 from lxml import etree
 from typing import List
 
-from verbecc.src.parsers.person_ending import PersonEnding
+from verbecc.src.parsers.person_ending_parser import PersonEndingParser
+from verbecc.src.defs.types.data.person_ending import PersonEnding
 from verbecc.src.defs.constants import grammar_defines
 from verbecc.src.defs.types.tense import Tense
 from verbecc.src.defs.types.person import Person
@@ -89,7 +90,7 @@ def __init__(self, lang: Lang, mood: Mood, tense_elem: etree._Element) -> None:
             person = grammar_defines.PERSONS[person_num]
             if self.mood == xmood(self.lang, Mood.en.Imperative):
                 person = grammar_defines.IMPERATIVE_PERSONS[self.lang][person_num]
-            pe = PersonEnding(p_elem, person)
+            pe = PersonEndingParser().parse(p_elem, person)
             person_num += 1
             if len(pe.endings) > 0:
                 self.person_endings.append(pe)