nv-ingest-api 2025.2.23.dev20250223233319__py3-none-any.whl → 2025.2.24.dev20250224233318__py3-none-any.whl

nv_ingest_api/primitives/control_message_task.py

@@ -1,10 +1,12 @@
+from uuid import UUID
+
 from pydantic import BaseModel, Field, ConfigDict
-from typing import Any, Dict
+from typing import Any, Dict, Union
 
 
 class ControlMessageTask(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
-    name: str
-    id: str
+    type: str
+    id: Union[str, UUID]
     properties: Dict[str, Any] = Field(default_factory=dict)

nv_ingest_api/primitives/ingest_control_message.py

@@ -12,6 +12,46 @@ from nv_ingest_api.primitives.control_message_task import ControlMessageTask
 logger = logging.getLogger(__name__)
 
 
+def remove_task_by_type(ctrl_msg, task: str):
+    """
+    Remove a task from the control message by matching its type.
+
+    This function iterates over the tasks in the control message, and if it finds a task
+    whose type matches the provided task string, it removes that task (using its unique id)
+    and returns the task's properties.
+
+    Parameters
+    ----------
+    ctrl_msg : IngestControlMessage
+        The control message from which to remove the task.
+    task : str
+        The task type to remove.
+
+    Returns
+    -------
+    dict
+        The properties of the removed task.
+
+    Raises
+    ------
+    ValueError
+        If no task with the given type is found.
+    """
+    task_obj = None
+    for t in ctrl_msg.get_tasks():
+        if t.type == task:
+            task_obj = t
+            break
+
+    if task_obj is None:
+        err_msg = f"process_control_message: Task '{task}' not found in control message."
+        logger.error(err_msg)
+        raise ValueError(err_msg)
+
+    removed_task = ctrl_msg.remove_task(task_obj.id)
+    return removed_task.properties
+
+
 class IngestControlMessage:
     """
     A control message class for ingesting tasks and managing associated metadata,
@@ -53,14 +93,18 @@ class IngestControlMessage:
         """
         return task_id in self._tasks
 
-    def remove_task(self, task_id: str) -> None:
+    def remove_task(self, task_id: str) -> ControlMessageTask:
         """
         Remove a task from the control message. Logs a warning if the task does not exist.
         """
         if task_id in self._tasks:
+            _task = self._tasks[task_id]
+
             del self._tasks[task_id]
+
+            return _task
         else:
-            logger.warning(f"Attempted to remove non-existent task with id: {task_id}")
+            raise RuntimeError(f"Attempted to remove non-existent task with id: {task_id}")
 
     def config(self, config: Dict[str, Any] = None) -> Dict[str, Any]:
         """
@@ -154,7 +198,8 @@ class IngestControlMessage:
         Retrieve timestamps whose keys match the regex filter.
         """
         pattern = re.compile(regex_filter)
-        return {key: ts for key, ts in self._timestamps.items() if pattern.search(key)}
+        timestamps_snapshot = self._timestamps.copy()
+        return {key: ts for key, ts in timestamps_snapshot.items() if pattern.search(key)}
 
     def get_timestamp(self, key: str, fail_if_nonexist: bool = False) -> datetime:
         """
@@ -188,12 +233,14 @@ class IngestControlMessage:
         """
         if isinstance(timestamp, datetime):
             self._timestamps[key] = timestamp
+
         elif isinstance(timestamp, str):
             try:
                 dt = datetime.fromisoformat(timestamp)
                 self._timestamps[key] = dt
             except ValueError as e:
                 raise ValueError(f"Invalid timestamp format: {timestamp}") from e
+
         else:
             raise ValueError("timestamp must be a datetime object or ISO format string")
 

{nv_ingest_api-2025.2.23.dev20250223233319.dist-info → nv_ingest_api-2025.2.24.dev20250224233318.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: nv-ingest-api
-Version: 2025.2.23.dev20250223233319
+Version: 2025.2.24.dev20250224233318
 Summary: Python module with core document ingestion functions.
 Author-email: Jeremy Dyer <jdyer@nvidia.com>
 License:                                  Apache License

nv_ingest_api-2025.2.24.dev20250224233318.dist-info/RECORD

@@ -0,0 +1,9 @@
+nv_ingest_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nv_ingest_api/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nv_ingest_api/primitives/control_message_task.py,sha256=D2NCO6RyJyWZT6Vc2UBpZ6KdYstrTxwuVjPLEX9iQX8,295
+nv_ingest_api/primitives/ingest_control_message.py,sha256=DF6ibcqPE1qiMk7isOL8x1ZlfDLCf6vWvCVUVvMq2Us,8362
+nv_ingest_api-2025.2.24.dev20250224233318.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+nv_ingest_api-2025.2.24.dev20250224233318.dist-info/METADATA,sha256=1x2-8hcEU4DNYp4QTj2Pu9zsZHiXxY27R9f07OICZnU,13873
+nv_ingest_api-2025.2.24.dev20250224233318.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+nv_ingest_api-2025.2.24.dev20250224233318.dist-info/top_level.txt,sha256=abjYMlTJGoG5tOdfIB-IWvLyKclw6HLaRSc8MxX4X6I,14
+nv_ingest_api-2025.2.24.dev20250224233318.dist-info/RECORD,,

nv_ingest_api-2025.2.23.dev20250223233319.dist-info/RECORD

@@ -1,9 +0,0 @@
-nv_ingest_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nv_ingest_api/primitives/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nv_ingest_api/primitives/control_message_task.py,sha256=ZsG-z1IZq60FxLXsb8q3riJ2gjjzb5GtuxQ_RamezNI,252
-nv_ingest_api/primitives/ingest_control_message.py,sha256=d5e03zg-1MEkcYZpjVfGwJabo_XnStP0b76QGBckME0,7134
-nv_ingest_api-2025.2.23.dev20250223233319.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-nv_ingest_api-2025.2.23.dev20250223233319.dist-info/METADATA,sha256=4HGJ5q7mpAKxvz7AtTHH1s-ZKk8oY38gNWEVVXYKwQE,13873
-nv_ingest_api-2025.2.23.dev20250223233319.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-nv_ingest_api-2025.2.23.dev20250223233319.dist-info/top_level.txt,sha256=abjYMlTJGoG5tOdfIB-IWvLyKclw6HLaRSc8MxX4X6I,14
-nv_ingest_api-2025.2.23.dev20250223233319.dist-info/RECORD,,