sera-2 1.5.4__tar.gz → 1.6.0__tar.gz

{sera_2-1.5.4 → sera_2-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sera-2
-Version: 1.5.4
+Version: 1.6.0
 Summary: 
 Author: Binh Vu
 Author-email: bvu687@gmail.com

{sera_2-1.5.4 → sera_2-1.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sera-2"
-version = "1.5.4"
+version = "1.6.0"
 description = ""
 authors = ["Binh Vu <bvu687@gmail.com>"]
 readme = "README.md"

{sera_2-1.5.4 → sera_2-1.6.0}/sera/make/make_app.py

@@ -10,6 +10,7 @@ from loguru import logger
 from sera.make.make_python_api import make_python_api
 from sera.make.make_python_model import (
     make_python_data_model,
+    make_python_enums,
     make_python_relational_model,
 )
 from sera.make.make_python_services import make_python_service_structure
@@ -121,7 +122,7 @@ def make_app(
         ),
     ] = [],
 ):
-    schema = parse_schema(schema_files)
+    schema = parse_schema(app_dir.name, schema_files)
 
     app = App(app_dir.name, app_dir, schema_files, language)
 
@@ -137,6 +138,8 @@ def make_app(
             + parts[1]
             for path in referenced_schema
         }
+
+        make_python_enums(schema, app.models.pkg("enums"), referenced_classes)
         make_python_data_model(schema, app.models.pkg("data"), referenced_classes)
         referenced_classes = {
             path.rsplit(".", 1)[1]: (parts := path.rsplit(".", 1))[0]

{sera_2-1.5.4 → sera_2-1.6.0}/sera/make/make_python_model.py

@@ -21,6 +21,53 @@ from sera.models import (
 from sera.typing import ObjectPath
 
 
+def make_python_enums(
+    schema: Schema,
+    target_pkg: Package,
+    reference_objects: dict[str, ObjectPath],
+):
+    """Make enums defined in the schema.
+
+    Args:
+        schema: The schema to generate the classes from.
+        target_pkg: The package to write the enums to.
+        reference_objects: A dictionary of objects to their references (e.g., the ones that are defined outside and used as referenced such as Tenant).
+    """
+    for enum in schema.enums.values():
+        if enum.name in reference_objects:
+            # skip enums that are defined in different apps
+            continue
+
+        program = Program()
+        program.import_("__future__.annotations", True)
+        program.import_("enum.Enum", True)
+
+        enum_values = []
+        for value in enum.values.values():
+            enum_values.append(
+                stmt.DefClassVarStatement(
+                    name=value.name,
+                    type=None,
+                    value=expr.ExprConstant(value.value),
+                )
+            )
+
+        program.root(
+            stmt.LineBreak(),
+            lambda ast: ast.class_(
+                enum.name,
+                (
+                    [expr.ExprIdent("str")]
+                    if enum.is_str_enum()
+                    else [expr.ExprIdent("int")]
+                )
+                + [expr.ExprIdent("Enum")],
+            )(*enum_values),
+        )
+
+        target_pkg.module(enum.get_pymodule_name()).write(program)
+
+
 def make_python_data_model(
     schema: Schema, target_pkg: Package, reference_classes: dict[str, ObjectPath]
 ):
@@ -158,7 +205,7 @@ def make_python_data_model(
                 if prop.default_value is not None:
                     prop_default_value = expr.ExprConstant(prop.default_value)
                 elif prop.default_factory is not None:
-                    program.import_(prop.default_factory.pyfunc)
+                    program.import_(prop.default_factory.pyfunc, True)
                     prop_default_value = expr.ExprFuncCall(
                         expr.ExprIdent("msgspec.field"),
                         [

sera_2-1.6.0/sera/models/_enum.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+from collections import Counter
+from dataclasses import dataclass
+
+from sera.misc import to_snake_case
+from sera.models._multi_lingual_string import MultiLingualString
+
+
+@dataclass
+class EnumValue:
+    name: str
+    value: str | int
+    description: MultiLingualString
+
+
+@dataclass
+class Enum:
+    """Enum class to represent a set of named values."""
+
+    # name of the enum in the application layer
+    name: str
+    values: dict[str, EnumValue]
+
+    def __post_init__(self):
+        # Ensure that all `value` attributes in EnumValue are unique
+        unique_values = {value.value for value in self.values.values()}
+        if len(unique_values) != len(self.values):
+            value_counts = Counter(value.value for value in self.values.values())
+            duplicates = [val for val, count in value_counts.items() if count > 1]
+            raise ValueError(
+                f"All 'value' attributes in EnumValue must be unique. Duplicates found: {duplicates}"
+            )
+
+        # Ensure that all `value` attributes in EnumValue are either all strings or all integers
+        if not (self.is_str_enum() or self.is_int_enum()):
+            raise ValueError(
+                "All 'value' attributes in EnumValue must be either all strings or all integers."
+            )
+
+    def get_pymodule_name(self) -> str:
+        """Get the python module name of this class as if there is a python module created to store this class only."""
+        return to_snake_case(self.name)
+
+    def is_str_enum(self) -> bool:
+        """Check if this enum is a string enum."""
+        return all(isinstance(value.value, str) for value in self.values.values())
+
+    def is_int_enum(self) -> bool:
+        """Check if this enum is a int enum."""
+        return all(isinstance(value.value, int) for value in self.values.values())

{sera_2-1.5.4 → sera_2-1.6.0}/sera/models/_parse.py

@@ -10,12 +10,16 @@ from sera.models._class import Class, ClassDBMapInfo, Index
 from sera.models._constraints import Constraint, predefined_constraints
 from sera.models._datatype import (
     DataType,
+    PyTypeWithDep,
+    SQLTypeWithDep,
+    TsTypeWithDep,
     predefined_datatypes,
     predefined_py_datatypes,
     predefined_sql_datatypes,
     predefined_ts_datatypes,
 )
 from sera.models._default import DefaultFactory
+from sera.models._enum import Enum, EnumValue
 from sera.models._multi_lingual_string import MultiLingualString
 from sera.models._property import (
     Cardinality,
@@ -30,13 +34,16 @@ from sera.models._property import (
 from sera.models._schema import Schema
 
 
-def parse_schema(files: Sequence[Path | str]) -> Schema:
-    schema = Schema(classes={})
+def parse_schema(name: str, files: Sequence[Path | str]) -> Schema:
+    schema = Schema(name=name, classes={}, enums={})
 
     # parse all classes
     raw_defs = {}
     for file in files:
         for k, v in serde.yaml.deser(file).items():
+            if k.startswith("enum:"):
+                schema.enums[k[5:]] = _parse_enum(schema, k[5:], v)
+                continue
             cdef = _parse_class_without_prop(schema, k, v)
             assert k not in schema.classes
             schema.classes[k] = cdef
@@ -45,7 +52,6 @@ def parse_schema(files: Sequence[Path | str]) -> Schema:
     # now parse properties of the classes
     for clsname, v in raw_defs.items():
         cdef = schema.classes[clsname]
-
         for propname, prop in (v["props"] or {}).items():
             assert propname not in cdef.properties
             cdef.properties[propname] = _parse_property(schema, propname, prop)
@@ -75,6 +81,22 @@ def _parse_class_without_prop(schema: Schema, clsname: str, cls: dict) -> Class:
     )
 
 
+def _parse_enum(schema: Schema, enum_name: str, enum: dict) -> Enum:
+    values = {}
+    for k, v in enum.items():
+        if isinstance(v, (str, int)):
+            values[k] = EnumValue(
+                name=k, value=v, description=MultiLingualString.en("")
+            )
+        else:
+            values[k] = EnumValue(
+                name=k,
+                value=v["value"],
+                description=_parse_multi_lingual_string(v.get("desc", "")),
+            )
+    return Enum(name=enum_name, values=values)
+
+
 def _parse_property(
     schema: Schema, prop_name: str, prop: dict
 ) -> DataProperty | ObjectProperty:
@@ -93,14 +115,16 @@ def _parse_property(
                 name=prop_name,
                 label=_parse_multi_lingual_string(prop_name),
                 description=_parse_multi_lingual_string(""),
-                datatype=_parse_datatype(datatype),
+                datatype=_parse_datatype(schema, datatype),
             )
 
     db = prop.get("db", {})
     _data = prop.get("data", {})
     data_attrs = PropDataAttrs(
         is_private=_data.get("is_private", False),
-        datatype=_parse_datatype(_data["datatype"]) if "datatype" in _data else None,
+        datatype=(
+            _parse_datatype(schema, _data["datatype"]) if "datatype" in _data else None
+        ),
         constraints=[
             _parse_constraint(constraint) for constraint in _data.get("constraints", [])
         ],
@@ -112,7 +136,7 @@ def _parse_property(
             name=prop_name,
             label=_parse_multi_lingual_string(prop.get("label", prop_name)),
             description=_parse_multi_lingual_string(prop.get("desc", "")),
-            datatype=_parse_datatype(prop["datatype"]),
+            datatype=_parse_datatype(schema, prop["datatype"]),
             data=data_attrs,
             db=(
                 DataPropDBInfo(
@@ -176,7 +200,7 @@ def _parse_constraint(constraint: str) -> Constraint:
     return predefined_constraints[constraint]
 
 
-def _parse_datatype(datatype: dict | str) -> DataType:
+def _parse_datatype(schema: Schema, datatype: dict | str) -> DataType:
     if isinstance(datatype, str):
         if datatype.endswith("[]"):
             datatype = datatype[:-2]
@@ -184,6 +208,25 @@ def _parse_datatype(datatype: dict | str) -> DataType:
         else:
             is_list = False
 
+        if datatype.startswith("enum:"):
+            enum_name = datatype[5:]
+            if enum_name not in schema.enums:
+                raise NotImplementedError("Unknown enum: " + enum_name)
+            enum = schema.enums[enum_name]
+            return DataType(
+                # we can't set the correct dependency of this enum type because we do not know
+                # the correct package yet.
+                pytype=PyTypeWithDep(
+                    type=enum.name,
+                    dep=f"{schema.name}.models.enums.{enum.get_pymodule_name()}.{enum.name}",
+                ),
+                sqltype=SQLTypeWithDep(
+                    type="String", mapped_pytype="str", deps=["sqlalchemy.String"]
+                ),
+                tstype=TsTypeWithDep(type=enum.name, dep="@/models/enums"),
+                is_list=is_list,
+            )
+
         if datatype not in predefined_datatypes:
             raise NotImplementedError(datatype)
 
@@ -228,7 +271,7 @@ def _parse_default_value(
     return default_value
 
 
-def _parse_default_factory(default_factory: str | None) -> str | None:
+def _parse_default_factory(default_factory: dict | None) -> DefaultFactory | None:
     if default_factory is None:
         return None
     return DefaultFactory(

{sera_2-1.5.4 → sera_2-1.6.0}/sera/models/_schema.py

@@ -4,12 +4,16 @@ from dataclasses import dataclass
 from graphlib import TopologicalSorter
 
 from sera.models._class import Class
+from sera.models._enum import Enum
 from sera.models._property import ObjectProperty
 
 
 @dataclass
 class Schema:
+    # top-level application name
+    name: str
     classes: dict[str, Class]
+    enums: dict[str, Enum]
 
     def topological_sort(self) -> list[Class]:
         """