convert jinja non strings back to their type

epics-containers · Jun 1, 2024 · 93b5f59 · 93b5f59
1 parent ec460d8
commit 93b5f59
Show file tree

Hide file tree

Showing 11 changed files with 155 additions and 638 deletions.
diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py
@@ -63,7 +63,8 @@ def _make_entity_model(
         def add_arg(name, typ, description, default):
             if default is None:
                 default = PydanticUndefined
-            if typ in [str, object]:
+            # cheesy check for enum, can this be improved?
+            if typ in [str, object] or "enum" in str(typ):
                 args[name] = (Annotated[typ, Field(description=description)], default)
             else:
                 args[name] = (

diff --git a/src/ibek/ioc.py b/src/ibek/ioc.py
@@ -5,6 +5,7 @@
 
 from __future__ import annotations
 
+import json
 from enum import Enum
 from typing import Any, Dict, List, Sequence
 
@@ -71,7 +72,19 @@ def add_ibek_attributes(self):
             if isinstance(value, str):
                 # Jinja expansion of any of the Entity's string args/values
                 value = UTILS.render(entity_dict, value)
-                setattr(self, arg, str(value))
+                # this is a cheesy test - any better ideas please let me know
+                if "Union" in str(model_field.annotation):
+                    # Args that were non strings and have been rendered by Jinja
+                    # must be coerced back into their original type
+                    try:
+                        # shame I need the replace - why are jinja an json disagreeing?
+                        value = json.loads(value.replace("'", '"'))
+                    except:
+                        print(
+                            f"ERROR: fail to decode {value} as a {model_field.annotation}"
+                        )
+                        raise
+                setattr(self, arg, value)
                 # update the entity_dict with the rendered value
                 entity_dict[arg] = value
 

diff --git a/tests/samples/iocs/ipac-test.ibek.ioc.yaml b/tests/samples/iocs/ipac-test.ibek.ioc.yaml
@@ -1,4 +1,4 @@
-# yaml-language-server: $schema=file:///tmp/schema.json
+# yaml-language-server: $schema=../schemas/ipac-test.ibek.schema.json
 
 ioc_name: ipac-test
 

diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml
@@ -7,4 +7,5 @@ entities:
     friends: ["Rimmer", "Holly", "Cat", "Kryten"]
 
   - entity_type: listtest.lister
-    friends: '{{  ["Rimmer"] + ["tt"] | list }}'
+    friends: |-
+      {{  ["Rimmer"] + ["tt"] | list }}
diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd
@@ -11,23 +11,9 @@ Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has
 - Kryten
 First friend is Rimmer
 Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends:
-- [
-- '
-- R
-- i
-- m
-- m
-- e
-- r
-- '
-- ,
--  
-- '
-- t
-- t
-- '
-- ]
-First friend is [
+- Rimmer
+- tt
+First friend is Rimmer
 
 dbLoadRecords /epics/runtime/ioc.db
 iocInit

diff --git a/tests/samples/schemas/gauges.ibek.ioc.schema.json b/tests/samples/schemas/gauges.ibek.ioc.schema.json
@@ -101,104 +101,49 @@
           "title": "Baud"
         },
         "parity": {
-          "anyOf": [
+          "allOf": [
             {
-              "description": "jinja that renders to <enum 'parity'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
-            {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/parity"
-                }
-              ],
-              "description": "Parity"
+              "$ref": "#/$defs/parity"
             }
           ],
           "default": "none",
-          "description": "union of <enum 'parity'> and jinja representation of {typ}",
-          "title": "Parity"
+          "description": "Parity"
         },
         "crtscts": {
-          "anyOf": [
+          "allOf": [
             {
-              "description": "jinja that renders to <enum 'crtscts'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
-            {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/crtscts"
-                }
-              ],
-              "description": "Set hardware flow control on"
+              "$ref": "#/$defs/crtscts"
             }
           ],
           "default": "N",
-          "description": "union of <enum 'crtscts'> and jinja representation of {typ}",
-          "title": "Crtscts"
+          "description": "Set hardware flow control on"
         },
         "stop": {
-          "anyOf": [
+          "allOf": [
             {
-              "description": "jinja that renders to <enum 'stop'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
-            {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/stop"
-                }
-              ],
-              "description": "Stop Bits"
+              "$ref": "#/$defs/stop"
             }
           ],
           "default": "1",
-          "description": "union of <enum 'stop'> and jinja representation of {typ}",
-          "title": "Stop"
+          "description": "Stop Bits"
         },
         "disconnectOnReadTimeout": {
-          "anyOf": [
-            {
-              "description": "jinja that renders to <enum 'disconnectOnReadTimeout'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
+          "allOf": [
             {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/disconnectOnReadTimeout"
-                }
-              ],
-              "description": "Disconnect when a read times out"
+              "$ref": "#/$defs/disconnectOnReadTimeout"
             }
           ],
           "default": "Y",
-          "description": "union of <enum 'disconnectOnReadTimeout'> and jinja representation of {typ}",
-          "title": "Disconnectonreadtimeout"
+          "description": "Disconnect when a read times out"
         },
         "bits": {
-          "anyOf": [
-            {
-              "description": "jinja that renders to <enum 'bits'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
+          "allOf": [
             {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/bits"
-                }
-              ],
-              "description": "Bits"
+              "$ref": "#/$defs/bits"
             }
           ],
           "default": "8",
-          "description": "union of <enum 'bits'> and jinja representation of {typ}",
-          "title": "Bits"
+          "description": "Bits"
         }
       },
       "required": [

diff --git a/tests/samples/schemas/motorSim.ibek.ioc.schema.json b/tests/samples/schemas/motorSim.ibek.ioc.schema.json
@@ -109,104 +109,49 @@
           "title": "Baud"
         },
         "parity": {
-          "anyOf": [
-            {
-              "description": "jinja that renders to <enum 'parity'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
+          "allOf": [
             {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/parity"
-                }
-              ],
-              "description": "Parity"
+              "$ref": "#/$defs/parity"
             }
           ],
           "default": "none",
-          "description": "union of <enum 'parity'> and jinja representation of {typ}",
-          "title": "Parity"
+          "description": "Parity"
         },
         "crtscts": {
-          "anyOf": [
+          "allOf": [
             {
-              "description": "jinja that renders to <enum 'crtscts'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
-            {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/crtscts"
-                }
-              ],
-              "description": "Set hardware flow control on"
+              "$ref": "#/$defs/crtscts"
             }
           ],
           "default": "N",
-          "description": "union of <enum 'crtscts'> and jinja representation of {typ}",
-          "title": "Crtscts"
+          "description": "Set hardware flow control on"
         },
         "stop": {
-          "anyOf": [
-            {
-              "description": "jinja that renders to <enum 'stop'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
+          "allOf": [
             {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/stop"
-                }
-              ],
-              "description": "Stop Bits"
+              "$ref": "#/$defs/stop"
             }
           ],
           "default": "1",
-          "description": "union of <enum 'stop'> and jinja representation of {typ}",
-          "title": "Stop"
+          "description": "Stop Bits"
         },
         "disconnectOnReadTimeout": {
-          "anyOf": [
-            {
-              "description": "jinja that renders to <enum 'disconnectOnReadTimeout'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
+          "allOf": [
             {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/disconnectOnReadTimeout"
-                }
-              ],
-              "description": "Disconnect when a read times out"
+              "$ref": "#/$defs/disconnectOnReadTimeout"
             }
           ],
           "default": "Y",
-          "description": "union of <enum 'disconnectOnReadTimeout'> and jinja representation of {typ}",
-          "title": "Disconnectonreadtimeout"
+          "description": "Disconnect when a read times out"
         },
         "bits": {
-          "anyOf": [
+          "allOf": [
             {
-              "description": "jinja that renders to <enum 'bits'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
-            {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/bits"
-                }
-              ],
-              "description": "Bits"
+              "$ref": "#/$defs/bits"
             }
           ],
           "default": "8",
-          "description": "union of <enum 'bits'> and jinja representation of {typ}",
-          "title": "Bits"
+          "description": "Bits"
         }
       },
       "required": [
@@ -342,24 +287,13 @@
           "type": "string"
         },
         "DIR": {
-          "anyOf": [
-            {
-              "description": "jinja that renders to <enum 'DIR'>",
-              "pattern": ".*\\{\\{.*\\}\\}.*",
-              "type": "string"
-            },
+          "allOf": [
             {
-              "allOf": [
-                {
-                  "$ref": "#/$defs/DIR"
-                }
-              ],
-              "description": "The direction of the axis"
+              "$ref": "#/$defs/DIR"
             }
           ],
           "default": 0,
-          "description": "union of <enum 'DIR'> and jinja representation of {typ}",
-          "title": "Dir"
+          "description": "The direction of the axis"
         },
         "VELO": {
           "anyOf": [