toktokkie.metadata.book_series.components package

Submodules

toktokkie.metadata.book_series.components.BookVolume module

class toktokkie.metadata.book_series.components.BookVolume.BookVolume(volume_number: int, path: str, parent_ids: Dict[toktokkie.enums.IdType, List[str]], ids: Dict[toktokkie.enums.IdType, List[str]])

Bases: toktokkie.metadata.base.components.JsonComponent.JsonComponent

Class that models a Volume in a Book Series

__init__(volume_number: int, path: str, parent_ids: Dict[toktokkie.enums.IdType, List[str]], ids: Dict[toktokkie.enums.IdType, List[str]])

Initializes the Book Volume :param volume_number: The volume number :param path: The path to the volume file :param parent_ids: The IDs of the parent BookSeries object :param ids: The specific IDs for this book volume

classmethod from_json(volume_number: int, path: str, parent_ids: Dict[toktokkie.enums.IdType, List[str]], json_data: Dict[str, Dict[str, List[str]]]) → toktokkie.metadata.book_series.components.BookVolume.BookVolume

Generates a BookVolume object based on json data :param volume_number: The volume number :param path: The path to the volume file :param parent_ids: The IDs of the parent metadata :param json_data: The JSON data :return: None :raises InvalidMetadataException: If the provided JSON is invalid

property json

Returns

A JSON-compatible dictionary representing this object

property name

The name of the volume :return: None

Module contents