Cache functionality

.circleci/config.yml

@@ -14,7 +14,7 @@ jobs:
       - checkout
       - run: HOMEBREW_NO_AUTO_UPDATE=1 brew install imagemagick geos
       - run: make deps-test install PIP=pip3
-      - run: make test PYTHON=python3
+      - run: make test benchmark PYTHON=python3
 
   test-python36:
     docker:
@@ -24,7 +24,7 @@ jobs:
       - checkout
       - run: apt-get -y update
       - run: make deps-ubuntu deps-test install
-      - run: make test
+      - run: make test benchmark
 
   test-python37:
     docker:
@@ -34,7 +34,7 @@ jobs:
       - checkout
       - run: apt-get -y update
       - run: make deps-ubuntu deps-test install
-      - run: make test
+      - run: make test benchmark
 
   test-python38:
     docker:
@@ -44,7 +44,7 @@ jobs:
       - checkout
       - run: apt-get -y update
       - run: make deps-ubuntu deps-test install
-      - run: make test
+      - run: make test benchmark
 
   test-python39:
     docker:
@@ -54,7 +54,7 @@ jobs:
       - checkout
       - run: apt-get -y update
       - run: make deps-ubuntu deps-test install
-      - run: make test
+      - run: make test benchmark
 
   deploy:
     docker:

Makefile

@@ -149,7 +149,13 @@ assets: repo/assets
 test: assets
 	HOME=$(CURDIR)/ocrd_utils $(PYTHON) -m pytest --continue-on-collection-errors -k TestLogging $(TESTDIR)
 	HOME=$(CURDIR) $(PYTHON) -m pytest --continue-on-collection-errors -k TestLogging $(TESTDIR)
-	$(PYTHON) -m pytest --continue-on-collection-errors --durations=10 --ignore=$(TESTDIR)/test_logging.py $(TESTDIR)
+	$(PYTHON) -m pytest --continue-on-collection-errors --durations=10 --ignore=$(TESTDIR)/test_logging.py --ignore-glob="$(TESTDIR)/**/*bench*.py" $(TESTDIR)
+
+benchmark:
+	$(PYTHON) -m pytest $(TESTDIR)/model/test_ocrd_mets_bench.py
+
+benchmark-extreme:
+	$(PYTHON) -m pytest $(TESTDIR)/model/*bench*.py
 
 test-profile:
 	$(PYTHON) -m cProfile -o profile $$(which pytest)

README.md

@@ -19,6 +19,7 @@
 * [Command line tools](#command-line-tools)
 	* [`ocrd` CLI](#ocrd-cli)
 	* [`ocrd-dummy` CLI](#ocrd-dummy-cli)
+* [Configuration](#configuration)
 * [Packages](#packages)
 	* [ocrd_utils](#ocrd_utils)
 	* [ocrd_models](#ocrd_models)
@@ -82,6 +83,14 @@ supported flags, options and arguments.
 
 A minimal [OCR-D processor](https://ocr-d.de/en/user_guide#using-the-ocr-d-processors) that copies from `-I/-input-file-grp` to `-O/-output-file-grp`
 
+## Configuration
+
+Almost all behaviour of the OCR-D/core software is configured via CLI options and flags, which can be listed with the `--help` flag that all CLI support.
+
+Some parts of the software are configured via environement variables:
+
+* `OCRD_METS_CACHING`: If set to `true`, access to the METS file is cached, speeding in-memory search and modification.
+
 ## Packages
 
 ### ocrd_utils

ocrd_models/ocrd_models/ocrd_file.py

@@ -138,7 +138,6 @@ def pageId(self, pageId):
             raise Exception("OcrdFile %s has no member 'mets' pointing to parent OcrdMets" % self)
         self.mets.set_physical_page_for_file(pageId, self)
 
-
     @property
     def loctype(self):
         """