add base Piccolo & Encode ORM models

Author: xnuinside

.pre-commit-config.yaml

@@ -1,12 +1,4 @@
 repos:
--   repo: https://github.com/asottile/seed-isort-config
-    rev: v2.2.0
-    hooks:
-    - id: seed-isort-config
--   repo: https://github.com/pycqa/isort
-    rev: 5.4.2
-    hooks:
-      - id: isort
 -   repo: https://github.com/ambv/black
     rev: stable
     hooks:

CHANGELOG.txt

@@ -1,3 +1,9 @@
+**v0.6.0**
+Features:
+1. Added support for Encode ORM models https://github.com/encode/orm
+2. Added support for Piccolo ORM models https://piccolo-orm.readthedocs.io/en/latest/piccolo/schema/defining.html
+
+
 **v0.5.1**
 Fixes:
 1. Sometimes multiple parents names in "parents" output was joined in one string - fixed.

README.md

@@ -9,10 +9,12 @@ Py-Models-Parser can parse & extract information from models & table definitions
 - Sqlalchemy ORM (https://docs.sqlalchemy.org/en/14/orm/),
 - Gino ORM (https://python-gino.org/),
 - Tortoise ORM (https://tortoise-orm.readthedocs.io/en/latest/),
+- Encode ORM (https://github.com/encode/orm)
 - Django ORM Model (https://docs.djangoproject.com/en/3.2/topics/db/queries/),
 - Pydantic (https://pydantic-docs.helpmanual.io/),
 - Python Enum (https://docs.python.org/3/library/enum.html),
 - Pony ORM (https://ponyorm.org/),
+- Piccolo ORM models (https://piccolo-orm.readthedocs.io/en/latest/piccolo/schema/defining.html),
 - Pydal Tables definitions (http://www.web2py.com/books/default/chapter/29/06/the-database-abstraction-layer#The-DAL-A-quick-tour),
 - Python Dataclasses (https://docs.python.org/3/library/dataclasses.html),
 - pure Python Classes (https://docs.python.org/3/tutorial/classes.html#class-objects)
@@ -171,12 +173,17 @@ For model from point 1 (above) library will produce the result:
 
 ## TODO: in next Release
 
-1. Add more tests for supported models (and fix existed not covered cases): Django ORM, Pydantic, Enums, Dataclasses, SQLAlchemy Models, GinoORM models, TortoiseORM models, PonyORM, for lists
+1. Add more tests for supported models
 2. Add support for SQLAlchemy Core Tables
-3. Add support for Piccolo ORM models
 
 
 ## Changelog
+**v0.6.0**
+Features:
+1. Added support for Encode ORM models https://github.com/encode/orm
+2. Added support for Piccolo ORM models https://piccolo-orm.readthedocs.io/en/latest/piccolo/schema/defining.html
+
+
 **v0.5.1**
 Fixes:
 1. Sometimes multiple parents names in "parents" output was joined in one string - fixed.

docs/README.rst

@@ -28,10 +28,12 @@ Py-Models-Parser can parse & extract information from models & table definitions
 * Sqlalchemy ORM (https://docs.sqlalchemy.org/en/14/orm/),
 * Gino ORM (https://python-gino.org/),
 * Tortoise ORM (https://tortoise-orm.readthedocs.io/en/latest/),
+* Encode ORM (https://github.com/encode/orm)
 * Django ORM Model (https://docs.djangoproject.com/en/3.2/topics/db/queries/),
 * Pydantic (https://pydantic-docs.helpmanual.io/),
 * Python Enum (https://docs.python.org/3/library/enum.html),
 * Pony ORM (https://ponyorm.org/),
+* Piccolo ORM models (https://piccolo-orm.readthedocs.io/en/latest/piccolo/schema/defining.html),
 * Pydal Tables definitions (http://www.web2py.com/books/default/chapter/29/06/the-database-abstraction-layer#The-DAL-A-quick-tour),
 * Python Dataclasses (https://docs.python.org/3/library/dataclasses.html),
 * pure Python Classes (https://docs.python.org/3/tutorial/classes.html#class-objects)
@@ -194,13 +196,19 @@ TODO: in next Release
 ---------------------
 
 
-#. Add more tests for supported models (and fix existed not covered cases): Django ORM, Pydantic, Enums, Dataclasses, SQLAlchemy Models, GinoORM models, TortoiseORM models, PonyORM, for lists
+#. Add more tests for supported models
 #. Add support for SQLAlchemy Core Tables
-#. Add support for Piccolo ORM models
 
 Changelog
 ---------
 
+**v0.6.0**
+Features:
+
+
+#. Added support for Encode ORM models https://github.com/encode/orm
+#. Added support for Piccolo ORM models https://piccolo-orm.readthedocs.io/en/latest/piccolo/schema/defining.html
+
 **v0.5.1**
 Fixes:
 

py_models_parser/core.py

@@ -62,10 +62,58 @@ def output(input: str):
     return output
 
 
+def process_models_attr(model: Dict, models_by_name: Dict) -> Dict:
+    for attr in model["attrs"]:
+        if (
+            attr.get("properties")
+            and attr["properties"].get("foreign_key")
+            and not attr["properties"].get("through")
+        ):
+            split_type = attr["type"].split(".")
+            target_model = models_by_name.get(split_type[0])
+            if target_model:
+                key = [
+                    attr
+                    for attr in target_model["attrs"]
+                    if attr["name"] == split_type[1]
+                ]
+                if not key:
+                    _type = "serial"
+                else:
+                    _type = key[0]["type"]
+                attr["type"] = _type
+    return model
+
+
+def clear_parents(model: Dict) -> Dict:
+
+    parents = []
+
+    for parent in model["parents"]:
+        if "tablename" in parent:
+            name = parent.split("=")
+            model["properties"]["table_name"] = name[1]
+            continue
+        parents.append(parent)
+
+    model["parents"] = parents
+
+    return model
+
+
+def format_ouput(output: List[Dict]):
+    models_by_name = {model["name"]: model for model in output}
+    for model in output:
+        model = process_models_attr(model, models_by_name)
+        model = clear_parents(model)
+    return output
+
+
 def parse(models: str) -> List[Dict]:
     models = pre_processing(models)
     result = grammar.parse(models)
     result = output(result)
+    result = format_ouput(result)
     return result
 
 

py_models_parser/grammar.py

@@ -2,8 +2,9 @@
 
 grammar = Grammar(
     r"""
-    expr = (class / if_else/ call_result / return / attr_def / emptyline / funct_def)*
+    expr = (class / if_else/ call_result / return / comments / attr_def / emptyline / funct_def)*
     return = "return" (id* ","*)*
+    comments = "\#" (text / list)
     if_else= ("if" (compare/ id / attr_def) ":")/("elif" (id/attr_def) ":")/("else" ":")
     compare = (call_result / id / args /args_in_brackets  ) operator (call_result/id/args_in_brackets/args)
     operator = "==" / "!=" / ">" / "<" / ">=" / "<="

py_models_parser/visitor.py

@@ -3,6 +3,11 @@
 from parsimonious.nodes import NodeVisitor
 
 from py_models_parser.parsers.pydal import process_pydal_table_definition
+from py_models_parser.types import (
+    orm_triggers,
+    ormar_and_piccollo_types,
+    pony_orm_fields,
+)
 
 
 class Visitor(NodeVisitor):
@@ -46,30 +51,26 @@ def clean_up_cases_with_inner_pars(text: str) -> str:
                 pass
         return text
 
+    def ormar_and_piccollo_info(
+        self, text: List[str], i: str, properties: Dict
+    ) -> Tuple[str, Dict]:
+        default = None
+        _type = i
+        for text_str in text:
+            data = text_str.split("=")
+            if len(data) == 2:
+                if data[0] == "default":
+                    default = data[1].strip()
+                else:
+                    properties[data[0].strip()] = data[1].strip()
+        return _type, properties, default
+
     def extract_orm_attr(self, text: str):
         _type = None
         default = None
         not_orm = True
         properties = {}
-        orm_triggers = ["Column", "Field", "relationship", "ForeignKey"]
-        pony_orm_fields = ["Required", "Set", "Optional", "PrimaryKey"]
-        ormar_types = [
-            "Integer",
-            "String",
-            "Text",
-            "Boolean",
-            "BigInteger",
-            "SmallInteger",
-            "Float",
-            "Decimal",
-            "Date",
-            "Time",
-            "JSON",
-            "DateTime",
-            "LargeBinary",
-        ]
-        orm_triggers.extend(pony_orm_fields)
-        orm_triggers.extend(ormar_types)
+
         for i in orm_triggers:
             if i in text:
                 not_orm = False
@@ -85,11 +86,15 @@ def extract_orm_attr(self, text: str):
                     prop_index = 0
                 elif i == "ForeignKey":
                     # mean it is a Django model.ForeignKey
-                    _type = "serial"
+                    _type = f"{text[0]}.id"
                     properties["foreign_key"] = text[0]
                 elif i in pony_orm_fields:
                     # mean it is a Pony ORM
                     _type, properties = get_pony_orm_info(text, i, properties)
+                elif i in ormar_and_piccollo_types:
+                    _type, properties, default = self.ormar_and_piccollo_info(
+                        text, i, properties
+                    )
                 else:
                     _type = text[0]
                 if i == "relationship":
@@ -169,6 +174,8 @@ def _process_attr(attr: Dict, final_item: Dict) -> Dict:
             final_item["properties"]["init"] = []
         elif "tablename" in attr["name"]:
             final_item["properties"]["table_name"] = attr["default"]
+        elif attr["name"] in ["__database__", "__metadata__"]:
+            final_item["properties"][attr["name"]] = attr["default"]
         elif "table_args" in attr["name"]:
             final_item["properties"][attr["name"]] = attr["type"] or attr["default"]
         else:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "py-models-parser"
-version = "0.5.1"
+version = "0.6.0"
 description = "Parser for Different Python Models (Pydantic, Enums, ORMs: Tortoise, SqlAlchemy, GinoORM, PonyORM, Pydal tables) to extract information about columns(attrs), model, table args,etc in one format."
 authors = ["Iuliia Volkova <xnuinside@gmail.com>"]
 license = "MIT"