comicbox.transforms.filename

[docs] module comicbox.transforms.filename 

 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
"""
Parse comic book archive names using the simple 'parse' parser.

A more sophisticaed library like pyparsing or rebulk might be able to
build a faster, more powerful matching engine with fewer parsers with
optional fields. But this brute force method with the parse library is
effective, simple and easy to read and to contribute to.
"""

from bidict import frozenbidict

from comicbox.schemas.comicbox import (
    EXT_KEY,
    ORIGINAL_FORMAT_KEY,
    REMAINDERS_KEY,
    SCAN_INFO_KEY,
    TITLE_KEY,
)
from comicbox.schemas.filename import FilenameSchema
from comicbox.transforms.base import BaseTransform
from comicbox.transforms.comicbox import ISSUE_NAME_KEYPATH, YEAR_KEYPATH
from comicbox.transforms.publishing_tags import (
    ISSUE_COUNT_KEYPATH,
    SERIES_NAME_KEYPATH,
    VOLUME_NUMBER_KEYPATH,
)
from comicbox.transforms.spec import (
    MetaSpec,
    create_specs_from_comicbox,
    create_specs_to_comicbox,
)

SIMPLE_KEY_MAP = frozenbidict(
    {
        "ext": EXT_KEY,
        "issue": ISSUE_NAME_KEYPATH,
        "issue_count": ISSUE_COUNT_KEYPATH,
        "original_format": ORIGINAL_FORMAT_KEY,
        "remainders": REMAINDERS_KEY,
        "series": SERIES_NAME_KEYPATH,
        "scan_info": SCAN_INFO_KEY,
        "title": TITLE_KEY,
        "volume": VOLUME_NUMBER_KEYPATH,
        "year": YEAR_KEYPATH,
    }
)


class FilenameTransform(BaseTransform):
    """File name schema."""

    SCHEMA_CLASS = FilenameSchema
    SPECS_TO = create_specs_to_comicbox(
        MetaSpec(key_map=SIMPLE_KEY_MAP.inverse),
        format_root_keypath=FilenameSchema.ROOT_KEYPATH,
    )
    SPECS_FROM = create_specs_from_comicbox(
        MetaSpec(key_map=SIMPLE_KEY_MAP),
        format_root_keypath=FilenameSchema.ROOT_KEYPATH,
    )