Reference for all built-in template language functions

Here, we document all the built-in functions available in the calibre template language. Every function is implemented as a class in python and you can click the source links to see the source code, in case the documentation is insufficient. The functions are arranged in logical groups by type.

Arithmetic

add(x [, y]*)

class calibre.utils.formatter_functions.BuiltinAdd[źródło]

add(x [, y]*) – returns the sum of its arguments. Throws an exception if an argument is not a number. This function can often be replaced with the + operator.

ceiling(x)

class calibre.utils.formatter_functions.BuiltinCeiling[źródło]

ceiling(x) – returns the smallest integer greater than or equal to x. Throws an exception if x is not a number.

divide(x, y)

class calibre.utils.formatter_functions.BuiltinDivide[źródło]

divide(x, y) – returns x / y. Throws an exception if either x or y are not numbers. This function can often be replaced with the / operator.

floor(x)

class calibre.utils.formatter_functions.BuiltinFloor[źródło]

floor(x) – returns the largest integer less than or equal to x. Throws an exception if x is not a number.

fractional_part(x)

class calibre.utils.formatter_functions.BuiltinFractionalPart[źródło]

fractional_part(x) – returns the value after the decimal point. For example, fractional_part(3.14) returns 0.14. Throws an exception if x is not a number.

mod(x)

class calibre.utils.formatter_functions.BuiltinMod[źródło]

mod(x) – returns floor(remainder of x / y). Throws an exception if either x or y is not a number.

multiply(x [, y]*)

class calibre.utils.formatter_functions.BuiltinMultiply[źródło]

multiply(x [, y]*) – returns the product of its arguments. Throws an exception if any argument is not a number. This function can often be replaced with the * operator.

round(x)

class calibre.utils.formatter_functions.BuiltinRound[źródło]

round(x) – returns the nearest integer to x. Throws an exception if x is not a number.

subtract(x, y)

class calibre.utils.formatter_functions.BuiltinSubtract[źródło]

subtract(x, y) – returns x - y. Throws an exception if either x or y are not numbers. This function can often be replaced with the - operator.

Boolean

and(value [, value]*)

class calibre.utils.formatter_functions.BuiltinAnd[źródło]

and(value [, value]*) – returns the string „1” if all values are not empty, otherwise returns the empty string. This function works well with test or first_non_empty. You can have as many values as you want. In many cases the && operator can replace this function.

not(value)

class calibre.utils.formatter_functions.BuiltinNot[źródło]

not(value) – returns the string „1” if the value is empty, otherwise returns the empty string. This function works well with test or first_non_empty. In many cases the ! operator can replace this function.

or(value [, value]*)

class calibre.utils.formatter_functions.BuiltinOr[źródło]

or(value [, value]*) – returns the string „1” if any value is not empty, otherwise returns the empty string. This function works well with test or first_non_empty. You can have as many values as you want. In many cases the || operator can replace this function.

Date functions

date_arithmetic(date, calc_spec, fmt)

class calibre.utils.formatter_functions.BuiltinDateArithmetic[źródło]

date_arithmetic(date, calc_spec, fmt) – Calculate a new date from «date» using «calc_spec». Return the new date formatted according to optional «fmt»: if not supplied then the result will be in iso format. The calc_spec is a string formed by concatenating pairs of «vW» (valueWhat) where «v» is a possibly-negative number and W is one of the following letters: s: add «v» seconds to «date» m: add «v» minutes to «date» h: add «v» hours to «date» d: add «v» days to «date» w: add «v» weeks to «date» y: add «v» years to «date», where a year is 365 days. Example: «1s3d-1m» will add 1 second, add 3 days, and subtract 1 minute from «date».

days_between(data1, data2)

class calibre.utils.formatter_functions.BuiltinDaysBetween[źródło]

days_between(data1, data2) – Zwraca liczbę dni między data1 a data2. Liczba jest dodatnia jeśli data1 jest większa niż data2, w przeciwnym przypadku ujemna. Jeśli obie daty są nieprawidłowe (ciągi znaków nie są datami) zwracany jest pusty ciąg znaków.

today()

class calibre.utils.formatter_functions.BuiltinToday[źródło]

today() – zwraca bieżącą datę w postaci tekstu. Wynik jest przeznaczony do użycia w funkcjach format_date lub days_between, ale może być przetwarzany jak każdy inny łańcuch. Data jest w formacie ISO.

Formatting values

finish_formatting(wartość, fmt, przedrostek, przyrostek)

class calibre.utils.formatter_functions.BuiltinFinishFormatting[źródło]

finish_formatting(wartość, fmt, przedrostek, przyrostek) – zastosuj format, przedrostek i przyrostek do wartości tak jak to się dzieje w szablonach takich jak {series_index:05.2f| - |- }. Na przykład następujący program zwróci wynik taki sam jak powyższy szablon: program: finish_formatting(field(„series_index”), „05.2f”, „ - „, „ - „)

format_date(val, format_string)

class calibre.utils.formatter_functions.BuiltinFormatDate[źródło]

format_date(val, format_string) – format the value, which must be a date, using the format_string, returning a string. The formatting codes are: d : the day as number without a leading zero (1 to 31) dd : the day as number with a leading zero (01 to 31) ddd : the abbreviated localized day name (e.g. „Mon” to „Sun”). dddd : the long localized day name (e.g. „Monday” to „Sunday”). M : the month as number without a leading zero (1 to 12). MM : the month as number with a leading zero (01 to 12) MMM : the abbreviated localized month name (e.g. „Jan” to „Dec”). MMMM : the long localized month name (e.g. „January” to „December”). yy : the year as two digit number (00 to 99). yyyy : the year as four digit number. h : the hours without a leading 0 (0 to 11 or 0 to 23, depending on am/pm) hh : the hours with a leading 0 (00 to 11 or 00 to 23, depending on am/pm) m : the minutes without a leading 0 (0 to 59) mm : the minutes with a leading 0 (00 to 59) s : the seconds without a leading 0 (0 to 59) ss : the seconds with a leading 0 (00 to 59) ap : use a 12-hour clock instead of a 24-hour clock, with „ap” replaced by the localized string for am or pm AP : use a 12-hour clock instead of a 24-hour clock, with „AP” replaced by the localized string for AM or PM iso : the date with time and timezone. Must be the only format present to_number: the date as a floating point number from_number[:fmt]: format the timestamp using fmt if present otherwise iso

format_number(v, template)

class calibre.utils.formatter_functions.BuiltinFormatNumber[źródło]

format_number(v, template) – format the number v using a Python formatting template such as „{0:5.2f}” or „{0:,d}” or „${0:5,.2f}”. The field_name part of the template must be a 0 (zero) (the „{0:” in the above examples). See the template language and Python documentation for more examples. You can leave off the leading „{0:” and trailing „}” if the template contains only a format. Returns the empty string if formatting fails.

human_readable(v)

class calibre.utils.formatter_functions.BuiltinHumanReadable[źródło]

human_readable(v) – zwraca ciąg znaków reprezentujący liczbę v w KB, MB, GB itd.

rating_to_stars(value, use_half_stars)

class calibre.utils.formatter_functions.BuiltinRatingToStars[źródło]

rating_to_stars(value, use_half_stars) – Returns the rating as string of star characters. The value is a number between 0 and 5. Set use_half_stars to 1 if you want half star characters for custom ratings columns that support non-integer ratings, for example 2.5.

urls_from_identifiers(identifiers, sort_results)

class calibre.utils.formatter_functions.BuiltinUrlsFromIdentifiers[źródło]

urls_from_identifiers(identifiers, sort_results) – given a comma-separated list of identifiers, where an identifier is a colon-separated pair of values (name:id_value), returns a comma-separated list of HTML URLs generated from the identifiers. The list not sorted if sort_results is 0 (character or number), otherwise it is sorted alphabetically by the identifier name. The URLs are generated in the same way as the built-in identifiers column when shown in Book details.

Get values from metadata

annotation_count()

class calibre.utils.formatter_functions.BuiltinAnnotationCount[źródło]

annotation_count() – return the total number of annotations of all types attached to the current book. This function works only in the GUI.

approximate_formats()

class calibre.utils.formatter_functions.BuiltinApproximateFormats[źródło]

approximate_formats() – zwraca oddzielaną przecinkami listę formatów, które w pewnym momencie były powiązane z książką. Nie ma gwarancji, że jest to prawidłowa lista, chociaż prawdopodobnie jest. Ta funkcja może zostać wywołana w trybie programowym przy użyciu szablonu „{:»approximate_formats()»}”. Formaty są zawsze pisane wielkimi literami np. EPUB. Ta funkcja działa wyłącznie w GUI. Jeśli jej wynik ma być użyty przy zapisywaniu na dysk lub wysyłaniu do urządzenia to trzeba stworzyć kolumnę typu „Kolumna składająca się z innych kolumn”, zastosować funkcję w szablonie tej kolumny, a następnie użyć kolumny w szablonie zapisywania/wysyłania.

author_sorts(val_separator)

class calibre.utils.formatter_functions.BuiltinAuthorSorts[źródło]

author_sorts(val_separator) – zwraca ciąg znaków, zawierający wartości sortowania dla autorów w danej książce. Sortowanie to dotyczy metadanych autorów (nie jest tym samym, co author_sort w książkach). Lista ma postać autor 1 val_separator autor 2 itp. Autorzy na tej liście są w tej samej kolejności, co w książce. Spacje przed i po separatorze zostaną dodane tylko wtedy, kiedy będą uwzględnione w ciągu znaków val_separator.

booksize()

class calibre.utils.formatter_functions.BuiltinBooksize[źródło]

booksize() – zwraca wartość pola «wielkość». Ta funkcja działa wyłącznie w GUI. Jeśli jej wynik ma być użyty przy zapisywaniu na dysk lub wysyłaniu do urządzenia to trzeba stworzyć kolumnę typu „Kolumna składająca się z innych kolumn”, zastosować funkcję w szablonie tej kolumny, a następnie użyć kolumny w szablonie zapisywania/wysyłania.

connected_device_name(storage_location)

class calibre.utils.formatter_functions.BuiltinConnectedDeviceName[źródło]

connected_device_name(storage_location) – if a device is connected then return the device name, otherwise return the empty string. Each storage location on a device can have a different name. The location names are «main», «carda» and «cardb». This function works only in the GUI.

connected_device_uuid(storage_location)

class calibre.utils.formatter_functions.BuiltinConnectedDeviceUUID[źródło]

connected_device_uuid(storage_location) – if a device is connected then return the device uuid (unique id), otherwise return the empty string. Each storage location on a device has a different uuid. The location names are «main», «carda» and «cardb». This function works only in the GUI.

current_library_name()

class calibre.utils.formatter_functions.BuiltinCurrentLibraryName[źródło]

current_library_name() – zwraca ostatnią część ścieżki bieżącej biblioteki. Ta funkcja może być używana trybie programowym przy użyciu szablonu „{:»current_library_name()»}”.

current_library_path()

class calibre.utils.formatter_functions.BuiltinCurrentLibraryPath[źródło]

current_library_path() – zwraca ścieżkę do aktualnie używanej biblioteki. Ta funkcja może być wywołana w szablonie w trybie programu za pomocą „{:»current_library_path()»}”.

current_virtual_library_name()

class calibre.utils.formatter_functions.BuiltinCurrentVirtualLibraryName[źródło]

current_virtual_library_name() – return the name of the current virtual library if there is one, otherwise the empty string. Library name case is preserved. Example: „program: current_virtual_library_name()”.

field(lookup_name)

class calibre.utils.formatter_functions.BuiltinField[źródło]

field(lookup_name) – returns the metadata field named by lookup_name

formats_modtimes(date_format)

class calibre.utils.formatter_functions.BuiltinFormatsModtimes[źródło]

formats_modtimes(date_format) – zwraca oddzielaną przecinkami listę, której elementy są parami oddzielonymi dwukropkiem i reprezentują datę ostatniej modyfikacji poszczególnych formatów. Argument date_format określa sposób formatowania daty. Informacje o sposobach formatowania daty znajdziesz w opisie funkcji date_format. Aby wybrać datę modyfikacji konkretnego formatu książki można użyć funcji select. Należy pamiętać, że nazwy formatów są zawsze pisane wielkimi literami, np. EPUB.

formats_paths()

class calibre.utils.formatter_functions.BuiltinFormatsPaths[źródło]

formats_paths() – zwraca oddzielaną przecinkami listę elementów, które składają się z nazwy formatu i ścieżki, oddzielonych średnikami. Dzięki tej funkcji można uzyskać ścieżkę do konkretnego formatu. Nazwy formatów są zawsze pisane wielkimi literami np. EPUB.

formats_sizes()

class calibre.utils.formatter_functions.BuiltinFormatsSizes[źródło]

formats_sizes() – zwraca oddzielaną przecinkami listę, której elementy są parami oddzielonymi dwukropkiem i reprezentują rozmiar poszczególnych formatów książki w bajtach. Możesz użyć funkcji select żeby wybrać konkretny format. Należy pamiętać, że nazwy formatów są zawsze pisane wielkimi literami np. EPUB.

has_cover()

class calibre.utils.formatter_functions.BuiltinHasCover[źródło]

has_cover() – zwraca Yes jeśli książka ma okładkę, w przeciwnym wypadku pusty łańcuch

is_marked()

class calibre.utils.formatter_functions.BuiltinIsMarked[źródło]

is_marked() – check whether the book is «marked» in calibre. If it is then return the value of the mark, either «true» or the comma-separated list of named marks. Returns «» if the book is not marked.

language_codes(lang_strings)

class calibre.utils.formatter_functions.BuiltinLanguageCodes[źródło]

language_codes(lang_strings) – zwraca kody języka dla podanych ciągów. Ciągi muszą być w języku bieżącej lokalizacji. Lang_strings jest listą rozdzielaną przecinkami.

ondevice()

class calibre.utils.formatter_functions.BuiltinOndevice[źródło]

ondevice() – zwraca Yes jeśli parametr ondevice jest ustawiony, w przeciwnym przypadku pusty ciąg. Ta funkcja działa wyłącznie w GUI. Jeśli jej wynik ma być użyty przy zapisywaniu na dysk lub wysyłaniu do urządzenia to trzeba stworzyć kolumnę typu „Kolumna składająca się z innych kolumn”, zastosować funkcję w szablonie tej kolumny, a następnie użyć kolumny w szablonie zapisywania/wysyłania.

raw_field(lookup_name [, optional_default])

class calibre.utils.formatter_functions.BuiltinRawField[źródło]

raw_field(lookup_name [, optional_default]) – returns the metadata field named by lookup_name without applying any formatting. It evaluates and returns the optional second argument «default» if the field is undefined («None»).

raw_list(lookup_name, separator)

class calibre.utils.formatter_functions.BuiltinRawList[źródło]

raw_list(lookup_name, separator) – returns the metadata list named by lookup_name without applying any formatting or sorting and with items separated by separator.

series_sort()

class calibre.utils.formatter_functions.BuiltinSeriesSort[źródło]

series_sort() – zwraca wartość pola sortowania serii

user_categories()

class calibre.utils.formatter_functions.BuiltinUserCategories[źródło]

user_categories() – zwraca rozdzielaną przecinkami listę kategorii zdefiniowanych przez użytkownika, zawierających daną książkę. Funkcja działa wyłącznie w GUI. Jeśli jej wynik ma być użyty przy zapisywaniu na dysk lub wysyłaniu do urządzenia to trzeba stworzyć kolumnę typu „Kolumna składająca się z innych kolumn”, zastosować funkcję w szablonie tej kolumny, a następnie użyć kolumny w szablonie zapisywania/wysyłania.

virtual_libraries()

class calibre.utils.formatter_functions.BuiltinVirtualLibraries[źródło]

virtual_libraries() – return a comma-separated list of Virtual libraries that contain this book. This function works only in the GUI. If you want to use these values in save-to-disk or send-to-device templates then you must make a custom „Column built from other columns”, use the function in that column’s template, and use that column’s value in your save/send templates

If-then-else

check_yes_no(field_name, is_undefined, is_false, is_true)

class calibre.utils.formatter_functions.BuiltinCheckYesNo[źródło]

check_yes_no(field_name, is_undefined, is_false, is_true) – checks the value of the yes/no field named by the lookup key field_name for a value specified by the parameters, returning „yes” if a match is found, otherwise returning an empty string. Set the parameter is_undefined, is_false, or is_true to 1 (the number) to check that condition, otherwise set it to 0. Example: check_yes_no(„#bool”, 1, 0, 1) returns „yes” if the yes/no field „#bool” is either undefined (neither True nor False) or True. More than one of is_undefined, is_false, or is_true can be set to 1. This function is usually used by the test() or is_empty() functions.

contains(val, pattern, text if match, text if not match)

class calibre.utils.formatter_functions.BuiltinContains[źródło]

contains(val, pattern, text if match, text if not match) – checks if val contains matches for the regular expression pattern. Returns text if match if matches are found, otherwise it returns text if no match

field_exists(field_name)

class calibre.utils.formatter_functions.BuiltinFieldExists[źródło]

field_exists(field_name) – checks if a field (column) named field_name exists, returning «1» if so and «» if not.

ifempty(val, tekst jeśli pusty)

class calibre.utils.formatter_functions.BuiltinIfempty[źródło]

ifempty(val, tekst jeśli pusty) – zwraca val jeśli val nie jest pusty, w przeciwnym wypadku zwraca tekst jeśli pusty

test(val, text if not empty, text if empty)

class calibre.utils.formatter_functions.BuiltinTest[źródło]

test(val, text if not empty, text if empty) – return text if not empty if val is not empty, otherwise return text if empty

Iterating over values

first_non_empty(value [, value]*)

class calibre.utils.formatter_functions.BuiltinFirstNonEmpty[źródło]

first_non_empty(value [, value]*) – returns the first value that is not empty. If all values are empty, then the empty string is returned. You can have as many values as you want.

lookup(val, [pattern, field,]+ else_field)

class calibre.utils.formatter_functions.BuiltinLookup[źródło]

lookup(val, [pattern, field,]+ else_field) – like switch, except the arguments are field (metadata) names, not text. The value of the appropriate field will be fetched and used. Note that because composite columns are fields, you can use this function in one composite field to use the value of some other composite field. This is extremely useful when constructing variable save paths

switch(val, [pattern, value,]+ else_value)

class calibre.utils.formatter_functions.BuiltinSwitch[źródło]

switch(val, [pattern, value,]+ else_value) – for each pattern, value pair, checks if val matches the regular expression pattern and if so, returns that value. If no pattern matches, then else_value is returned. You can have as many pattern, value pairs as you want

List lookup

identifier_in_list(val, id, found_val, not_found_val)

class calibre.utils.formatter_functions.BuiltinIdentifierInList[źródło]

identifier_in_list(val, id, found_val, not_found_val) – Potraktuj val jako listę elementów oddzielanych przecinkami i porównaj każdy jej element z id. Elementy listy powinny mieć postać „identyfikator:wartość”. Argument id powinien mieć postać „id” albo „id:regexp”. W pierwszym przypadku warunek jest spełniony jeśli lista zawiera podane id. W drugim przypadku dodatkowo wartość elementu listy musi pasować do wyrażenia regularnego. Jeśli warunek jest spełniony jest zwracana wartość found_val, w przeciwnym przypadku wartość not_found_val.

in_list(val, separator, [ pattern, found_val, ]+ not_found_val)

class calibre.utils.formatter_functions.BuiltinInList[źródło]

in_list(val, separator, [ pattern, found_val, ]+ not_found_val) – treating val as a list of items separated by separator, if the pattern matches any of the list values then return found_val.If the pattern matches no list value then return not_found_val. The pattern and found_value pairs can be repeated as many times as desired. The patterns are checked in order. The found_val for the first match is returned. Aliases: in_list(), list_contains()

list_item(val, index, separator)

class calibre.utils.formatter_functions.BuiltinListitem[źródło]

list_item(val, index, separator) – interpretuje wartość jako listę oddzielaną separatorem, zwraca index elementu. Pierwszy element to numer zero. Ostatni element może zostać zwrócony przy użyciu list_item(-1,separator). Jeśli element nie jest w liście, wówczas zwrócona zostaje pusta wartość. Separator ma takie samo znaczenie jak w funkcji count.

select(val, key)

class calibre.utils.formatter_functions.BuiltinSelect[źródło]

select(val, key) – interpret the value as a comma-separated list of items, with the items being „id:value”. Find the pair with the id equal to key, and return the corresponding value. Returns the empty string if no match is found.

str_in_list(val, separator, [string, found_val, ]+ not_found_val)

class calibre.utils.formatter_functions.BuiltinStrInList[źródło]

str_in_list(val, separator, [string, found_val, ]+ not_found_val) – treating val as a list of items separated by separator, if the string matches any of the list values then return found_val.If the string matches no list value then return not_found_val. The comparison is exact match (not contains) and is case insensitive. The string and found_value pairs can be repeated as many times as desired. The patterns are checked in order. The found_val for the first match is returned.

List manipulation

count(val, separator)

class calibre.utils.formatter_functions.BuiltinCount[źródło]

count(val, separator) – interprets the value as a list of items separated by separator, returning the number of items in the list. Most lists use a comma as the separator, but authors uses an ampersand. Examples: {tags:count(,)}, {authors:count(&)}. Aliases: count(), list_count()

list_count_matching(list, pattern, separator)

class calibre.utils.formatter_functions.BuiltinListCountMatching[źródło]

list_count_matching(list, pattern, separator) – interprets «list» as a list of items separated by «separator», returning the number of items in the list that match the regular expression «pattern». Aliases: list_count_matching(), count_matching()

list_difference(list1, list2, separator)

class calibre.utils.formatter_functions.BuiltinListDifference[źródło]

list_difference(list1, list2, separator) – return a list made by removing from list1 any item found in list2, using a case-insensitive comparison. The items in list1 and list2 are separated by separator, as are the items in the returned list.

list_equals(list1, sep1, list2, sep2, yes_val, no_val)

class calibre.utils.formatter_functions.BuiltinListEquals[źródło]

list_equals(list1, sep1, list2, sep2, yes_val, no_val) – return yes_val if list1 and list2 contain the same items, otherwise return no_val. The items are determined by splitting each list using the appropriate separator character (sep1 or sep2). The order of items in the lists is not relevant. The comparison is case insensitive.

list_intersection(list1, list2, separator)

class calibre.utils.formatter_functions.BuiltinListIntersection[źródło]

list_intersection(list1, list2, separator) – return a list made by removing from list1 any item not found in list2, using a case-insensitive comparison. The items in list1 and list2 are separated by separator, as are the items in the returned list.

list_join(with_separator, list1, separator1 [, list2, separator2]*)

class calibre.utils.formatter_functions.BuiltinListJoin[źródło]

list_join(with_separator, list1, separator1 [, list2, separator2]*) – return a list made by joining the items in the source lists (list1, etc) using with_separator between the items in the result list. Items in each source list[123…] are separated by the associated separator[123…]. A list can contain zero values. It can be a field like publisher that is single-valued, effectively a one-item list. Duplicates are removed using a case-insensitive comparison. Items are returned in the order they appear in the source lists. If items on lists differ only in letter case then the last is used. All separators can be more than one character. Example:

program:

list_join(«#@#», $authors, «&», $tags, «,»)

You can use list_join on the results of previous calls to list_join as follows:

program:

a = list_join(«#@#», $authors, «&», $tags, «,»); b = list_join(«#@#», a, «#@#», $#genre, «,», $#people, «&»)

Możesz użyć wyrażeń do wygenerowania listy. Załóżmy na przykład, że chcesz mieć pozycje dla autorów i #gatunek, ale po zmianie gatunku na słowo „Genre:” z pierwszą literą gatunku, tj. gatunek „Fiction” staje się „Genre: F”. Zrobią to następujące:
program:

list_join(«#@#», $authors, «&», list_re($#genre, «,», «^(.).*$», «Genre: 1»), «,»)

list_re(src_list, separator, include_re, opt_replace)

class calibre.utils.formatter_functions.BuiltinListRe[źródło]

list_re(src_list, separator, include_re, opt_replace) – konstruuje listę, dzieląc src_list przy użyciu znaku separator. Dla każdego elementu listy sprawdza, czy pasuje on do include_re. Jeśli tak - dodaje go do zwracanej listy. Jeżeli opt_replace nie jest pustym ciągiem, następuje zamiana przed umieszczeniem elementu na liście.

list_re_group(src_list, separator, include_re, search_re [, group_template]+)

class calibre.utils.formatter_functions.BuiltinListReGroup[źródło]

list_re_group(src_list, separator, include_re, search_re [, group_template]+) – Like list_re except replacements are not optional. It uses re_group(list_item, search_re, group_template, …) when doing the replacements on the resulting list.

list_remove_duplicates(list, separator)

class calibre.utils.formatter_functions.BuiltinListRemoveDuplicates[źródło]

list_remove_duplicates(list, separator) – return a list made by removing duplicate items in the source list. If items differ only in case, the last of them is returned. The items in source list are separated by separator, as are the items in the returned list.

list_sort(lista, kolejność, separator)

class calibre.utils.formatter_functions.BuiltinListSort[źródło]

list_sort(lista, kolejność, separator) – zwraca posortowaną listę. Wielkość znaków nie ma znaczenia. Jeśli kolejność = 0 sortowanie jest rosnąco, w przeciwnym przypadku malejąco. Elementy listy wynikowej są oddzielane tym samym separatorem co listy źródłowej.

list_split(list_val, sep, id_prefix)

class calibre.utils.formatter_functions.BuiltinListSplit[źródło]

list_split(list_val, sep, id_prefix) – splits the list_val into separate values using «sep», then assigns the values to variables named «id_prefix_N» where N is the position of the value in the list. The first item has position 0 (zero). The function returns the last element in the list. Example: split(«one:two:foo», «:», «var») is equivalent to var_0 = «one»; var_1 = «two»; var_2 = «foo».

list_union(list1, list2, separator)

class calibre.utils.formatter_functions.BuiltinListUnion[źródło]

list_union(list1, list2, separator) – return a list made by merging the items in list1 and list2, removing duplicate items using a case-insensitive comparison. If items differ in case, the one in list1 is used. The items in list1 and list2 are separated by separator, as are the items in the returned list. Aliases: list_union(), merge_lists()

range(start, stop, step, limit)

class calibre.utils.formatter_functions.BuiltinRange[źródło]

range(start, stop, step, limit) – returns a list of numbers generated by looping over the range specified by the parameters start, stop, and step, with a maximum length of limit. The first value produced is «start». Subsequent values next_v are current_v+step. The loop continues while next_v < stop assuming step is positive, otherwise while next_v > stop. An empty list is produced if start fails the test: start>=stop if step is positive. The limit sets the maximum length of the list and has a default of 1000. The parameters start, step, and limit are optional. Calling range() with one argument specifies stop. Two arguments specify start and stop. Three arguments specify start, stop, and step. Four arguments specify start, stop, step and limit. Examples: range(5) -> «0,1,2,3,4». range(0,5) -> «0,1,2,3,4». range(-1,5) -> «-1,0,1,2,3,4». range(1,5) -> «1,2,3,4». range(1,5,2) -> «1,3». range(1,5,2,5) -> «1,3». range(1,5,2,1) -> error(limit exceeded).

subitems(val, start_index, end_index)

class calibre.utils.formatter_functions.BuiltinSubitems[źródło]

subitems(val, start_index, end_index) – Ta funkcja ma za zadanie podzielenie listy takiej jak gatunki literackie. Funkcja interpretuje val jako oddzielaną przecinkami listę elementów, z których każdy jest oddzielną, oddzielaną kropkami listą. Zwraca nową listę utworzoną poprzez odnalezienie wszystkich oddzielanych kropkami elementów, wyodrębnienie z nich elementów od start_index do end_index, a następnie złożenie ich z powrotem. Pierwszy element listy oddzielanej kropkami ma numer zero. Jeśli indeks początkowy jest ujemny to liczenie odbywa się od końca listy. W szczególnym przypadku kiedy end_index jest równy zero zakłada się, że brana jest pod uwagę cała lista. Na przykład, przy użyciu szablonu w trybie podstawowym i zakładając, że #gatunek ma wartość „A.B.C” to {#gatunek:subitems(0,1)} zwróci „A”. {#gatunek:subitems(0,2)} zwróci „A.B”. {#gatunek:subitems(1,0)} zwróci „B.C”. Przy założeniu, że #gatunek ma wartość „A.B.C, D.E.F” {#gatunek:subitems(0,1)} zwróci „A, D”, a {#gatunek:subitems(0,2)} zwróci „A.B, D.E”.

sublist(val, start_index, end_index, separator)

class calibre.utils.formatter_functions.BuiltinSublist[źródło]

sublist(val, start_index, end_index, separator) – interpret the value as a list of items separated by separator, returning a new list made from the start_index to the end_index item. The first item is number zero. If an index is negative, then it counts from the end of the list. As a special case, an end_index of zero is assumed to be the length of the list. Examples using basic template mode and assuming that the tags column (which is comma-separated) contains „A, B, C”: {tags:sublist(0,1,\,)} returns „A”. {tags:sublist(-1,0,\,)} returns „C”. {tags:sublist(0,-1,\,)} returns „A, B”.

Other

arguments(id[=expression] [, id[=expression]]*)

class calibre.utils.formatter_functions.BuiltinArguments[źródło]

arguments(id[=expression] [, id[=expression]]*) – Used in a stored template to retrieve the arguments passed in the call. It both declares and initializes local variables, effectively parameters. The variables are positional; they get the value of the parameter given in the call in the same position. If the corresponding parameter is not provided in the call then arguments assigns that variable the provided default value. If there is no default value then the variable is set to the empty string.

assign(id, val)

class calibre.utils.formatter_functions.BuiltinAssign[źródło]

assign(id, val) – assigns val to id, then returns val. id must be an identifier, not an expression. This function can often be replaced with the = operator.

globals(id[=expression] [, id[=expression]]*)

class calibre.utils.formatter_functions.BuiltinGlobals[źródło]

globals(id[=expression] [, id[=expression]]*) – Retrieves „global variables” that can be passed into the formatter. It both declares and initializes local variables with the names of the global variables passed in. If the corresponding variable is not provided in the passed-in globals then it assigns that variable the provided default value. If there is no default value then the variable is set to the empty string.

Recursion

eval(szablon)

class calibre.utils.formatter_functions.BuiltinEval[źródło]

eval(szablon) – rozwiązuje szablon, podstawiając lokalne zmienne zamiast metadanych książki. Pozwala to na tworzenie nawet skomplikowanych wyników z lokalnych zmiennych. Ponieważ znaki { i } są znakami specjalnymi należy użyć zamiast nich [[ i ]] . Są one automatycznie konwertowane. Należy pamiętać, że przedrostki i przyrostki (|przedrostek|przyrostek) nie mogą być użyte w argumencie funkcji w trybie programowym.

template(x)

class calibre.utils.formatter_functions.BuiltinTemplate[źródło]

template(x) – rozwiązuje x jako szablon. Szablon jest rozwiązywany we własnym kontekście, co oznacza, że zmienne wywołującego i szablonu nie są wspólne. Ponieważ znaki { i } są znakami specjalnymi musisz użyć [[ zamiast { i ]] zamiast }; są one automatycznie konwertowane. Na przykład template(«[[title_sort]]») zostanie rozwiązany jako szablon {title_sort} i zwróci wartość tego pola. Należy pamiętać, że przedrostki i przyrostki (składnia |przedrostek|przyrostek) nie może być użyta w argumencie tej funkcji w trybie programowym.

Relational

cmp(x, y, lt, eq, gt)

class calibre.utils.formatter_functions.BuiltinCmp[źródło]

cmp(x, y, lt, eq, gt) – compares x and y after converting both to numbers. Returns lt if x < y. Returns eq if x == y. Otherwise returns gt. In many cases the numeric comparison operators (>#, <#, ==# etc) can replace this function.

first_matching_cmp(val, [cmp1, result1,]+, else_result)

class calibre.utils.formatter_functions.BuiltinFirstMatchingCmp[źródło]

first_matching_cmp(val, [cmp1, result1,]+, else_result) – compares „val < cmpN” in sequence, returning resultN for the first comparison that succeeds. Returns else_result if no comparison succeeds. Example: first_matching_cmp(10,5,”small”,10,”middle”,15,”large”,”giant”) returns „large”. The same example with a first value of 16 returns „giant”.

strcmp(x, y, lt, eq, gt)

class calibre.utils.formatter_functions.BuiltinStrcmp[źródło]

strcmp(x, y, lt, eq, gt) – does a case-insensitive comparison of x and y as strings. Returns lt if x < y. Returns eq if x == y. Otherwise returns gt. In many cases the lexical comparison operators (>, <, == etc) can replace this function.

strcmpcase(x, y, lt, eq, gt)

class calibre.utils.formatter_functions.BuiltinStrcmpcase[źródło]

strcmpcase(x, y, lt, eq, gt) – does a case-sensitive comparison of x and y as strings. Returns lt if x < y. Returns eq if x == y. Otherwise returns gt. Note: This is NOT the default behavior used by calibre, for example, in the lexical comparison operators (==, >, <, etc.). This function could cause unexpected results, preferably use strcmp() whenever possible.

String case changes

capitalize(val)

class calibre.utils.formatter_functions.BuiltinCapitalize[źródło]

capitalize(val) – return val capitalized

lowercase(val)

class calibre.utils.formatter_functions.BuiltinLowercase[źródło]

lowercase(val) – zwraca wartość pola małymi literami

titlecase(val)

class calibre.utils.formatter_functions.BuiltinTitlecase[źródło]

titlecase(val) – zwraca wartość pola jako każdy wyraz z wielkiej litery

uppercase(val)

class calibre.utils.formatter_functions.BuiltinUppercase[źródło]

uppercase(val) – zwraca wartość pola dużymi literami

String manipulation

character(character_name)

class calibre.utils.formatter_functions.BuiltinCharacter[źródło]

character(character_name) – returns the character named by character_name. For example, character(«newline») returns a newline character (»n»). The supported character names are «newline», «return», «tab», and «backslash».

re(val, pattern, replacement)

class calibre.utils.formatter_functions.BuiltinRe[źródło]

re(val, pattern, replacement) – return val after applying the regular expression. All instances of pattern are replaced with replacement. As in all of calibre, these are Python-compatible regular expressions

re_group(val, pattern [, template_for_group]*)

class calibre.utils.formatter_functions.BuiltinReGroup[źródło]

re_group(val, pattern [, template_for_group]*) – return a string made by applying the regular expression pattern to the val and replacing each matched instance with the string computed by replacing each matched group by the value returned by the corresponding template. The original matched value for the group is available as $. In template program mode, like for the template and the eval functions, you use [[ for { and ]] for }. The following example in template program mode looks for series with more than one word and uppercases the first word: {series:»re_group($, „(S* )(.*)”, „[[$:uppercase()]]”, „[[$]]”)»}

shorten(val, left chars, middle text, right chars)

class calibre.utils.formatter_functions.BuiltinShorten[źródło]

shorten(val, left chars, middle text, right chars) – Return a shortened version of val, consisting of left chars characters from the beginning of val, followed by middle text, followed by right chars characters from the end of the string. Left chars and right chars must be integers. For example, assume the title of the book is Ancient English Laws in the Times of Ivanhoe, and you want it to fit in a space of at most 15 characters. If you use {title:shorten(9,-,5)}, the result will be Ancient E-anhoe. If the field’s length is less than left chars + right chars + the length of middle text, then the field will be used intact. For example, the title The Dome would not be changed.

strcat(a [, b]*)

class calibre.utils.formatter_functions.BuiltinStrcat[źródło]

strcat(a [, b]*) – can take any number of arguments. Returns the string formed by concatenating all the arguments

strcat_max(max, string1 [, prefix2, string2]*)

class calibre.utils.formatter_functions.BuiltinStrcatMax[źródło]

strcat_max(max, string1 [, prefix2, string2]*) – Returns a string formed by concatenating the arguments. The returned value is initialized to string1. Prefix, string pairs are added to the end of the value as long as the resulting string length is less than max. String1 is returned even if string1 is longer than max. You can pass as many prefix, string pairs as you wish.

strlen(a)

class calibre.utils.formatter_functions.BuiltinStrlen[źródło]

strlen(a) – zwraca długość łańcucha znaków, przekazanego jako parametr

substr(str, startowy, końcowy)

class calibre.utils.formatter_functions.BuiltinSubstr[źródło]

substr(str, startowy, końcowy) – zwraca startowy poprzez końcowy znak ciągu. Pierwszy znak str to zerowy znak. Jeśli końcowy jest ujemny, wówczas wskazuje tylko znaków licząc od prawej. Jeśli końcowy jest zerem, wówczas wskazuje ostatni znak. Na przykład, substr(«12345», 1, 0) zwraca «2345», a substr(«12345», 1, -1) zwraca «234».

swap_around_articles(val, separator)

class calibre.utils.formatter_functions.BuiltinSwapAroundArticles[źródło]

swap_around_articles(val, separator) – returns the val with articles moved to the end. The value can be a list, in which case each member of the list is processed. If the value is a list then you must provide the list value separator. If no separator is provided then the value is treated as being a single value, not a list.

swap_around_comma(val)

class calibre.utils.formatter_functions.BuiltinSwapAroundComma[źródło]

swap_around_comma(val) – parametr jest ciągiem znaków w postaci „B, A”, zwracany jest ciąg w postaci „A B”. Przydatne najbardziej przy konwersji nazwisk z postacji LN, FN do FN LN. Jeśli parametr funkcji nie zawiera przecinka jest zwracany bez zmian.

to_hex(val)

class calibre.utils.formatter_functions.BuiltinToHex[źródło]

to_hex(val) – returns the string encoded in hex. This is useful when constructing calibre URLs.

transliterate(a)

class calibre.utils.formatter_functions.BuiltinTransliterate[źródło]

transliterate(a) – Zwraca ciąg znaków w alfabecie łacińskim utworzony na podstawie przybliżonego brzmienia ciągu źródłowego. Na przykłada jeśli źródłem jest „Фёдор Миха́йлович Достоевский” to funkcja zwróci „Fiodor Mikhailovich Dostoievskii”.

Template database functions

book_count(query, use_vl)

class calibre.utils.formatter_functions.BuiltinBookCount[źródło]

book_count(query, use_vl) – returns the count of books found by searching for query. If use_vl is 0 (zero) then virtual libraries are ignored. This function can be used only in the GUI.

book_values(column, query, sep, use_vl)

class calibre.utils.formatter_functions.BuiltinBookValues[źródło]

book_values(column, query, sep, use_vl) – returns a list of the values contained in the column „column”, separated by „sep”, in the books found by searching for „query”. If use_vl is 0 (zero) then virtual libraries are ignored. This function can be used only in the GUI.

other

set_globals(id[=expression] [, id[=expression]]*)

class calibre.utils.formatter_functions.BuiltinSetGlobals[źródło]

set_globals(id[=expression] [, id[=expression]]*) – Sets „global variables” that can be passed into the formatter. The globals are given the name of the id passed in. The value of the id is used unless an expression is provided.

API of the Metadata objects

The python implementation of the template functions is passed in a Metadata object. Knowing it’s API is useful if you want to define your own template functions.

class calibre.ebooks.metadata.book.base.Metadata(title, authors=('Nieznany',), other=None, template_cache=None, formatter=None)[źródło]

A class representing all the metadata for a book. The various standard metadata fields are available as attributes of this object. You can also stick arbitrary attributes onto this object.

Metadata from custom columns should be accessed via the get() method, passing in the lookup name for the column, for example: „#mytags”.

Use the is_null() method to test if a field is null.

This object also has functions to format fields into strings.

The list of standard metadata fields grows with time is in STANDARD_METADATA_FIELDS.

Please keep the method based API of this class to a minimum. Every method becomes a reserved field name.

is_null(field)[źródło]

Return True if the value of field is null in this object. «null» means it is unknown or evaluates to False. So a title of _(«Unknown») is null or a language of «und» is null.

Be careful with numeric fields since this will return True for zero as well as None.

Also returns True if the field does not exist.

deepcopy(class_generator=<function Metadata.<lambda>>)[źródło]

Do not use this method unless you know what you are doing, if you want to create a simple clone of this object, use deepcopy_metadata() instead. Class_generator must be a function that returns an instance of Metadata or a subclass of it.

get_identifiers()[źródło]

Return a copy of the identifiers dictionary. The dict is small, and the penalty for using a reference where a copy is needed is large. Also, we don’t want any manipulations of the returned dict to show up in the book.

set_identifiers(identifiers)[źródło]

Set all identifiers. Note that if you previously set ISBN, calling this method will delete it.

set_identifier(typ, val)[źródło]

If val is empty, deletes identifier of type typ

standard_field_keys()[źródło]

return a list of all possible keys, even if this book doesn’t have them

custom_field_keys()[źródło]

return a list of the custom fields in this book

all_field_keys()[źródło]

All field keys known by this instance, even if their value is None

metadata_for_field(key)[źródło]

return metadata describing a standard or custom field.

all_non_none_fields()[źródło]

Return a dictionary containing all non-None metadata fields, including the custom ones.

get_standard_metadata(field, make_copy)[źródło]

return field metadata from the field if it is there. Otherwise return None. field is the key name, not the label. Return a copy if requested, just in case the user wants to change values in the dict.

get_all_standard_metadata(make_copy)[źródło]

return a dict containing all the standard field metadata associated with the book.

get_all_user_metadata(make_copy)[źródło]

return a dict containing all the custom field metadata associated with the book.

get_user_metadata(field, make_copy)[źródło]

return field metadata from the object if it is there. Otherwise return None. field is the key name, not the label. Return a copy if requested, just in case the user wants to change values in the dict.

set_all_user_metadata(metadata)[źródło]

store custom field metadata into the object. Field is the key name not the label

set_user_metadata(field, metadata)[źródło]

store custom field metadata for one column into the object. Field is the key name not the label

remove_stale_user_metadata(other_mi)[źródło]

Remove user metadata keys (custom column keys) if they don’t exist in «other_mi», which must be a metadata object

template_to_attribute(other, ops)[źródło]

Takes a list [(src,dest), (src,dest)], evaluates the template in the context of other, then copies the result to self[dest]. This is on a best-efforts basis. Some assignments can make no sense.

smart_update(other, replace_metadata=False)[źródło]

Merge the information in other into self. In case of conflicts, the information in other takes precedence, unless the information in other is NULL.

format_field(key, series_with_index=True)[źródło]

Returns the tuple (display_name, formatted_value)

to_html()[źródło]

A HTML representation of this object.

calibre.ebooks.metadata.book.base.STANDARD_METADATA_FIELDS

The set of standard metadata fields.


'''
All fields must have a NULL value represented as None for simple types,
an empty list/dictionary for complex types and (None, None) for cover_data
'''

SOCIAL_METADATA_FIELDS = frozenset((
    'tags',             # Ordered list
    'rating',           # A floating point number between 0 and 10
    'comments',         # A simple HTML enabled string
    'series',           # A simple string
    'series_index',     # A floating point number
    # Of the form { scheme1:value1, scheme2:value2}
    # For example: {'isbn':'123456789', 'doi':'xxxx', ... }
    'identifiers',
))

'''
The list of names that convert to identifiers when in get and set.
'''

TOP_LEVEL_IDENTIFIERS = frozenset((
    'isbn',
))

PUBLICATION_METADATA_FIELDS = frozenset((
    'title',            # title must never be None. Should be _('Unknown')
    # Pseudo field that can be set, but if not set is auto generated
    # from title and languages
    'title_sort',
    'authors',          # Ordered list. Must never be None, can be [_('Unknown')]
    'author_sort_map',  # Map of sort strings for each author
    # Pseudo field that can be set, but if not set is auto generated
    # from authors and languages
    'author_sort',
    'book_producer',
    'timestamp',        # Dates and times must be timezone aware
    'pubdate',
    'last_modified',
    'rights',
    # So far only known publication type is periodical:calibre
    # If None, means book
    'publication_type',
    'uuid',             # A UUID usually of type 4
    'languages',        # ordered list of languages in this publication
    'publisher',        # Simple string, no special semantics
    # Absolute path to image file encoded in filesystem_encoding
    'cover',
    # Of the form (format, data) where format is, e.g. 'jpeg', 'png', 'gif'...
    'cover_data',
    # Either thumbnail data, or an object with the attribute
    # image_path which is the path to an image file, encoded
    # in filesystem_encoding
    'thumbnail',
))

BOOK_STRUCTURE_FIELDS = frozenset((
    # These are used by code, Null values are None.
    'toc', 'spine', 'guide', 'manifest',
))

USER_METADATA_FIELDS = frozenset((
    # A dict of dicts similar to field_metadata. Each field description dict
    # also contains a value field with the key #value#.
    'user_metadata',
))

DEVICE_METADATA_FIELDS = frozenset((
    'device_collections',   # Ordered list of strings
    'lpath',                # Unicode, / separated
    'size',                 # In bytes
    'mime',                 # Mimetype of the book file being represented
))

CALIBRE_METADATA_FIELDS = frozenset((
    'application_id',   # An application id, currently set to the db_id.
    'db_id',            # the calibre primary key of the item.
    'formats',          # list of formats (extensions) for this book
    # a dict of user category names, where the value is a list of item names
    # from the book that are in that category
    'user_categories',
    # a dict of author to an associated hyperlink
    'author_link_map',
))

ALL_METADATA_FIELDS =      SOCIAL_METADATA_FIELDS.union(
                           PUBLICATION_METADATA_FIELDS).union(
                           BOOK_STRUCTURE_FIELDS).union(
                           USER_METADATA_FIELDS).union(
                           DEVICE_METADATA_FIELDS).union(
                           CALIBRE_METADATA_FIELDS)

# All fields except custom fields
STANDARD_METADATA_FIELDS = SOCIAL_METADATA_FIELDS.union(
                           PUBLICATION_METADATA_FIELDS).union(
                           BOOK_STRUCTURE_FIELDS).union(
                           DEVICE_METADATA_FIELDS).union(
                           CALIBRE_METADATA_FIELDS)

# Metadata fields that smart update must do special processing to copy.
SC_FIELDS_NOT_COPIED =     frozenset(('title', 'title_sort', 'authors',
                                      'author_sort', 'author_sort_map',
                                      'cover_data', 'tags', 'languages',
                                      'identifiers'))

# Metadata fields that smart update should copy only if the source is not None
SC_FIELDS_COPY_NOT_NULL =  frozenset(('device_collections', 'lpath', 'size', 'comments', 'thumbnail'))

# Metadata fields that smart update should copy without special handling
SC_COPYABLE_FIELDS =       SOCIAL_METADATA_FIELDS.union(
                           PUBLICATION_METADATA_FIELDS).union(
                           BOOK_STRUCTURE_FIELDS).union(
                           DEVICE_METADATA_FIELDS).union(
                           CALIBRE_METADATA_FIELDS) - \
                           SC_FIELDS_NOT_COPIED.union(
                           SC_FIELDS_COPY_NOT_NULL)

SERIALIZABLE_FIELDS =      SOCIAL_METADATA_FIELDS.union(
                           USER_METADATA_FIELDS).union(
                           PUBLICATION_METADATA_FIELDS).union(
                           CALIBRE_METADATA_FIELDS).union(
                           DEVICE_METADATA_FIELDS) - \
                           frozenset(('device_collections', 'formats',
                               'cover_data'))
# these are rebuilt when needed