mets server: __str__ handlers

ocrd/ocrd/mets_server.py

@@ -95,6 +95,7 @@ def __init__(self, el, mimetype=None, pageId=None, loctype='OTHER', local_filena
             mimetype (string): ``@MIMETYPE`` of this ``mets:file``
             pageId (string): ``@ID`` of the physical ``mets:structMap`` entry corresponding to this ``mets:file``
             loctype (string): ``@LOCTYPE`` of this ``mets:file``
+            url (string): ignored XXX the remote/original file once we have proper mets:FLocat bookkeeping 
             local_filename (): ``@xlink:href`` of this ``mets:file`` - XXX the local file once we have proper mets:FLocat bookkeeping
             ID (string): ``@ID`` of this ``mets:file``
         """
@@ -105,6 +106,13 @@ def __init__(self, el, mimetype=None, pageId=None, loctype='OTHER', local_filena
         self.pageId = pageId
         self.fileGrp = fileGrp
 
+    def __str__(self):
+        props = ', '.join([
+            '='.join([k, getattr(self, k) if hasattr(self, k) and getattr(self, k) else '---'])
+            for k in ['fileGrp', 'ID', 'mimetype', 'url', 'local_filename']
+        ])
+        return '<OcrdFile %s]/>' % (props)
+
 class ClientSideOcrdAgent():
     """
     Provides the same interface as :py:class:`ocrd_models.ocrd_file.OcrdAgent`
@@ -132,6 +140,14 @@ def __init__(self, el, name=None, _type=None, othertype=None, role=None, otherro
         self.otherrole = otherrole
         self.notes = notes
 
+    def __str__(self):
+        props = ', '.join([
+            '='.join([k, getattr(self, k) if getattr(self, k) else '---'])
+            for k in ['type', 'othertype', 'role', 'otherrole', 'name']
+        ])
+        return '<OcrdAgent [' + props + ']/>'
+
+
 class ClientSideOcrdMets():
     """
     Partial substitute for :py:class:`ocrd_models.ocrd_mets.OcrdMets` which provides for
@@ -153,9 +169,11 @@ def __init__(self, host, port, socket):
             self.session = requests_session()
 
     def __getattr__(self, name):
-        if hasattr(self, name):
-            return self.get(name)
-        raise Exception("ClientSideOcrdMets has no access to '%s' - try without METS server", name)
+        raise NotImplementedError(f"ClientSideOcrdMets has no access to '{name}' - try without METS server")
+
+    def __str__(self):
+        return f'<ClientSideOcrdMets[url={self.url}]>'
+
     @deprecated_alias(ID="file_id")
     @deprecated_alias(pageId="page_id")
     @deprecated_alias(fileGrp="file_grp")

tests/test_mets_server.py

@@ -105,3 +105,17 @@ def test_mets_server_add_agents(start_mets_server):
     workspace_file.reload_mets()
 
     assert len(workspace_file.mets.agents) == NO_AGENTS + no_agents_before
+
+def test_mets_server_str(start_mets_server):
+    workspace = Workspace(Resolver(), WORKSPACE_DIR, mets_server_socket=SOCKET_PATH)
+    f = next(workspace.find_files())
+    assert str(f) == '<OcrdFile fileGrp=OCR-D-IMG, ID=INPUT_0017, mimetype=image/tiff, url=---, local_filename=OCR-D-IMG/INPUT_0017.tif]/>'
+    a = workspace.mets.agents[0]
+    assert str(a) == '<OcrdAgent [type=---, othertype=SOFTWARE, role=CREATOR, otherrole=---, name=DFG-Koordinierungsprojekt zur Weiterentwicklung von Verfahren der Optical Character Recognition (OCR-D)]/>'
+    assert str(workspace.mets) == '<ClientSideOcrdMets[url=http+unix://%2Ftmp%2Focrd-mets-server.sock]>'
+
+def test_mets_test_unimplemented(start_mets_server):
+    workspace = Workspace(Resolver(), WORKSPACE_DIR, mets_server_socket=SOCKET_PATH)
+    with raises(NotImplementedError):
+        workspace.mets.rename_file_group('OCR-D-IMG', 'FOO')
+