comicbox.schemas.comet

[docs] module comicbox.schemas.comet 

 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
"""A class to encapsulate CoMet data."""
# http://www.denvog.com/comet/comet-specification/

from decimal import Decimal
from types import MappingProxyType

from marshmallow.fields import Nested

from comicbox.fields.xml_fields import (
    XmlDateField,
    XmlDecimalField,
    XmlIntegerField,
    XmlIssueField,
    XmlLanguageField,
    XmlReadingDirectionField,
    XmlStringField,
    XmlStringSetField,
)
from comicbox.schemas.xml_schemas import (
    XmlSchema,
    XmlSubHeadSchema,
    create_xml_headers,
)


class CoMetSubSchema(XmlSubHeadSchema):
    """CoMet Sub Schema."""

    DELETE_KEY_MAP = MappingProxyType(
        {
            "reprints": frozenset(
                {
                    "isVersionOf",
                }
            )
        }
    )

    character = XmlStringSetField()
    coverImage = XmlStringField()  # noqa: N815
    date = XmlDateField()
    description = XmlStringField()
    genre = XmlStringSetField()
    identifier = XmlStringSetField(as_string=True)
    isVersionOf = XmlStringSetField(as_string=True)  # noqa: N815
    issue = XmlIssueField()
    language = XmlLanguageField()
    lastMark = XmlIntegerField(minimum=0)  # noqa: N815
    pages = XmlIntegerField(minimum=0)
    publisher = XmlStringField()
    price = XmlDecimalField(minimum=Decimal("0.0"), places=2)
    rating = XmlStringField()
    readingDirection = XmlReadingDirectionField()  # noqa: N815
    rights = XmlStringField()
    series = XmlStringField()
    title = XmlStringField()
    volume = XmlIntegerField(minimum=0)

    # Credit Roles
    colorist = XmlStringSetField()
    coverDesigner = XmlStringSetField()  # noqa: N815
    creator = XmlStringSetField()
    editor = XmlStringSetField()
    inker = XmlStringSetField()
    letterer = XmlStringSetField()
    penciller = XmlStringSetField()
    writer = XmlStringSetField()

    class Meta(XmlSubHeadSchema.Meta):
        """Schema Options."""

        NS = "comet"
        NS_URI = "http://www.denvog.com/comet/"
        XSD_URI = (
            "https://github.com/ajslater/comicbox/blob/main/schemas/CoMet-v1.1.xsd"
        )

        include = MappingProxyType(
            {
                **create_xml_headers(NS, NS_URI, XSD_URI),
                "format": XmlStringField(),
            }
        )


class CoMetSchema(XmlSchema):
    """CoMet Schema."""

    ROOT_TAG: str = "comet"
    ROOT_KEYPATH: str = ROOT_TAG
    HAS_PAGE_COUNT: bool = True

    comet = Nested(CoMetSubSchema)