[ENH] A dirty minor update: functions from petrovich-java copied yet not fully adapted

Author: alexeyev

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Petrovich Developers
+
+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.

README.md

@@ -1,20 +1,31 @@
-The MIT License (MIT)
-
-Copyright (c) 
-
-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.
+![Petrovich](petrovich.png) pytrovich
+==========================================
+
+__pytrovich__ is a library which inflects Russian names to given grammatical case. It supports first names, last names and middle names inflections.
+
+__pytrovich__ is a Python implementation of Petrovich ruby gem (petrovich-ruby -> petrovich-java -> pytrovich).
+
+## Usage
+
+```python
+maker = PetrovichDeclinationMaker.getInstance();
+
+maker.make(NamePart.FIRSTNAME, Gender.MALE, Case.GENITIVE, "Иван");     //Ивана
+maker.make(NamePart.LASTNAME, Gender.MALE, Case.INSTRUMENTAL, "Иванов");   //Ивановым
+maker.make(NamePart.MIDDLENAME, Gender.FEMALE, Case.DATIVE, "Ивановна");   //Ивановне
+```
+
+### Custom rule file
+
+You can replace default rules file with some custom one. Only JSON format supported by now.
+```python
+PetrovichDeclinationMaker maker = PetrovichDeclinationMaker.getInstance("/path/to/custom/rules.file.json");
+```
+
+### Accuracy
+
+You can read about accuracy statistics in [petrovich-ruby](https://github.com/petrovich/petrovich-ruby#Оценка-аккуратности) project front page
+
+### License
+
+This project is available under MIT license.

petrovich.png

@@ -9,5 +9,5 @@
 authors_string = ', '.join(authors)
 emails = ['[email protected]']
 license = 'MIT'
-copyright = '2017 ' + authors_string
-url = 'https://github.com/petrovich/pytrovich'
+copyright = '2020 ' + authors_string
+url = 'https://github.com/alexeyev/pytrovich'

pytrovich/__main__.py

@@ -3,27 +3,73 @@
 
 class Rule(object):
 
-    def __init__(self, gender, mods, test):
+    def __init__(self, gender: str, mods: list, test: list):
+        """
+            :param gender: grammatical gender
+            :param mods: modifications rules list
+            :param test: search rules list
+        """
         self.gender = gender
         self.mods = mods
         self.test = test
 
+    def serialize(self):
+        return {"gender": self.gender,
+                "mods": self.mods,
+                "test": self.test}
+
+    @staticmethod
+    def parse(o: dict):
+        return Rule(gender=o["gender"], mods=o["mods"], test=o["test"])
+
 
 class Name(object):
 
-    def __init__(self, exceptions, suffixes):
+    def __init__(self, exceptions: list, suffixes: list):
         """
-        :param exceptions: list(Rule):
-        :param suffixes: list(Rule)
+            :param exceptions: list(Rule):
+            :param suffixes: list(Rule)
         """
         self.exceptions = exceptions
         self.suffixes = suffixes
 
+    def serialize(self):
+        return {"exceptions": [e.serialize() for e in self.exceptions],
+                "suffixes": [s.serialize() for s in self.suffixes]}
+
+    @staticmethod
+    def parse(o: dict):
+        return Name(exceptions=[Rule.parse(e) for e in o["exceptions"]],
+                    suffixes=[Rule.parse(s) for s in o["suffixes"]])
+
 
 class Root(object):
 
     def __init__(self, firstname, lastname, middlename):
-
         self.firstname = firstname
         self.lastname = lastname
-        self. middlename = middlename
+        self.middlename = middlename
+
+    def serialize(self):
+        return {"firstname": self.firstname.serialize(),
+                "lastname": self.lastname.serialize(),
+                "middlename": self.middlename.serialize()}
+
+    @staticmethod
+    def parse(a: dict):
+        # a = json.loads(s)
+        return Root(firstname=Name.parse(a["firstname"]),
+                    lastname=Name.parse(a["lastname"]),
+                    middlename=Name.parse(a["middlename"]))
+
+
+if __name__ == "__main__":
+    import json
+
+    r = Rule("gender", ["a", "b", "c"], ["d", "e", "f"])
+
+    # print(jsonpickle.encode(r))
+    # a = json.loads(jsonpickle.encode(r))
+    # a.pop("py/object", None)
+    # print(a)
+    # print(jsonpickle.decode(json.dumps(a), classes=[Rule]))