lesya 0.0.1__tar.gz

lesya-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lesya-0.0.1/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: lesya
+Version: 0.0.1
+Summary: Python package to form Ukrainian names cases : 'Леся Українка' -- 'Лесі Українки' , 'Лесі Українці', 'Лесею Українкою' ... etc.
+Author: Dmytro Ustynov
+Author-email: Dmytro Ustynov <ustynov.dev@gmail.com>
+License: Copyright (c) 2018 The Python Packaging Authority
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/ustynov-py-dev/lesya.git
+Project-URL: Issues, https://github.com/ustynov-py-dev/lesya/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Lesya
+
+Lesya is a simple Python package for declining Ukrainian personal names into Ukrainian grammatical cases (_відмінки_): NOMINATIVE, GENITIVE, DATIVE, ACCUSATIVE, INSTRUMENTAL, PREPOSITIONAL, and VOCATIVE (_називний, родовий, давальний, знахідний, орудний, місцевий, кличний_).
+
+## Usage example
+
+The most common usage is to convert a name into all cases:
+
+```python
+from lesya import Lesya
+
+person = Lesya('Леся Українка')
+print(person.nominative) # Леся Українка
+print(person.genitive) # Лесі Українки
+print(person.dative) # Лесі Українці
+print(person.accusative) # Лесю Українку
+print(person.instrumental) # Лесею Українкою
+print(person.prepositional) # Лесі Українці
+print(person.vocative) # Лесе Українко
+```
+
+You can also get a name in a specific case:
+
+```python
+from lesya import Lesya
+from lesya import CaseUA
+
+person = Lesya('Тарас Григорович Шевченко')
+print(person[CaseUA.DATIVE]) # Тарасу Григоровичу Шевченку
+print(person[CaseUA.PREPOSITIONAL]) # Тарасові Григоровичу Шевченкові
+print(person['орудний']) # Тарасом Григоровичем Шевченком
+```
+
+## Double names support
+
+Lesya works well with double last names:
+    
+```python
+from lesya import Lesya
+
+person = Lesya('Іван Семенович Нечуй-Левицький')
+print(person.forms)
+# Output:
+{
+    'називний': 'Іван Семенович Нечуй-Левицький', 
+    'родовий': 'Івана Семеновича Нечуя-Левицького', 
+    'давальний': 'Івану Семеновичу Нечуєві-Левицькому', 
+    'знахідний': 'Івана Семеновича Нечуя-Левицького', 
+    'орудний': 'Іваном Семеновичем Нечуєм-Левицьким', 
+    'місцевий': 'Іванові Семеновичу Нечуєві-Левицькому', 
+    'кличний': 'Іване Семеновичу Нечую-Левицький'
+}
+```
+
+## `forms` attribute
+
+You can get all cases at once using the forms attribute. It returns a dictionary where the keys are case names (in lowercase Ukrainian), and the values are the corresponding declined names.
+
+## Foreign names support
+
+Lesya supports foreign names. However, since it does not use an ML model to automatically detect a person's gender, it works better if you explicitly provide the gender:
+
+```python
+from lesya import Lesya
+from lesya import CaseUA
+from lesya import Gender
+
+person = Lesya('Джозеф Байден', gender='male')  
+print(person[CaseUA.DATIVE]) # Джозефу Байдену
+print(person[CaseUA.PREPOSITIONAL]) # Джозефові Байденові
+
+person = Lesya('Камала Гаріс', gender=Gender.FEMALE)
+print(person[CaseUA.DATIVE]) # Камалі Гаріс
+print(person[CaseUA.PREPOSITIONAL]) # Камалі Гаріс
+```

lesya-0.0.1/README.md

@@ -0,0 +1,75 @@
+# Lesya
+
+Lesya is a simple Python package for declining Ukrainian personal names into Ukrainian grammatical cases (_відмінки_): NOMINATIVE, GENITIVE, DATIVE, ACCUSATIVE, INSTRUMENTAL, PREPOSITIONAL, and VOCATIVE (_називний, родовий, давальний, знахідний, орудний, місцевий, кличний_).
+
+## Usage example
+
+The most common usage is to convert a name into all cases:
+
+```python
+from lesya import Lesya
+
+person = Lesya('Леся Українка')
+print(person.nominative) # Леся Українка
+print(person.genitive) # Лесі Українки
+print(person.dative) # Лесі Українці
+print(person.accusative) # Лесю Українку
+print(person.instrumental) # Лесею Українкою
+print(person.prepositional) # Лесі Українці
+print(person.vocative) # Лесе Українко
+```
+
+You can also get a name in a specific case:
+
+```python
+from lesya import Lesya
+from lesya import CaseUA
+
+person = Lesya('Тарас Григорович Шевченко')
+print(person[CaseUA.DATIVE]) # Тарасу Григоровичу Шевченку
+print(person[CaseUA.PREPOSITIONAL]) # Тарасові Григоровичу Шевченкові
+print(person['орудний']) # Тарасом Григоровичем Шевченком
+```
+
+## Double names support
+
+Lesya works well with double last names:
+    
+```python
+from lesya import Lesya
+
+person = Lesya('Іван Семенович Нечуй-Левицький')
+print(person.forms)
+# Output:
+{
+    'називний': 'Іван Семенович Нечуй-Левицький', 
+    'родовий': 'Івана Семеновича Нечуя-Левицького', 
+    'давальний': 'Івану Семеновичу Нечуєві-Левицькому', 
+    'знахідний': 'Івана Семеновича Нечуя-Левицького', 
+    'орудний': 'Іваном Семеновичем Нечуєм-Левицьким', 
+    'місцевий': 'Іванові Семеновичу Нечуєві-Левицькому', 
+    'кличний': 'Іване Семеновичу Нечую-Левицький'
+}
+```
+
+## `forms` attribute
+
+You can get all cases at once using the forms attribute. It returns a dictionary where the keys are case names (in lowercase Ukrainian), and the values are the corresponding declined names.
+
+## Foreign names support
+
+Lesya supports foreign names. However, since it does not use an ML model to automatically detect a person's gender, it works better if you explicitly provide the gender:
+
+```python
+from lesya import Lesya
+from lesya import CaseUA
+from lesya import Gender
+
+person = Lesya('Джозеф Байден', gender='male')  
+print(person[CaseUA.DATIVE]) # Джозефу Байдену
+print(person[CaseUA.PREPOSITIONAL]) # Джозефові Байденові
+
+person = Lesya('Камала Гаріс', gender=Gender.FEMALE)
+print(person[CaseUA.DATIVE]) # Камалі Гаріс
+print(person[CaseUA.PREPOSITIONAL]) # Камалі Гаріс
+```

lesya-0.0.1/lesya/__init__.py

@@ -0,0 +1,3 @@
+from .language.case_helpers import CaseUA
+from .language.case_helpers import Gender
+from .language.name_case import Lesya

lesya-0.0.1/lesya/language/case_helpers.py

@@ -0,0 +1,138 @@
+class Gender:
+    """
+    A class containing constants for gender determination
+    """
+    MALE = 'male'
+    FEMALE = 'female'
+    MAN = 'male'
+    WOMAN = 'female'
+
+
+class CaseUA:
+    """
+    A class containing constants for grammatical cases in Ukrainian
+    """
+    NOMINATIVE = "nominative"  # "Називний відмінок (Nominative)"  # Nominative case
+    GENITIVE = "genitive"  # "Родовий відмінок (Genitive)"  # Genitive case
+    DATIVE = "dative"  # "Давальний відмінок (Dative)"  # Dative case
+    ACCUSATIVE = "accusative"  # "Знахідний відмінок (Accusative)"  # Accusative case
+    INSTRUMENTAL = "instrumental"  # "Орудний відмінок (Instrumental)"  # Instrumental case
+    PREPOSITIONAL = "prepositional"  # "Місцевий відмінок (Prepositional)"  # Prepositional case
+    VOCATIVE = "vocative"  # "Кличний відмінок (Vocative)"  # Vocative case
+
+    @classmethod
+    def __getitem__(cls, number: int):
+        if number in range(7):
+            return {0: cls.NOMINATIVE,
+                    1: cls.GENITIVE,
+                    2: cls.DATIVE,
+                    3: cls.ACCUSATIVE,
+                    4: cls.INSTRUMENTAL,
+                    5: cls.PREPOSITIONAL,
+                    6: cls.VOCATIVE}.get(number)
+        raise TypeError("The number must be in the range from 0 to 6")
+
+    def all(self, lang='en'):
+        if lang == 'en':
+            return [self.NOMINATIVE, self.GENITIVE, self.DATIVE, self.ACCUSATIVE, self.INSTRUMENTAL, self.PREPOSITIONAL,
+                    self.VOCATIVE]
+        elif lang == 'ua':
+            return ['називний', 'родовий', 'давальний', 'знахідний', 'орудний', 'місцевий', 'кличний']
+
+    @staticmethod
+    def count():
+        return 7
+
+    @classmethod
+    def __len__(cls):
+        return cls.count()
+
+
+class NamePart:
+    FIRSTNAME = 'firstname'
+    LASTNAME = 'lastname'
+    PATRONYMIC = 'patronymic'
+
+
+class NCLNameCaseWord:
+    """
+    A class representing a word with additional properties and methods for handling name cases and gender determination.
+    """
+    def __init__(self, word):
+        self.word = word.lower()
+        self.word_orig = word
+        self.name_part = None
+        self.gender_man = 0
+        self.gender_woman = 0
+        self.gender_solved = None
+        # mask to define origin capital and string letters: X, or x
+        self.letter_mask = ''
+        # array of cases for the word
+        self.name_cases = []
+        # self.rule = 0
+        self.create_mask(word)
+
+    def create_mask(self, word):
+        """
+        Generating mask for the word
+        """
+        for letter in word:
+            if letter.isupper():
+                self.letter_mask += 'X'
+            else:
+                self.letter_mask += 'x'
+
+    def return_mask(self):
+        """ Convert the word to the capital / small letter format according to its mask
+        """
+        mask_length = len(self.letter_mask)
+        for i, case in enumerate(self.name_cases):
+            case_length = len(case)
+            max_len = min(case_length, mask_length)
+            new_case = ''
+            for j in range(max_len):
+                letter = case[j]
+                if self.letter_mask[j] == 'X':
+                    letter = letter.upper()
+                new_case += letter
+            new_case += case[max_len:case_length]
+            self.name_cases[i] = new_case
+
+    def set_name_cases(self, name_cases, is_return_mask=True):
+        self.name_cases = name_cases
+        if is_return_mask:
+            self.return_mask()
+
+    def get_name_cases(self):
+        return self.name_cases
+
+    def gender(self):
+        if not self.gender_solved:
+            if self.gender_man >= self.gender_woman:
+                self.gender_solved = Gender.MALE
+            else:
+                self.gender_solved = Gender.FEMALE
+        return self.gender_solved
+
+    def set_gender(self, man, woman):
+        self.gender_man = man
+        self.gender_woman = woman
+
+    def set_true_gender(self, gender):
+        self.gender_solved = gender
+
+    def get_gender(self):
+        return {Gender.MALE: self.gender_man, Gender.FEMALE: self.gender_woman}
+
+    def is_gender_solved(self):
+        return bool(self.gender_solved)
+
+    def __repr__(self):
+        return f'{self.word_orig} - {self.name_cases}'
+
+    def __eq__(self, other):
+        if isinstance(other, str):
+            return self.word_orig == other
+        elif isinstance(other, NCLNameCaseWord):
+            return self.word_orig == other.word_orig
+        return False