Added: separate script for yaml constructors (#150)

Author: signebedi

libreforms_fastapi/utils/custom_yaml.py

@@ -0,0 +1,52 @@
+from datetime import datetime, date, time, timedelta
+
+
+def get_yaml_constructors(**kwargs):
+    """
+    This factory is used to build a dictionary of built-in and custom constructors that
+    will be used in building the internal, dictionary representation of the form config.
+    """
+
+    # Default constructors for returning Python types
+    def type_constructor_int(loader, node):
+        return int
+
+    def type_constructor_str(loader, node):
+        return str
+
+    def type_constructor_date(loader, node):
+        return date
+
+    def type_constructor_datetime(loader, node):
+        return datetime
+
+    def type_constructor_time(loader, node):
+        return time
+
+    def type_constructor_timedelta(loader, node):
+        return timedelta
+
+    def type_constructor_list(loader, node):
+        return list
+
+    def type_constructor_tuple(loader, node):
+        return tuple
+
+    def type_constructor_bytes(loader, node):
+        return bytes
+
+    # We create a constructor mapping that we'll use later to 
+    # register the constructors.
+    constructor_mapping = {
+        '!int': type_constructor_int,
+        '!str': type_constructor_str,
+        '!date': type_constructor_date,
+        '!type_datetime': type_constructor_datetime,
+        '!type_time': type_constructor_time,
+        '!type_timedelta': type_constructor_time,
+        '!list': type_constructor_list,
+        '!tuple': type_constructor_list,
+        '!bytes': type_constructor_bytes,
+        **kwargs,
+    }
+    return constructor_mapping

libreforms_fastapi/utils/pydantic_models.py

@@ -18,6 +18,11 @@
 
 from pydantic.functional_validators import field_validator, model_validator
 
+# We externalize the custom yaml constructors to create an easier entrypoint 
+# to manage both default custom constructors, as well as end-user logic, see
+# https://github.com/signebedi/libreforms-fastapi/issues/150
+from libreforms_fastapi.utils.custom_yaml import get_yaml_constructors
+
 class ImproperUsernameFormat(Exception):
     """Raised when the username does not meet the regular expression defined in the app config"""
     pass
@@ -276,56 +281,6 @@ def password_pattern(cls, value):
     description: This is a file field
 """
 
-def get_yaml_constructors(**kwargs):
-    """
-    This factory is used to build a dictionary of built-in and custom constructors that
-    will be used in building the internal, dictionary representation of the form config.
-    """
-
-    # Default constructors for returning Python types
-    def type_constructor_int(loader, node):
-        return int
-
-    def type_constructor_str(loader, node):
-        return str
-
-    def type_constructor_date(loader, node):
-        return date
-
-    def type_constructor_datetime(loader, node):
-        return datetime
-
-    def type_constructor_time(loader, node):
-        return time
-
-    def type_constructor_timedelta(loader, node):
-        return timedelta
-
-    def type_constructor_list(loader, node):
-        return list
-
-    def type_constructor_tuple(loader, node):
-        return tuple
-
-    def type_constructor_bytes(loader, node):
-        return bytes
-
-    # We create a constructor mapping that we'll use later to 
-    # register the constructors.
-    constructor_mapping = {
-        '!int': type_constructor_int,
-        '!str': type_constructor_str,
-        '!date': type_constructor_date,
-        '!type_datetime': type_constructor_datetime,
-        '!type_time': type_constructor_time,
-        '!type_timedelta': type_constructor_time,
-        '!list': type_constructor_list,
-        '!tuple': type_constructor_list,
-        '!bytes': type_constructor_bytes,
-        **kwargs,
-    }
-    return constructor_mapping
-
 # Register the type constructors
 for key, value in get_yaml_constructors().items():
     yaml.add_constructor(key, value)