ocrd 3.0.2__py3-none-any.whl → 3.0.3__py3-none-any.whl

ocrd/processor/base.py

@@ -534,15 +534,20 @@ class Processor():
                     # forward messages from log queue (in subprocesses) to all root handlers
                     log_listener = logging.handlers.QueueListener(log_queue, *logging.root.handlers, respect_handler_level=True)
                     log_listener.start()
+                tasks = None
                 try:
                     self._base_logger.debug("started executor %s with %d workers", str(executor), max_workers or 1)
                     tasks = self.process_workspace_submit_tasks(executor, max_seconds)
                     stats = self.process_workspace_handle_tasks(tasks)
                 finally:
                     executor.shutdown(kill_workers=True, wait=False)
+                    self._base_logger.debug("stopped executor %s after %d tasks", str(executor), len(tasks) if tasks else -1)
                     if max_workers > 1:
-                        log_listener.stop()
-                        del log_listener
+                        # can cause deadlock:
+                        #log_listener.stop()
+                        # not much better:
+                        #log_listener.enqueue_sentinel()
+                        pass
 
             except NotImplementedError:
                 # fall back to deprecated method
@@ -670,11 +675,12 @@ class Processor():
                 nr_succeeded += 1
             # else skipped - already exists
         nr_errors = dict(nr_errors)
+        nr_all = nr_succeeded + nr_failed
         if nr_failed > 0:
-            nr_all = nr_succeeded + nr_failed
             if config.OCRD_MAX_MISSING_OUTPUTS > 0 and nr_failed / nr_all > config.OCRD_MAX_MISSING_OUTPUTS:
                 raise Exception(f"too many failures with {reason} output ({nr_failed} of {nr_all}, {str(nr_errors)})")
             self._base_logger.warning("%s %d of %d pages due to %s", reason, nr_failed, nr_all, str(nr_errors))
+        self._base_logger.debug("succeeded %d, missed %d of %d pages due to %s", nr_succeeded, nr_failed, nr_all, str(nr_errors))
         return nr_succeeded, nr_failed, nr_errors, len(tasks)
 
     def process_workspace_handle_page_task(self, page_id : str, input_files : List[Optional[OcrdFileType]], task : TFuture) -> Union[bool, Exception]:

ocrd/processor/helpers.py

@@ -56,13 +56,19 @@ def run_processor(
     - :py:attr:`output_file_grp`
     - :py:attr:`parameter` (after applying any :py:attr:`parameter_override` settings)
 
-    Warning: Avoid setting the `instance_caching` flag to True. It may have unexpected side effects.
-    This flag is used for an experimental feature we would like to adopt in future.
-
     Run the processor on the workspace (creating output files in the filesystem).
 
     Finally, write back the workspace (updating the METS in the filesystem).
 
+    If :py:attr:`instance_caching` is True, then processor instances (for the same set
+    of :py:attr:`parameter` values) will be cached internally. Thus, these objects (and
+    all their memory resources, like loaded models) get re-used instead of re-instantiated
+    when a match occurs - as long as the program is being run. They only get deleted (and
+    their resources freed) when as many as :py:data:`~ocrd_utils.config.OCRD_MAX_PROCESSOR_CACHE`
+    instances have already been cached while this particular parameter set was re-used
+    least frequently. (See :py:class:`~ocrd_network.ProcessingWorker` and
+    :py:class:`~ocrd_network.ProcessorServer` for use-cases.)
+
     Args:
         processorClass (object): Python class of the module processor.
     """

{ocrd-3.0.2.dist-info → ocrd-3.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ocrd
-Version: 3.0.2
+Version: 3.0.3
 Summary: OCR-D framework
 Author-email: Konstantin Baierer <unixprog@gmail.com>
 License: Apache License 2.0

{ocrd-3.0.2.dist-info → ocrd-3.0.3.dist-info}/RECORD

@@ -26,8 +26,8 @@ ocrd/decorators/mets_find_options.py,sha256=d4oATKMP6bFQHNqOK6nLqgUiWF2FYdkPvzkT
 ocrd/decorators/ocrd_cli_options.py,sha256=lIvtE8re1VmpHm45u71ltE0QJS8nyd28HhLC7zGSvlo,2691
 ocrd/decorators/parameter_option.py,sha256=n8hYw7XVTd3i3tvpK8F1Jx_CqRp6EGF9qJVH95yj92Q,1076
 ocrd/processor/__init__.py,sha256=39ymNwYRdc-b_OJzzKmWCvo2ga3KdsGSYDHE1Hzkn_w,274
-ocrd/processor/base.py,sha256=L396ON0p77D8r34CESJ2SIYspTZ6mYFqaBq6DYg6ywM,59315
-ocrd/processor/helpers.py,sha256=8ngrqAJ01BSoSJNsIoK_YfA8QdryM5y0MqaqA9f7ELM,10483
+ocrd/processor/base.py,sha256=wAu3d5E2Vt-rWBejzgZOOnxuI0njgShuLfRZPxyuUGk,59731
+ocrd/processor/helpers.py,sha256=rk7OYucvUgS0fTsxNpYaiPmuyD2l0hVg9uSXb4Jdgow,10975
 ocrd/processor/ocrd_page_result.py,sha256=eDkpyVHcpaBzTHXiGrcNk9PP9Xr-XZru2w_uoX_ZeNA,510
 ocrd/processor/builtin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ocrd/processor/builtin/dummy_processor.py,sha256=a-4kKJ1JeXQuBIyyN8w2R3s7ov-wAfyEdEz3nxrf0sU,3479
@@ -120,9 +120,9 @@ ocrd_validators/xlink.xsd,sha256=8fW7YAMWXN2PbB_MMvj9H5ZeFoEBDzuYBtlGC8_6ijw,318
 ocrd_validators/xsd_mets_validator.py,sha256=4GWfLyqkmca0x7osDuXuExYuM0HWVrKoqn0S35sFhHU,467
 ocrd_validators/xsd_page_validator.py,sha256=BNz_9u-Ek4UCeyZu3KxSQoolfW9lvuaSR9nIu1XXxeE,467
 ocrd_validators/xsd_validator.py,sha256=6HrVAf6SzCvfUIuQdIzz9bOq4V-zhyii9yrUPoK2Uvo,2094
-ocrd-3.0.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-ocrd-3.0.2.dist-info/METADATA,sha256=e6sO3z4kPE8qe8Ne-aPLX5Tl03M_NcrORBnlAQodLDE,10442
-ocrd-3.0.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ocrd-3.0.2.dist-info/entry_points.txt,sha256=4hcJ2LkK_OlIabHnKgFit35Ap7b5Lz1Gb4hzkxV0Kiw,152
-ocrd-3.0.2.dist-info/top_level.txt,sha256=pUgiN42t4KXC5rvpi6V8atza31XP4SCznXpXlVlvomM,75
-ocrd-3.0.2.dist-info/RECORD,,
+ocrd-3.0.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ocrd-3.0.3.dist-info/METADATA,sha256=gZiKn6AO1tPL9NAfVsX0f3UTUZipDtEUOIXmMLXr76k,10442
+ocrd-3.0.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ocrd-3.0.3.dist-info/entry_points.txt,sha256=4hcJ2LkK_OlIabHnKgFit35Ap7b5Lz1Gb4hzkxV0Kiw,152
+ocrd-3.0.3.dist-info/top_level.txt,sha256=pUgiN42t4KXC5rvpi6V8atza31XP4SCznXpXlVlvomM,75
+ocrd-3.0.3.dist-info/RECORD,,