comicbox.identifiers.urns

[docs] module comicbox.identifiers.urns 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
"""Universal Resource Name support."""

from loguru import logger
from urnparse import URN8141, NSIdentifier, NSSString

from comicbox.enums.comicbox import IdSources
from comicbox.enums.maps.identifiers import get_id_source_by_alias
from comicbox.identifiers import DEFAULT_ID_TYPE
from comicbox.identifiers.other import parse_identifier_other_str


def _parse_urn_identifier(tag: str) -> tuple[IdSources | None, str, str]:
    urn = URN8141.from_string(tag)
    id_source_str = str(urn.namespace_id)
    id_source = get_id_source_by_alias(id_source_str, None)
    parts = urn.specific_string.parts
    try:
        id_type = str(parts[-2])
    except IndexError:
        id_type = DEFAULT_ID_TYPE
    id_key = str(parts[-1])
    return id_source, id_type, id_key


def parse_urn_identifier_and_warn(tag: str) -> tuple[IdSources | None, str, str]:
    """Parse an identifier from a tag and log a debug warning."""
    try:
        id_source, id_type, id_key = _parse_urn_identifier(tag)
    except Exception as exc:
        logger.debug(f"Unable to decode urn: {tag} {exc}")
        id_source = None
        id_type = id_key = ""
    return id_source, id_type, id_key


def parse_urn_identifier(tag: str) -> tuple[IdSources | None, str, str]:
    """Parse an identifier from a tag."""
    try:
        id_source, id_type, id_key = _parse_urn_identifier(tag)
    except Exception:
        id_source = None
        id_type = id_key = ""
    return id_source, id_type, id_key


def parse_string_identifier(
    item: str, default_id_source: IdSources | None = None
) -> tuple[IdSources | None, str, str]:
    """Parse identifiers from strings or xml dicts."""
    id_source, id_type, id_key = parse_urn_identifier_and_warn(item)
    if not id_key:
        id_source, id_type, id_key = parse_identifier_other_str(item)
    if not id_source:
        id_source = default_id_source
    if not id_type:
        id_type = DEFAULT_ID_TYPE
    return id_source, id_type, id_key


def to_urn_string(id_source_str: str, id_type: str, id_key_str: str) -> str:
    """Compose an urn string."""
    if "." in id_source_str:
        return ""
    id_source = NSIdentifier(id_source_str)
    id_key_str = id_type + ":" + id_key_str
    id_key = NSSString(id_key_str)
    urn = URN8141(nid=id_source, nss=id_key)
    return str(urn)