sera-2 1.4.9__py3-none-any.whl → 1.5.1__py3-none-any.whl

sera/make/make_python_model.py

@@ -142,7 +142,19 @@ def make_python_data_model(
                 pytype = prop.get_data_model_datatype().get_python_type()
                 if pytype.dep is not None:
                     program.import_(pytype.dep, True)
-                cls_ast(stmt.DefClassVarStatement(prop.name, pytype.type))
+                pytype_type = pytype.type
+                if len(prop.data.constraints) > 0:
+                    # if the property has constraints, we need to figure out
+                    program.import_("typing.Annotated", True)
+                    if len(prop.data.constraints) == 1:
+                        pytype_type = f"Annotated[%s, %s]" % (
+                            pytype_type,
+                            prop.data.constraints[0].get_msgspec_constraint(),
+                        )
+                    else:
+                        raise NotImplementedError(prop.data.constraints)
+
+                cls_ast(stmt.DefClassVarStatement(prop.name, pytype_type))
             elif isinstance(prop, ObjectProperty):
                 if prop.target.db is not None:
                     # if the target class is in the database, we expect the user to pass the foreign key for it.
@@ -568,6 +580,10 @@ def make_python_relational_object_property(
                             "onupdate",
                             expr.ExprConstant(prop.db.on_target_update.to_sqlalchemy()),
                         ),
+                        PredefinedFn.keyword_assignment(
+                            "nullable",
+                            expr.ExprConstant(prop.is_optional),
+                        ),
                     ],
                 ),
             ],
@@ -600,7 +616,7 @@ def make_python_relational_object_property(
                             .datatype.get_sqlalchemy_type()
                             .type
                         ),
-                        expr.PredefinedFn.keyword_assignment(
+                        PredefinedFn.keyword_assignment(
                             "nullable",
                             expr.ExprConstant(prop.is_optional),
                         ),
@@ -614,7 +630,15 @@ def make_python_relational_object_property(
     else:
         assert prop.db.is_embedded == "json"
         # we create a custom field, the custom field mapping need to be defined in the base
-        propval = expr.ExprFuncCall(expr.ExprIdent("mapped_column"), [])
+        propval = expr.ExprFuncCall(
+            expr.ExprIdent("mapped_column"),
+            [
+                PredefinedFn.keyword_assignment(
+                    "nullable",
+                    expr.ExprConstant(prop.is_optional),
+                ),
+            ],
+        )
         custom_types.append(prop)
 
     cls_ast(stmt.DefClassVarStatement(propname, proptype, propval))

sera/make/make_typescript_model.py

@@ -706,7 +706,15 @@ def make_typescript_data_model(schema: Schema, target_pkg: Package):
                     (expr.ExprIdent("datatype"), expr.ExprConstant(tstype.type)),
                     (
                         expr.ExprIdent("isList"),
-                        expr.ExprConstant(prop.datatype.is_list),
+                        expr.ExprConstant(prop.get_data_model_datatype().is_list),
+                    ),
+                    (
+                        expr.ExprIdent("isRequired"),
+                        expr.ExprConstant(
+                            # TODO: fix me.
+                            prop.db is None
+                            or not prop.db.is_nullable
+                        ),
                     ),
                 ]
             else:
@@ -747,6 +755,10 @@ def make_typescript_data_model(schema: Schema, target_pkg: Package):
                         expr.ExprIdent("isEmbedded"),
                         expr.ExprConstant(prop.target.db is not None),
                     ),
+                    (
+                        expr.ExprIdent("isRequired"),
+                        expr.ExprConstant(not prop.is_optional),
+                    ),
                 ]
 
             prop_defs.append(
@@ -761,7 +773,11 @@ def make_typescript_data_model(schema: Schema, target_pkg: Package):
                             ),
                             (
                                 expr.ExprIdent("description"),
-                                expr.ExprConstant(prop.description.to_dict()),
+                                (
+                                    expr.ExprConstant(prop.description.to_dict())
+                                    if not prop.description.is_empty()
+                                    else expr.ExprConstant("undefined")
+                                ),
                             ),
                         ]
                         + tsprop

sera/models/_constraints.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Literal
+
+ConstraintName = Literal["phone_number", "email", "not_empty", "username", "password"]
+
+
+@dataclass
+class Constraint:
+    name: ConstraintName
+    args: tuple
+
+    def get_msgspec_constraint(self) -> str:
+        if self.name == "phone_number":
+            # the UI will ensure to submit it in E.164 format
+            return r"msgspec.Meta(pattern=r'^\+[1-9]\d{1,14}$')"
+        elif self.name == "email":
+            return r"msgspec.Meta(min_length=3, max_length=254, pattern=r'^[^@]+@[^@]+\.[^@]+$')"
+        elif self.name == "not_empty":
+            return "msgspec.Meta(min_length=1)"
+        elif self.name == "username":
+            return (
+                "msgspec.Meta(min_length=3, max_length=32, pattern=r'^[a-zA-Z0-9_]+$')"
+            )
+        elif self.name == "password":
+            return "msgspec.Meta(min_length=8, max_length=32)"
+
+        raise NotImplementedError()
+
+
+predefined_constraints: dict[ConstraintName, Constraint] = {
+    "phone_number": Constraint("phone_number", ()),
+    "email": Constraint("email", ()),
+    "not_empty": Constraint("not_empty", ()),
+    "username": Constraint("username", ()),
+    "password": Constraint("password", ()),
+}

sera/models/_multi_lingual_string.py

@@ -20,6 +20,9 @@ class MultiLingualString(str):
     def has_lang(self, lang: str) -> bool:
         return lang in self.lang2value
 
+    def is_empty(self):
+        return all(value == "" for value in self.lang2value.values())
+
     @staticmethod
     def en(label: str):
         return MultiLingualString(lang2value={"en": label}, lang="en")

sera/models/_parse.py

@@ -7,6 +7,7 @@ from typing import Sequence
 
 import serde.yaml
 from sera.models._class import Class, ClassDBMapInfo, Index
+from sera.models._constraints import Constraint, predefined_constraints
 from sera.models._datatype import (
     DataType,
     predefined_datatypes,
@@ -99,6 +100,9 @@ def _parse_property(
     data_attrs = PropDataAttrs(
         is_private=_data.get("is_private", False),
         datatype=_parse_datatype(_data["datatype"]) if "datatype" in _data else None,
+        constraints=[
+            _parse_constraint(constraint) for constraint in _data.get("constraints", [])
+        ],
     )
 
     assert isinstance(prop, dict), prop
@@ -163,6 +167,12 @@ def _parse_multi_lingual_string(o: dict | str) -> MultiLingualString:
     return MultiLingualString(lang2value=o, lang="en")
 
 
+def _parse_constraint(constraint: str) -> Constraint:
+    if constraint not in predefined_constraints:
+        raise NotImplementedError(constraint)
+    return predefined_constraints[constraint]
+
+
 def _parse_datatype(datatype: dict | str) -> DataType:
     if isinstance(datatype, str):
         if datatype.endswith("[]"):

sera/models/_property.py

@@ -4,6 +4,7 @@ from dataclasses import dataclass, field
 from enum import Enum
 from typing import TYPE_CHECKING, Literal, Optional
 
+from sera.models._constraints import Constraint
 from sera.models._datatype import DataType
 from sera.models._multi_lingual_string import MultiLingualString
 
@@ -66,6 +67,9 @@ class PropDataAttrs:
     # whether this data model has a different data type than the one from the database
     datatype: Optional[DataType] = None
 
+    # list of constraints applied to the data model's field
+    constraints: list[Constraint] = field(default_factory=list)
+
 
 @dataclass(kw_only=True)
 class Property:

{sera_2-1.4.9.dist-info → sera_2-1.5.1.dist-info}/METADATA

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

{sera_2-1.4.9.dist-info → sera_2-1.5.1.dist-info}/RECORD

@@ -8,21 +8,22 @@ sera/make/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sera/make/__main__.py,sha256=EvskvcZ5BikA6c0QyUXMbHfKrjr44W0JTmW_-iXFEGg,1416
 sera/make/make_app.py,sha256=4iXMmyvOSLvUWzZLrXWUg8jnkwOZyDH-AZVwKcQMfLY,5654
 sera/make/make_python_api.py,sha256=RuJUm9z-4plBEtjobeOPr12o27OT-0tSeXI4ZlM3IY0,29433
-sera/make/make_python_model.py,sha256=CHLZuFd15RypLq1EK1j-0pq1BwxX33wshcehcl3EVNI,32164
+sera/make/make_python_model.py,sha256=hKA5xnKsReibfHEsW3pXJgRgxLYZUhVPUKA_gEvdRJM,33150
 sera/make/make_python_services.py,sha256=RsinYZdfkrTlTn9CT50VgqGs9w6IZawsJx-KEmqfnEY,2062
-sera/make/make_typescript_model.py,sha256=ZZZ56-cMfM-4lmRnpRfB3DYZSqu6661lu1WWRFrAt3Y,33305
+sera/make/make_typescript_model.py,sha256=x9OFcKx9oke-T9ZLG-6gSckXZEVvT4MJMA6VBqsdrRY,34013
 sera/misc/__init__.py,sha256=G-vpwJtdS596Yle7W007vArHRwmK0QgGmLhzlqTiHMQ,311
 sera/misc/_utils.py,sha256=V5g4oLGHOhUCR75Kkcn1w01pAvGvaepK-T8Z3pIgHjI,1450
 sera/models/__init__.py,sha256=Kz3Cg7GIVzsM0qFG5ERB5gobLAxBy2SdxItIl73ui2g,759
 sera/models/_class.py,sha256=Wf0e8x6-szG9TzoFkAlqj7_dG0SCICMBw_333n3paxk,2514
 sera/models/_collection.py,sha256=ZnQEriKC4X88Zz48Kn1AVZKH-1_l8OgWa-zf2kcQOOE,1414
+sera/models/_constraints.py,sha256=lZmCh6Py0UVMdhTR7zUOPPzGqJGbmDCzf7xH7yITcbQ,1278
 sera/models/_datatype.py,sha256=uMxK_8wBLowaIMIAYCb3V17YmkzJrKKc5orjImzqWbA,5818
 sera/models/_module.py,sha256=4xZO8Ey4La7JTiCRfU50pYw4V6ssECH6dGIuplodwQY,5215
-sera/models/_multi_lingual_string.py,sha256=cVoxge1SW68dVmOjDZJU93tUq2ccJse3kSPqxrNkmgc,1091
-sera/models/_parse.py,sha256=ne0nI_PLYNiWwwkLJzmVkmv9c60bGjARcNFwkSsdJyA,6910
-sera/models/_property.py,sha256=8q0UZznXLcYdXhcjhu_S8Ey7r3kqT8SFNvkn3GiW-ts,5117
+sera/models/_multi_lingual_string.py,sha256=JETN6k00VH4wrA4w5vAHMEJV8fp3SY9bJebskFTjQLA,1186
+sera/models/_parse.py,sha256=t43g-PpW_Fy1DeN8f1ys6bLVkoT5EngK-hTuDuN2Kac,7301
+sera/models/_property.py,sha256=nRDyptwADR8ZIA-fpLryRY-pHbBAdKv0PwFfJFQ-d8s,5290
 sera/models/_schema.py,sha256=1F_Ict1NLvDcQDUZwcvnRS5MtsOTv584y3ChymUeUYA,1046
 sera/typing.py,sha256=QkzT07FtBwoiX2WHXDUrU1zSPLoRmKJgsXa2kLyLMxU,327
-sera_2-1.4.9.dist-info/METADATA,sha256=4VXNPNaqKyeF5KQ-KO9yRYgfuqJ4ya__TKGtqBtt1-k,856
-sera_2-1.4.9.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-sera_2-1.4.9.dist-info/RECORD,,
+sera_2-1.5.1.dist-info/METADATA,sha256=GkB3rfwqgYfRTIAGo1AOaBdR1TGImkfsN3RNYfF6DjQ,856
+sera_2-1.5.1.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+sera_2-1.5.1.dist-info/RECORD,,