basic logic for adding gettext + babel to json schema generator

Author: phenobarbital

datamodel/base.py

@@ -449,8 +449,39 @@ def sample(cls) -> dict:
             "required": required
         }
 
+    def _get_meta_value(self, key: str, fallback: Any = None, locale: Any = None):
+        value = getattr(self.Meta, key, fallback)
+        if locale is not None:
+            value = locale(value)
+        return value
+
+    def _get_metadata(self, field, key: str, locale: Any = None):
+        value = field.metadata.get(key, None)
+        if locale is not None:
+            value = locale(value)
+        return value
+
+    def _get_field_schema(
+        self,
+        type_info: str,
+        field: object,
+        description: str,
+        locale: Any = None,
+        **kwargs
+    ) -> dict:
+        return {
+            "type": type_info,
+            "nullable": field.metadata.get('nullable', False),
+            "attrs": {
+                "placeholder": description,
+                "format": field.metadata.get('format', None),
+            },
+            "readOnly": field.metadata.get('readonly', False),
+            **kwargs
+        }
+
     @classmethod
-    def schema(cls, as_dict=False):
+    def schema(cls, as_dict=False, locale: Any = None):
         """Convert Model to JSON-Schema.
 
         Args:
@@ -460,27 +491,47 @@ def schema(cls, as_dict=False):
         Returns:
             _type_: JSON-Schema version of Model.
         """
-        title = getattr(cls.Meta, 'title', cls.__name__)
+        # description:
+        description = cls._get_meta_value(
+            cls,
+            'description',
+            fallback=cls.__doc__.strip("\n").strip(),
+            locale=locale
+        )
+        title = cls._get_meta_value(
+            cls,
+            'title',
+            fallback=cls.__name__,
+            locale=locale
+        )
         try:
             title = slugify_camelcase(title)
         except Exception:
             pass
 
+        # Table Name:
+        table = cls.Meta.name.lower() if cls.Meta.name else title.lower()
         endpoint = cls.Meta.endpoint
         schema = cls.Meta.schema
-        table = cls.Meta.name.lower() if cls.Meta.name else title.lower()
         columns = cls.get_columns().items()
-        description = cls.Meta.description or cls.__doc__.strip("\n").strip()
+
         fields = {}
         required = []
         defs = {}
 
         # settings:
-        settings = getattr(cls.Meta, 'settings', {})
-        if settings:
+        settings = cls._get_meta_value(
+            cls,
+            'settings',
+            fallback={},
+            locale=None
+        )
+        try:
             settings = {
                 "settings": settings
             }
+        except TypeError:
+            settings = {}
 
         for name, field in columns:
             _type = field.type
@@ -494,7 +545,6 @@ def schema(cls, as_dict=False):
             minimum = field.metadata.get('min', None)
             maximum = field.metadata.get('max', None)
             secret = field.metadata.get('secret', None)
-
             # custom endpoint for every field:
             custom_endpoint = field.metadata.get('endpoint', None)
 
@@ -507,22 +557,27 @@ def schema(cls, as_dict=False):
             }
             # schema_extra:
             schema_extra = field.metadata.get('schema_extra', {})
-
-            fields[name] = {
-                "type": type_info,
-                "nullable": field.metadata.get('nullable', False),
-                "attrs": {
-                    "placeholder": field.metadata.get('description', None),
-                    "format": field.metadata.get('format', None),
-                },
-                "readOnly": field.metadata.get('readonly', False),
+            meta_description = cls._get_metadata(
+                cls,
+                field,
+                key='description',
+                locale=locale
+            )
+            fields[name] = cls._get_field_schema(
+                cls,
+                type_info,
+                field,
+                description=meta_description,
+                locale=locale,
                 **ui_objects,
                 **schema_extra,
                 **ref_info
-            }
-            label = field.metadata.get('label', None)
+            )
+            label = cls._get_metadata(cls, field, 'label', locale=locale)
             if label:
                 fields[name]["label"] = label
+            if meta_description:
+                fields[name]["description"] = meta_description
             if custom_endpoint:
                 fields[name]["endpoint"] = custom_endpoint
 
@@ -578,7 +633,7 @@ def schema(cls, as_dict=False):
         if defs:
             base_schema["$defs"] = defs
 
-        if as_dict:
+        if as_dict is True:
             return base_schema
         else:
             return json_encoder(base_schema)

datamodel/version.py

@@ -4,7 +4,7 @@
 __title__ = 'python-datamodel'
 __description__ = ('simple library based on python +3.8 to use Dataclass-syntax'
                    'for interacting with Data')
-__version__ = '0.6.27'
+__version__ = '0.6.28'
 __author__ = 'Jesus Lara'
 __author_email__ = '[email protected]'
 __license__ = 'BSD'

examples/json_schema.py

@@ -0,0 +1,55 @@
+import pprint
+from datetime import datetime
+import locale
+from datamodel import BaseModel, Column
+from navigator.ext.locale import LocaleSupport
+from navigator import Application
+
+pp = pprint.PrettyPrinter(width=41, compact=True)
+
+l18n = LocaleSupport(
+    localization=['en_US', 'es_ES', 'es', 'it_IT', 'de_DE', 'fr_FR'],
+    domain='nav'
+)
+app = Application()
+l18n.setup(app)
+
+class Airport(BaseModel):
+    iata: str = Column(
+        primary_key=True, required=True, label="IATA"
+    )
+    airport: str = Column(
+        required=True, label="airport"
+    )
+    city: str = Column(
+        required=False, label="city"
+    )
+    country: str = Column(
+        required=False, label="country"
+    )
+    created_by: int = Column(
+        required=False, label="created_by"
+    )
+    created_at: datetime = Column(
+        default=datetime.now, repr=False, label="created_at"
+    )
+
+    class Meta:
+        name: str = 'airports'
+        description: str = 'airports'
+        title: str = 'airports'
+        schema = 'public'
+        strict = True
+
+localization = 'it_IT'
+locale.setlocale(
+    locale.LC_ALL, f"{localization}.UTF-8"
+)  # set the current localization
+
+trans = l18n.translator(locale=locale, lang=f"{localization}.UTF-8")
+print('LOCALE > ', l18n.current_locale())
+print('T > ', trans)
+d = trans('city')
+print(d)
+schema = Airport.schema(as_dict=True, locale=trans)
+print(schema)

tests/test_qsobject.py

@@ -45,6 +45,7 @@ class QueryObject(ClassDict):
 
 def test_queryobject():
     qry = QueryObject(**data)
+    print('AQUI >> ', qry.fields)
     assert qry.fields == ["store_id", "postpaid_sales", "postpaid_trended", "apd", "postpaid_to_goal", "hours_worked", "hps", "hps_to_goal"]
     fields = qry.pop('fields')
     assert fields == ["store_id", "postpaid_sales", "postpaid_trended", "apd", "postpaid_to_goal", "hours_worked", "hps", "hps_to_goal"]