Replace APISchema Serialization with Pydantic 1.0

README.rst

@@ -23,13 +23,15 @@ to the input of **counter_sink**.
 
 .. code-block:: yaml
 
-    - examples.devices.counter.Counter:
-        name: counter
-        inputs: {}
-    - tickit.devices.sink.Sink:
-        name: counter_sink
-        inputs:
-          input: counter:_value
+    - type: examples.devices.counter.Counter
+      name: counter
+      inputs: {}
+    - type: tickit.devices.sink.Sink
+      name: counter_sink
+      inputs:
+        input:
+          component: counter
+          port: _value
 
 
 This file is executed to run the simulation.

docs/user/explanations/components.rst

@@ -37,28 +37,36 @@ the master scheduler's wiring is correct, for example:
 
 .. code-block:: yaml
 
-    - examples.devices.trampoline.RandomTrampoline:
-        name: random_trampoline
-        inputs: {}
-        callback_period: 10000000000
-    - tickit.core.components.system_simulation.SystemSimulation:
-        name: internal_tickit
-        inputs:
-          input_1: random_trampoline:output
-        components:
-          - tickit.devices.sink.Sink:
-              name: internal_sink
-              inputs:
-                sink_1: external:input_1
-          - examples.devices.remote_controlled.RemoteControlled:
-              name: internal_tcp_controlled
-              inputs: {}
-        expose:
-          output_1: internal_tcp_controlled:observed
-    - tickit.devices.sink.Sink:
-        name: external_sink
-        inputs:
-          sink_1: internal_tickit:output_1
+    - type: examples.devices.trampoline.RandomTrampoline
+      name: random_trampoline
+      inputs: {}
+      callback_period: 10000000000
+    - type: tickit.core.components.system_simulation.SystemSimulation
+      name: internal_tickit
+      inputs:
+        input_1:
+          component: random_trampoline
+          port: output
+      components:
+        - type: tickit.devices.sink.Sink
+          name: internal_sink
+          inputs:
+            sink_1:
+              component: external
+              port: input_1
+        - type: examples.devices.remote_controlled.RemoteControlled
+          name: internal_tcp_controlled
+          inputs: {}
+      expose:
+        output_1:
+          component: internal_tcp_controlled
+          port: observed
+    - type: tickit.devices.sink.Sink
+      name: external_sink
+      inputs:
+        sink_1:
+          component: internal_tickit
+          port: output_1
 
 (See `SystemSimulationComponent`.)
 

docs/user/explanations/wiring.rst

@@ -23,11 +23,13 @@ which outputs random numbers, and a sink taking that output as an input:
 
 .. code-block:: yaml
 
-    - examples.devices.trampoline.RandomTrampoline:
-        name: rand_tramp
-        inputs: {}
-        callback_period: 1000000000
-    - tickit.devices.sink.Sink:
-        name: tramp_sink
-        inputs:
-          input: rand_tramp:output
+    - type: examples.devices.trampoline.RandomTrampoline
+      name: rand_tramp
+      inputs: {}
+      callback_period: 1000000000
+    - type: tickit.devices.sink.Sink
+      name: tramp_sink
+      inputs:
+        input:
+          component: rand_tramp
+          port: output

docs/user/tutorials/create-a-device.rst

@@ -118,13 +118,13 @@ if the device requires any adapters to control it externally.
 
 .. code-block:: python
 
-    from dataclasses import dataclass
+    from tickit.utils.compat.pydantic_compat import pydantic_dataclass
 
     from tickit.core.components.component import Component, ComponentConfig
     from tickit.core.components.device_simulation import DeviceSimulation
 
 
-    @dataclass
+    @pydantic_dataclass
     class Amplifier(ComponentConfig):
         initial_amplification: float
 
@@ -147,19 +147,23 @@ and a `Sink`, named sink, which will receive the amplified signal.
 
 .. code-block:: yaml
 
-    - tickit.devices.source.Source:
-        name: source
-        inputs: {}
-        value: 10.0
-    - amp.Amplifier:
-        name: amp
-        inputs:
-          initial_signal: source:value
-        initial_amplification: 2.0
-    - tickit.devices.sink.Sink:
-        name: sink
-        inputs:
-          input: amp:amplified_signal
+    - type: tickit.devices.source.Source
+      name: source
+      inputs: {}
+      value: 10.0
+    - type: amp.Amplifier
+      name: amp
+      inputs:
+        initial_signal:
+          component: source
+          port: value
+      initial_amplification: 2.0
+    - type: tickit.devices.sink.Sink
+      name: sink
+      inputs:
+        input:
+          component: amp
+          port: amplified_signal
 
 
 Where in ``amp.Amplifier`` ``amp`` is the name of the ``.py`` file the amplifier

docs/user/tutorials/creating-a-simulation.rst

@@ -26,23 +26,25 @@ we may extend our config, as:
 
 .. code-block:: yaml
 
-    - examples.devices.trampoline.RandomTrampoline:
-        name: rand_tramp
-        inputs: {}
+    - type: examples.devices.trampoline.RandomTrampoline
+      name: rand_tramp
+      inputs: {}
 
 We will now add a `Sink` device. This device will be named ``tramp_sink``, will have
 no adapters but will take the ``output`` value of ``rand_tramp`` as ``input``. As
 such we may extend our config, as:
 
 .. code-block:: yaml
 
-    - examples.devices.trampoline.RandomTrampoline:
-        name: rand_tramp
-        inputs: {}
-    - tickit.devices.sink.Sink:
-        name: tramp_sink
-        inputs:
-          input: rand_tramp:output
+    - type: examples.devices.trampoline.RandomTrampoline
+      name: rand_tramp
+      inputs: {}
+    - type: tickit.devices.sink.Sink
+      name: tramp_sink
+      inputs:
+        input:
+          component rand_tramp
+          port: output
 
 Running the Simulation
 ----------------------

docs/user/tutorials/use-composed-adapter.rst

@@ -130,7 +130,7 @@ our amplifier `ComponentConfig`. To do this we simply add it to the arguments of
 
 .. code-block:: python
 
-    @dataclass
+    @pydantic_dataclass
     class Amplifier(ComponentConfig):
         initial_amplification: int
 

examples/configs/amplifier.yaml

@@ -1,13 +1,17 @@
-- tickit.devices.source.Source:
-    name: source
-    inputs: {}
-    value: 10.0
-- examples.devices.amplifier.Amplifier:
-    name: amp
-    inputs:
-      initial_signal: source:value
-    initial_amplification: 2
-- tickit.devices.sink.Sink:
-    name: sink
-    inputs:
-      input: amp:amplified_signal
+- type: tickit.devices.source.Source
+  name: source
+  inputs: {}
+  value: 10.0
+- type: examples.devices.amplifier.Amplifier
+  name: amp
+  inputs:
+    initial_signal:
+      component: source
+      port: value
+  initial_amplification: 2
+- type: tickit.devices.sink.Sink
+  name: sink
+  inputs:
+    input:
+      component: amp
+      port: amplified_signal

examples/configs/counter.yaml

@@ -1,7 +1,9 @@
-- examples.devices.counter.Counter:
-    name: counter  
-    inputs: {}
-- tickit.devices.sink.Sink:
-    name: counter_sink
-    inputs:
-      input: counter:_value
+- type: examples.devices.counter.Counter
+  name: counter
+  inputs: {}
+- type: tickit.devices.sink.Sink
+  name: counter_sink
+  inputs:
+    input:
+      component: counter
+      port: _value

examples/configs/http-and-zeromq-devices.yaml

@@ -4,4 +4,6 @@
 - examples.devices.zeromq_push_device.ExampleZeroMqPusher:
     name: zeromq-pusher
     inputs: 
-        updates: http-device:updates
+        updates:
+          component: http-device
+          port: updates

examples/configs/http-device.yaml

@@ -1,3 +1,3 @@
-- examples.devices.http_device.ExampleHttpDevice:
-    name: http-device
-    inputs: {}
+- type: examples.devices.http_device.ExampleHttpDevice
+  name: http-device
+  inputs: {}

examples/configs/isolated-device.yaml

@@ -1,6 +1,6 @@
-- examples.devices.isolated_device.IsolatedBox:
-    name: MrBox
-    inputs: {}
-    initial_value: 2
-    ioc_name: ISOLATED_BOX
-    port: 25561
+- type: examples.devices.isolated_device.IsolatedBox
+  name: MrBox
+  inputs: {}
+  initial_value: 2
+  ioc_name: ISOLATED_BOX
+  port: 25561

examples/configs/nested.yaml

@@ -1,22 +1,30 @@
-- examples.devices.trampoline.RandomTrampoline:
-    name: random_trampoline
-    inputs: {}
-    callback_period: 10000000000
-- tickit.core.components.system_simulation.SystemSimulation:
-    name: internal_tickit
-    inputs:
-      input_1: random_trampoline:output
-    components:
-      - tickit.devices.sink.Sink:
-          name: internal_sink
-          inputs:
-            sink_1: external:input_1
-      - examples.devices.remote_controlled.RemoteControlled:
-          name: internal_tcp_controlled
-          inputs: {}
-    expose:
-      output_1: internal_tcp_controlled:observed
-- tickit.devices.sink.Sink:
-    name: external_sink
-    inputs:
-      sink_1: internal_tickit:output_1
+- type: examples.devices.trampoline.RandomTrampoline
+  name: random_trampoline
+  inputs: {}
+  callback_period: 10000000000
+- type: tickit.core.components.system_simulation.SystemSimulation
+  name: internal_tickit
+  inputs:
+    input_1:
+      component: random_trampoline
+      port: output
+  components:
+    - type: tickit.devices.sink.Sink
+      name: internal_sink
+      inputs:
+        sink_1:
+          component: external
+          port: input_1
+    - type: examples.devices.remote_controlled.RemoteControlled
+      name: internal_tcp_controlled
+      inputs: {}
+  expose:
+    output_1:
+      component: internal_tcp_controlled
+      port: observed
+- type: tickit.devices.sink.Sink
+  name: external_sink
+  inputs:
+    sink_1:
+      component: internal_tickit
+      port: output_1

examples/configs/shutter.yaml

@@ -1,14 +1,18 @@
-- tickit.devices.source.Source:
-    name: source
-    inputs: {}
-    value: 42.0
-- examples.devices.shutter.Shutter:
-    name: shutter
-    inputs:
-      flux: source:value
-    default_position: 0.2
-    initial_position: 0.24
-- tickit.devices.sink.Sink:
-    name: sink
-    inputs:
-      flux: shutter:flux
+- type: tickit.devices.source.Source
+  name: source
+  inputs: {}
+  value: 42.0
+- type: examples.devices.shutter.Shutter
+  name: shutter
+  inputs:
+    flux:
+      component: source
+      port: value
+  default_position: 0.2
+  initial_position: 0.24
+- type: tickit.devices.sink.Sink
+  name: sink
+  inputs:
+    flux:
+      component: shutter
+      port: flux

examples/configs/sunk-tcp.yaml

@@ -1,8 +1,10 @@
-- examples.devices.remote_controlled.RemoteControlled:
-    name: tcp_contr
-    inputs: {}
-    format: "%b\r\n"
-- tickit.devices.sink.Sink:
-    name: contr_sink
-    inputs:
-      input: tcp_contr:observed
+- type: examples.devices.remote_controlled.RemoteControlled
+  name: tcp_contr
+  inputs: {}
+  format: "%b\r\n"
+- type: tickit.devices.sink.Sink
+  name: contr_sink
+  inputs:
+    input:
+      component: tcp_contr
+      port: observed