sl-shared-assets 5.0.0__py3-none-any.whl → 5.0.1__py3-none-any.whl

sl_shared_assets/__init__.py

@@ -11,6 +11,7 @@ from .tools import (
     ProjectManifest,
     delete_directory,
     transfer_directory,
+    generate_project_manifest,
     calculate_directory_checksum,
 )
 from .server import (
@@ -30,6 +31,7 @@ from .data_classes import (
     DrugData,
     ImplantData,
     SessionData,
+    SessionLock,
     SubjectData,
     SurgeryData,
     SessionTypes,
@@ -89,6 +91,7 @@ __all__ = [
     "Server",
     "ServerCredentials",
     "SessionData",
+    "SessionLock",
     "SessionTypes",
     "SubjectData",
     "SurgeryData",
@@ -98,6 +101,7 @@ __all__ = [
     "calculate_directory_checksum",
     "delete_directory",
     "generate_manager_id",
+    "generate_project_manifest",
     "get_credentials_file_path",
     "get_system_configuration_data",
     "get_working_directory",

sl_shared_assets/server/pipeline.py

@@ -169,6 +169,12 @@ class ProcessingTracker(YamlConfig):
     _lock_path: str = field(init=False)
     """Stores the path to the .lock file used to ensure that only a single process can simultaneously access the data 
     stored inside the tracker file."""
+    _job_count: int = 1
+    """Stores the total number of jobs to be executed as part of the tracked pipeline. This is used to 
+    determine when the tracked pipeline is fully complete when tracking intermediate job outcomes."""
+    _completed_jobs: int = 0
+    """Stores the total number of jobs completed by the tracked pipeline. This is used together with the '_job_count' 
+    field to determine when the tracked pipeline is fully complete."""
 
     def __post_init__(self) -> None:
         # Generates the .lock file path for the target tracker .yaml file.
@@ -210,7 +216,7 @@ class ProcessingTracker(YamlConfig):
         original._lock_path = None  # type: ignore
         original.to_yaml(file_path=self.file_path)
 
-    def start(self, manager_id: int) -> None:
+    def start(self, manager_id: int, job_count: int = 1) -> None:
         """Configures the tracker file to indicate that a manager process is currently executing the tracked processing
         runtime.
 
@@ -222,6 +228,10 @@ class ProcessingTracker(YamlConfig):
         Args:
             manager_id: The unique xxHash-64 hash identifier of the manager process which attempts to start the runtime
                 tracked by this tracker file.
+            job_count: The total number of jobs to be executed as part of the tracked pipeline. This is used to make
+                the stop() method properly track the end of the pipeline as a whole, rather than the end of intermediate
+                jobs. Primarily, this is used by multi-job pipelines where all jobs are submitted as part of a single
+                phase and the job completion order cannot be known in-advance.
 
         Raises:
             TimeoutError: If the .lock file for the target .YAML file cannot be acquired within the timeout period.
@@ -253,6 +263,7 @@ class ProcessingTracker(YamlConfig):
             self._manager_id = manager_id
             self._complete = False
             self._encountered_error = False
+            self._job_count = job_count
             self._save_state()
 
     def error(self, manager_id: int) -> None:
@@ -331,12 +342,16 @@ class ProcessingTracker(YamlConfig):
                 console.error(message=message, error=RuntimeError)
                 raise RuntimeError(message)  # Fallback to appease mypy, should not be reachable
 
-            # Otherwise, marks the runtime as complete (stopped)
-            self._running = False
-            self._manager_id = -1
-            self._complete = True
-            self._encountered_error = False
-            self._save_state()
+            # Increments completed job tracker
+            self._completed_jobs += 1
+
+            # If the pipeline has completed all required jobs, marks the runtime as complete (stopped)
+            if self._completed_jobs >= self._job_count:
+                self._running = False
+                self._manager_id = -1
+                self._complete = True
+                self._encountered_error = False
+                self._save_state()
 
     def abort(self) -> None:
         """Resets the runtime tracker file to the default state.

{sl_shared_assets-5.0.0.dist-info → sl_shared_assets-5.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sl-shared-assets
-Version: 5.0.0
+Version: 5.0.1
 Summary: Provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries.
 Project-URL: Homepage, https://github.com/Sun-Lab-NBB/sl-shared-assets
 Project-URL: Documentation, https://sl-shared-assets-api-docs.netlify.app/
@@ -755,7 +755,7 @@ manage the data at all stages of Sun lab data workflow: acquisition, processing,
 - [Authors](#authors)
 - [License](#license)
 - [Acknowledgements](#Acknowledgments)
-- 
+
 ___
 
 ## Dependencies

{sl_shared_assets-5.0.0.dist-info → sl_shared_assets-5.0.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-sl_shared_assets/__init__.py,sha256=U8LE1n48mw1TgNqhESdZ1QKvYbAPCHCEDEjRHSQMIbs,2577
+sl_shared_assets/__init__.py,sha256=97oYSDN15AVCv-nk1MzIs_7FfsQP8ENR1wkJYQc6vEY,2677
 sl_shared_assets/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sl_shared_assets/command_line_interfaces/__init__.py,sha256=dbcCiuBCe1uqz6d1D-dFpSkRwYP603tEGkc1RbZcI6w,126
 sl_shared_assets/command_line_interfaces/configure.py,sha256=lAWhLzJ7UmdvUZlges9Hg5pnblQuXSDlgzr12y41108,6140
@@ -10,14 +10,14 @@ sl_shared_assets/data_classes/session_data.py,sha256=q34M6xDl_ntnvIG_tdDlGrkSXbH
 sl_shared_assets/data_classes/surgery_data.py,sha256=riwyULMdZ8pDXFLdyNByNSeMk1-mVTo1FcCl5FrThas,7495
 sl_shared_assets/server/__init__.py,sha256=6REoeUvHW39V1Uwal_Af4uZ8J6UYDmR2N-saZoau30E,869
 sl_shared_assets/server/job.py,sha256=92nCVaLYqEJH7-xaS0bZmIVoGp-nJ5gh6dnwyRyZ9gI,19406
-sl_shared_assets/server/pipeline.py,sha256=j02AMqpl9TgKh9ASfsj9jUZmueMJ9M1IyFQ6L19SqEo,32359
+sl_shared_assets/server/pipeline.py,sha256=0Peuq499BxKA3GaebQyhl_9VLepuaJQuwwt2vuM5ULg,33503
 sl_shared_assets/server/server.py,sha256=BUELEQbO-sx-9E2epGURCYSGN-I9WAD2dRETMWEPcRU,36483
 sl_shared_assets/tools/__init__.py,sha256=Pf8_MqZOLiityR112Txkermxf1bBLHYdEdw-raeY9Fc,737
 sl_shared_assets/tools/packaging_tools.py,sha256=hvOrdRwQCoe199G_XHhIpbKtIx-I0ad9O4SLZwhgj7U,7035
 sl_shared_assets/tools/project_management_tools.py,sha256=AcZpkzcXyAv4aBn-LIXawQgd7le7-vtZ9dl5MvMFmkg,40365
 sl_shared_assets/tools/transfer_tools.py,sha256=6lwk4zyHWWB0QeWQageiQ1pPIGUV0IhBNNzsbgQ_qH4,9026
-sl_shared_assets-5.0.0.dist-info/METADATA,sha256=2_8gWUYQdol0BRYXGODfNu9xQYk_y9TnljNLqHgC2sU,46886
-sl_shared_assets-5.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sl_shared_assets-5.0.0.dist-info/entry_points.txt,sha256=19NzFPG5CcW-4RhEacTcX3J2TbrvmjOE4tlLCH2O5wI,161
-sl_shared_assets-5.0.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-sl_shared_assets-5.0.0.dist-info/RECORD,,
+sl_shared_assets-5.0.1.dist-info/METADATA,sha256=kH_5OOIkoJbGKbiBoAG8_Ghg5iSisLLsxAV3NjTPY4E,46884
+sl_shared_assets-5.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sl_shared_assets-5.0.1.dist-info/entry_points.txt,sha256=19NzFPG5CcW-4RhEacTcX3J2TbrvmjOE4tlLCH2O5wI,161
+sl_shared_assets-5.0.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+sl_shared_assets-5.0.1.dist-info/RECORD,,