mccode-plumber 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

mccode_plumber/file_writer_control/WriteJob.py

@@ -0,0 +1,83 @@
+import uuid
+from datetime import datetime, timedelta
+
+from streaming_data_types import serialise_pl72
+
+
+class WriteJob:
+    """
+    Represents a file-writer write job (before it has been started).
+    """
+
+    def __init__(
+        self,
+        nexus_structure: str,
+        file_name: str,
+        broker: str,
+        start_time: datetime,
+        stop_time: datetime = None,
+        job_id="",
+        instrument_name: str = "",
+        run_name: str = "",
+        metadata: str = "",
+        control_topic: str = "",
+    ):
+        self.structure = nexus_structure
+        self.file = file_name
+        if job_id:
+            try:
+                uuid.UUID(job_id)
+                self.job_id = job_id
+            except ValueError as e:
+                raise RuntimeError("Job ID should be a valid UUID (v1).") from e
+        else:
+            self.job_id = str(uuid.uuid1())
+        self.start = start_time
+        if stop_time is None:
+            self.stop = self.start + timedelta(days=365.25 * 10)
+        else:
+            self.stop = stop_time
+        self._service_id = ""
+        self.broker = broker
+        self.instrument_name = instrument_name
+        self.run_name = run_name
+        self.metadata = metadata
+        self.control_topic = control_topic
+
+    def generate_new_job_id(self):
+        """
+        Generate a new job id. Should be called if an attempt at starting this write job fails and another attempt is made.
+        """
+        self.job_id = str(uuid.uuid1())
+
+    @property
+    def service_id(self) -> str:
+        """
+        The service identifier that should process this job. Defaults to an empty string.
+        .. note:: Must be set if job is to be processed by a specific file-writer instance.
+        """
+        return self._service_id
+
+    @service_id.setter
+    def service_id(self, new_service_id: str):
+        self._service_id = new_service_id
+
+    def get_start_message(self) -> bytes:
+        """
+        Generate the (flatbuffer) start message that will start this job. If you are sending the message to a specific
+        file-writer instance, you have to set the service_id property first or the message will fail to start the job.
+        :return: A flatbuffer message that holds the necessary information for starting a write job.
+        """
+        return serialise_pl72(
+            self.job_id,
+            self.file,
+            self.start,
+            self.stop,
+            nexus_structure=self.structure,
+            service_id=self.service_id,
+            broker=self.broker,
+            instrument_name=self.instrument_name,
+            run_name=self.run_name,
+            metadata=self.metadata,
+            control_topic=self.control_topic,
+        )

mccode_plumber/file_writer_control/__init__.py

@@ -0,0 +1,13 @@
+from .CommandStatus import CommandState
+from .JobHandler import JobHandler
+from .JobStatus import JobState
+from .WorkerJobPool import WorkerJobPool
+from .WriteJob import WriteJob
+
+__all__ = [
+    "JobHandler",
+    "WorkerJobPool",
+    "WriteJob",
+    "CommandState",
+    "JobState",
+]

mccode_plumber/writer.py

@@ -138,7 +138,7 @@ def insert_events_in_nexus_structure(ns: dict, config: dict):
 
 
 def get_writer_pool(broker: str = None, job: str = None, command: str = None):
-    from file_writer_control import WorkerJobPool
+    from .file_writer_control import WorkerJobPool
     pool = WorkerJobPool(f"{broker}/{job}", f"{broker}/{command}")
     return pool
 
@@ -175,7 +175,7 @@ def start_pool_writer(start_time_string, structure, filename=None, stop_time_str
     from time import sleep
     from json import dumps
     from datetime import datetime, timedelta
-    from file_writer_control import JobHandler, WriteJob, CommandState
+    from .file_writer_control import JobHandler, WriteJob, CommandState
 
     start_time = datetime.fromisoformat(start_time_string)
     if filename is None:
@@ -301,7 +301,7 @@ def wait_on_writer():
     from os import EX_OK, EX_UNAVAILABLE
     from time import sleep
     from datetime import datetime, timedelta
-    from file_writer_control import JobHandler, CommandState
+    from .file_writer_control import JobHandler, CommandState
 
     from argparse import ArgumentParser
     parser = ArgumentParser()

{mccode_plumber-0.6.0.dist-info → mccode_plumber-0.7.0.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: mccode-plumber
-Version: 0.6.0
+Version: 0.7.0
 Author-email: Gregory Tucker <gregory.tucker@ess.eu>
 Classifier: License :: OSI Approved :: BSD License
 Description-Content-Type: text/markdown
 Requires-Dist: p4p
-Requires-Dist: file-writer-control>=1.3.0
+Requires-Dist: kafka-python>=2.0
+Requires-Dist: ess-streaming-data-types>=0.14.0
 Requires-Dist: restage>=0.4.0
 Requires-Dist: mccode-to-kafka>=0.2.1
 Requires-Dist: moreniius>=0.2.3

mccode_plumber-0.7.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+mccode_plumber/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mccode_plumber/conductor.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mccode_plumber/epics.py,sha256=THzech5V1UCLIN9u1r3GiEKxUVCDkYVXhfOQV71aQn4,3989
+mccode_plumber/forwarder.py,sha256=1PdW91qLksDnA41-gOFMtgSae4wDdSLVvgAlrF23Uks,3764
+mccode_plumber/kafka.py,sha256=8fHTy2Zzk638XXj29pfrk-7fUxafuse9OYWmaRgvV7M,1195
+mccode_plumber/mccode.py,sha256=WXlu89Cs6a3s0aKtfRGuzqcOWoFZtdZWibLgBQnaXCI,2210
+mccode_plumber/splitrun.py,sha256=MsR1cUvoayQGNCJNl5fIPG92Wfcy9V_8QNO_ITQTvtA,1295
+mccode_plumber/utils.py,sha256=E8NoGo_3Z-pPEpzicVGSWfQOX8p3eR-GxElT33-kX5U,2167
+mccode_plumber/writer.py,sha256=TSWw7Q1mlXcwOx4OuvNGN-yyB_X10Vmt1KywA79RmBs,16359
+mccode_plumber/file_writer_control/CommandChannel.py,sha256=rrQxmQ6VJsl9OC5n45XkL3g7MXtICT_8tsv_xuGdIKI,9119
+mccode_plumber/file_writer_control/CommandHandler.py,sha256=ETPGNiD3umt2XazCWztoaO6qgtilBzrB1N1EH5EAKUw,2245
+mccode_plumber/file_writer_control/CommandStatus.py,sha256=biNK58vY1H-USYAl9uB_JNQyMohBj1cwJwmXktndd4E,4517
+mccode_plumber/file_writer_control/InThreadStatusTracker.py,sha256=sLb8v1JBs3QSWXu-_kIznku3h_ZqVNwx0o9-RoxaKu4,10196
+mccode_plumber/file_writer_control/JobHandler.py,sha256=H6fr0O6lcGw4EKRUuR9Ak4gk5Rknozru0PGaNxNITeg,4296
+mccode_plumber/file_writer_control/JobStatus.py,sha256=ncLYEcTAOdrIASQvY0jJAX3fC4qF9tyzLavm5YUOhlQ,4416
+mccode_plumber/file_writer_control/KafkaTopicUrl.py,sha256=dG6Aj2tYo1UGZferxyvURUAr77z9dhBN_SRzizzt1Vo,736
+mccode_plumber/file_writer_control/StateExtractor.py,sha256=FaroeEuZCGTIi7kEIxeS7QHjnD7CxU1ONvKRQqRCmrc,2068
+mccode_plumber/file_writer_control/WorkerFinder.py,sha256=vMv-_YQSdchGDo5TAHQfJODWsatjCyCbLiCwtJJGZi4,6093
+mccode_plumber/file_writer_control/WorkerJobPool.py,sha256=2P6qYNgRtcolSO910a2BejoZyJf4H2ZiSfsVgYzwq8g,2966
+mccode_plumber/file_writer_control/WorkerStatus.py,sha256=uw1q-Pvf1o2hxpMIPVwdtnAXLcO7VeEpcZ3wKjxxdsk,2826
+mccode_plumber/file_writer_control/WriteJob.py,sha256=-2tQvfajctf6Bn19c9hT9N1lOP0uTo7SZRMnXV1A-aA,2721
+mccode_plumber/file_writer_control/__init__.py,sha256=Wp8A7JOB0vgpwAbvI9ik5cBlZa6lY-cq8dxYGRTRs0M,285
+mccode_plumber-0.7.0.dist-info/METADATA,sha256=4_DYv6ndynDY98_6zuO9aaC7e4fnaJ5JEHDz0Lsgjrs,552
+mccode_plumber-0.7.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+mccode_plumber-0.7.0.dist-info/entry_points.txt,sha256=V-ULMAQo7W1O3CLd39iSJcRWNjx9p4OuzEC_8y3T-Zs,520
+mccode_plumber-0.7.0.dist-info/top_level.txt,sha256=kCCIpYtKHCKWxiPEqX9J1UaGEm-ze0Qb-cemBCEPhDA,15
+mccode_plumber-0.7.0.dist-info/RECORD,,

mccode_plumber-0.6.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-mccode_plumber/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mccode_plumber/conductor.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mccode_plumber/epics.py,sha256=THzech5V1UCLIN9u1r3GiEKxUVCDkYVXhfOQV71aQn4,3989
-mccode_plumber/forwarder.py,sha256=1PdW91qLksDnA41-gOFMtgSae4wDdSLVvgAlrF23Uks,3764
-mccode_plumber/kafka.py,sha256=8fHTy2Zzk638XXj29pfrk-7fUxafuse9OYWmaRgvV7M,1195
-mccode_plumber/mccode.py,sha256=WXlu89Cs6a3s0aKtfRGuzqcOWoFZtdZWibLgBQnaXCI,2210
-mccode_plumber/splitrun.py,sha256=MsR1cUvoayQGNCJNl5fIPG92Wfcy9V_8QNO_ITQTvtA,1295
-mccode_plumber/utils.py,sha256=E8NoGo_3Z-pPEpzicVGSWfQOX8p3eR-GxElT33-kX5U,2167
-mccode_plumber/writer.py,sha256=-gdh6fyOtr6mBhm5AZOs4x2D-bo4_zRSgGkNk-X0ez8,16356
-mccode_plumber-0.6.0.dist-info/METADATA,sha256=7NnOPT9uLE_ogTmdR3pSx0-L3T1oUNj9j4cep7pT4LU,513
-mccode_plumber-0.6.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-mccode_plumber-0.6.0.dist-info/entry_points.txt,sha256=V-ULMAQo7W1O3CLd39iSJcRWNjx9p4OuzEC_8y3T-Zs,520
-mccode_plumber-0.6.0.dist-info/top_level.txt,sha256=kCCIpYtKHCKWxiPEqX9J1UaGEm-ze0Qb-cemBCEPhDA,15
-mccode_plumber-0.6.0.dist-info/RECORD,,