fix: read the uuid from a file page title with suffixes

- merge the two get_uuid copies into osw.utils.wiki.get_uuid
- OSW.get_uuid delegates to it instead of holding a second copy
- ignore the OSW prefix and any number of file suffixes via regex
- reject a string that is not an OSW-ID instead of parsing it partly

Author: LukasGold

src/osw/core.py

@@ -59,12 +59,14 @@
     get_full_title,
     get_namespace,
     get_title,
-    get_uuid,
     is_empty,
     namespace_from_full_title,
     remove_empty,
     title_from_full_title,
 )
+from osw.utils.wiki import (
+    get_uuid as get_uuid_from_osw_id,
+)
 from osw.wiki_tools import SearchParam
 from osw.wtsite import WtPage, WtSite
 
@@ -197,18 +199,21 @@ def get_osw_id(uuid: Union[str, UUID]) -> str:
 
     @staticmethod
     def get_uuid(osw_id: str) -> UUID:
-        """Returns the uuid for a given OSW-ID
+        """Returns the uuid for a given OSW-ID. Kept for backwards compatibility,
+        the implementation lives in osw.utils.wiki.get_uuid()
 
         Parameters
         ----------
         osw_id
-            OSW-ID string, e.g. OSW2ea5b605c91f4e5a95593dff79fdd4a5
+            OSW-ID string, e.g. OSW2ea5b605c91f4e5a95593dff79fdd4a5, with or
+            without file suffixes, e.g.
+            OSW2ea5b605c91f4e5a95593dff79fdd4a5.drawio.png
 
         Returns
         -------
             uuid object, e.g. UUID("2ea5b605-c91f-4e5a-9559-3dff79fdd4a5")
         """
-        return UUID(osw_id.replace("OSW", ""))
+        return get_uuid_from_osw_id(osw_id)
 
     class SortEntitiesResult(OswBaseModel):
         by_name: Dict[str, List[OswBaseModel]]
@@ -1348,7 +1353,7 @@ def validate_entity(cls, entity, values):
             if jsondata is None:  # Guard clause
                 title = title_from_full_title(page.title)
                 try:
-                    uuid_from_title = get_uuid(title)
+                    uuid_from_title = get_uuid_from_osw_id(title)
                 except ValueError:
                     print(
                         f"Error: UUID could not be determined from title: '{title}', "

src/osw/utils/wiki.py

@@ -1,9 +1,18 @@
+import re
 from copy import deepcopy
 from uuid import UUID
 
 # Legacy imports:
 from opensemantic.v1 import get_full_title, get_namespace, get_title  # noqa: F401
 
+OSW_ID_PATTERN = re.compile(
+    r"^(?:OSW)?"  # the prefix, absent when a bare uuid is passed
+    r"([0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12})"
+    r"(?:\.[\w-]+)*$",  # file suffixes, e.g. '.png' or '.drawio.png'
+    re.IGNORECASE,
+)
+"""Matches an OSW-ID with an optional prefix and any number of file suffixes"""
+
 
 def get_osw_id(uuid: UUID) -> str:
     """Generates a OSW-ID based on the given uuid by prefixing "OSW" and removing
@@ -21,19 +30,33 @@ def get_osw_id(uuid: UUID) -> str:
     return "OSW" + str(uuid).replace("-", "")
 
 
-def get_uuid(osw_id) -> UUID:
-    """Returns the uuid for a given OSW-ID. Duplicate of OSW.get_uuid() from src/sw/core/osw.py
+def get_uuid(osw_id: str) -> UUID:
+    """Returns the uuid for a given OSW-ID. The single implementation, wrapped by
+    OSW.get_uuid() from src/osw/core.py
+
+    A file page keeps its file extension in the title, so the OSW-ID of a file is
+    followed by one or more suffixes that are not part of the uuid. These are
+    ignored, as is the OSW prefix.
 
     Parameters
     ----------
     osw_id
-        OSW-ID string, e.g., OSW2ea5b605c91f4e5a95593dff79fdd4a5
+        OSW-ID string, e.g., OSW2ea5b605c91f4e5a95593dff79fdd4a5, with or without
+        file suffixes, e.g., OSW2ea5b605c91f4e5a95593dff79fdd4a5.drawio.png
 
     Returns
     -------
         uuid object, e.g., UUID("2ea5b605-c91f-4e5a-9559-3dff79fdd4a5")
+
+    Raises
+    ------
+    ValueError
+        If no OSW-ID can be read from the given string.
     """
-    return UUID(osw_id.replace("OSW", ""))
+    match = OSW_ID_PATTERN.match(osw_id)
+    if match is None:
+        raise ValueError(f"No OSW-ID could be read from '{osw_id}'")
+    return UUID(match.group(1))
 
 
 def namespace_from_full_title(full_title: str) -> str:

tests/utils/utils_test.py

@@ -1,6 +1,9 @@
 import uuid
 
+import pytest
+
 import osw.model.entity as model
+from osw.core import OSW
 from osw.utils.regex import count_match_groups
 from osw.utils.strings import camel_case, pascal_case
 from osw.utils.wiki import (
@@ -28,6 +31,49 @@ def test_get_uuid():
     assert get_uuid(osw_id) == uuid_
 
 
+@pytest.mark.parametrize(
+    "suffix", ["", ".png", ".drawio.png", ".tar.gz", ".jpg-2", ".a.b.c.d"]
+)
+def test_get_uuid_ignores_file_suffixes(suffix):
+    """File pages carry their extension in the title, ahead of the OSW-ID."""
+    uuid_ = uuid.uuid4()
+    osw_id = f"OSW{str(uuid_).replace('-', '')}{suffix}"
+
+    assert get_uuid(osw_id) == uuid_
+
+
+@pytest.mark.parametrize("prefix", ["", "OSW", "osw"])
+def test_get_uuid_accepts_a_bare_uuid(prefix):
+    uuid_ = uuid.uuid4()
+
+    assert get_uuid(f"{prefix}{str(uuid_).replace('-', '')}") == uuid_
+    assert get_uuid(f"{prefix}{uuid_}") == uuid_  # dashed
+
+
+@pytest.mark.parametrize(
+    "osw_id",
+    [
+        "",
+        "OSW",
+        "Category:OSW2ea5b605c91f4e5a95593dff79fdd4a5",  # full title, not an ID
+        "OSW2ea5b605c91f4e5a95593dff79fdd4a",  # one character short
+        "OSW2ea5b605c91f4e5a95593dff79fdd4a5x",
+        "OSW2ea5b605c91f4e5a95593dff79fdd4a5.",  # empty suffix
+        "OSWzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz",
+    ],
+)
+def test_get_uuid_rejects_what_is_not_an_osw_id(osw_id):
+    with pytest.raises(ValueError):
+        get_uuid(osw_id)
+
+
+def test_osw_get_uuid_delegates():
+    """OSW.get_uuid is a wrapper, so it must handle suffixes just the same."""
+    osw_id = "OSW2ea5b605c91f4e5a95593dff79fdd4a5.drawio.png"
+
+    assert OSW.get_uuid(osw_id) == get_uuid(osw_id)
+
+
 def test_get_entity_namespace():
     class DummyClass(model.Entity):
         pass