feat: custom success message for ExtractionPipelineRun

CHANGELOG.md

@@ -12,6 +12,12 @@ Changes are grouped as follows
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## 7.5.12
+
+## Added
+
+- Allow users to override what message to send on shutdown
+
 ## 7.5.11
 
 ### Added

cognite/extractorutils/__init__.py

@@ -16,7 +16,7 @@
 Cognite extractor utils is a Python package that simplifies the development of new extractors.
 """
 
-__version__ = "7.5.11"
+__version__ = "7.5.12"
 from .base import Extractor
 
 __all__ = ["Extractor"]

cognite/extractorutils/base.py

@@ -90,6 +90,7 @@ def __init__(
         handle_interrupts: bool = True,
         reload_config_interval: int | None = 300,
         reload_config_action: ReloadConfigAction = ReloadConfigAction.DO_NOTHING,
+        success_message: str = "Successful shutdown",
     ):
         self.name = name
         self.description = description
@@ -104,6 +105,7 @@ def __init__(
         self.handle_interrupts = handle_interrupts
         self.reload_config_interval = reload_config_interval
         self.reload_config_action = reload_config_action
+        self.success_message = success_message
 
         self.started = False
         self.configured_logger = False
@@ -218,7 +220,7 @@ def _report_success(self) -> None:
                 ExtractionPipelineRun(
                     extpipe_external_id=self.extraction_pipeline.external_id,
                     status="success",
-                    message="Successful shutdown",
+                    message=self.success_message,
                 )
             )
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite-extractor-utils"
-version = "7.5.11"
+version = "7.5.12"
 description = "Utilities for easier development of extractors for CDF"
 authors = [
     {name = "Mathias Lohne", email = "mathias.lohne@cognite.com"}