improve progress reporting

osm/pipeline/core.py

@@ -15,9 +15,14 @@ def __init__(self, version: str = "0.0.1"):
         self._orm_model = None
 
     @abstractmethod
-    def run(self, data: Any, **kwargs) -> Any:
+    def _run(self, data: Any, **kwargs) -> Any:
+        """Abstract method that subclasses must implement."""
         pass
 
+    def run(self, data: Any, *args, **kwargs) -> Any:
+        print(f"{self.name} (version {self.version}) is running.")
+        return self._run(data, *args, **kwargs)
+
     def _get_orm_fields(self) -> dict[str, Any]:
         fields = {}
         for fieldname in self.orm_model_class.model_fields.keys():
@@ -100,7 +105,6 @@ def run(self):
             if isinstance(parsed_data, str):
                 self.savers.save_file(parsed_data, self.xml_path)
             for extractor in self.extractors:
-                # extracted_metrics = extractor.run(parsed_data,parser=parser.name)
                 extracted_metrics = extractor.run(parsed_data)
                 self.savers.save_osm(
                     file_in=self.file_data,

osm/pipeline/extractors.py

@@ -8,7 +8,7 @@
 
 
 class RTransparentExtractor(Component):
-    def run(self, data: str, parser: str = None) -> dict:
+    def _run(self, data: str, parser: str = None) -> dict:
         headers = {"Content-Type": "application/octet-stream"}
         response = requests.post(
             "http://localhost:8071/extract-metrics",

osm/pipeline/parsers.py

@@ -10,13 +10,13 @@
 class NoopParser(Component):
     """Used if the input is xml and so needs no parsing."""
 
-    def run(self, data: bytes) -> str:
+    def _run(self, data: bytes) -> str:
         self.sample = LongBytes(data)
         return data.decode("utf-8")
 
 
 class ScienceBeamParser(Component):
-    def run(self, data: bytes) -> str:
+    def _run(self, data: bytes) -> str:
         self.sample = LongBytes(data)
         headers = {"Accept": "application/tei+xml", "Content-Type": "application/pdf"}
         response = requests.post(SCIENCEBEAM_URL, data=data, headers=headers)

osm/pipeline/savers.py

@@ -21,7 +21,7 @@
 class FileSaver(Component):
     """Basic saver that writes data to a file."""
 
-    def run(self, data: str, path: Path):
+    def _run(self, data: str, path: Path):
         """Write data to a file.
 
         Args:
@@ -35,7 +35,7 @@ def run(self, data: str, path: Path):
 class JSONSaver(Component):
     """Saver that writes JSON data to a file."""
 
-    def run(self, data: dict, path: Path):
+    def _run(self, data: dict, path: Path):
         """Write output metrics to a JSON file for the user.
 
         Args:
@@ -66,7 +66,7 @@ def __init__(self, comment, email, user_defined_id, filename):
         self.user_defined_id = user_defined_id
         self.filename = filename
 
-    def run(self, file_in: bytes, metrics: dict, components: list[schemas.Component]):
+    def _run(self, file_in: bytes, metrics: dict, components: list[schemas.Component]):
         """Save the extracted metrics to the OSM API.
 
         Args: