Skip to main content

Module metadata

Module metadata 

Source

Structsยง

Annotation
BookQuery
FileInfo
Info
Margin
ReaderInfo
TITLE_PREFIXES

Enumsยง

CroppingMargins
PageScheme
ScrollMode
SimpleStatus
SortMethod
Status
TextAlign
ZoomMode

Constantsยง

DEFAULT_CONTRAST_EXPONENT
DEFAULT_CONTRAST_GRAY

Functionsยง

alphabetic_author ๐Ÿ”’
Returns the sort key for an author string by extracting the last word of the first name in a comma-separated list.
alphabetic_title ๐Ÿ”’
Returns the sort key for a title by stripping leading articles based on the bookโ€™s language, delegating to the TITLE_PREFIXES regex table.
consolidate
extract_metadata_from_document
extract_metadata_from_filename
file_name_from_info
make_query
natural_cmp ๐Ÿ”’
Compares two strings using natural sort order so that embedded numbers sort by value rather than by their string representation (โ€œ9โ€ < โ€œ10โ€ < โ€œ100โ€).
numeric_token_len ๐Ÿ”’
Returns the byte length of a numeric token starting at the beginning of s. A numeric token is one or more ASCII digits optionally followed by a single '.' and one or more additional ASCII digits (e.g. "4", "4.5"). A trailing dot with no digits after it (e.g. "4.") is not included.
rename_from_info
sort_added
sort_author
sort_filename
sort_filepath
sort_kind
sort_opened
sort_pages
sort_progress
sort_series
sort_size
sort_status
sort_title
sort_year
sorter

Type Aliasesยง

Metadata