Merge pull request #157 from jverswijver/update_forms

Update forms to enable presets

Author: guzman-raphael

CHANGELOG.md

@@ -2,13 +2,13 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
-## [0.8.1] - TBD
+## [0.8.1] - 2023-03-20
 
 ### Added
 - Api endpoint `/spec` which returns the spec for the current dynamic routes [#156](https://github.com/datajoint/pharus/pull/156)
+- Support for presets in Dynamic forms [#157](https://github.com/datajoint/pharus/pull/157)
 
 ### Bugfix
-
 - Added print statement to let user know if their component override has gone through [#156](https://github.com/datajoint/pharus/pull/156)
 
 ## [0.8.0] - 2023-02-06
@@ -275,6 +275,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 - Support for DataJoint attribute types: `varchar`, `int`, `float`, `datetime`, `date`, `time`, `decimal`, `uuid`.
 - Check dependency utility to determine child table references.
 
+[0.8.1]: https://github.com/datajoint/pharus/compare/0.8.0...0.8.1
 [0.8.0]: https://github.com/datajoint/pharus/compare/0.7.3...0.8.0
 [0.7.3]: https://github.com/datajoint/pharus/compare/0.7.2...0.7.3
 [0.7.2]: https://github.com/datajoint/pharus/compare/0.7.1...0.7.2

pharus/component_interface.py

@@ -207,11 +207,14 @@ def dj_query_route(self):
 class InsertComponent(Component):
     rest_verb = ["POST", "GET"]
     fields_route_format = "{route}/fields"
+    presets_route_format = "{route}/presets"
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        component_config = kwargs.get("component_config", args[1] if args else None)
-        self.fields_map = component_config.get("map")
+        self.component_config = kwargs.get(
+            "component_config", args[1] if args else None
+        )
+        self.fields_map = self.component_config.get("map")
         self.tables = [
             getattr(
                 dj.VirtualModule(
@@ -222,7 +225,8 @@ def __init__(self, *args, **kwargs):
                 t,
             )
             for s, t in (
-                _.format(**request.args).split(".") for _ in component_config["tables"]
+                _.format(**request.args).split(".")
+                for _ in self.component_config["tables"]
             )
         ]
         self.parents = sorted(
@@ -243,6 +247,24 @@ def __init__(self, *args, **kwargs):
         }
         self.input_lookup = {v: k for k, v in self.destination_lookup.items()}
 
+        if "presets" in self.component_config:
+            lcls = locals()
+            exec(self.component_config["presets"], globals(), lcls)
+            self.presets = lcls["presets"]
+
+            self.preset_vm_list = [
+                dj.VirtualModule(
+                    s,
+                    s.replace("__", "-"),
+                    connection=self.connection,
+                )
+                for s in inspect.getfullargspec(self.presets).args
+            ]
+
+    @property
+    def presets_dict(self):
+        return self.presets(*self.preset_vm_list)
+
     def dj_query_route(self):
         with self.connection.transaction:
             for t in self.tables:
@@ -315,6 +337,45 @@ def fields_route(self):
             + list(source_fields.values())
         )
 
+    def presets_route(self):
+        # Table content for presets should follow the following format:
+        #
+        # preset_names: string
+        # ---
+        # presets: blob or json
+        #
+        # Example result from query:
+        # [['preset_name', {"b_id": 1, "b_number": 2345}],
+        # ['preset2_name', {"b_id": 13, "b_number": 225}]]
+        #
+        # If you have a name mapping it will be applied to each preset
+        # Route will 404 if no preset query is defined and 500 if there is an Exception
+
+        # Helper function to filter out fields not in the insert,
+        # as well as apply the fields_map
+        def filterPreset(preset: dict):
+            return {
+                (self.input_lookup[k] if k in self.input_lookup else k): v
+                for k, v in preset.items()
+            }
+
+        if "presets" not in self.component_config:
+            return (
+                "No Preset query found",
+                404,
+                {"Content-Type": "text/plain"},
+            )
+
+        filtered_preset_dictionary = {
+            k: filterPreset(v) for k, v in self.presets_dict.items()
+        }
+
+        return (
+            NumpyEncoder.dumps(filtered_preset_dictionary),
+            200,
+            {"Content-Type": "application/json"},
+        )
+
 
 class TableComponent(FetchComponent):
     attributes_route_format = "{route}/attributes"

pharus/dynamic_api_gen.py

@@ -170,6 +170,9 @@ def {method_name}() -> dict:
                             fields_route = type_map[
                                 comp["type"]
                             ].fields_route_format.format(route=comp["route"])
+                            presets_route = type_map[
+                                comp["type"]
+                            ].presets_route_format.format(route=comp["route"])
                             f.write(
                                 (active_route_template).format(
                                     route=fields_route,
@@ -183,6 +186,19 @@ def {method_name}() -> dict:
                                     method_name_type="fields_route",
                                 )
                             )
+                            f.write(
+                                (active_route_template).format(
+                                    route=presets_route,
+                                    rest_verb=[InsertComponent.rest_verb[1]],
+                                    method_name=presets_route.replace("/", ""),
+                                    component_type=comp["type"],
+                                    component_name=comp_name,
+                                    component=json.dumps(comp),
+                                    static_config=static_config,
+                                    payload="payload=None",
+                                    method_name_type="presets_route",
+                                )
+                            )
                         elif issubclass(type_map[comp["type"]], TableComponent):
                             attributes_route = type_map[
                                 comp["type"]

pharus/version.py

@@ -1,2 +1,2 @@
 """Package metadata."""
-__version__ = "0.8.0"
+__version__ = "0.8.1"

tests/init/test_dynamic_api_spec.yaml

@@ -94,6 +94,9 @@ SciViz: # top level tab
                   destination: c_id
                 - type: attribute #omitted input means display is session_note
                   destination: c_name
+              presets: >
+                def presets():
+                    return {'preset 1': {'b_id': 14}}
             insert3:
               route: /insert3
               x: 1

tests/test_form.py

@@ -374,3 +374,12 @@ def test_form_datetime_FPK(token, client, connection, schemas_simple):
             {"datatype": "int", "default": "1", "name": "u_int", "type": "attribute"},
         ]
     }
+
+
+def test_form_response_presets(token, client, connection, schemas_simple):
+    REST_response = client.get(
+        "/insert2/presets",
+        headers=dict(Authorization=f"Bearer {token}"),
+    )
+    assert REST_response.status_code == 200, f"Error: {REST_response.data}"
+    assert REST_response.get_json() == {"preset 1": {"B Id": 14}}