Documentación de la API para complementos¶

Define varias clases abstractas de base que pueden usarse para crear potentes complementos como subclase. Las clases útiles son:

Complemento ¶

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

Un complemento de calibre. Los miembros útiles incluyen:

self.installation_type: Almacena cómo se instaló el complemento.

self.plugin_path: Almacena la ubicación del archivo ZIP que contiene
este complemento o None si es un complemento predefinido

self.site_customization: Guarda un texto de personalización introducido
por el usuario.

Métodos que deben reemplazarse en subclases:

initialize()

customization_help()

Métodos útiles:

temporary_file()

__enter__()

load_resources()

supported_platforms = []¶: Lista de plataformas con las que este complemento es compatible. Por ejemplo: ['windows', 'osx', 'linux']

name = 'Trivial Plugin'¶: El nombre de este complemento. Debe establecer algo distinto de «Trivial Plugin» para que funcione.

version = (1, 0, 0)¶: La versión de este complemento como una 3-tupla (mayor, menor, revisión)

description = 'No hace absolutamente nada'¶: Una breve descripción de lo que hace este complemento

author = 'Desconocido'¶: El autor de este complemento

priority = 1¶: Cuando existe más de un complemento para un tipo de archivo, los complementos se ejecutarán en orden de prioridad decreciente. Los complementos de mayor prioridad se ejecutarán primero. La prioridad más alta posible es sys.maxsize. La prioridad predeterminada es 1.

minimum_calibre_version = (0, 4, 118)¶: La versión más antigua requerida por este complemento

installation_type = None¶: La manera en que se instaló este complemento

can_be_disabled = True¶: Si es False, el usuario no podrá deshabilitar este complemento. Usar con precaución.

type = 'Base'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

initialize()[fuente]¶

Se ejecuta una vez cuando se inicializan los complementos de calibre. Los complementos se vuelven a inicializar cada vez que se añade uno nuevo. Tenga en cuenta que si el complemento se ejecuta como un proceso de trabajo, por ejemplo para añadir libros, el complemento debe inicializarse por cada nuevo proceso.

Realice cualquier inicialización específica del complemento aquí, tal como extraer recursos del archivo ZIP del complemento. La ruta al archivo ZIP está disponible como self.plugin_path.

Tenga en cuenta que self.site_customization no está disponible en este punto.

config_widget()[fuente]¶

Implemente este método y save_settings() en el complemento para usar un cuadro de diálogo de configuración personalizado, en lugar de emplear la configuración predeterminada basada en textos.

Este método, si se implementa, debe devolver un QWidget. El widget puede tener un método opcional validate() que no toma ningún argumento y se ejecuta en cuanto el usuario pulsa el botón «Aceptar». Los cambios se aplican si y sólo si el método devuelve True.

Si por alguna razón no se puede realizar la configuración en este momento, deberá devolver una tupla de dos textos (mensaje, detalles), que se mostrarán como un cuadro de diálogo de advertencia al usuario y el proceso se cancelará.

save_settings(config_widget)[fuente]¶

Guardar las configuraciones especificadas por el usuario con config_widget.

Parámetros:: config_widget – El widget devuelto por config_widget().

do_user_config(parent=None)[fuente]¶: Este método muestra un diálogo de configuración para este complemento. Devuelve True si el usuario pulsa en «Aceptar» o False en caso contrario. Los cambios se aplican automáticamente.

load_resources(names)[fuente]¶

Si este complemento viene en un archivo en formato ZIP (complemento añadido por el usuario), este método le permitirá cargar recursos desde el archivo ZIP.

Por ejemplo, para cargar una imagen:

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

Parámetros:: names – Lista de rutas a los recursos en el archivo ZIP utilizando / como separador
Devuelve:: Un diccionario de la forma {nombre: contenido_del_archivo}. Cualquier nombre que no se encuentre en el archivo ZIP, no estará en el diccionario.

customization_help(gui=False)[fuente]¶

Devuelve un texto que ofrece ayuda sobre cómo personalizar este complemento. De manera predeterminada, genera el error NotImplementedError, que indica que el complemento no necesita personalización.

Si reimplementa este método en la subclase, se le pedirá al usuario que introduzca un texto como personalización para este complemento. El texto de personalización estará disponible como self.site_customization.

site_customization puede ser cualquier cosa, por ejemplo, la ruta de acceso a un archivo binario necesario en el equipo del usuario.

Parámetros:: gui – Si es True devuelve la ayuda HTML, de lo contrario devuelve ayuda de texto sin formato.

temporary_file(suffix)[fuente]¶

Devuelve un objeto de tipo archivo que es un archivo temporal en el sistema de archivos. Este archivo permanecerá disponible incluso después de cerrarse y sólo se eliminará al terminar el intérprete. Utilice el miembro name del objeto devuelto para acceder a la ruta completa del archivo temporal creado.

Parámetros:: suffix – El sufijo del archivo temporal.

cli_main(args)[fuente]¶: Este método es el principal punto de acceso para la interfaz de línea de órdenes de los complementos. Se ejecuta cuando el usuario teclea: calibre-debug -r «Nombre del complemento». Todos los argumentos que se pasen están presentes en la variable args.

FileTypePlugin ¶

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

Bases: Plugin

Un complemento asociado con un determinado conjunto de tipos de archivo.

file_types = {}¶: Conjunto de tipos de archivo para que este complemento debe ejecutarse. Use '*' para todos los tipos de archivo. Por ejemplo: {'lit', 'mobi', 'prc'}

on_import = False¶: Si es True, este complemento se ejecuta cuando se añaden libros a la base de datos

on_postimport = False¶: Si es True, este complemento se ejecuta después de añadir libros a la base de datos. En tal caso, se ejecutarán los métodos de postimport() y postadd() del complemento.

on_postconvert = False¶: Si es True, este complemento se ejecuta después de convertir un libro. En tal caso, se ejecutará el método postconvert() del complemento.

on_postdelete = False¶: Si es True, este complemento se ejecuta después de eliminar un archivo de libro de la base de datos. En tal caso, se ejecutará el método postdelete() del complemento.

on_preprocess = False¶: Si es True, este complemento se ejecuta justo antes de una conversión

on_postprocess = False¶: Si es True, este complemento se ejecuta después de la conversión sobre el archivo final producido por el complemento de salida de conversión.

type = 'Tipo de archivo'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

run(path_to_ebook)[fuente]¶

Ejecutar el complemento. Debe implementarse en subclases. Debe realizar cualquier modificación necesaria sobre el libro y devolver la ruta absoluta al libro modificado. Si no se necesita ninguna modificación, debe devolver la ruta de acceso al libro original. Si ocurre un error, debe generar una excepción. La implementación predeterminada simplemente devuelve la ruta de acceso al libro original. Tenga en cuenta que la ruta al archivo original (antes de que se ejecute ningún complemento de tipo de archivo) está disponible como self.original_path_to_file.

El archivo de libro electrónico modificado debe crearse con el método temporary_file().

Parámetros:: path_to_ebook – Ruta absoluta al libro electrónico.
Devuelve:: Ruta absoluta al libro electrónico modificado.

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

Se ejecuta después de la importación, es decir, después de añadir el archivo del libro a la base de datos. Tenga en cuenta que se trata de un método diferente de postadd(), que se ejecuta cuando se crea el registro del libro por primera vez. Este método se ejecuta siempre que se añade un archivo nuevo al registro del libro. Resulta útil para modificar el registro del libro según el contenido del archivo recién añadido.

Parámetros:

book_id – Identificador de la base de datos del libro añadido.
book_format – El tipo de archivo del libro que se ha añadido.
db – Base de datos de biblioteca.

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

Se ejecuta después de la conversión, es decir, después de añadir el archivo del libro de salida a la base de datos. Tenga en cuenta que sólo se ejecuta después de una conversión, no cuando se añade un libro. Resulta útil para modificar el registro del libro según el contenido del archivo recién añadido.

Parámetros:

book_id – Identificador de la base de datos del libro añadido.
book_format – El tipo de archivo del libro que se ha añadido.
db – Base de datos de biblioteca.

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

Se ejecuta después de la eliminación, es decir, después de eliminar el archivo del libro de la base de datos. Tenga en cuenta que no se ejecuta cuando se elimina un registro de libro, sólo cuando se elimina uno o más formatos del libro. Resulta útil para modificar el registro del libro según el formato del archivo eliminado.

Parámetros:

book_id – Identificador de la base de datos del libro añadido.
book_format – El tipo de archivo del libro que se ha añadido.
db – Base de datos de biblioteca.

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

Se ejecuta después la creación, es decir, después de añadir un nuevo libro a la base de datos. Tenga en cuenta que se trata de un método diferente de postimport(), que se ejecuta cuando se añade un archivo de libro a un registro. Este método se ejecuta sólo cuando se crea un nuevo registro de libro, que puede contener más de un archivo de libro. Resulta útil si desea modificar el registro del libro en la base de datos cuando se añade el libro por primera vez en calibre.

Parámetros:

book_id – Identificador de la base de datos del libro añadido.
fmt_map – Correspondencia de formato de archivo con ruta desde la que se añadió el archivo. Tenga cuenta que esto puede apuntar a un archivo existente en realidad o no, pues a veces se añaden archivos como flujos, en cuyo caso puede ser un valor inútil o una ruta no existente.
db – Base de datos de biblioteca

Complementos de metadatos ¶

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

Bases: Plugin

Un complemento que implementa la lectura de metadatos de un conjunto de tipos de archivo.

file_types = {}¶: Conjunto de tipos de archivo para los que este complemento debe ejecutarse. Por ejemplo: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: Lista de plataformas con las que este complemento es compatible. Por ejemplo: ['windows', 'osx', 'linux']

version = (7, 21, 100)¶: La versión de este complemento como una 3-tupla (mayor, menor, revisión)

author = 'Kovid Goyal'¶: El autor de este complemento

type = 'Lector de metadatos'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

get_metadata(stream, type)[fuente]¶

Devuelve metadatos del archivo representado por stream (un objeto de tipo archivo que admite lectura). Genera una excepción si hay un error con los datos de entrada.

Parámetros:: type – El tipo del archivo. Es con seguridad una de las entradas en file_types.
Devuelve:: Un objeto calibre.ebooks.metadata.book.Metadata.

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

Bases: Plugin

Un complemento que implementa la lectura de metadatos de un conjunto de tipos de archivo.

file_types = {}¶: Conjunto de tipos de archivo para los que este complemento debe ejecutarse. Por ejemplo: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: Lista de plataformas con las que este complemento es compatible. Por ejemplo: ['windows', 'osx', 'linux']

version = (7, 21, 100)¶: La versión de este complemento como una 3-tupla (mayor, menor, revisión)

author = 'Kovid Goyal'¶: El autor de este complemento

type = 'Escritor de metadatos'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

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

Establece los metadatos del archivo representado por stream (un objeto de tipo archivo que admite lectura). Genera una excepción si hay un error con los datos de entrada.

Parámetros:

type – El tipo del archivo. Es con seguridad una de las entradas en file_types.
mi – Un objeto calibre.ebooks.metadata.book.Metadata.

Complementos de catálogo ¶

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

Bases: Plugin

Un complemento que implementa un generador de catálogos.

file_types = {}¶: Tipo de archivo de salida para el que debe ejecutarse este complemento. Por ejemplo: «epub» o «xml»

type = 'Generador de catálogo'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

cli_options = []¶

Opciones del intérprete de línea de órdenes específicas de este complemento, declaradas como un namedtuple Option:

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()[fuente]¶: Si el complemento no es uno de los incorporados, copiar los archivos .ui y .py del archivo ZIP a $TMPDIR. Se generará dinámicamente una pestaña que se añadirá a las opciones de catálogo en calibre.gui2.dialogs.catalog.py:Catalog

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

Ejecutar el complemento. Debe implementarse en subclases. Debe generar el catálogo en el formato especificado en file_types y devolver la ruta de acceso absoluta al archivo de catálogo generado. Si ocurre un error, debe generar una excepción.

El archivo del catálogo generado debe crearse con el método temporary_file().

Parámetros:

path_to_output – Ruta absoluta al archivo de catálogo generado.
opts – Un diccionario de argumentos de palabras claves
db – Un objeto LibraryDatabase2

Complementos de descarga de metadatos ¶

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

Bases: Plugin

type = 'Origen de metadatos'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

author = 'Kovid Goyal'¶: El autor de este complemento

supported_platforms = ['windows', 'osx', 'linux']¶: Lista de plataformas con las que este complemento es compatible. Por ejemplo: ['windows', 'osx', 'linux']

capabilities = frozenset({})¶: Conjunto de capacidades ofrecidas por este complemento. Algunas capacidades útiles son: “identify”, “cover”

touched_fields = frozenset({})¶: Lista de campos de metadatos que este complemento puede descargarse durante la fase de identificación.

has_html_comments = False¶: Establézcala a True si el complemento devuelve comentarios en formato HTML

supports_gzip_transfer_encoding = False¶: Si se establece en True el objeto de navegador indicará que admite transferencias codificadas con gzip. Esto puede acelerar las descargas, pero asegúrese primero de que el origen admite transferencias codificadas con gzip correctamente

ignore_ssl_errors = False¶: Si se establece en true se ignoran los errores de certificado HTTPS al conectar con este origen.

cached_cover_url_is_reliable = True¶: Los URL de portadas en caché no siempre son fiables (la descarga puede fallar o la imagen puede ser incorrecta). Si esto ocurre a menudo con este origen, establézcalo en False

options = ()¶: Una lista de objetos Option. Se usarán para construir automáticamente el widget de configuración para este complemento

config_help_message = None¶: Un texto que se muestra en la parte superior del widget de configuración de este complemento.

can_get_multiple_covers = False¶: Si es True este recurso puede devolver múltiples portadas para una consulta dada

auto_trim_covers = False¶: Si se establece en True, las portadas descargadas por este complemento se recortan automáticamente.

prefer_results_with_isbn = True¶: Si se establece en True, y esta fuente devuelve múltiples resultados para una consulta, algunos de los cuales tienen ISBN y otros no, los resultados sin ISBN se ignorarán

is_configured()[fuente]¶: Devuelve False si el complemento necesita configurarse antes de usarlo. Por ejemplo, puede requerir un nombre de usuario, contraseña o clave API.

customization_help()[fuente]¶

Devuelve un texto que ofrece ayuda sobre cómo personalizar este complemento. De manera predeterminada, genera el error NotImplementedError, que indica que el complemento no necesita personalización.

Si reimplementa este método en la subclase, se le pedirá al usuario que introduzca un texto como personalización para este complemento. El texto de personalización estará disponible como self.site_customization.

site_customization puede ser cualquier cosa, por ejemplo, la ruta de acceso a un archivo binario necesario en el equipo del usuario.

Parámetros:: gui – Si es True devuelve la ayuda HTML, de lo contrario devuelve ayuda de texto sin formato.

config_widget()[fuente]¶

Implemente este método y save_settings() en el complemento para usar un cuadro de diálogo de configuración personalizado, en lugar de emplear la configuración predeterminada basada en textos.

Este método, si se implementa, debe devolver un QWidget. El widget puede tener un método opcional validate() que no toma ningún argumento y se ejecuta en cuanto el usuario pulsa el botón «Aceptar». Los cambios se aplican si y sólo si el método devuelve True.

Si por alguna razón no se puede realizar la configuración en este momento, deberá devolver una tupla de dos textos (mensaje, detalles), que se mostrarán como un cuadro de diálogo de advertencia al usuario y el proceso se cancelará.

save_settings(config_widget)[fuente]¶

Guardar las configuraciones especificadas por el usuario con config_widget.

Parámetros:: config_widget – El widget devuelto por config_widget().

get_author_tokens(authors, only_first_author=True)[fuente]¶: Toma una lista de autores y devuelve una lista de elementos útiles para una consulta de búsqueda AND. Esta función intenta devolver elementos con el orden «nombres apellidos», suponiendo que si hay una coma en nombre de autor, el nombre está en la forma «apellidos, nombre».

get_title_tokens(title, strip_joiners=True, strip_subtitle=False)[fuente]¶: Toma un título y devuelve una lista de elementos útiles para una consulta de búsqueda AND. Excluye conectores (opcionalmente) y puntuación.

split_jobs(jobs, num)[fuente]¶: Divide una lista de tareas en num grupos como máximo, tan igualados como sea posible

test_fields(mi)[fuente]¶: Devuelve el primer campo de self.touched_fields que es nulo en el objeto mi

clean_downloaded_metadata(mi)[fuente]¶: Ejecutar este métedo en el método de identificación del complemento para normalizar los metadatos antes de poner el objeto mi en result_queue. Lógicamente puede usar un algoritmo personalizado adecuado a la fuente de metadatos.

get_book_url(identifiers)[fuente]¶: Devuelve una 3-tupla o None. La 3-tupla es de la forma: (tipo_identificador, valor_identificador, URL). URL es el URL del libro identificado por los identificadores en este origen. tipo_identificador y valor_identificador especifican el identificador correspondiente al URL. Este URL debe ser accesible a un humano por medio de un navegador. El propósito es proporcionar un enlace que el usuario pueda pulsar para visitar la página del libro en este origen. Si no se encuentra ningún URL, devuelve None. Este método debe ser rápido y coherente, por lo que sólo debe implementarlo si es posible construir el URL mediante un esquema conocido dado identifiers.

get_book_url_name(idtype, idval, url)[fuente]¶: Devuelve un nombre legible por humanos a partir valor devuelto por get_book_url().

get_book_urls(identifiers)[fuente]¶: Sustituya este método si desea devolver varios URL para este libro. Devuelve una lista de 3-tuplas. De manera predeterminada, este método simplemente ejecuta get_book_url().

get_cached_cover_url(identifiers)[fuente]¶

Devuelve el URL de portada en caché para el libro identificado por el diccionario identifiers o None si no existe el URL.

Tenga en cuenta que este método sólo debe devolver URL validados, es decir no URL que puedan resultar en una imagen de portada genérica o un error.

id_from_url(url)[fuente]¶: Analiza un URL y devuelve una tupla de la forma: (tipo_de_identificador, valor_de_identificador). Si el URL no coincide con el patrón del origen de metadatos, devuelve None.

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

Devuelve una función empleada para generar una clave que pueda ordenar objetos de tipo Metadata por su relevancia dada una consulta de búsqueda (title, authors, identifiers).

Estas claves se usan para ordenar los resultados de identify().

Para detalles sobre el algoritmo predeterminado ver InternalMetadataCompareKeyGen. Implemente de nuevo esta función en el complemento si el algoritmo predeterminado no es el adecuado.

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

Identificar un libro por su título, autor, ISBN, etc.

Si se especifica identifiers y no se encuentran coincidencias y este origen de metadatos no almacena todos los identificadores relacionados (por ejemplo, todos los ISBN de un libro), este método debe volver a intentarlo con sólo el título y el autor (si se especificaron).

Si este origen de metadatos también proporciona portadas, el URL de la portada debe almacenarse en caché para que ejecuciones posteriores a la API para obtener portadas con el mismo ISBN o identificador especial no tenga que volver a obtener el URL de portada. Usar la API de caché para esto.

Cada objeto Metadata puesto en result_queue por este método debe tener un atributo attr:source_relevance que es un entero que indica el orden en que el origen de metadatos devuelve los resultados para esta búsqueda. Este entero se usará por compare_identify_results(). Si el orden no es importante, póngalo a cero para todos los resultados.

Asegúrese de que cualquier información de correspondencia de portada o ISBN está en caché antes de poner el objeto Metadata en result_queue.

Parámetros:

log – Un objeto de registro, úselo para obtener errores e información de depuración
result_queue – Un objeto Queue resultante, los resultados deben ser puestos en él. Cada resultado es un objeto Metadata.
abort – Si abort.is_set() devuelve True, interrumpir el proceso y volver tan pronto como sea posible
title – El título del libro, puede ser None
authors – Una lista de autores del libro, puede ser None
identifiers – Un diccionario de otros identificadores, principalmente {“isbn”:”1234…”}
timeout – Tiempo de espera en segundos, ninguna petición de red debería esperar más de este tiempo.

Devuelve:

None si no hubo ningún error, en caso contrario una representación unicode del error que pueda mostrarse al usuario

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

Descarga una portada y pone el resultado en result_queue. Todos los parámetros tienen el mismo significado que para identify(). Pone (self, cover_data) en result_queue.

Este metodo de usar los URL de portada en caché siempre que sea posible. Cuando no se encuentran los datos en caché, la mayoría de los complementos ejecutan identify() y usan sus resultados.

Si el parámetro get_best_cover es True y este complemento puede obtener múltiples portadas, esto debería obtener sólo la «mejor».

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

Generar una clave de orden para comparar la relevancia de los objetos Metadata, dada una consulta de búsqueda. Esto se usa sólo para comparar resultados del mismo origen de metadatos, no entre distintos orígenes.

La clave de orden garantiza que el orden ascendente corresponde a un orden descendiente de relevancia.

El algoritmo es:

Dar prioridad a los resultados que tienen al menos un identificador igual al de la consulta

Preferir resultados con un URL de portada en caché

Preferir resultados con todos los campos disponibles rellenos

Dar prioridad a los resultados en el mismo idioma que la interfaz de usuario actual

Preferir resultados con una coincidencia de título perfecto con la consulta

Preferir resultados con comentarios más largos (diferencia mayor del 10%)

Usar la relevancia del resultado según la indice la búsqueda del origen de metadatos
motor

Complementos de conversión ¶

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

Bases: Plugin

Los complementos InputFormatPlugin son los responsables de convertir un documento a HTML+OPF+CSS+etc. Los resultados de la conversión deben estar codificados en UTF-8. La acción principal ocurre en convert().

type = 'Entrada para la conversión'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

can_be_disabled = False¶: Si es False, el usuario no podrá deshabilitar este complemento. Usar con precaución.

supported_platforms = ['windows', 'osx', 'linux']¶: Lista de plataformas con las que este complemento es compatible. Por ejemplo: ['windows', 'osx', 'linux']

file_types = {}¶: Conjunto de tipos de archivo para los que este complemento debe ejecutarse. Por ejemplo: set(['asw', 'mobi', 'prc'])

is_image_collection = False¶: Si es True, este complemento de entrada genera una colección de imágenes, una por archivo HTML. Esto puede ser establecido dinámicamente en el método convert() si los archivos de entrada pueden ser o no colecciones de imágenes. Si lo establece en True, debe implementar el método get_images() que devuelve una lista de imágenes.

core_usage = 1¶: Número de núcleos de CPU utilizados por este complemento. Un valor de -1 significa que utiliza todos los núcleos disponibles

for_viewer = False¶: Si es True, el complemento de entrada realizará un procesado especial para que la salida sea adecuada para visualización

output_encoding = 'utf-8'¶: La codificación de los archivos que crea el complemento de entrada. Un valor de None significa que la codificación no está definida y debe detectarse individualmente

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: Opciones compartidas por todos los complementos de formato de entrada. No reemplazar en subclases. Usar options en su lugar. Toda opción debe ser un ejemplar de OptionRecommendation.

options = {}¶: Opciones para personalizar el comportamiento de este complemento. Toda opción debe ser un ejemplar de OptionRecommendation.

recommendations = {}¶: Un conjunto de 3-tuplas del tipo (nombre_opción, valor_recomendado, nivel_de_recomendación)

get_images()[fuente]¶: Devuelve una lista de rutas absolutas a las imágenes, si este complemento representa una colección de imágenes. La lista de imágenes está en el mismo orden que el lomo y el índice.

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

Este método debe ser implementado en subclases. Debe volver la ruta al archivo OPF creado o un ejemplar OEBBook. Toda la salida debe estar contenida en la carpeta actual. Si este complemento crea archivos fuera de la carpeta actual, deben ser eliminados o marcados para su eliminación antes de que termine este método.

Parámetros:

stream – Un objeto de tipo archivo que contiene el archivo de entrada.
options – Opciones para personalizar el proceso de conversión. Debe tener atributos correspondientes a todas las opciones declaradas por este complemento. Además, debe haber un atributo verbose que toma valores enteros a partir de cero. Valores mayores significan más detalles. Otro atributo útil es input_profile, que es un ejemplar de calibre.customize.profiles.InputProfile.
file_ext – La extensión (sin el «.») del archivo de entrada. Debe ser uno de los file_types admitidos por este complemento.
log – Un objeto calibre.utils.logging.Log. Toda salida debería usar este objeto.
accelerators – Un diccionario con diversa información que el complemento de entrada puede obtener fácilmente y que acelerará las etapas posteriores de la conversión.

postprocess_book(oeb, opts, log)[fuente]¶: Se ejecuta para permitir que el complemento de entrada lleve a cabo el posprocesado del libro después del procesado principal.

specialize(oeb, opts, log, output_fmt)[fuente]¶: Se ejecuta para permitir que el complemento de entrada especialice el libro analizado para un formato de salida particular. Se ejecuta después de postprocess_book() y antes de que se realice cualquier transformación sobre el libro analizado.

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[fuente]¶: Ejecutado para crear el widget que se usa para configurar este complemento en la interfaz de calibre. El widget debe ser un objeto de la clase PluginWidget. Puede ver ejemplos en los complementos de entrada incorporados.

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

Bases: Plugin

Los complementos OutputFormatPlugin son los responsables de convertir un documento OEB (OPF+HTML) en un libro de salida.

El documento OEB puede suponerse codificado en UTF-8. La acción principal ocurre en convert().

type = 'Salida de la conversión'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

can_be_disabled = False¶: Si es False, el usuario no podrá deshabilitar este complemento. Usar con precaución.

supported_platforms = ['windows', 'osx', 'linux']¶: Lista de plataformas con las que este complemento es compatible. Por ejemplo: ['windows', 'osx', 'linux']

file_type = None¶: El tipo de archivo (extensión sin punto inicial) que produce este complemento

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: Opciones compartidas por todos los complementos de formato de entrada. No reemplazar en subclases. Usar options en su lugar. Toda opción debe ser un ejemplar de OptionRecommendation.

options = {}¶: Opciones para personalizar el comportamiento de este complemento. Toda opción debe ser un ejemplar de OptionRecommendation.

recommendations = {}¶: Un conjunto de 3-tuplas del tipo (nombre_opción, valor_recomendado, nivel_de_recomendación)

property description¶

str(object=””) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Crea un nuevo objeto de texto a partir de object. Si se especifica encoding o errors, el objeto debe exponer un buffer de datos que se descodificará con la codificación y controlador de errores especificados. En caso contrario, devuelve el resultado de object.__str__()` (si está definido) o ``repr(object). El valor predeterminado de encoding es sys.getdefaultencoding(). El valor predeterminado de errors es 'strict'.

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

Mostrar el contenido de oeb_book (que es un espécimen de calibre.ebooks.oeb.OEBBook) en el archivo especificado por salida.

Parámetros:

output – Un objeto de tipo archivo o un texto. Si es un texto es la ruta a una carpeta que puede existir o no. El complemento de salida debe escribir su resultado en esta carpeta. Si es un objeto de tipo archivo, el complemento de salida debe escribir su resultado en el archivo.
input_plugin – El archivo de entrada que se usó al inicio del proceso de conversión.
opts – Opciones de conversión. Es seguro que tiene atributos correspondientes a los valores de OptionRecommendations de este complemento.
log – El registrador. Escribir mensajes de depuración, información, etc. usando este objeto.

specialize_options(log, opts, input_fmt)[fuente]¶: Puede usarse para modificar los valores de las opciones de conversión, como en el proceso de conversión.

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

Puede usarse para hacer cambios al css durante el proceso de aplanamiento del CSS.

Parámetros:

item – El elemento (archivo HTML) que se está procesando.
stylizer – Un objeto de tipo Stylizer que contiene los estilos aplanados para item. Puede obtener el estilo para cualquier elemento con ``stylizer.style(elemento)`.

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[fuente]¶: Ejecutado para crear el widget que se usa para configurar este complemento en la interfaz de calibre. El widget debe ser un objeto de la clase PluginWidget. Puede ver ejemplos en los complementos de salida incorporados.

Controladores de dispositivo ¶

La clase base para todos los controladores de dispositivo es DevicePlugin. Sin embargo, si el dispositivo se muestra como una unidad USBMS ante el sistema operativo, debe usar la clase USBMS en su lugar, pues implementa toda la lógica necesaria para este tipo de dispositivos.

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

Bases: Plugin

Define la interfaz que deben implementar los motores que comunican con un lector de libros electrónicos.

type = 'Interfaz del dispositivo'¶: El tipo de este complemento. Utilizado para clasificar los complementos en la interfaz gráfica.

FORMATS = ['lrf', 'rtf', 'pdf', 'txt']¶: Lista ordenada de formatos soportados

VENDOR_ID = 0¶

VENDOR_ID puede ser un entero, una lista de enteros o un diccionario. Si es un diccionario, debe ser un diccionario de diccionarios de la forma:

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

PRODUCT_ID = 0¶: Un entero o una lista de enteros

BCD = None¶: BCD puede ser bien None para no distinguir entre dispositivos según BCD, o bien una lista de los números BCD de todos los dispositivos soportados por este controlador.

THUMBNAIL_HEIGHT = 68¶: Altura de las miniaturas en el dispositivo

THUMBNAIL_COMPRESSION_QUALITY = 75¶: Calidad de compresión para las miniaturas. Cuanto más cercano a 100, mejor será la calidad de las miniaturas y menores los defectos de compresión. Por supuesto, también ocuparán más espacio las miniaturas.

WANTS_UPDATED_THUMBNAILS = False¶: Establézcalo en True si el dispositivo admite actualizar miniaturas de portada durante meth:sync_booklists. Si es True, se pedirá a device.py que vuelva a cargar las miniaturas al comparar libros

CAN_SET_METADATA = ['title', 'authors', 'collections']¶: Especifica si los metadatos de los libros pueden establecerse a través de la interfaz gráfica.

CAN_DO_DEVICE_DB_PLUGBOARD = False¶: Especifica si el dispositivo puede gestionar paneles de conexiones de metadatos device_db

path_sep = '/'¶: Separador de ruta para rutas de acceso a los libros en el dispositivo

icon = 'reader.png'¶: Icono para este dispositivo

UserAnnotation¶: alias de Annotation

OPEN_FEEDBACK_MESSAGE = None¶: La interfaz gráfica muestra esto como un mensaje en la barra de estado si no es None. Útil si la apertura puede llevar mucho tiempo

VIRTUAL_BOOK_EXTENSIONS = frozenset({})¶: Conjunto de extensiones que son «libros virtuales» en el dispositivo y por lo tanto no pueden visualizarse, guardarse o añadirse a la biblioteca. Por ejemplo: frozenset(['kobo'])

VIRTUAL_BOOK_EXTENSION_MESSAGE = None¶: Mensaje que se mostrará al usuario para las extensiones de libro virtuales.

NUKE_COMMENTS = None¶: Indica si se eliminan los comentarios de la copia del libro que se envía al dispositivo. Si no es None, debería ser un texto corto por el que se sustituirán los comentarios.

MANAGES_DEVICE_PRESENCE = False¶: Si es True, indica que este controlador gestiona completamente la detección de dispositivos, la desconexión, etc. Si la establece a True, debe implementar los métodos detect_managed_devices y debug_managed_device_detection. Un controlador con esta variable como True tiene la responsabilidad de detectar dispositivos, gestionar una lista negra de dispositivos, una lista de dispositivos desconectados, etc. calibre ejecutará periódicamente el método meth:detect_managed_devices() y si devuleve un dispositivo detectado, calibre ejecutará open(). open() se ejecutará cada vez que se devuelva un dispositivo, incluso si previamente open() falló, por lo tanto el controlador debe mantener su propia lista negra de dispositivos fallidos. Análogamente, al desconectar, calibre ejecutará eject() y, suponiendo que que la siguiente ejecución de detect_managed_devices() devuelva None, ejecutará post_yank_cleanup().

SLOW_DRIVEINFO = False¶: Si se establece en True, calibre ejecutará el método get_driveinfo() una vezs cargadas las listas de libros para obtener la información de la unidad.

ASK_TO_ALLOW_CONNECT = False¶: Si se establece en True, calibre preguntará al usuario si quiere administrar el dispositivo con calibre la primera vez que se detecta. Si lo establece en True debe implementar get_device_uid(), ignore_connected_device(), get_user_blacklisted_devices() y set_user_blacklisted_devices()

user_feedback_after_callback = None¶: Establezca esto a un diccionario de la forma {“title”:título, “msg”:mensaje, “det_msg”:mensaje_detallado} para que calibre muestre una ventana con un mensaje para el usuario tras ejecutar varias acciones (actualmente sólo upload_books()). Procure no mostrar demasiados mensajes al usuario. Esta variable se comprueba después de cada acción, así que establézcala sólo cuando sea realmente necesaria.

classmethod get_open_popup_message()[fuente]¶: La interfaz gráfica muestra esto como una ventana emergente no modal. Debe ser un ejemplar de OpenPopupMessage

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

Devuelve True, device_info si algún dispositivo gestionado por este complemento está actualmente conectado.

Parámetros:: devices_on_system – Lista de dispositivos conectados actualmente

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

Sólo se llama si MANAGES_DEVICE_PRESENCE es True.

Buscar dispositivos que pueda gestionar este controlador. Debe devolver un objeto de dispositivo si se encuentra algún dispositivo. Este objeto se pasará al método open() como connected_device. Si no se encuentra ningún dispositivo, devuelve None. El objeto devuelto puede ser cualquier cosa, calibre no lo usa, sólo lo pasa a open().

Este método se ejecuta periódicamente por la interfaz gráfica, así que asegúrese de que no requiere demasiados recursos. Use un caché para evitar buscar en el sistema una y otra vez.

Parámetros:

devices_on_system – Conjunto de dispositivos USB encontrados en el sistema.
force_refresh – Si es True y el controlador usa un caché para evitar búsquedas repetitivas, el caché debe vaciarse.

debug_managed_device_detection(devices_on_system, output)[fuente]¶

Sólo se llama si MANAGES_DEVICE_PRESENCE es True.

Debe escribir en output información sobre los dispositivos detectados en el sistema, que es un objeto de tipo archivo.

Debe devolver True si se detecta un dispositivo y se abre con éxito, en caso contrario debe devolver False.

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

Parámetros:

key – La clave para desbloquear el dispositivo
log_packets – Si es True, el flujo de paquetes de o al dispositivo se registra
report_progress – Función que se ejecuta con un argumento de progreso en porcentaje (número entre 0 y 100) para diversas tareas. Si el argumento es -1 significa que la tarea no tiene información de progreso.
detected_device – Información de dispositivo desde el examinador de dispositivos

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

Método opcional para comprobar si este controlador puede manejar un dispositivo mediante más pruebas. Si no puede, debe devolver False. Este método sólo se ejecuta una vez que los identificadores del fabricante y del producto, así como el BCD se han reconocido, por lo que puede realizar pruebas que requieran un tiempo relativamente prolongado. La implementación predeterminada devuelve True. Este método sólo se ejecuta en Windows. Véase también can_handle().

Tenga en cuenta que para dispositivos basados en USBMS este método de manera predeterminada delega en can_handle(). Así que sólo necesita sustituir can_handle() en la subclase de USBMS.

Parámetros:: usbdevice – Un dispositivo usb devuelto por calibre.devices.winusb.scan_usb_devices()

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

Versión unix de can_handle_windows().

Parámetros:: device_info – Es una tupla de (id_fab, id_prod, bcd, fabricante, producto, número de serie)

open(connected_device, library_uuid)[fuente]¶

Realiza cualquier inicio específico del dispositivo. Se ejecuta una vez que se ha detectado el dispositivo, pero antes de cualquier otra función que comunique con él. Por ejemplo, para dispositivos que se muestran como dispositivos de almacenamiento masivo USB, este método será el responsable de montar el dispositivo o, si se ha montado automáticamente, averiguar dónde. El método calibre.devices.usbms.device.Device.open() tiene una implementación de esta función que puede ser un buen ejemplo para dispositivos de almacenamiento masivo USB.

Este método puede generar una excepción de tipo OpenFeedback para mostrar un mensaje al usuario final.

Parámetros:

connected_device – El dispositivo que se intenta abrir. Es una tupla de (identificador de fabricante, identificador de producto, bcd, nombre de fabricante, nombre de producto, número de serie del dispositivo). Sin embargo, algunos dispositivos no tienen número de serie y en Windows sólo aparecen los tres primeros campos, el resto son None.
library_uuid – El UUID de la biblioteca de calibre actual. Puede ser None si no existe una biblioteca (por ejemplo cuando se usa desde la línea de órdenes).

eject()[fuente]¶

Desmontar o expulsar el dispositivo del sistema operativo. Esto no comprueba si hay tareas de interfaz gráfica pendientes que tengan que comunicar con el dispositivo.

NOTA: Este método no puede ejecutarse en el mismo subproceso que el resto de los métodos de dispositivo.

post_yank_cleanup()[fuente]¶: Se ejecuta si el usuario desconecta el dispositivo sin expulsarlo primero.

set_progress_reporter(report_progress)[fuente]¶

Establece una función para mostrar información de progreso.

Parámetros:: report_progress – Función que se ejecuta con un argumento de progreso en porcentaje (número entre 0 y 100) para diversas tareas. Si el argumento es -1 significa que la tarea no tiene información de progreso.

get_device_information(end_session=True)[fuente]¶

Pregunta al dispositivo por su información interna. Ver L{DeviceInfoQuery}.

Devuelve:: (nombre del dispositivo, versión del dispositivo, versión del software en el dispositivo, tipo MIME) La tupla puede tener un quinto elemento opcional, que es un diccionario de información de unidad. Puede verse un ejemplo en usbms.driver.

get_driveinfo()[fuente]¶: Devuelve el diccionario de información de dispositivo. Normalmente se ejecuta desde get_device_information(), pero si la carga de la información del dispositivo es lenta para este controlador, debería establecer SLOW_DRIVEINFO. En este caso, calibre ejecutará este método después de cargar la lista de libros. Tenga en cuenta que no se ejecuta en el hilo del dispositivo, por lo que el controlador debería almacenar en caché la información del dispositivo en el método books() y esta función debería devolver los datos almacenados.

card_prefix(end_session=True)[fuente]¶: Devuelve una lista de dos elementos con los prefijos para las rutas de acceso en las tarjetas. Si no hay tarjeta, el prefijo correspondiente será None. Por ejemplo: (“/lugar”, “/lugar2”) (None, “lugar2”) (“lugar”, None) (None, None)

total_space(end_session=True)[fuente]¶

Obtiene el espacio total disponible en los puntos de montaje:

Memoria principal
Tarjeta de almacenamiento A
Tarjeta de almacenamiento B

Devuelve:: Una lista de tres elementos con el espacio total en bytes de (1, 2, 3). Si un dispositivo concreto no tiene alguna de estas ubicaciones, debe devolver 0.

free_space(end_session=True)[fuente]¶

Obtiene el espacio libre disponible en los puntos de montaje:

Memoria principal
Tarjeta A
Tarjeta B

Devuelve:: Una lista de tres elementos con el espacio libre en bytes de (1, 2, 3). Si un dispositivo concreto no tiene alguna de estas ubicaciones, debe devolver -1.

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

Devuelve una lista de los libros electrónicos en el dispositivo.

Parámetros:: oncard – Si es “carda” o “cardb”, devuelve una lista de los libros en la tarjeta de almacenamiento especificada, en caso contrario devuelve una lista de los libros en la memoria principal del dispositivo. Si se especifica una tarjeta y no hay libros en ella, devuelva una lista vacía.
Devuelve:: Un objeto BookList.

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

Copia una lista de libros al dispositivo. Si un archivo ya existe en el dispositivio, deberá ser sustituido. Este método debería generar un error FreeSpaceError si no hay suficiente espacio libre en el dispositivo. El texto del error FreeSpaceError debe contener la palabra «card» si ``on_card` no es None, si no, debe contener la palabra «memory».

Parámetros:

files – Una lista de rutas
names – Una lista de nombres de archivo que los libros deberán tener una vez copiados al dispositivo. len(names) == len(files)
metadata – Si no es None, es una lista de objetos Metadata. La idea es utilizar los metadatos para determinar dónde poner el libro en el dispositivo. len(metadata) == len(files). Aparte de la portada normal (ruta a la portada), también puede haber un atributo de miniatura (thumbnail), que debería tener prioridad. El atributo thumbnail es de la forma (anchura, altura, datos_de_portada como jpeg).

Devuelve:

Una lista de tuplas de 3 elementos. La lista se envía a add_books_to_metadata().

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

Añade ubicaciones a las listas de libros. Esta función no debe comunicarse con el dispositivo.

Parámetros:

locations – Resultado de una llamada a L{upload_books}
metadata – Lista de objetos Metadata, igual que para upload_books().
booklists – Una tupla que contiene el resultado de las llamadas a (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=”cardb”)`).

delete_books(paths, end_session=True)[fuente]¶: Borrar libros en ubicaciones del dispositivo.

classmethod remove_books_from_metadata(paths, booklists)[fuente]¶

Elimina libros de la lista de metadatos. Esta función no debe comunicarse con el dispositivo.

Parámetros:

paths – rutas a los libros en el dispositivo.
booklists – Una tupla que contiene el resultado de las llamadas a (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=”cardb”)`).

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

Actualizar metadatos del dispositivo.

Parámetros:: booklists – Una tupla que contiene el resultado de las llamadas a (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=”cardb”)`).

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

Lee el archivo en path en el dispositivo y lo escribe en outfile.

Parámetros:: outfile – objeto de archivo como sys.stdout o el resultado de ejecutar open().

classmethod config_widget()[fuente]¶: Debe devolver un QWidget. El QWidget contiene las configuraciones de la interfaz de dispositivo.

classmethod save_settings(settings_widget)[fuente]¶: Debe guardar las configuraciones en el disco. Toma el widget creado en config_widget() y guarda todas las configuraciones en el disco.

classmethod settings()[fuente]¶: Debe devolver un objeto opts. El objeto opts debería tener al menos un atributo format_map que es una lista ordenada de formatos para el dispositivo.

set_plugboards(plugboards, pb_func)[fuente]¶

Proporciona al controlador el conjunto actual de paneles de conexiones y una función para seleccionar un panel de conexión específico. Este método se ejecuta inmediatamente antes de add_books y sync_booklists.

pb_func es un metodo ejecutable con la siguiente firma:: def pb_func(device_name, format, plugboards)

Le da el nombre del dispositivo actual (ya sea el nombre de la clase o DEVICE_PLUGBOARD_NAME), el formato en que está interesado (un formato «real» o `device_db`), y los paneles de conexiones (suministrados por set_plugboards, en el mismo lugar de donde se obtuvo este método).

Devuelve:: None o un único panel de conexiones.

set_driveinfo_name(location_code, name)[fuente]¶

Establece el nombre de dispositivo en el archivo driveinfo como name. Este ajuste persistirá hasta que el archivo se vuelva a crear o se cambie el nombre de nuevo.

Los dispositivos que no son de disco deberían implementar este método según los códigos de ubicación devueltos por el método get_device_information().

prepare_addable_books(paths)[fuente]¶

Dada una lista de rutas de acceso, devuelve otra lista de rutas de acceso. Estas rutas apuntan a versiones de los libros que pueden añadirse.

Si ocurre un error al preparar un libro, en lugar de una ruta de acceso, la posición en la lista devuelta para ese libro debería de ser una tupla de tres elementos: (ruta_original, la excepción, rastro)

startup()[fuente]¶: Se ejecuta cuando calibre inicia el dispositivo. Realiza cualquier inicialización necesaria. Tenga en cuenta que pueden generarse varios especímenes de la clase, y por lo tanto __init__() puede ejecutarse varias veces, pero sólo un espécimen ejecutará este método. Este método se ejecuta en el hilo del dispositivo, no en el de la interfaz gráfica.

shutdown()[fuente]¶: Se ejecuta cuando calibre se está apagando, ya sea definitivamente o como preparación para reiniciarse. Lleva a cabo cualquier limpieza requerida. Este método se ejecuta en el hilo del dispositivo, no en el de la interfaz gráfica.

get_device_uid()[fuente]¶: Debe devolver un identificador único para el dispositivo conectado actualmente (se ejecuta inmediatamente después de ejecutarse open() con éxito). Debe implementar este método si establece ASK_TO_ALLOW_CONNECT = True.

ignore_connected_device(uid)[fuente]¶: El dispositivo identificado por uid (el resultado de ejecutar get_device_uid()) debe ignorarse en el futuro. Debe implementar este método si establece ASK_TO_ALLOW_CONNECT = True. Tenga en cuenta que esta función se ejecuta inmediatamente después de open(), así que si open() almacena algún estado en caché el controlador debería restablecer el estado.

get_user_blacklisted_devices()[fuente]¶: Devuelve un diccionario de identificadores y nombres de dispositivo para todos los dispositivos que el usuario ha pedido ignorar.

set_user_blacklisted_devices(devices)[fuente]¶: Establecer la lista de uids de dispositivo que deben ser ignorados por este controlador.

specialize_global_preferences(device_prefs)[fuente]¶: Implemente este método si el dispositivo quiere sustituir una preferencia particular. Debe asegurarse de que todos los lugares de ejecución que emplean una preferencia que pueda ser sustituida usen device_prefs['algo'] en lugar de prefs['algo']. El metodo debe ejecutar device_prefs.set_overrides(pref=val, pref=val, ...). Actualmente se usa para: gestión de metadatos (prefs['manage_device_metadata']).

set_library_info(library_name, library_uuid, field_metadata)[fuente]¶: Implemente este método si quiere información sobre la biblioteca de calibre actual. Este método se ejecuta al inicio y cuando la biblioteca de calibre cambia mientras está conectado.

is_dynamically_controllable()[fuente]¶

Ejecutado por el administrador de dispositivos al iniciar complementos. Si este método devuelve un texto, entonces a) soporta la interfaz de control dinámica del administrador de dispositivos y b) debe usarse ese nombre para comunicarse con el complemento.