Документація з програмного інтерфейсу для роботи з додатками¶

Визначає різноманітні абстрактні базові класи, з яких можна утворювати підкласи для створення потужних додатків. Корисні класи:

Додаток ¶

class calibre.customize.Plugin(plugin_path)[source]¶

Додаток до calibre. Корисні учасники:

self.installation_type: зберігає спосіб встановлення додатка.

self.plugin_path: Зберігає шлях до файла ZIP, шо містить
цей додаток або None, якщо це вбудований додаток

self.site_customization: зберігає введений рядок налаштовування
користувачем.

Методи, які слід перевизначити у підкласах:

initialize()

customization_help()

Корисні методи:

temporary_file()

__enter__()

load_resources()

supported_platforms = []¶: Список платформ, на яких працює додаток. Приклад: ['windows', 'osx', 'linux']

name = 'Trivial Plugin'¶: Назва цього додатка. Щоб додаток працював, вам слід вказати якусь назву, не просто Trivial Plugin.

version = (1, 0, 0)¶: Версія цього додатка у форматі кортежу з трьох чисел (основний номер, додатковий номер, модифікація)

description = 'Не робить абсолютно нічого'¶: Короткий рядок із описом призначення додатка

author = 'Невідомий'¶: Автор цього додатка

priority = 1¶: Якщо для обробки певного типу файлів передбачено декілька додатків, додатки будуть запускатися за зменшенням пріоритетності, тобто першими буде запущено додатки з вищою пріоритетністю. Найвищою можливою пріоритетністю є sys.maxsize. Типовою пріоритетністю є 1.

minimum_calibre_version = (0, 4, 118)¶: Цей додаток потребує більш ранньої версії Calibre

installation_type = None¶: Спосіб встановлення додатка

can_be_disabled = True¶: Якщо матиме значення False, користувач не зможе вимкнути цей додаток. Користуйтеся із осторогою.

type = 'Основне'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

initialize()[source]¶

Викликається один раз під час ініціалізації додатків calibre. Додатки повторно ініціалізуватимуться кожного разу, коли додаватиметься новий додаток. Також зауважте, що якщо додаток запускається у робочому процесі, наприклад для додавання книг, додаток ініціалізуватиметься для кожного нового процесу обробки.

Тут виконується будь-яка специфічна для додатків ініціалізація, зокрема видобування ресурсів з файла ZIP додатка. Шлях до файла ZIP доступний як self.plugin_path.

Зауважте, що на цьому етапі self.site_customization є недоступним.

config_widget()[source]¶

Реалізуйте цей метод і save_settings() у вашому додатку, щоб скористатися нетиповим діалоговим вікном налаштування, а не покладатися на типове налаштовування на основі рядків.

Цей метод, якщо його реалізовано, має повертати QWidget. Віджет може мати необов’язковий метод validate(), який не приймає аргументів і викликається одразу після натискання користувачем кнопки «Гаразд». Зміни застосовуються, якщо і лише якщо метод повертає True.

Якщо з певної причини ви не змогли виконати налаштовування до цього часу, повернути кортеж з двох рядків (повідомлення, подробиці), ці дані буде показано як діалогове вікно попередження користувачеві, процес буде перервано.

save_settings(config_widget)[source]¶

Зберегти визначені користувачем за допомогою config_widget параметри.

Параметри:: config_widget – Віджет, який повертається config_widget().

do_user_config(parent=None)[source]¶: Цей метод показує діалогове вікно налаштувань цього додатка. Повертає True, якщо користувач натискає кнопку «Гаразд», і False, якщо ні. Зміни буде застосовано автоматично.

load_resources(names)[source]¶

Якщо цей додаток постачається у форматі файла ZIP (додаток, що встановлюється користувачем), цей метод дозволить вам завантажити ресурси з файла ZIP.

Наприклад, для завантаження зображення:

pixmap = QPixmap()
pixmap.loadFromData(self.load_resources(['images/icon.png'])['images/icon.png'])
icon = QIcon(pixmap)

Параметри:: names – Список шляхів до ресурсів у файлі ZIP з використанням роздільника /
Повертає:: Словник у формі {назва: вміст_файла}. Усі назви, які не було знайдено у файлі ZIP, не буде включено до словника.

customization_help(gui=False)[source]¶

Повертає рядок із довідкою щодо налаштовування цього додатка. Типово, надсилає сигнал NotImplementedError, який позначає, що додаток не потребує налаштовування.

Якщо ви повторно реалізуєте цей метод у вашому підкласі, додаток проситиме користувача ввести рядок для налаштовування цього додатка. Доступ до рядка налаштовування можна буде отримати у формі self.site_customization.

Налаштовуванням місця може бути будь-яким, наприклад, шлях до виконуваного файла на комп’ютері користувача.

Параметри:: gui – Якщо True, повертати довідку у форматі HTML, якщо ні, повертати довідку у простому текстовому форматі.

temporary_file(suffix)[source]¶

Повертає файлоподібний об’єкт, який є тимчасовим файлом у файловій системі. Цей файл залишатиметься доступним навіть після його закриття. Файл буде вилучено під час завершення роботи інтерпретатора коду. Скористайтеся учасником name повернутого об’єкта, щоб отримати доступу до повного шляху до створеного тимчасового файла.

Параметри:: suffix – Суфікс назви тимчасових файлів.

cli_main(args)[source]¶: Цей метод є основною точкою входу до інтерфейсу командного рядка додатка. Викликається, коли користувач віддає таку команду: calibre-debug -r «Назва додатка». Усі передані аргументи будуть зберігатися у змінній args.

FileTypePlugin ¶

class calibre.customize.FileTypePlugin(plugin_path)[source]¶

Основа: Plugin

Додаток, який пов’язано із певним набором типів файлів.

file_types = {}¶: Набір типів файлів, для яких слід запускати додаток. Скористайтеся «*», якщо додаток слід запускати для усіх файлів. Приклад: {'lit', 'mobi', 'prc'}

on_import = False¶: Якщо True, цей додаток запускається, якщо до бази даних додаються книги.

on_postimport = False¶: Якщо True, цей додаток запускається після додавання книг до бази даних. У цьому випадку викликаються методи postimport і postadd додатка.

on_postconvert = False¶: Якщо True, цей додаток буде запущено після перетворення книги. У цьому випадку буде викликано метод postconvert додатка.

on_postdelete = False¶: Якщо True, цей додаток буде запущено після вилучення файла книги з бази даних. У цьому випадку буде викликано метод postdelete додатка.

on_preprocess = False¶: Якщо True, цей додаток запускається безпосередньо перед перетворенням.

on_postprocess = False¶: Якщо True, цей додаток запускається після перетворення для обробки остаточного файла, який буде створено додатку виведення даних перетворення.

type = 'Тип файлу'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

run(path_to_ebook)[source]¶

Запустити додаток. Має бути реалізовано у підкласах. Має вносити усі потрібні зміни до електронної книги і повертати абсолютний шлях до файла зміненої книги. Якщо вносити зміни не потрібно. Якщо станеться помилка, має повідомляти про виключення (Exception). Типова реалізація просто повертає шлях до початкового файла електронної книги. Зауважте, що шлях до початкового файла (до запуску будь-яких додатків), доступний як self.original_path_to_file.

Змінений файл електронної книги має бути створено за допомогою методу temporary_file().

Параметри:: path_to_ebook – Повний шлях до електронної книги.
Повертає:: Повний шлях до зміненої електронної книги.

postimport(book_id, book_format, db)[source]¶

Викликається після імпортування, тобто після того, як файл книги було додано до бази даних. Зауважте, що цей метод відрізняється від postadd(), який викликається, коли запис книги створюється вперше. Цей метод викликається кожного разу, коли до запису книги додається новий файл. Корисний для внесення змін до запису книги на основі вмісту нового доданого файла.

Параметри:

book_id – ідентифікатор доданої книжки в базі даних.
book_format – Тип файла доданої книги.
db – База даних бібліотеки.

postconvert(book_id, book_format, db)[source]¶

Буде викликано після перетворення, тобто після того, як перетворений файл результатів буде додано до бази даних. Зауважте, що запуск відбуватиметься лише після перетворення, а не після додавання книги. Корисно для внесення змін до запису книги на основі вмісту щойно доданого файла.

Параметри:

book_id – ідентифікатор доданої книжки в базі даних.
book_format – Тип файла доданої книги.
db – База даних бібліотеки.

postdelete(book_id, book_format, db)[source]¶

Буде викликано після вилучення, тобто після того, як файл книги буде вилучено з бази даних. Зауважте, що запуск відбуватиметься не після вилучення запису книги, а лише після того, як буде вилучено один або декілька форматів книги. Корисно для внесення змін до запису книги на основі формату вилученого файла.

Параметри:

book_id – ідентифікатор доданої книжки в базі даних.
book_format – Тип файла доданої книги.
db – База даних бібліотеки.

postadd(book_id, fmt_map, db)[source]¶

Викликається після додавання (add), тобто після того, як книгу буде додано до бази даних. Зауважте, що цей метод відрізняється від postimport(), який викликається після додавання окремого файла до запису книги. postadd() викликається, лише якщо вперше створюється увесь запис книги, можливо з декількома файлами книги. Корисно, якщо вам потрібно внести зміни до запису книги у базі даних, якщо книгу вперше додано до calibre.

Параметри:

book_id – ідентифікатор доданої книжки в базі даних.
fmt_map – Прив’язка формату файла до шляху, з якого було додано цей формат файла. Зауважте, що цей шлях може і не вказувати на наявний файл, оскільки іноді файли додаються як потоки даних. У такому випадку значення шляху може бути фіктивним або таким, якого не існує.
db – База даних бібліотеки

Додати роботи з метаданими ¶

class calibre.customize.MetadataReaderPlugin(*args, **kwargs)[source]¶

Основа: Plugin

Додаток, який реалізує читання метаданих із файлів певного набору типів.

file_types = {}¶: Набір типів файлів, для яких слід запускати додаток. Приклад: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: Список платформ, на яких працює додаток. Приклад: ['windows', 'osx', 'linux']

version = (7, 22, 0)¶: Версія цього додатка у форматі кортежу з трьох чисел (основний номер, додатковий номер, модифікація)

author = 'Kovid Goyal'¶: Автор цього додатка

type = 'Читання метаданих'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

get_metadata(stream, type)[source]¶

Повертає метадані для файла, представленого потоком даних (файлоподібним об’єктом, для якого передбачено підтримку читання). Надсилає повідомлення щодо виключення, якщо сталася помилка із вхідними даними.

Параметри:: type – тип файла. Гарантовано є одним із записів у file_types.
Повертає:: A calibre.ebooks.metadata.book.Metadata object

class calibre.customize.MetadataWriterPlugin(*args, **kwargs)[source]¶

Основа: Plugin

Додаток, який реалізує читання метаданих із файлів певного набору типів.

file_types = {}¶: Набір типів файлів, для яких слід запускати додаток. Приклад: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: Список платформ, на яких працює додаток. Приклад: ['windows', 'osx', 'linux']

version = (7, 22, 0)¶: Версія цього додатка у форматі кортежу з трьох чисел (основний номер, додатковий номер, модифікація)

author = 'Kovid Goyal'¶: Автор цього додатка

type = 'Запис метаданих'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

set_metadata(stream, mi, type)[source]¶

Встановлює метадані для файла, представленого потоком даних (файлоподібним об’єктом, для якого передбачено підтримку читання). Надсилає повідомлення щодо виключення, якщо сталася помилка із вхідними даними.

Параметри:

type – тип файла. Гарантовано є одним із записів у file_types.
mi – A calibre.ebooks.metadata.book.Metadata object

Додатки роботи з каталогом ¶

class calibre.customize.CatalogPlugin(plugin_path)[source]¶

Основа: Plugin

Додаток, який реалізує засіб створення каталогу.

file_types = {}¶: Вивести тип файлів, для яких слід запускати додаток. Приклад: „epub“ або „xml“

type = 'Генератор каталогу'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

cli_options = []¶

Параметри обробки інтерфейсу командного рядка, специфічні для цього додатка, оголошені як Option у namedtuple:

from collections import namedtuple Option = namedtuple(„Option“, „option, default, dest, help“) cli_options = [Option(“–catalog-title“, default = „My Catalog“, dest = „catalog_title“, help = (_(„Title of generated catalog. nDefault:“) + « „» + „%default“ + «“»))] cli_options parsed in calibre.db.cli.cmd_catalog:option_parser()

initialize()[source]¶: Якщо додаток не є вбудованим, копіює файли .ui і .py з файла ZIP до $TMPDIR. Вкладку буде створено динамічно і додано до діалогового вікна параметрів каталогу у calibre.gui2.dialogs.catalog.py:Catalog

run(path_to_output, opts, db, ids, notification=None)[source]¶

Запускає додаток. Має бути реалізовано у підкласах. Має створити каталог у форматі, вказаному у file_types, повернувши абсолютний шлях до створеного файла каталогу. Якщо станеться помилка, має надіслати сигнал Exception.

Створений файл каталогу має бути створено за допомогою методу temporary_file().

Параметри:

path_to_output – Абсолютний шлях до створеного файла каталогу.
opts – Словник аргументів ключових слів
db – Об’єкт LibraryDatabase2

Додатки отримання метаданих ¶

class calibre.ebooks.metadata.sources.base.Source(*args, **kwargs)[source]¶

Основа: Plugin

type = 'Джерело метаданих'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

author = 'Kovid Goyal'¶: Автор цього додатка

supported_platforms = ['windows', 'osx', 'linux']¶: Список платформ, на яких працює додаток. Приклад: ['windows', 'osx', 'linux']

capabilities = frozenset({})¶: Набір можливостей, підтримуваних цим додатком. Корисні можливості: «identify», «cover»

touched_fields = frozenset({})¶: Список полів метаданих, які потенційно може бути отримано цим додатком під час фази ідентифікації.

has_html_comments = False¶: Встановіть значення True, якщо ваш додаток повертає форматовані у HTML коментарі.

supports_gzip_transfer_encoding = False¶: Встановлення для цього параметра значення True означає, що об’єкт навігатора (browser) вказуватиме, що у ньому передбачено підтримку передавання даних зі стисканням gzip. Це може пришвидшити отримання даних, але варто спочатку пересвідчитися, що джерело справді може надавати дані у форматі gzip належним чином.

ignore_ssl_errors = False¶: Встановіть значення True, якщо помилки, пов’язані із сертифікатами HTTPS, слід ігнорувати для цього джерела.

cached_cover_url_is_reliable = True¶: Кешовані адреси зображень обкладинок іноді можуть стати неактуальними (тобто обкладинка стає недоступно до отримання або повернуте зображення є непридатним до використання). Якщо таке трапляється часто з цим джерелом, встановіть значення False.

options = ()¶: Список об’єктів Option. Об’єкти буде використано для автоматичної побудови віджета налаштовування для цього додатка.

config_help_message = None¶: Рядок, який буде показано у верхній частині віджета налаштовування цього додатка.

can_get_multiple_covers = False¶: Якщо True, це джерело може повертати декілька зображень обкладинок у відповідь на заданий запит.

auto_trim_covers = False¶: Якщо встановлено значення True, зображення обкладинок, отримані цим додатком, буде автоматично обрізано.

prefer_results_with_isbn = True¶: Якщо встановлено значення True і це джерело повертає декілька результатів у відповідь на один запит, деякі з яких містять дані щодо ISBN, а деякі — ні, результати без ISBN буде проігноровано.

is_configured()[source]¶: Повертає False, якщо ваш додаток має бути налаштовано перед використанням. Наприклад, йому потрібне ім’я користувача, пароль або ключ до програмного інтерфейсу.

customization_help()[source]¶

Повертає рядок із довідкою щодо налаштовування цього додатка. Типово, надсилає сигнал NotImplementedError, який позначає, що додаток не потребує налаштовування.

Якщо ви повторно реалізуєте цей метод у вашому підкласі, додаток проситиме користувача ввести рядок для налаштовування цього додатка. Доступ до рядка налаштовування можна буде отримати у формі self.site_customization.

Налаштовуванням місця може бути будь-яким, наприклад, шлях до виконуваного файла на комп’ютері користувача.

Параметри:: gui – Якщо True, повертати довідку у форматі HTML, якщо ні, повертати довідку у простому текстовому форматі.

config_widget()[source]¶

Реалізуйте цей метод і save_settings() у вашому додатку, щоб скористатися нетиповим діалоговим вікном налаштування, а не покладатися на типове налаштовування на основі рядків.

Цей метод, якщо його реалізовано, має повертати QWidget. Віджет може мати необов’язковий метод validate(), який не приймає аргументів і викликається одразу після натискання користувачем кнопки «Гаразд». Зміни застосовуються, якщо і лише якщо метод повертає True.

Якщо з певної причини ви не змогли виконати налаштовування до цього часу, повернути кортеж з двох рядків (повідомлення, подробиці), ці дані буде показано як діалогове вікно попередження користувачеві, процес буде перервано.

save_settings(config_widget)[source]¶

Зберегти визначені користувачем за допомогою config_widget параметри.

Параметри:: config_widget – Віджет, який повертається config_widget().

get_author_tokens(authors, only_first_author=True)[source]¶: Отримує список авторів і повертає список ключів, корисних для створення запитів щодо пошуку із логікою «І». Ця функція намагається повернути ключі у порядку «ім’я по-батькові прізвище», припускаючи, що якщо у імені автора є кома, ім’я записано у формі «прізвище, решта імені».

get_title_tokens(title, strip_joiners=True, strip_subtitle=False)[source]¶: Отримує заголовок і повертає список ключів, які потрібні для запиту щодо пошуку з логікою І. Включає з’єднання (необов’язково) і пунктуацію.

split_jobs(jobs, num)[source]¶: Поділити список завдань на не більше за num груп, наскільки можна однаково.

test_fields(mi)[source]¶: Повертає перше поле з self.touched_fields, яке є нулем у об’єкті mi.

clean_downloaded_metadata(mi)[source]¶: Викличте цей метод у вашому методі identify додатка для нормалізації метаданих до передавання об’єкта Metadata до result_queue. Ви, звичайно ж, можете скористатися нетиповим алгоритмом, який відповідатиме вашому джерелу метаданих.

get_book_url(identifiers)[source]¶: Повертає триелементний кортеж або None. Триелементний кортеж записується у такому форматі: (тип ідентифікатора, значення ідентифікатора, адреса). Адресою є адреса (URL) книги, що визначається за ідентифікаторами у цьому джерелі. Тип ідентифікатора та значення ідентифікатора визначають ідентифікатор, що відповідає адресі. Адреса має бути придатною для переходу за нею користувача за допомогою програми для перегляду сторінок інтернету. Її призначено для створення придатного до натискання посилання для відвідання користувачем сторінки книги у цьому джерелі. Якщо адреси не буде знайдено, буде повернуто None. Цей метод має працювати швидко і послідовно, отже, вам слід реалізовувати його, лише якщо можна побудувати адресу на основі відомих ідентифікаторів з бази даних.

get_book_url_name(idtype, idval, url)[source]¶: Повернути назву у зручному для читанні форматі із повернутого значення get_book_url().

get_book_urls(identifiers)[source]¶: Перевизначте цей метод, якщо для цієї книги слід повернути декілька адрес. Повертає список з кортежів, що складаються з 3 значень. Типово, цей метод просто викликає get_book_url().

get_cached_cover_url(identifiers)[source]¶

Повертає кешовану адресу зображення обкладинки для книги, вказаної словником ідентифікаторів, або None, якщо такої адреси не існує.

Зауважте, що цей метод має повертати лише перевірені адреси, тобто не ті адреси, використання яких може призвести до використання типового зображення обкладинки або які не може бути знайдено.

id_from_url(url)[source]¶: Обробити адресу і повернути кортеж у форматі (тип_ідентифікатора, значення_ідентифікатора). Якщо адреса не відповідає взірцю для джерела метаданих, повернути None.

identify_results_keygen(title=None, authors=None, identifiers={})[source]¶

Повертає функцію, яка використовується для створення ключа, який може упорядковувати об’єкти Metadata за відповідністю вказаному критерію пошуку (назві, авторам, ідентифікаторам).

Ці ключі використовуються для упорядковування результатів виклику identify().

Докладніше про типовий алгоритм можна дізнатися з документації до InternalMetadataCompareKeyGen. Повторно реалізуйте цю функцію у вашому додатку, якщо типовий алгоритм є непридатним.

identify(log, result_queue, abort, title=None, authors=None, identifiers={}, timeout=30)[source]¶

Ідентифікувати книжку за назвою/автором/ISBN

Якщо вказано ідентифікатори і не знайдено відповідників, а це джерело метаданих не зберігає усіх пов’язаних ідентифікаторів (наприклад, усіх ISBN книги), цей метод має повторити спробу на основі лише даних про назву та автора (припускаючи, що ці дані вказано).

Якщо це джерело метаданих також надає зображення обкладинок, адресу обкладинки має бути кешовано так, щоб наступний виклик функції отримання даних з тими самими даними щодо ISBN або спеціального ідентифікатор не потребував повторного отримання адреси обкладинки. Для цього використовуйте програмний інтерфейс кешування.

Усі об’єкти Metadata, які додаються до result_queue за допомогою цього методу, повинні мати атрибут source_relevance, тобто ціле число, яке позначає порядок, у якому слід повертати результати з цього джерела метаданих для цього запиту. Це ціле число буде використано методом compare_identify_results(). Якщо порядок не є важливим, встановіть нульове значення для усіх результатів.

Переконайтеся, що усі дані щодо прив’язки до обкладинки або ISBN буде кешовано до того, як об’єкт Metadata буде передано до result_queue.

Параметри:

log – Об’єкт журналу. Використовуйте його для виведення діагностичної інформації і даних щодо помилок.
result_queue – Черга результатів, до неї додаються результати. Кожен результат є об’єктом Metadata.
abort – Якщо abort.is_set() повертає True, перервати подальшу обробку і повернути керування якомога швидше.
title – Назва (заголовок) книги, може бути None
authors – Список авторів книги, може бути None
identifiers – Словник інших ідентифікаторів, найчастіше {„isbn“:“1234…“}
timeout – Час очікування у секундах. Жоден запит до мережі має бути виконано протягом часу, який визначається часом очікування.

Повертає:

None, якщо помилок не було. Якщо сталися помилки, буде виведено представлення unicode повідомлення про помилку для показу користувачеві.

download_cover(log, result_queue, abort, title=None, authors=None, identifiers={}, timeout=30, get_best_cover=False)[source]¶

Отримати обкладинку і додати її до result_queue. Параметри усі мають те саме значення, що і для identify(). Додати (self, cover_data) до result_queue.

Якщо можна, цей метод має використовувати кешовані адреси обкладинок. Якщо кешованих даних немає, більшість додатків просто викликають identify і використовують її результати.

Якщо параметр get_best_cover має значення True і цей додаток може отримувати декілька обкладинок, він має отримувати лише «найкращу».

class calibre.ebooks.metadata.sources.base.InternalMetadataCompareKeyGen(mi, source_plugin, title, authors, identifiers)[source]¶

Створює ключ упорядковування для порівняння відповідності об’єктів Metadata за заданим запитом щодо пошуку. Використовується лише для порівняння результатів з одного джерела метаданих, а не з різних джерел.

Ключ упорядковування забезпечує відповідність упорядковування за зростанням упорядковуванню за спаданням відповідності.

Алгоритм:

Надавати перевагу результатам, які мають принаймні один ідентифікатор, який збігається із запитом.

Пріоритет результатів із кешованою адресою зображення обкладинки

Пріоритет результатів, у яких усі поля заповнено

Надавати перевагу результатам тією самою мовою, що і поточна мова інтерфейсу користувача.

Пріоритет результатів, які повністю збігаються за назвою із запитом

Надавати перевагу результатам із довшими коментарями (понад 10% довшими)

Використовувати відповідність результатів, яку повідомляє засіб пошуку джерела метаданих
engine

Додатки перетворення даних ¶

class calibre.customize.conversion.InputFormatPlugin(*args)[source]¶

Основа: Plugin

Додатки InputFormatPlugins відповідають за перетворення документів у набір даних HTML+OPF+CSS+інше. Результати перетворення мають зберігатися у кодуванні UTF-8. Основна дія відбувається у convert().

type = 'Вхід перетворення'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

can_be_disabled = False¶: Якщо матиме значення False, користувач не зможе вимкнути цей додаток. Користуйтеся із осторогою.

supported_platforms = ['windows', 'osx', 'linux']¶: Список платформ, на яких працює додаток. Приклад: ['windows', 'osx', 'linux']

file_types = {}¶: Набір типів файлів, для яких слід запускати додаток. Приклад: set(['azw', 'mobi', 'prc'])

is_image_collection = False¶: Якщо має значення True, цей додаток вхідних даних створює збірку зображень, по одному на файл HTML. Можна встановлювати під час роботи додатка, у методі convert, якщо файли вхідних даних можуть бути як збірками зображень, так і збірками без зображень. Якщо ви встановите значення True, вам слід реалізувати метод get_images(), який повертатиме список зображень.

core_usage = 1¶: Кількість ядер процесора, які використовуються цим додатком. Значення «-1» означає, що слід використовувати усі доступні ядра.

for_viewer = False¶: Якщо встановлено значення True, додаток обробки вхідних даних виконуватиме спеціальну обробку, щоб зробити виведені дані придатними для перегляду.

output_encoding = 'utf-8'¶: Кодування, у якому цей додаток створює файли. Значення None означає, що кодування не визначено, і його слід визначити окремо.

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: Параметри є спільними для усіх додатків вхідних форматів даних. Не перевизначайте їх у підкласах. Замість цього, скористайтеся options. Кожен параметр має бути екземпляром OptionRecommendation.

options = {}¶: Параметри для налаштовування поведінки цього додатка. Кожен параметр має бути екземпляром OptionRecommendation.

recommendations = {}¶: Набір кортежів з 3 елементів у формі (назва_параметра, рекомендоване_значення, рівень_рекомендування)

get_images()[source]¶: Повернути список абсолютних шляхів до зображень, якщо цей вхідні дані є збіркою зображень. Список зображень формується у тому самому порядку, що і у вмісті та таблиці змісту.

convert(stream, options, file_ext, log, accelerators)[source]¶

Цей метод має бути реалізовано у підкласах. Має повертати шлях до створеного файла OPF або екземпляр OEBBook. Усі виведені дані мають міститися у поточній теці. Якщо цей додаток створює файли поза поточною текою, їх має бути вилучено або позначено для вилучення до повернення керування цим методом.

Параметри:

stream – Файл як об’єкт, який містить дані файла вхідних даних.
options – Параметри для налаштовування процесу перетворення. Гарантовано має атрибути, що відповідають усім параметрам, оголошеним цим додатком. Крім того, має атрибут verbose, який приймає інтегральні дані від нуля. Більші значення атрибута означають докладніше виведення діагностичних даних. Іншим корисним атрибутом є input_profile, який є екземпляром calibre.customize.profiles.InputProfile.
file_ext – Суфікс назви (без крапки) файла вхідних даних. Гарантовано має належати набору значень file_types, підтримку яких передбачено у додатку.
log – Об’єкт calibre.utils.logging.Log. Усе виведення має використовувати цей об’єкт.
accelerators – Словник різноманітних даних, доступ до якого має бути простим для додатка вхідних даних. Пришвидшує наступні етапи перетворення.

postprocess_book(oeb, opts, log)[source]¶: Викликається для уможливлення виконання додатком вхідних даних остаточної обробки після основного етапу обробки даних книги.

specialize(oeb, opts, log, output_fmt)[source]¶: Викликається для того, щоб надати змогу додатку спеціалізувати оброблену книгу для певного формату виведення даних. Викликається після postprocess_book і перед будь-якими перетвореннями, які виконуються над обробленою книгою.

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[source]¶: Викликається для створення віджета, який використовується для налаштовування цього додатка у графічному інтерфейсі calibre. Віджет має бути екземпляром класу PluginWidget. Приклади можна знайти у вбудованих додатках обробки вхідних даних.

class calibre.customize.conversion.OutputFormatPlugin(*args)[source]¶

Основа: Plugin

OutputFormatPlugins відповідають за перетворення документа OEB (OPF+HTML) на остаточну електронну книгу.

Можна припускати, що документ OEB має кодування UTF-8. Основна дія відбувається у convert().

type = 'Вивід перетворення'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

can_be_disabled = False¶: Якщо матиме значення False, користувач не зможе вимкнути цей додаток. Користуйтеся із осторогою.

supported_platforms = ['windows', 'osx', 'linux']¶: Список платформ, на яких працює додаток. Приклад: ['windows', 'osx', 'linux']

file_type = None¶: Тип файлів (суфікс назви без крапки), до якого виводить дані цей додаток

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: Параметри є спільними для усіх додатків вхідних форматів даних. Не перевизначайте їх у підкласах. Замість цього, скористайтеся options. Кожен параметр має бути екземпляром OptionRecommendation.

options = {}¶: Параметри для налаштовування поведінки цього додатка. Кожен параметр має бути екземпляром OptionRecommendation.

recommendations = {}¶: Набір кортежів з 3 елементів у формі (назва_параметра, рекомендоване_значення, рівень_рекомендування)

property description¶

str(object=““) -> str str(байти_або_буфер[, кодування[, помилки]]) -> str

Створює рядковий об’єкт з вказаного об’єкта. Якщо вказано «кодування » або «помилки», об’єкт має розкривати буфер даних, який буде декодовано з використанням вказаного кодування та обробника помилок. Якщо ці параметри не вказано, повертає результат object.__str__() (if defined) або repr(object). Типовим значенням «кодування» є sys.getdefaultencoding(). Типовим значенням «помилки» є «strict».

convert(oeb_book, output, input_plugin, opts, log)[source]¶

Обробити вміст oeb_book (екземпляра calibre.ebooks.oeb.OEBBook) до файла, вказаного параметром виведення.

Параметри:

output – Файлоподібний об’єкт або рядок. Якщо це рядок, він вважається шляхом до каталогу, який може і не існувати. Додаток виведення даних має записати виведені дані до цієї теки. Якщо це файлоподібний об’єкт, додаток виведення має записати свої дані до цього файла.
input_plugin – Додаток обробки вхідних даних, який було використано на початку конвеєра перетворення.
opts – Параметри перетворення. Гарантовано мають атрибути, які відповідають OptionRecommendations цього додатка.
log – Засіб журналювання. За допомогою цього можна виводити діагностичні та інші повідомлення.

specialize_options(log, opts, input_fmt)[source]¶: Можна скористатися для зміни значень параметрів перетворення, які використовуються у конвеєрі перетворення.

specialize_css_for_output(log, opts, item, stylizer)[source]¶

Можна використовувати для внесення змін до CSS під час процедури спрощення CSS.

Параметри:

item – Запис (файл HTML), який обробляється.
stylizer – Об’єкт Stylizer, який містить спрощені стилі для запису. Отримати стиль для будь-якого елемента можна за допомогою stylizer.style(елемент).

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[source]¶: Викликається для створення віджета, який використовується для налаштовування цього додатка у графічному інтерфейсі calibre. Віджет має бути екземпляром класу PluginWidget. Приклади можна знайти у вбудованих додатках для виведення даних.

Драйвери пристроїв ¶

Базовим класом для всіх драйверів пристроїв є DevicePlugin. Втім, якщо пристрій представляє себе операційній системі як диск USBMS, вам слід використовувати замість нього клас USBMS, оскільки у ньому реалізовано усю логіку, потрібну для цього типу пристроїв.

class calibre.devices.interface.DevicePlugin(plugin_path)[source]¶

Основа: Plugin

Визначає інтерфейс, який має бути реалізовано модулями обробки, які обмінюються даними з пристроєм для читання електронних книг.

type = 'Інтерфейс пристрою'¶: Тип цього додатка. Використовується для розподілу додатків за категоріями у графічному інтерфейсі програми

FORMATS = ['lrf', 'rtf', 'pdf', 'txt']¶: Упорядкований список підтримуваних форматів

VENDOR_ID = 0¶

VENDOR_ID може бути або цілим числом, або списком цілих чисел, або словником. Якщо це словник, він має бути словником словників у такій формі:

{
 integer_vendor_id : { product_id : [list of BCDs], ... },
 ...
}

PRODUCT_ID = 0¶: Ціле число або список цілих чисел

BCD = None¶: BCD може бути або None для розрізнення між пристроями, які засновано на BCD, або списком номерів BCD усіх пристроїв, підтримку яких передбачено у цьому драйвері.

THUMBNAIL_HEIGHT = 68¶: Висота мініатюр на пристрої

THUMBNAIL_COMPRESSION_QUALITY = 75¶: Якість стискання мініатюр. Встановіть близьке до 100 значення, щоб мати мініатюри вищої якості із меншою кількістю викривлень стискання. Звичайно ж, при цьому мініатюри матимуть більший розмір.

WANTS_UPDATED_THUMBNAILS = False¶: Встановіть для цього параметра значення True, якщо на пристрої передбачено оновлення мініатюр зображень обкладинок під час sync_booklists. Встановлення значення true накаже device.py оновлювати мініатюри обкладинок під час встановлення відповідності книг.

CAN_SET_METADATA = ['title', 'authors', 'collections']¶: Визначає, чи може бути встановлено метадані для книг за допомогою графічного інтерфейсу.

CAN_DO_DEVICE_DB_PLUGBOARD = False¶: Визначає, чи може пристрій обробляти набори метаданих device_db.

path_sep = '/'¶: Роздільник у шляху для шляхів до книг на пристрої

icon = 'reader.png'¶: Піктограма для цього пристрою

UserAnnotation¶: alias of Annotation

OPEN_FEEDBACK_MESSAGE = None¶: Якщо має значення, відмінне від None на смужці стану, графічний інтерфейс показує цей рядок як повідомлення. Корисно, якщо відкриття даних є довготривалим.

VIRTUAL_BOOK_EXTENSIONS = frozenset({})¶: Набір суфіксів файлів, які є на пристрої «віртуальними книгами», і тому їх не можна переглядати, зберігати або додавати до бібліотеки. Приклад: frozenset(['kobo'])

VIRTUAL_BOOK_EXTENSION_MESSAGE = None¶: Повідомлення, яке слід показувати користувачеві для файлів із суфіксами назв віртуальних книг.

NUKE_COMMENTS = None¶: Визначає, чи слід вилучати коментарі у копії книги, яка надсилається на пристрій. Якщо має значення, відмінне від None, це має бути коротким рядком, яким буде замінено коментарі.

MANAGES_DEVICE_PRESENCE = False¶: Якщо має значення True, позначає, що цей драйвер повністю керує виявленням пристроїв, вилученням пристроїв тощо. Якщо ви встановите значення True, вам слід реалізувати методи detect_managed_devices і debug_managed_device_detection. Драйвер зі встановленим значенням True є відповідальним за виявлення пристроїв, керування «чорним» списком пристроїв, списком вилучених пристроїв тощо. calibre періодично викликатиме метод detect_managed_devices() і, якщо він повертатиме виявлений пристрій, calibre викликатиме open(). open() буде викликано кожного разу після повернення пристрою, навіть якщо попередні виклики open() завершувалися помилками, тому драйвер має підтримувати актуальність власного «чорного» списку пристроїв із помилками. Так само, під час вилучення пристрою calibre викличе eject(), а потім, припускаючи, що наступний виклик detect_managed_devices() повертає None, програма викличе post_yank_cleanup().

SLOW_DRIVEINFO = False¶: Якщо встановлено значення True, calibre викликатиме метод get_driveinfo() після завантаження списків книг для отримання даних щодо диска (driveinfo).

ASK_TO_ALLOW_CONNECT = False¶: Якщо встановлено значення True, calibre питатиме користувача про те, чи хоче він керувати пристроєм за допомогою calibre під час першого виявлення пристрою. Якщо ви встановите значення True, вам доведеться реалізувати get_device_uid(), ignore_connected_device(), get_user_blacklisted_devices() та set_user_blacklisted_devices()

user_feedback_after_callback = None¶: Встановіть значення у форматі словника {„title“:title, „msg“:msg, „det_msg“:detailed_msg}, щоб програма calibre показувала повідомлення користувачеві після певних зворотних викликів (у поточній версії лише upload_books). Спробуйте не набридати користувачеві повідомленнями. Значення цієї змінної перевірятиметься після кожного зворотного виклику, тому вам слід встановлювати його, лише якщо це справді потрібно.

classmethod get_open_popup_message()[source]¶: У графічному інтерфейсі буде показано як немодальне контекстне вікно. Має бути екземпляром OpenPopupMessage

is_usb_connected(devices_on_system, debug=False, only_presence=False)[source]¶

Повертає True, device_info, якщо пристрій, який обробляється цим додатком, з’єднано з комп’ютером.

Параметри:: devices_on_system – Поточний список з’єднаних пристроїв

detect_managed_devices(devices_on_system, force_refresh=False)[source]¶

Викликається, лише якщо MANAGES_DEVICE_PRESENCE має значення True.

Шукати пристрої, з якими може працювати цей драйвер. Має повернути об’єкт пристрою, якщо пристрій буде знайдено. Цей об’єкт буде передано до методу open() як connected_device. Якщо пристрій знайдено не буде, повертає None. Повернутий об’єкт може бути будь-чим — calibre його не використовує, просто передає open().

Цей метод періодично викликається графічним інтерфейсом програми, тому він має бути не надто вибагливим до ресурсів. Скористайтеся кешуванням, щоб уникнути регулярного сканування системи.

Параметри:

devices_on_system – Набір пристроїв USB, які виявлено у системі.
force_refresh – Якщо має значення True, і драйвер використовує кешування для запобігання повторним скануванням, кеш має бути спорожнено.

debug_managed_device_detection(devices_on_system, output)[source]¶

Викликається, лише якщо MANAGES_DEVICE_PRESENCE має значення True.

Має записувати дані щодо пристроїв, які виявлено у системі, до виведення, яке є файлоподібним об’єктом.

Має повернути True, якщо пристрій було виявлено і успішно відкрито. Якщо цього не відбулося, має повернути False.

reset(key='-1', log_packets=False, report_progress=None, detected_device=None)[source]¶

Параметри:

key – Ключ для розблокування пристрою
log_packets – Якщо true, потік пакетів на пристрій і з пристрою записується до журналу.
report_progress – Функція, яка викликається із відсотком виконання (числом від 0 до 100) для виконання різних завдань. Якщо викликано з -1, програма вважатиме, що завдання не має даних щодо поступу виконання.
detected_device – Дані щодо пристрою від засобу сканування пристроїв

can_handle_windows(usbdevice, debug=False)[source]¶

Необов’язковий метод для виконання подальших перевірок для пристрою з метою переконатися, що цей драйвер може з ним працювати. Якщо це не так, має повертати False. Цей метод викликається лише після встановлення відповідності виробника, ідентифікаторів продукту та bcd, отже він може виконувати доволі тривалі за часом перевірки. Типова реалізація завжди повертає True. Цей метод викликається лише у Windows. Див. також can_handle().

Зауважте, що для пристроїв на основі USBMS це метод типово делегується can_handle(). Отже, вам слід лише перевизначити can_handle() у вашому підкласі USBMS.

Параметри:: usbdevice – Пристрій USB (usbdevice) у форматі, який повертає calibre.devices.winusb.scan_usb_devices()

can_handle(device_info, debug=False)[source]¶

Версія Unix can_handle_windows().

Параметри:: device_info – Є кортежем (vid, pid, bcd, виробник, продукт, серійний номер)

open(connected_device, library_uuid)[source]¶

Виконати усі специфічні для пристрою дії з ініціалізації. Викликається після виявлення пристрою, але перед усіма іншими функціями, які обмінюються даними з пристроєм. Приклад: для пристроїв, які представляються як сховища даних із інтерфейсом USB, цей метод має відповідати за монтування пристрою або, якщо пристрій змонтовано у автоматичному режимі, за пошук точки монтування. Метод calibre.devices.usbms.device.Device.open() містить реалізацію цієї функції і має слугувати добрим прикладом для реалізації доступу до сховищ даних із інтерфейсом USB.

Цей метод може викликати виключення OpenFeedback для показу повідомлення користувачеві.

Параметри:

connected_device – Пристрій, який ми намагаємося відкрити. Є кортежем (ідентифікатор виробника, ідентифікатор продукту, назва виробника, серійний номер пристрою). Втім, у деяких пристроїв немає серійного номера, а у Windows доступні лише перші три поля, останнє подається як None.
library_uuid – UUID поточної бібліотеки calibre. Може мати значення None, якщо бібліотеки немає (наприклад, якщо використано з командного рядка).

eject()[source]¶

Демонтувати і вилучити запис пристрою з операційної системи. Наявність завдань з графічним інтерфейсом, які продовжують виконувати завдання з пристроєм, при цьому не перевіряється.

ЗАУВАЖЕННЯ: цей метод не можна викликати у тому самому потоці виконання, що і решта методів роботи з пристроями.

post_yank_cleanup()[source]¶: Викликається, якщо користувач від’єднує пристрій без його вилучення з системи.

set_progress_reporter(report_progress)[source]¶

Встановлює функцію для надання даних щодо поступу виконання.

Параметри:: report_progress – Функція, яка викликається із відсотком виконання (числом від 0 до 100) для виконання різних завдань. Якщо викликано з -1, програма вважатиме, що завдання не має даних щодо поступу виконання.

get_device_information(end_session=True)[source]¶

Опитує пристрій щодо даних про нього. Див. L{DeviceInfoQuery}.

Повертає:: (назва пристрою, версія пристрою, версія програмного забезпечення на пристрої, тип MIME) Кортеж даних може містити п’ятий елемент, який є словником із даними щодо диска. Див. приклад у usbms.driver.

get_driveinfo()[source]¶: Повертає словник driveinfo. Зазвичай, викликається з get_device_information(), але якщо завантаження driveinfo є повільним для цього драйвера, він має встановити SLOW_DRIVEINFO. У цьому випадку, функцію буде викликано calibre після завантаження списків книг. Зауважте, що метод викликається не у потоці обробки пристрою, отже, драйвер має кешувати дані щодо диска у методі books(), а ця функція має повернути кешовані дані.

card_prefix(end_session=True)[source]¶: Повертає двоелементний список префіксів до шляхів на картках. Якщо картки немає, для префікса картки буде встановлено значення None. Приклади: („/місце“, „/місце2“) (None, „місце2“) („місце“, None) (None, None)

total_space(end_session=True)[source]¶

Отримати загальний об’єм доступного місця на точках монтування:

Основна пам’ять
Картка пам’яті A
Картка пам’яті B

Повертає:: Триелементних список із загальним об’ємом у байтах для (1, 2, 3). Якщо за якоюсь із адрес пристрою немає, має повернути 0.

free_space(end_session=True)[source]¶

Отримати об’єм вільного місця на точках монтування:

Основна пам’ять
Картка A
Картка B

Повертає:: Триелементних список із вільним об’ємом у байтах для (1, 2, 3). Якщо за якоюсь із адрес пристрою немає, має повернути -1.

books(oncard=None, end_session=True)[source]¶

Повертає список електронних книг на пристрої.

Параметри:: oncard – Якщо «carda» або «cardb», повертає список електронних книг на вказаній картці пам’яті. Якщо інше значення, повертає список електронних книг у основній пам’яті пристрою. Якщо вказано картку, але на картці немає книг, повертає порожній список.
Повертає:: BookList.

upload_books(files, names, on_card=None, end_session=True, metadata=None)[source]¶

Вивантажити список книг на пристрій. Якщо якийсь файл вже існує на пристрої, його буде замінено. Цей метод має повідомляти про FreeSpaceError, якщо на пристрої недостатньо вільного місця. Текст FreeSpaceError має містити слово «card», якщо on_card має значення, відмінне від None. Інакше, він має містити слово «memory».

Параметри:

files – Список шляхів
names – Список назв файлів, які повинні мати книги після вивантаження на пристрій. len(names) == len(files)
metadata – Якщо має значення, яке є відмінним від None, є списком об’єктів Metadata. Ідея полягає у використанні метаданих для визначення, куди на пристрої слід зберегти книгу. len(metadata) == len(files). Окрім типового зображення обкладинки (шляху до зображення), може також існувати атрибут мініатюри, який матиме вищий пріоритет. Атрибут мініатюри записується у форматі (ширина, висота, дані обкладинки у форматі jpeg).

Повертає:

Список триелементни кортежів. Список призначено для передавання до add_books_to_metadata().

classmethod add_books_to_metadata(locations, metadata, booklists)[source]¶

Додає адреси до списків книг. Ця функція не повинна обмінюватися даними з пристроєм.

Параметри:

locations – Результати виклику L{upload_books}
metadata – Список об’єктів Metadata, той самий, що і для upload_books().
booklists – Кортеж, що містить результати викликів (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=“cardb“)`).

delete_books(paths, end_session=True)[source]¶: Вилучити книги за вказаними шляхами на пристрої.

classmethod remove_books_from_metadata(paths, booklists)[source]¶

Вилучити книги зі списку метаданих. Ця функція не повинна обмінюватися даними з пристроєм.

Параметри:

paths – шляхи до книг на пристрої.
booklists – Кортеж, що містить результати викликів (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=“cardb“)`).

sync_booklists(booklists, end_session=True)[source]¶

Оновити метадані на пристрої.

Параметри:: booklists – Кортеж, що містить результати викликів (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=“cardb“)`).

get_file(path, outfile, end_session=True)[source]¶

Прочитати файл з адресою path на пристрої і записати його вміст до outfile.

Параметри:: outfile – файлових об’єкт, наприклад sys.stdout, або результат виклику open().

classmethod config_widget()[source]¶: Має повернути QWidget. QWidget містить параметри для інтерфейсу пристрою.

classmethod save_settings(settings_widget)[source]¶: Має зберегти параметри на диск. Отримує віджет, створений у config_widget(), із зберігає усі параметри на диск.

classmethod settings()[source]¶: Має повернути об’єкт opts. Об’єкт opts повинен мати принаймні один атрибут format_map, який є упорядкованим списком форматів для пристрою.

set_plugboards(plugboards, pb_func)[source]¶

надає драйверу поточний набір метаданих та функцію для вибору певного набору. Цей метод викликається безпосередньо перед add_books і sync_booklists.

pb_func є придатною до виконання функцією із таким підписом:: def pb_func(назва_пристрою, формат, засоби обробки метаданих)

Ви передаєте функції назву поточного пристрою (як назву класу або як DEVICE_PLUGBOARD_NAME), формат, який вам потрібен («справжній» формат або «device_db»), і засоби обробки метаданих (ви вказали їх за допомогою set_plugboards там, де ви отримали цей метод).

Повертає:: None або окремий екземпляр засобу обробки метаданих.

set_driveinfo_name(location_code, name)[source]¶

Встановити назву пристрою у файлі driveinfo у значення «name». Цей параметр не змінюється, аж доки файл не буде повторно створено або його назву не буде знову змінено.

Недискові пристрої мають реалізовувати цей метод на основі кодів розташування, які повертаються методом get_device_information().

prepare_addable_books(paths)[source]¶

За вказаним списком шляхів повертає інший список шляхів. Ці шляхи вказують на придатні до додавання версії книг.

Якщо під час приготування книги сталася помилка, замість шляху позиція книги у повернутому списку має бути триелементним кортежем: (початковий шлях, екземпляр виключення, трасування)

startup()[source]¶: Викликається, коли calibre розпочинає роботу з пристроєм. Виконує усі потрібні дії з ініціалізації. Зауважте, що можна створити декілька екземплярів класу, отже __init__ можна викликати декілька разів, але викликатиме цей метод лише один екземпляр. Цей метод викликається у потоці виконання пристрою, а не у потоці графічного інтерфейсу.

shutdown()[source]¶: Викликається, коли calibre завершує роботу за наказом користувача або під час приготувань до перезапуску. Виконує правильне завершення усіх завдань. Цей метод викликається у потоці обробки пристрою, а не у потоці роботи графічного інтерфейсу користувача.

get_device_uid()[source]¶: Має повертати унікальний ідентифікатор для поточного з’єднаного пристрою (викликається одразу після успішного виклику open()). Вам слід реалізувати цей метод, якщо ви встановили ASK_TO_ALLOW_CONNECT = True

ignore_connected_device(uid)[source]¶: Програма має у майбутньому ігнорувати пристрій, вказаний за uid (результат виклику get_device_uid()). Вам слід реалізувати цей метод, якщо ви встановлюєте ASK_TO_ALLOW_CONNECT = True. Зауважте, що ця функція викликається негайно після open(). Отже, якщо open() кешовано якийсь стан, драйвер має скинути систему до цього стану.

get_user_blacklisted_devices()[source]¶: Повертає відображення uid пристрою на зручну для користування назву для усіх пристроїв, які користувач наказав ігнорувати.

set_user_blacklisted_devices(devices)[source]¶: Встановлює список uid пристроїв, які мають ігноруватися цим драйвером.

specialize_global_preferences(device_prefs)[source]¶: Реалізуйте цей метод, якщо ваш пристрій має перевизначати певне налаштування. Вам слід переконатися, що усі виклики, яким потрібно налаштування, яке може бути перевизначено, використовують device_prefs[„щось“], а не prefs[„щось“]. Ваш метод має викликати device_prefs.set_overrides(налаштування=значення, налаштування=значення, …). У поточній версії використовується для керування метаданими (prefs[„manage_device_metadata“])

set_library_info(library_name, library_uuid, field_metadata)[source]¶: Реалізуйте цей метод, якщо вам потрібна інформація щодо поточної бібліотеки calibre. Цей метод викликається під час запуску і коли бібліотека calibre змінюється під час з’єднання з пристроєм.

is_dynamically_controllable()[source]¶

Викликається засобом керування пристроями під час запуску додатків. Якщо цей метод повертає рядок, то: а) у ньому передбачено підтримку інтерфейсу динамічного керування засобу керування пристроями; і б) цю назву слід використовувати під час обміну даними з додатком.