isis-streaming-data-types 0.0.4__tar.gz

isis_streaming_data_types-0.0.4/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: isis_streaming_data_types
+Version: 0.0.4
+Summary: Python utilities for handling ISIS streamed data
+Author-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
+Maintainer-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
+Project-URL: Homepage, https://github.com/isiscomputinggroup/isis_streaming_data_types
+Project-URL: Bug Reports, https://github.com/isiscomputinggroup/isis_streaming_data_types/issues
+Project-URL: Source, https://github.com/isiscomputinggroup/isis_streaming_data_types
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: flatbuffers
+Requires-Dist: numpy>2
+Provides-Extra: dev
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"

isis_streaming_data_types-0.0.4/pyproject.toml

@@ -0,0 +1,99 @@
+[build-system]
+requires = ["setuptools", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "isis_streaming_data_types" 
+dynamic = ["version"]
+description = "Python utilities for handling ISIS streamed data"
+readme = "README.md"
+requires-python = ">=3.12"
+license-files = ["LICENSE"]
+
+authors = [
+  {name = "ISIS Experiment Controls", email = "ISISExperimentControls@stfc.ac.uk" }
+]
+maintainers = [
+  {name = "ISIS Experiment Controls", email = "ISISExperimentControls@stfc.ac.uk" }
+]
+
+# Classifiers help users find your project by categorizing it.
+#
+# For a list of valid classifiers, see https://pypi.org/classifiers/
+classifiers = [
+  # How mature is this project? Common values are
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+
+  # Specify the Python versions you support here. In particular, ensure
+  # that you indicate you support Python 3. These classifiers are *not*
+  # checked by "pip install". See instead "requires-python" key in this file.
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3 :: Only",
+]
+
+dependencies = [
+  "flatbuffers",
+  "numpy>2"
+]
+
+[project.optional-dependencies]
+dev = [
+  "ruff>=0.8",
+  "pyright",
+  "pytest",
+  "pytest-cov",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/isiscomputinggroup/isis_streaming_data_types"
+"Bug Reports" = "https://github.com/isiscomputinggroup/isis_streaming_data_types/issues"
+"Source" = "https://github.com/isiscomputinggroup/isis_streaming_data_types"
+
+[tool.pytest.ini_options]
+testpaths = "tests"
+asyncio_mode = "auto"
+addopts = "--cov --cov-report=html -vv"
+
+[tool.coverage.run]
+branch = true
+source = ["src"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "if typing.TYPE_CHECKING:",
+  "@abstractmethod",
+]
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
+[tool.pyright]
+include = ["src", "tests"]
+reportConstantRedefinition = true
+reportDeprecated = true
+reportInconsistentConstructor = true
+reportMissingParameterType = true
+reportMissingTypeArgument = true
+reportUnnecessaryCast = true
+reportUnnecessaryComparison = true
+reportUnnecessaryContains = true
+reportUnnecessaryIsInstance = true
+reportUntypedBaseClass = true
+reportUntypedClassDecorator = true
+reportUntypedFunctionDecorator = true
+
+[tool.setuptools_scm]
+version_file = "src/streaming_data_types/_version.py"
+relative_to = "pyproject.toml"
+root = ".."
+
+

isis_streaming_data_types-0.0.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

isis_streaming_data_types-0.0.4/src/isis_streaming_data_types.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: isis_streaming_data_types
+Version: 0.0.4
+Summary: Python utilities for handling ISIS streamed data
+Author-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
+Maintainer-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
+Project-URL: Homepage, https://github.com/isiscomputinggroup/isis_streaming_data_types
+Project-URL: Bug Reports, https://github.com/isiscomputinggroup/isis_streaming_data_types/issues
+Project-URL: Source, https://github.com/isiscomputinggroup/isis_streaming_data_types
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: flatbuffers
+Requires-Dist: numpy>2
+Provides-Extra: dev
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"

isis_streaming_data_types-0.0.4/src/isis_streaming_data_types.egg-info/SOURCES.txt

@@ -0,0 +1,116 @@
+pyproject.toml
+src/isis_streaming_data_types.egg-info/PKG-INFO
+src/isis_streaming_data_types.egg-info/SOURCES.txt
+src/isis_streaming_data_types.egg-info/dependency_links.txt
+src/isis_streaming_data_types.egg-info/requires.txt
+src/isis_streaming_data_types.egg-info/top_level.txt
+src/streaming_data_types/__init__.py
+src/streaming_data_types/_version.py
+src/streaming_data_types/action_response_answ.py
+src/streaming_data_types/alarm_al00.py
+src/streaming_data_types/area_detector_ad00.py
+src/streaming_data_types/dataarray_da00.py
+src/streaming_data_types/epics_connection_ep01.py
+src/streaming_data_types/eventdata_ev44.py
+src/streaming_data_types/exceptions.py
+src/streaming_data_types/finished_writing_wrdn.py
+src/streaming_data_types/forwarder_config_update_fc00.py
+src/streaming_data_types/histogram_hs01.py
+src/streaming_data_types/json_json.py
+src/streaming_data_types/logdata_f144.py
+src/streaming_data_types/run_start_pl72.py
+src/streaming_data_types/run_stop_6s4t.py
+src/streaming_data_types/status_x5f2.py
+src/streaming_data_types/units_un00.py
+src/streaming_data_types/utils.py
+src/streaming_data_types/fbschemas/__init__.py
+src/streaming_data_types/fbschemas/action_response_answ/ActionOutcome.py
+src/streaming_data_types/fbschemas/action_response_answ/ActionResponse.py
+src/streaming_data_types/fbschemas/action_response_answ/ActionType.py
+src/streaming_data_types/fbschemas/action_response_answ/__init__.py
+src/streaming_data_types/fbschemas/alarm_al00/Alarm.py
+src/streaming_data_types/fbschemas/alarm_al00/Severity.py
+src/streaming_data_types/fbschemas/alarm_al00/__init__.py
+src/streaming_data_types/fbschemas/area_detector_ad00/Attribute.py
+src/streaming_data_types/fbschemas/area_detector_ad00/DType.py
+src/streaming_data_types/fbschemas/area_detector_ad00/__init__.py
+src/streaming_data_types/fbschemas/area_detector_ad00/ad00_ADArray.py
+src/streaming_data_types/fbschemas/dataarray_da00/__init__.py
+src/streaming_data_types/fbschemas/dataarray_da00/da00_DataArray.py
+src/streaming_data_types/fbschemas/dataarray_da00/da00_Variable.py
+src/streaming_data_types/fbschemas/dataarray_da00/da00_dtype.py
+src/streaming_data_types/fbschemas/epics_connection_ep01/ConnectionInfo.py
+src/streaming_data_types/fbschemas/epics_connection_ep01/EpicsPVConnectionInfo.py
+src/streaming_data_types/fbschemas/epics_connection_ep01/__init__.py
+src/streaming_data_types/fbschemas/eventdata_ev44/Event44Message.py
+src/streaming_data_types/fbschemas/eventdata_ev44/__init__.py
+src/streaming_data_types/fbschemas/finished_writing_wrdn/FinishedWriting.py
+src/streaming_data_types/fbschemas/finished_writing_wrdn/__init__.py
+src/streaming_data_types/fbschemas/forwarder_config_update_fc00/Protocol.py
+src/streaming_data_types/fbschemas/forwarder_config_update_fc00/Stream.py
+src/streaming_data_types/fbschemas/forwarder_config_update_fc00/UpdateType.py
+src/streaming_data_types/fbschemas/forwarder_config_update_fc00/__init__.py
+src/streaming_data_types/fbschemas/forwarder_config_update_fc00/fc00_ConfigUpdate.py
+src/streaming_data_types/fbschemas/histogram_hs01/Array.py
+src/streaming_data_types/fbschemas/histogram_hs01/ArrayDouble.py
+src/streaming_data_types/fbschemas/histogram_hs01/ArrayFloat.py
+src/streaming_data_types/fbschemas/histogram_hs01/ArrayInt.py
+src/streaming_data_types/fbschemas/histogram_hs01/ArrayLong.py
+src/streaming_data_types/fbschemas/histogram_hs01/DimensionMetaData.py
+src/streaming_data_types/fbschemas/histogram_hs01/EventHistogram.py
+src/streaming_data_types/fbschemas/histogram_hs01/__init__.py
+src/streaming_data_types/fbschemas/json_json/JsonData.py
+src/streaming_data_types/fbschemas/json_json/__init__.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayByte.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayDouble.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayFloat.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayInt.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayLong.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayShort.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayUByte.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayUInt.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayULong.py
+src/streaming_data_types/fbschemas/logdata_f144/ArrayUShort.py
+src/streaming_data_types/fbschemas/logdata_f144/Byte.py
+src/streaming_data_types/fbschemas/logdata_f144/Double.py
+src/streaming_data_types/fbschemas/logdata_f144/Float.py
+src/streaming_data_types/fbschemas/logdata_f144/Int.py
+src/streaming_data_types/fbschemas/logdata_f144/Long.py
+src/streaming_data_types/fbschemas/logdata_f144/Short.py
+src/streaming_data_types/fbschemas/logdata_f144/UByte.py
+src/streaming_data_types/fbschemas/logdata_f144/UInt.py
+src/streaming_data_types/fbschemas/logdata_f144/ULong.py
+src/streaming_data_types/fbschemas/logdata_f144/UShort.py
+src/streaming_data_types/fbschemas/logdata_f144/Value.py
+src/streaming_data_types/fbschemas/logdata_f144/__init__.py
+src/streaming_data_types/fbschemas/logdata_f144/f144_LogData.py
+src/streaming_data_types/fbschemas/run_start_pl72/RunStart.py
+src/streaming_data_types/fbschemas/run_start_pl72/SpectraDetectorMapping.py
+src/streaming_data_types/fbschemas/run_start_pl72/__init__.py
+src/streaming_data_types/fbschemas/run_stop_6s4t/RunStop.py
+src/streaming_data_types/fbschemas/run_stop_6s4t/__init__.py
+src/streaming_data_types/fbschemas/status_x5f2/Status.py
+src/streaming_data_types/fbschemas/status_x5f2/__init__.py
+src/streaming_data_types/fbschemas/units_un00/Units.py
+src/streaming_data_types/fbschemas/units_un00/__init__.py
+tests/__init__.py
+tests/test_6s4t.py
+tests/test_ad00.py
+tests/test_al00.py
+tests/test_answ.py
+tests/test_da00.py
+tests/test_ep01.py
+tests/test_ev44.py
+tests/test_f144.py
+tests/test_fc00.py
+tests/test_hs01.py
+tests/test_json.py
+tests/test_pl72.py
+tests/test_un00.py
+tests/test_utils.py
+tests/test_wrdn.py
+tests/test_x52f.py
+tests/example_buffers/al00.bin
+tests/example_buffers/ev42.bin
+tests/example_buffers/f144.bin
+tests/example_buffers/hs01.bin

isis_streaming_data_types-0.0.4/src/isis_streaming_data_types.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

isis_streaming_data_types-0.0.4/src/isis_streaming_data_types.egg-info/requires.txt

@@ -0,0 +1,8 @@
+flatbuffers
+numpy>2
+
+[dev]
+ruff>=0.8
+pyright
+pytest
+pytest-cov

isis_streaming_data_types-0.0.4/src/isis_streaming_data_types.egg-info/top_level.txt

@@ -0,0 +1 @@
+streaming_data_types

isis_streaming_data_types-0.0.4/src/streaming_data_types/__init__.py

@@ -0,0 +1,59 @@
+from streaming_data_types._version import version
+from streaming_data_types.action_response_answ import deserialise_answ, serialise_answ
+from streaming_data_types.alarm_al00 import deserialise_al00, serialise_al00
+from streaming_data_types.area_detector_ad00 import deserialise_ad00, serialise_ad00
+from streaming_data_types.dataarray_da00 import deserialise_da00, serialise_da00
+from streaming_data_types.epics_connection_ep01 import deserialise_ep01, serialise_ep01
+from streaming_data_types.eventdata_ev44 import deserialise_ev44, serialise_ev44
+from streaming_data_types.finished_writing_wrdn import deserialise_wrdn, serialise_wrdn
+from streaming_data_types.forwarder_config_update_fc00 import (
+    deserialise_fc00,
+    serialise_fc00,
+)
+from streaming_data_types.histogram_hs01 import deserialise_hs01, serialise_hs01
+from streaming_data_types.json_json import deserialise_json, serialise_json
+from streaming_data_types.logdata_f144 import deserialise_f144, serialise_f144
+from streaming_data_types.run_start_pl72 import deserialise_pl72, serialise_pl72
+from streaming_data_types.run_stop_6s4t import deserialise_6s4t, serialise_6s4t
+from streaming_data_types.status_x5f2 import deserialise_x5f2, serialise_x5f2
+from streaming_data_types.units_un00 import serialise_un00, deserialise_un00
+
+__version__ = version
+
+
+SERIALISERS = {
+    "ev44": serialise_ev44,
+    "hs01": serialise_hs01,
+    "f144": serialise_f144,
+    "pl72": serialise_pl72,
+    "6s4t": serialise_6s4t,
+    "x5f2": serialise_x5f2,
+    "ep01": serialise_ep01,
+    "fc00": serialise_fc00,
+    "answ": serialise_answ,
+    "wrdn": serialise_wrdn,
+    "al00": serialise_al00,
+    "json": serialise_json,
+    "ad00": serialise_ad00,
+    "da00": serialise_da00,
+    "un00": serialise_un00,
+}
+
+
+DESERIALISERS = {
+    "ev44": deserialise_ev44,
+    "hs01": deserialise_hs01,
+    "f144": deserialise_f144,
+    "pl72": deserialise_pl72,
+    "6s4t": deserialise_6s4t,
+    "x5f2": deserialise_x5f2,
+    "ep01": deserialise_ep01,
+    "fc00": deserialise_fc00,
+    "answ": deserialise_answ,
+    "wrdn": deserialise_wrdn,
+    "al00": deserialise_al00,
+    "json": deserialise_json,
+    "ad00": deserialise_ad00,
+    "da00": deserialise_da00,
+    "un00": deserialise_un00,
+}

isis_streaming_data_types-0.0.4/src/streaming_data_types/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
+
+__commit_id__ = commit_id = 'gf53483d8d'

isis_streaming_data_types-0.0.4/src/streaming_data_types/action_response_answ.py

@@ -0,0 +1,81 @@
+from datetime import datetime, timezone
+from typing import NamedTuple, Union
+
+import flatbuffers
+
+import streaming_data_types.fbschemas.action_response_answ.ActionResponse as ActionResponse
+from streaming_data_types.fbschemas.action_response_answ.ActionOutcome import (
+    ActionOutcome,
+)
+from streaming_data_types.fbschemas.action_response_answ.ActionType import ActionType
+from streaming_data_types.utils import check_schema_identifier
+
+FILE_IDENTIFIER = b"answ"
+
+
+def serialise_answ(
+    service_id: str,
+    job_id: str,
+    command_id: str,
+    action: ActionType,
+    outcome: ActionOutcome,
+    message: str,
+    status_code: int,
+    stop_time: datetime,
+) -> bytes:
+    builder = flatbuffers.Builder(500)
+    builder.ForceDefaults(True)
+    service_id_offset = builder.CreateString(service_id)
+    job_id_offset = builder.CreateString(job_id)
+    message_offset = builder.CreateString(message)
+    command_id_offset = builder.CreateString(command_id)
+
+    ActionResponse.ActionResponseStart(builder)
+    ActionResponse.ActionResponseAddServiceId(builder, service_id_offset)
+    ActionResponse.ActionResponseAddJobId(builder, job_id_offset)
+    ActionResponse.ActionResponseAddAction(builder, action)
+    ActionResponse.ActionResponseAddOutcome(builder, outcome)
+    ActionResponse.ActionResponseAddMessage(builder, message_offset)
+    ActionResponse.ActionResponseAddCommandId(builder, command_id_offset)
+    ActionResponse.ActionResponseAddStatusCode(builder, status_code)
+    ActionResponse.ActionResponseAddStopTime(builder, int(stop_time.timestamp() * 1000))
+
+    out_message = ActionResponse.ActionResponseEnd(builder)
+    builder.Finish(out_message, file_identifier=FILE_IDENTIFIER)
+    return bytes(builder.Output())
+
+
+Response = NamedTuple(
+    "Response",
+    (
+        ("service_id", str),
+        ("job_id", str),
+        ("command_id", str),
+        ("action", ActionType),
+        ("outcome", ActionOutcome),
+        ("message", str),
+        ("status_code", int),
+        ("stop_time", datetime),
+    ),
+)
+
+
+def deserialise_answ(buffer: Union[bytearray, bytes]):
+    check_schema_identifier(buffer, FILE_IDENTIFIER)
+    answ_message = ActionResponse.ActionResponse.GetRootAsActionResponse(buffer, 0)
+    max_time = datetime(
+        year=3001, month=1, day=1, hour=0, minute=0, second=0
+    ).timestamp()
+    used_timestamp = answ_message.StopTime() / 1000
+    if used_timestamp > max_time:
+        used_timestamp = max_time
+    return Response(
+        service_id=answ_message.ServiceId().decode("utf-8"),
+        job_id=answ_message.JobId().decode("utf-8"),
+        command_id=answ_message.CommandId().decode("utf-8"),
+        action=answ_message.Action(),
+        outcome=answ_message.Outcome(),
+        message=answ_message.Message().decode("utf-8"),
+        status_code=answ_message.StatusCode(),
+        stop_time=datetime.fromtimestamp(used_timestamp, tz=timezone.utc),
+    )

isis_streaming_data_types-0.0.4/src/streaming_data_types/alarm_al00.py

@@ -0,0 +1,65 @@
+from collections import namedtuple
+from enum import Enum
+
+import flatbuffers
+
+import streaming_data_types.fbschemas.alarm_al00.Alarm as Alarm
+import streaming_data_types.fbschemas.alarm_al00.Severity as FBSeverity
+from streaming_data_types.utils import check_schema_identifier
+
+FILE_IDENTIFIER = b"al00"
+
+AlarmInfo = namedtuple("AlarmInfo", ("source", "timestamp_ns", "severity", "message"))
+
+
+class Severity(Enum):
+    OK = 0
+    MINOR = 1
+    MAJOR = 2
+    INVALID = 3
+
+
+_enum_to_severity = {
+    Severity.OK: FBSeverity.Severity.OK,
+    Severity.MINOR: FBSeverity.Severity.MINOR,
+    Severity.MAJOR: FBSeverity.Severity.MAJOR,
+    Severity.INVALID: FBSeverity.Severity.INVALID,
+}
+
+_severity_to_enum = {
+    FBSeverity.Severity.OK: Severity.OK,
+    FBSeverity.Severity.MINOR: Severity.MINOR,
+    FBSeverity.Severity.MAJOR: Severity.MAJOR,
+    FBSeverity.Severity.INVALID: Severity.INVALID,
+}
+
+
+def deserialise_al00(buffer) -> AlarmInfo:
+    check_schema_identifier(buffer, FILE_IDENTIFIER)
+    alarm = Alarm.Alarm.GetRootAsAlarm(buffer, 0)
+
+    return AlarmInfo(
+        alarm.SourceName().decode("utf-8") if alarm.SourceName() else "",
+        alarm.Timestamp(),
+        _severity_to_enum[alarm.Severity()],
+        alarm.Message().decode("utf-8") if alarm.Message() else "",
+    )
+
+
+def serialise_al00(
+    source: str, timestamp_ns: int, severity: Severity, message: str
+) -> bytes:
+    builder = flatbuffers.Builder(128)
+
+    message_offset = builder.CreateString(message)
+    source_offset = builder.CreateString(source)
+
+    Alarm.AlarmStart(builder)
+    Alarm.AlarmAddSourceName(builder, source_offset)
+    Alarm.AlarmAddTimestamp(builder, timestamp_ns)
+    Alarm.AlarmAddSeverity(builder, _enum_to_severity[severity])
+    Alarm.AlarmAddMessage(builder, message_offset)
+    alarm = Alarm.AlarmEnd(builder)
+
+    builder.Finish(alarm, file_identifier=FILE_IDENTIFIER)
+    return bytes(builder.Output())