support for ui:* attributes in models for JSON-schema export

Author: phenobarbital

datamodel/base.py

@@ -431,6 +431,13 @@ def schema(cls, as_dict=False):
             if field.metadata.get('required', False):
                 required.append(name)
 
+            # UI objects:
+            ui_objects = {
+                k.replace('_', ':'): v for k, v in field.metadata.items() if k.startswith('ui_')
+            }
+            # schema_extra:
+            schema_extra = field.metadata.get('schema_extra', {})
+
             fields[name] = {
                 "type": type_info,
                 "nullable": field.metadata.get('nullable', False),
@@ -440,7 +447,9 @@ def schema(cls, as_dict=False):
                     "format": field.metadata.get('format', None),
                 },
                 "readOnly": field.metadata.get('readonly', False),
-                "writeOnly": False
+                "writeOnly": False,
+                **ui_objects,
+                **schema_extra
             }
 
             if 'pattern' in field.metadata:

datamodel/fields.pyx

@@ -157,8 +157,8 @@ class Field(ff):
         # args["metadata"] = self._meta
         self.metadata = (
             _EMPTY_METADATA
-            if metadata is None else
-            MappingProxyType(metadata)
+            if self._meta is None else
+            MappingProxyType(self._meta)
         )
         self.default_factory = MISSING
         if default is None:

datamodel/version.py

@@ -1,9 +1,9 @@
-"""AsyncDB Meta information."""
+"""DataModel Meta information."""
 
 __title__ = 'python-datamodel'
 __description__ = ('simple library based on python +3.8 to use Dataclass-syntax'
                    'for interacting with Data')
-__version__ = '0.6.4'
+__version__ = '0.6.5'
 __author__ = 'Jesus Lara'
 __author_email__ = '[email protected]'
 __license__ = 'BSD'

examples/schema.py

@@ -26,7 +26,9 @@ class User(BaseModel):
     first_name: Text = Column(required=True, max=254, label="First Name", pattern="^\w*$")
     last_name: str = Column(required=True, max=254, label="Last Name")
     email: str = Column(required=False, max=254, label="User's Email")
-    password: str = Column(required=False, max=16, secret=True, widget='/properties/password')
+    password: str = Column(
+        required=False, max=16, secret=True, ui_widget='/properties/password'
+    )
     last_login: datetime = Column(required=False, format='YYYY-MM-DD', readonly=True)
     username: str = Column(required=False)
     user_type: UserType = Column(required=False)
@@ -37,7 +39,7 @@ class User(BaseModel):
     title: str = Column(equired=False, max=90)
     registration_key: str = Column(equired=False, max=512, repr=False, readonly=True)
     reset_pwd_key: str = Column(equired=False, max=512, repr=False, readonly=True)
-    avatar: Text = Column(max=512, repr=False)
+    avatar: Text = Column(max=512, repr=False, ui_widget='ImageUploader', ui_help='User Avatar, Hint: please upload a PNG file.')
     associate_id: str = Column(required=False, repr=False)
     group_id: list[int] = Column(required=False)
     groups: list = Column(required=False)