Skip to content

module book_file

Book's object.

class BookFile

Book's object.

method __init__

__init__(
    title: Optional[str] = None,
    book_id: Optional[str] = None,
    tags: Optional[List[str]] = None,
    rating: Optional[int] = None,
    isbn: Optional[int] = None,
    isbn13: Optional[int] = None,
    review: Optional[str] = None,
    series_titles: Optional[List[str]] = None,
    **kwargs: Any
) → None

Set fields from args. Rewrite them from content if provided.

property content

File content.

Automatically generate content from object's fields if not assigned.

Return file link.

property file_name

Markdown file name.

Automatically generate file name from book's fields if not assigned.

property path

Return file path.

property series

List of series objects constructed from series_names.

method check

check() → bool

Check regexps for the template.

Create file from fields and after that parse it and compare parsed values with the initial fields

method create_series_files

create_series_files() → Dict[str, Path]

Create series files if they do not exist.

Do not change already existed files. Return created series files {series name: series file path}

method parse

parse() → None

Parse file content.

method write

write() → None

Write markdown file to path.

If the file with author - title.md already exists, append book ID to the file name. Even if this file also exists that does not matter because that should be the book with the same ID.

This file was automatically generated via lazydocs.