Update testing on save/load json/yaml

Author: pgleeson

examples/test/test.md

@@ -24,4 +24,39 @@ A model....
  </tr>
 
 
+  <tr>
+    <td><b>float_like_optional2</b></td>
+    <td>int</td>
+    <td><i>name also says it all...</i></td>
+ </tr>
+
+
+  <tr>
+    <td><b>mid</b></td>
+    <td><a href="#midclassnoid">MidClassNoId</a></td>
+    <td><i></i></td>
+ </tr>
+
+
+</table>
+
+## MidClassNoId
+A model....
+
+### Allowed parameters
+<table>
+  <tr>
+    <td><b>int_val</b></td>
+    <td>int</td>
+    <td><i>name says it all...</i></td>
+ </tr>
+
+
+  <tr>
+    <td><b>str_val</b></td>
+    <td>int</td>
+    <td><i>name says it all...</i></td>
+ </tr>
+
+
 </table>

examples/test/test.py

@@ -1,6 +1,7 @@
 import modelspec
 from modelspec import field, instance_of, optional
 from modelspec.base_types import Base
+from modelspec.utils import load_json
 from typing import List
 
 # Example testing multiple options...
@@ -17,6 +18,20 @@ def convert2float(x: Any) -> float:
         return None
 
 
+@modelspec.define
+class MidClassNoId(Base):
+    """
+    A model....
+
+    Args:
+        int_val: name says it all...
+        str_val: name says it all...
+    """
+
+    int_val: int = field(default=None, validator=instance_of(int))
+    str_val: int = field(default=None, validator=optional(instance_of(str)))
+
+
 @modelspec.define
 class TopClass(Base):
     """
@@ -26,6 +41,7 @@ class TopClass(Base):
         id: The unique id of the thing
         float_like_req: name says it all...
         float_like_optional: name also says it all...
+        float_like_optional2: name also says it all...
     """
 
     id: str = field(validator=instance_of(str))
@@ -35,19 +51,37 @@ class TopClass(Base):
     float_like_optional: int = field(
         default=None, validator=optional(instance_of(float)), converter=convert2float
     )
+    float_like_optional2: int = field(
+        default=None, validator=optional(instance_of(float)), converter=convert2float
+    )
+
+    mid: MidClassNoId = field(
+        default=None, validator=optional(instance_of(MidClassNoId))
+    )
 
 
 tc = TopClass(
-    id="MyTest", float_like_req="03"
+    id="MyTest", float_like_req="04"
 )  # a string which can be converted to a float...
 
 # tc.float_like_req = 2.01
-tc.float_like_optional = 43
+tc.float_like_optional = 44
+tc.float_like_optional2 = 66
+# tc.mid = MidClassNoId(int_val=4, str_val="three")
 
 
 print(tc)
 
 tc.to_yaml_file("test_instance.yaml")
+tc.to_json_file("test_instance.json")
+tc.to_xml_file("test_instance.xml")
+
+str_b4 = str(tc)
+
+str_json_after = TopClass.from_json_file("test_instance.json")
+print(str_json_after)
+str_yaml_after = TopClass.from_yaml_file("test_instance.yaml")
+print(str_yaml_after)
 
 doc_md = tc.generate_documentation(format="markdown")
 

examples/test/test.specification.yaml

@@ -10,3 +10,18 @@ TopClass:
         float_like_optional:
             type: int
             description: name also says it all...
+        float_like_optional2:
+            type: int
+            description: name also says it all...
+        mid:
+            type: MidClassNoId
+            description: ''
+MidClassNoId:
+    definition: A model....
+    allowed_parameters:
+        int_val:
+            type: int
+            description: name says it all...
+        str_val:
+            type: int
+            description: name says it all...

examples/test/test_instance.json

@@ -0,0 +1,7 @@
+{
+    "MyTest": {
+        "float_like_req": 4.0,
+        "float_like_optional": 44.0,
+        "float_like_optional2": 66.0
+    }
+}

examples/test/test_instance.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" ?>
+<TopClass id="MyTest" float_like_req="4.0" float_like_optional="44.0" float_like_optional2="66.0" mid="None"/>

examples/test/test_instance.yaml

@@ -1,3 +1,4 @@
 MyTest:
-    float_like_req: 3.0
-    float_like_optional: 43.0
+    float_like_req: 4.0
+    float_like_optional: 44.0
+    float_like_optional2: 66.0

src/modelspec/base_types.py

@@ -156,11 +156,26 @@ def from_dict(cls, d: Dict[str, Any]) -> "Base":
         else:
             return converter.structure(d, cls)
 
+    @classmethod
+    def from_yaml(cls, yaml_str: str) -> "Base":
+        """Instantiate an modelspec object from a YAML string"""
+        return cls.from_dict(yaml.load(yaml_str, Loader=yaml.SafeLoader))
+
+    @classmethod
+    def from_yaml_file(cls, yaml_file: str) -> "Base":
+        """Instantiate an modelspec object from a file containing YAML"""
+        return cls.from_dict(yaml.load(yaml_str, Loader=yaml.SafeLoader))
+
     @classmethod
     def from_json(cls, json_str: str) -> "Base":
         """Instantiate an modelspec object from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
+    @classmethod
+    def from_json_file(cls, json_file: str) -> "Base":
+        """Instantiate an modelspec object from a file containing JSON"""
+        return cls.from_dict(json.load(json_file))
+
     @classmethod
     def from_bson(cls, bson_str: str) -> "Base":
         """Instantiate an modelspec object from a BSON string"""

tests/test_base.py

@@ -162,8 +162,8 @@ def test_save_load_json(tmp_path):
     # net.id = net.id+'_yaml'
     net.to_yaml_file(filenamey)
 
-    # filenamex = str(Path(tmp_path) / f"{net.id}.xml")
-    # net.to_xml_file(filenamex)
+    filenamex = str(Path(tmp_path) / f"{net.id}.xml")
+    net.to_xml_file(filenamex)
 
     from modelspec.utils import load_json, load_yaml, load_xml
 
@@ -173,12 +173,24 @@ def test_save_load_json(tmp_path):
 
     str_netj = str(netj)
 
+    netj2 = NewNetwork.from_json(net.to_json())
+    str_netj2 = str(netj2)
+
+    netj3 = NewNetwork.from_json_file(filenamej)
+    str_netj3 = str(netj3)
+
     datay = load_yaml(filenamey)
     print_v("Loaded network specification from %s" % filenamey)
 
     nety = NewNetwork.from_dict(datay)
     str_nety = str(nety)
 
+    nety2 = NewNetwork.from_yaml(net.to_yaml() + " ")
+    str_nety2 = str(nety2)
+
+    nety3 = NewNetwork.from_yaml_file(filenamey)
+    str_nety3 = str(nety3)
+
     # datax = load_xml(filenamex)
     # print_v("Loaded network specification from %s" % filenamex)
 
@@ -201,6 +213,8 @@ def test_save_load_json(tmp_path):
         )  # Order not preserved in py2, just test len
     else:
         assert str_orig == str_netj
+        assert str_orig == str_netj2
+        assert str_orig == str_netj3
 
     print("Test YAML..")
     if sys.version_info[0] == 2:
@@ -209,6 +223,8 @@ def test_save_load_json(tmp_path):
         )  # Order not preserved in py2, just test len
     else:
         assert str_orig == str_nety
+        assert str_orig == str_nety2
+        assert str_orig == str_nety3
 
     # print("Test XML..")
     # if sys.version_info[0] == 2: