Match Transport keys to package extra names (#263)

hyperrealist · web-flow · commit 7582add37496 · 2025-11-11T16:24:07.000Z
* rename `ca_ioc --&gt; epicsca`

* rename `pva_ioc --&gt; epicspva`

* rename `dsr --&gt; tango`
diff --git a/docs/snippets/dynamic.py b/docs/snippets/dynamic.py
@@ -131,7 +131,7 @@ async def initialise(self):
         await self._connection.close()
 
 
-epics_ca = EpicsCATransport(ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static04.py b/docs/snippets/static04.py
@@ -10,7 +10,7 @@ class TemperatureController(Controller):
     device_id = AttrR(String())
 
 
-epics_ca = EpicsCATransport(ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 fastcs = FastCS(TemperatureController(), [epics_ca])
 
 if __name__ == "__main__":
diff --git a/docs/snippets/static05.py b/docs/snippets/static05.py
@@ -16,7 +16,7 @@ class TemperatureController(Controller):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 fastcs = FastCS(TemperatureController(), [epics_ca])
 
 if __name__ == "__main__":
diff --git a/docs/snippets/static06.py b/docs/snippets/static06.py
@@ -25,7 +25,7 @@ async def connect(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static07.py b/docs/snippets/static07.py
@@ -49,7 +49,7 @@ async def connect(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static08.py b/docs/snippets/static08.py
@@ -55,7 +55,7 @@ async def connect(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static09.py b/docs/snippets/static09.py
@@ -62,7 +62,7 @@ async def connect(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static10.py b/docs/snippets/static10.py
@@ -80,7 +80,7 @@ async def connect(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static11.py b/docs/snippets/static11.py
@@ -87,7 +87,7 @@ async def connect(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static12.py b/docs/snippets/static12.py
@@ -100,7 +100,7 @@ async def update_voltages(self):
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])
 
diff --git a/docs/snippets/static13.py b/docs/snippets/static13.py
@@ -108,7 +108,7 @@ async def disable_all(self) -> None:
 gui_options = EpicsGUIOptions(
     output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"
 )
-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))
+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))
 connection_settings = IPConnectionSettings("localhost", 25565)
 fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])
 
diff --git a/src/fastcs/demo/controller.yaml b/src/fastcs/demo/controller.yaml
@@ -9,7 +9,7 @@ transport:
       host: localhost
       port: 8083
       log_level: info
-  - ca_ioc:
+  - epicsca:
       pv_prefix: GARYDEMO
     gui:
       title: Temperature Controller Demo
diff --git a/src/fastcs/demo/schema.json b/src/fastcs/demo/schema.json
@@ -194,7 +194,7 @@
     },
     "TangoOptions": {
       "properties": {
-        "dsr": {
+        "tango": {
           "$ref": "#/$defs/TangoDSROptions"
         }
       },
diff --git a/src/fastcs/transport/epics/ca/options.py b/src/fastcs/transport/epics/ca/options.py
@@ -13,4 +13,4 @@ class EpicsCAOptions:
 
     docs: EpicsDocsOptions = field(default_factory=EpicsDocsOptions)
     gui: EpicsGUIOptions = field(default_factory=EpicsGUIOptions)
-    ca_ioc: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
+    epicsca: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
diff --git a/src/fastcs/transport/epics/ca/transport.py b/src/fastcs/transport/epics/ca/transport.py
@@ -23,7 +23,7 @@
 class EpicsCATransport(Transport):
     """Channel access transport."""
 
-    ca_ioc: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
+    epicsca: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
     docs: EpicsDocsOptions | None = None
     gui: EpicsGUIOptions | None = None
 
@@ -34,8 +34,8 @@ def connect(
     ) -> None:
         self._controller_api = controller_api
         self._loop = loop
-        self._pv_prefix = self.ca_ioc.pv_prefix
-        self._ioc = EpicsCAIOC(self.ca_ioc.pv_prefix, controller_api, self.ca_ioc)
+        self._pv_prefix = self.epicsca.pv_prefix
+        self._ioc = EpicsCAIOC(self.epicsca.pv_prefix, controller_api, self.epicsca)
 
         if self.docs is not None:
             EpicsDocs(self._controller_api).create_docs(self.docs)
diff --git a/src/fastcs/transport/epics/pva/transport.py b/src/fastcs/transport/epics/pva/transport.py
@@ -21,7 +21,7 @@
 class EpicsPVATransport(Transport):
     """PV access transport."""
 
-    pva_ioc: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
+    epicspva: EpicsIOCOptions = field(default_factory=EpicsIOCOptions)
     docs: EpicsDocsOptions | None = None
     gui: EpicsGUIOptions | None = None
 
@@ -31,8 +31,8 @@ def connect(
         loop: asyncio.AbstractEventLoop,
     ) -> None:
         self._controller_api = controller_api
-        self._pv_prefix = self.pva_ioc.pv_prefix
-        self._ioc = P4PIOC(self.pva_ioc.pv_prefix, controller_api)
+        self._pv_prefix = self.epicspva.pv_prefix
+        self._ioc = P4PIOC(self.epicspva.pv_prefix, controller_api)
 
         if self.docs is not None:
             EpicsDocs(self._controller_api).create_docs(self.docs)
diff --git a/src/fastcs/transport/tango/transport.py b/src/fastcs/transport/tango/transport.py
@@ -11,7 +11,7 @@
 class TangoTransport(Transport):
     """Tango transport."""
 
-    dsr: TangoDSROptions = field(default_factory=TangoDSROptions)
+    tango: TangoDSROptions = field(default_factory=TangoDSROptions)
 
     def connect(
         self,
@@ -21,5 +21,5 @@ def connect(
         self._dsr = TangoDSR(controller_api, loop)
 
     async def serve(self) -> None:
-        coro = asyncio.to_thread(self._dsr.run, self.dsr)
+        coro = asyncio.to_thread(self._dsr.run, self.tango)
         await coro
diff --git a/tests/benchmarking/controller.py b/tests/benchmarking/controller.py
@@ -21,9 +21,9 @@ def run():
     transport_options = [
         RestTransport(rest=RestServerOptions(port=8090)),
         EpicsCATransport(
-            ca_ioc=EpicsIOCOptions(pv_prefix="BENCHMARK-DEVICE"),
+            epicsca=EpicsIOCOptions(pv_prefix="BENCHMARK-DEVICE"),
         ),
-        TangoTransport(dsr=TangoDSROptions(dev_name="MY/BENCHMARK/DEVICE")),
+        TangoTransport(tango=TangoDSROptions(dev_name="MY/BENCHMARK/DEVICE")),
     ]
     instance = FastCS(MyTestController(), transport_options, asyncio.get_event_loop())
     instance.run()
diff --git a/tests/data/config.yaml b/tests/data/config.yaml
@@ -1,13 +1,13 @@
 # yaml-language-server: $schema=schema.json
 transport:
-  - ca_ioc: {}
+  - epicsca: {}
     docs: {}
     gui: {}
-  - pva_ioc: {}
+  - epicspva: {}
     docs: {}
     gui: {}
   - rest: {}
-  - dsr: {}
+  - tango: {}
   - graphql: {}
 controller:
   name: controller-name
diff --git a/tests/data/schema.json b/tests/data/schema.json
@@ -2,7 +2,7 @@
   "$defs": {
     "EpicsCATransport": {
       "properties": {
-        "ca_ioc": {
+        "epicsca": {
           "$ref": "#/$defs/EpicsIOCOptions"
         },
         "docs": {
@@ -98,7 +98,7 @@
     },
     "EpicsPVATransport": {
       "properties": {
-        "pva_ioc": {
+        "epicspva": {
           "$ref": "#/$defs/EpicsIOCOptions"
         },
         "docs": {
@@ -223,7 +223,7 @@
     },
     "TangoTransport": {
       "properties": {
-        "dsr": {
+        "tango": {
           "$ref": "#/$defs/TangoDSROptions"
         }
       },
diff --git a/tests/example_p4p_ioc.py b/tests/example_p4p_ioc.py
@@ -93,7 +93,7 @@ async def i(self):
 
 def run(pv_prefix="P4P_TEST_DEVICE"):
     simple_attribute_io = SimpleAttributeIO()
-    p4p_options = EpicsPVATransport(pva_ioc=EpicsIOCOptions(pv_prefix=pv_prefix))
+    p4p_options = EpicsPVATransport(epicspva=EpicsIOCOptions(pv_prefix=pv_prefix))
     controller = ParentController(ios=[simple_attribute_io])
 
     class ChildVector(ControllerVector):
diff --git a/tests/example_softioc.py b/tests/example_softioc.py
@@ -33,7 +33,7 @@ def run(pv_prefix="SOFTIOC_TEST_DEVICE"):
         controller,
         [
             EpicsCATransport(
-                ca_ioc=EpicsIOCOptions(pv_prefix=pv_prefix), gui=gui_options
+                epicsca=EpicsIOCOptions(pv_prefix=pv_prefix), gui=gui_options
             )
         ],
     )
diff --git a/tests/transport/epics/ca/test_initial_value.py b/tests/transport/epics/ca/test_initial_value.py
@@ -55,7 +55,7 @@ async def test_initial_values_set_in_ca(mocker):
     controller = InitialValuesController()
     fastcs = FastCS(
         controller,
-        [EpicsCATransport(ca_ioc=EpicsIOCOptions(pv_prefix=pv_prefix))],
+        [EpicsCATransport(epicsca=EpicsIOCOptions(pv_prefix=pv_prefix))],
         loop,
     )
 
diff --git a/tests/transport/epics/pva/test_p4p.py b/tests/transport/epics/pva/test_p4p.py
@@ -212,7 +212,7 @@ async def test_numerical_alarms(p4p_subprocess: tuple[str, Queue]):
 
 def make_fastcs(pv_prefix: str, controller: Controller) -> FastCS:
     return FastCS(
-        controller, [EpicsPVATransport(pva_ioc=EpicsIOCOptions(pv_prefix=pv_prefix))]
+        controller, [EpicsPVATransport(epicspva=EpicsIOCOptions(pv_prefix=pv_prefix))]
     )
 
 

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class TemperatureController(Controller):`
`16`	`16`	`gui_options = EpicsGUIOptions(`
`17`	`17`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`18`	`18`	`)`
`19`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`19`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`20`	`20`	`fastcs = FastCS(TemperatureController(), [epics_ca])`
`21`	`21`
`22`	`22`	`if __name__ == "__main__":`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ async def connect(self):`
`25`	`25`	`gui_options = EpicsGUIOptions(`
`26`	`26`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`27`	`27`	`)`
`28`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`28`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`29`	`29`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`30`	`30`	`fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ async def connect(self):`
`49`	`49`	`gui_options = EpicsGUIOptions(`
`50`	`50`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`51`	`51`	`)`
`52`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`52`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`53`	`53`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`54`	`54`	`fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ async def connect(self):`
`55`	`55`	`gui_options = EpicsGUIOptions(`
`56`	`56`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`57`	`57`	`)`
`58`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`58`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`59`	`59`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`60`	`60`	`fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ async def connect(self):`
`62`	`62`	`gui_options = EpicsGUIOptions(`
`63`	`63`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`64`	`64`	`)`
`65`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`65`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`66`	`66`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`67`	`67`	`fastcs = FastCS(TemperatureController(connection_settings), [epics_ca])`
`68`	`68`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ async def connect(self):`
`80`	`80`	`gui_options = EpicsGUIOptions(`
`81`	`81`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`82`	`82`	`)`
`83`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`83`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`84`	`84`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`85`	`85`	`fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])`
`86`	`86`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ async def connect(self):`
`87`	`87`	`gui_options = EpicsGUIOptions(`
`88`	`88`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`89`	`89`	`)`
`90`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`90`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`91`	`91`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`92`	`92`	`fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])`
`93`	`93`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ async def update_voltages(self):`
`100`	`100`	`gui_options = EpicsGUIOptions(`
`101`	`101`	`output_path=Path(".") / "demo.bob", title="Demo Temperature Controller"`
`102`	`102`	`)`
`103`		`-epics_ca = EpicsCATransport(gui=gui_options, ca_ioc=EpicsIOCOptions(pv_prefix="DEMO"))`
	`103`	`+epics_ca = EpicsCATransport(gui=gui_options, epicsca=EpicsIOCOptions(pv_prefix="DEMO"))`
`104`	`104`	`connection_settings = IPConnectionSettings("localhost", 25565)`
`105`	`105`	`fastcs = FastCS(TemperatureController(4, connection_settings), [epics_ca])`
`106`	`106`