mccode-plumber 0.15.1__tar.gz → 0.16.0__tar.gz

{mccode_plumber-0.15.1/src/mccode_plumber.egg-info → mccode_plumber-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mccode-plumber
-Version: 0.15.1
+Version: 0.16.0
 Author-email: Gregory Tucker <gregory.tucker@ess.eu>
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3

{mccode_plumber-0.15.1 → mccode_plumber-0.16.0}/src/mccode_plumber/forwarder.py

@@ -7,6 +7,7 @@ list of EPICS PVs to monitor.
 Alternatively, the same functionality can be accessed from Python using the configure_forwarder and reset_forwarder
 functions. Which take PV information and Forwarder/Kafka configuration as arguments.
 """
+from mccode_antlr.common import InstrumentParameter
 
 
 def normalise_pvs(pvs: list[dict], config=None, prefix=None, topic=None):
@@ -59,10 +60,19 @@ def reset_forwarder(pvs: list[dict], config=None, prefix=None, topic=None):
     return pvs
 
 
-def forwarder_partial_streams(prefix, topic, parameters):
-    names = [p.name for p in parameters]
-    if 'mcpl_filename' not in names:
-        names.append("mcpl_filename")
+def forwarder_partial_streams(prefix: str, topic: str, parameters: list[InstrumentParameter]):
+    from mccode_antlr.common import DataType
+    # The streaming-data-type f144 only supports numeric data, so we need to
+    # filter out string-valued data types to avoid annoying error messages in the
+    # forwarder's log output.
+    names = [p.name for p in parameters if p.value.data_type is not DataType.str]
+
+    # splitrun adds an instrument parameter named 'mcpl_filename', but we also
+    # can not forward this since it is a string-valued parameter.
+    #
+    #if 'mcpl_filename' not in names:
+    #    names.append("mcpl_filename")
+
     # Minimal information used by the forwarder for stream setup:
     partial = [dict(source=f'{prefix}{n}', module='f144', topic=topic) for n in names]
     return partial

{mccode_plumber-0.15.1 → mccode_plumber-0.16.0}/src/mccode_plumber/writer.py

@@ -311,8 +311,16 @@ def construct_writer_pv_dicts(instr: Path | str, prefix: str, topic: str):
 
 
 def construct_writer_pv_dicts_from_parameters(parameters, prefix: str, topic: str):
+    from mccode_antlr.common import DataType
+
     def strip_quotes(s):
         return s[1:-1] if s is not None and len(s) > 2 and (s[0] == s[-1] == '"' or s[0] == s[-1] == "'") else s
+
+    # Remove string-valued parameters from the provided list since they are not
+    # supported by streaming-data-type f144. In the future we could specify a different
+    # module for them instead.
+    parameters = [p for p in parameters if p.value.data_type is not DataType.str]
+
     return [dict(name=p.name, dtype=p.value.data_type.name, source=f'{prefix}{p.name}', topic=topic,
                  description=parameter_description(p), module='f144', unit=strip_quotes(p.unit)) for p in parameters]
 

{mccode_plumber-0.15.1 → mccode_plumber-0.16.0/src/mccode_plumber.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mccode-plumber
-Version: 0.15.1
+Version: 0.16.0
 Author-email: Gregory Tucker <gregory.tucker@ess.eu>
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3

{mccode_plumber-0.15.1 → mccode_plumber-0.16.0}/tests/test_writer.py

@@ -61,10 +61,13 @@ class WriterUnitsTestCase(unittest.TestCase):
     def test_parse(self):
         from mccode_plumber.writer import construct_writer_pv_dicts_from_parameters
         params = construct_writer_pv_dicts_from_parameters(self.instr.parameters, 'mcstas:', 'topic')
-        self.assertEqual(len(params), 4)
-        for p, x in zip(params, [('a', 'Hz'), ('b', 'm'), ('c', None), ('d', None)]):
+        # Only non-string valued parameters should be extracted since f144 only
+        # supports numeric-valued data
+        self.assertEqual(len(params), 3)
+        for p, x in zip(params, [('a', 'Hz'), ('b', 'm'), ('c', None)]):
             self.assertEqual(p['name'], x[0])
             self.assertEqual(p['unit'], x[1])
+            self.assertEqual(p['module'], 'f144')
 
 
 if __name__ == '__main__':