API-dokumentation för insticksmoduler¶

Definiera diverse abstrakta basklasser som kan vara underklasser för att skapa kraftfulla insticksmoduler. Dessa användbara klasser är:

Insticksmoduler ¶

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

En calibre insticksmodul. Användbara medlemmar inkluderar:

self.installation_type: Lagrar hur insticksmoudlen installerades.

self.plugin_path: Lagrar sökväg till ZIP-filen som innehåller
denna insticksmodul eller None om den är en inbyggd insticksmodul

self.site_customization: Lagrar en anpassningssträng som har angetts
av användaren.

Metoder som ska åsidosättas i underklasser:

initialize()

customization_help()

Användbara metoder:

temporary_file()

__enter__()

load_resources()

supported_platforms = []¶: Lista över plattformar som den här insticksmodulen fungerar på. Till exempel: ['windows', 'osx', 'linux']

name = 'Trivial Plugin'¶: Namnet på denna insticksmodul. Du måste ange något annat än Trivial Plugin för att den ska fungera.

version = (1, 0, 0)¶: Versionen för denna insticksmodul är n 3-tupel (major, minor, revision)

description = 'Gör absolut ingenting'¶: En kort sträng som beskriver vad denna insticksmodul gör

author = 'Okänd'¶: Författare av denna insticksmodul

priority = 1¶: När flera insticksmoduler finns för samma filtyp körs de i fallande prioritetsordning. Moduler med högre prioritet körs först. Högsta möjliga prioritet är sys.maxsize. Standardprioriteten är 1.

minimum_calibre_version = (0, 4, 118)¶: Den tidigaste versionen av calibre som denna insticksmodul kräver

installation_type = None¶: Sättet den här insticksmodulen installeras

can_be_disabled = True¶: Om False, kommer inte användaren kunna deaktivera denna insticksmodul. Använd med försiktighet.

type = 'Grund'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

initialize()[source]¶

Anropas när calibre-insticksmoduler initieras. Insticksmoduler är återinitierade varje gång en ny insticksmodul läggs till. Observera också att om insticksmodulen körs i en arbetsprocess, såsom att lägga till böcker, då kommer insticksmodulen att initieras för varje ny arbetsprocess.

Utför valfri insticksmodulspecifik initiering här, såsom att utvinna resurser från insticksmoduls ZIP-filen. Sökvägen till ZIP-filen är tillgänglig som self.plugin_path.

Observera att self.site_customization är inte tillgänglig vid detta tillfälle.

config_widget()[source]¶

Implementera denna metod och save_settings() i din insticksmodul för att använda en anpassad konfigurationsdialog, snarare än att förlita sig på en enkel strängbaserad standardanpassning.

Om metoden implementeras måste den returnera en QWidget. Komponenten kan ha en valfri metod validate() utan argument, som anropas direkt efter att användaren klickat på OK. Ändringarna tillämpas endast om metoden returnerar True.

Om du av någon anledning inte kan utföra konfigurationen vid denna tid, returnera en tupel av två strängar (meddelande, detaljer), kommer dessa att visas som en varningsdialogruta för användaren och processen avbryts.

save_settings(config_widget)[source]¶

Spara inställningarna som anges av användaren med config_widget.

Parametrar:: config_widget – Gränssnittskomponenten som returneras av config_widget().

do_user_config(parent=None)[source]¶: Denna metod visar en inställningsdialogruta för denna insticksmodul. Den returnerar True om användaren klickar på OK, annars False. Ändringarna tillämpas automatiskt.

load_resources(names)[source]¶

Om denna insticksmodul kommer i en ZIP-fil (användartillagd insticksmodul), kommer denna metod tillåta dig läsa in resurser från ZIP-fil.

Till exempel att läsa in en bild:

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

Parametrar:: names – Förteckning över sökvägar till resurser i ZIP-filen som använder / som avskiljare
Returer:: En ordbok av formen {name: file_contents}. Namn som inte finns i ZIP-filen kommer inte att vara närvarande i ordboken.

customization_help(gui=False)[source]¶

Returnera en hjälptext om hur insticksmodulen anpassas. Standardimplementeringen genererar NotImplementedError, vilket anger att modulen inte behöver anpassas.

Om du återimplementerar den här metoden i din underklass, kommer användaren att bli ombedd att skriva in en sträng som anpassning för denna insticksmodul. Den anpassning strängen kommer att finnas tillgänglig som self.site_customization.

Platsanpassning skulle kunna vara vad som helst, till exempel vägen till en välbehövlig binär på användarens dator.

Parametrar:: gui – Om True returneras HTML-hjälp, annars returneras oformaterad hjälptext.

temporary_file(suffix)[source]¶

Returnera ett filliknande objekt som motsvarar en tillfällig fil i filsystemet. Filen finns kvar även efter att den har stängts och tas bort först när tolken avslutas. Använd medlemmen name i det returnerade objektet för att komma åt hela sökvägen till den skapade tillfälliga filen.

Parametrar:: suffix – Suffixet att den temporära filen kommer att ha.

cli_main(args)[source]¶: Denna metod är den huvudsakliga ingångspunkten för dina insticksmodulers kommandoradsgränssnitt. Det anropas när användaren utför: calibre-debug -r ”insticksmodulsnamn”. Eventuella argument som skickas finns i variabeln args.

FileTypePlugin ¶

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

Baser: Plugin

En insticksmodul som är associerad med en viss uppsättning filtyper.

file_types = {}¶: Uppsättning av filtyper som denna insticksmodul ska köra. Använd ”*” för alla filtyper. Till exempel: {'lit', 'mobi', 'prc'}

on_import = False¶: Om True, körs denna insticksmodul när böcker läggs till i databasen

on_postimport = False¶: Om True, körs denna insticksmodul efter att böcker läggs till i databasen. I detta fall anropas metoderna postimport och postadd av insticksmodulen.

on_postconvert = False¶: Om True, körs denna insticksmodul efter att en bok har konverterats. I det här fallet anropas insticksmodulens postkonverteringsmetod.

on_postdelete = False¶: Om True, körs denna insticksmodul efter att en bokfil har tagits bort från databasen. I det här fallet anropas insticksmodulens postborttagningsmetod.

on_preprocess = False¶: Om True, körs denna insticksmodul alldeles innan en konvertering

on_postprocess = False¶: Om True, körs denna insticksmodul efter konvertering på den slutliga filen som produceras av insticksmodulen för konverteringsutmatning.

type = 'Filtyp'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

run(path_to_ebook)[source]¶

Kör insticksmodulen. Metoden måste implementeras i underklasser. Den ska göra nödvändiga ändringar i e-boken och returnera den absoluta sökvägen till den ändrade filen. Om inga ändringar behövs returneras sökvägen till originalfilen. Om ett fel uppstår ska ett undantag genereras. Standardimplementeringen returnerar originalfilens sökväg. Sökvägen före körning av filtypsinsticksmoduler finns i self.original_path_to_file.

Den modifierade e-bokfilen ska skapas med temporary_file() metod.

Parametrar:: path_to_ebook – Absolut sökväg till e-boken.
Returer:: Absolut sökväg till den modifierade e-boken.

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

Anropas efter importering, dvs. efter bokfilen har lagts till i databasen. Observera att detta skiljer sig från postadd() som anropas när bokposten skapas för första gången. Denna metod anropas varje gång en ny fil läggs till i en bokpost. Det är användbart för att ändra bokposten baserat på innehållet i den nyligen tillagda filen.

Parametrar:

book_id – Databas id för tillagda boken.
book_format – Filtypen för boken som lades till.
db – Biblioteksdatabas.

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

Anropas efter konvertering, dvs. efter att konverteringsutmatningsboken har lagts till i databasen. Observera att den körs endast efter en konvertering, inte efter att en bok har lagts till. Det är användbart för att ändra bokposten baserat på innehållet i den nyligen tillagda filen.

Parametrar:

book_id – Databas id för tillagda boken.
book_format – Filtypen för boken som lades till.
db – Biblioteksdatabas.

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

Anropas postborttagning, dvs. efter att bokfilen har tagits bort från databasen. Observera att den inte körs när en bokpost tas bort, endast när ett eller flera format från boken tas bort. Det är användbart för att ändra bokposten baserat på formatet på den borttagna filen.

Parametrar:

book_id – Databas id för tillagda boken.
book_format – Filtypen för boken som lades till.
db – Biblioteksdatabas.

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

Anropad efter posttilläggning, dvs. efter en bok har lagts till i databasen. Observera att detta skiljer sig från postimport() som anropas efter en enskild bokfil har lagts till en bok. postadd() anropas när en hel bokpost med mer än en möjlig bokfil har skapats för första gången. Det är användbart för att ändra bokposten i databasen när boken läggs till för första gången till calibre.

Parametrar:

book_id – Databas id för tillagda boken.
fmt_map – Mappning från filformat till den sökväg som formatet lades till från. Observera att sökvägen inte nödvändigtvis pekar på en befintlig fil, eftersom filer ibland läggs till som strömmar. I sådana fall kan värdet vara ett platshållarvärde eller en obefintlig sökväg.
db – Biblioteksdatabas

Metadatainsticksmodul ¶

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

Baser: Plugin

En insticksmodul som implementerar läsning av metadata från en uppsättning filtyper.

file_types = {}¶: Uppsättning med filtyper som denna insticksmodul ska köra. Till exempel: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: Lista över plattformar som den här insticksmodulen fungerar på. Till exempel: ['windows', 'osx', 'linux']

version = (9, 12, 0)¶: Versionen för denna insticksmodul är n 3-tupel (major, minor, revision)

author = 'Kovid Goyal'¶: Författare av denna insticksmodul

type = 'Metadataläsare'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

get_metadata(stream, type)[source]¶

Returnera metadata för filen som representeras av ström (ett filliknande objekt som stöder läsning). Markera ett undantag när det finns ett fel med inmatningen.

Parametrar:: type – Filtypen. Garanterat en av posterna i file_types.
Returer:: Ett calibre.ebooks.metadata.book.Metadata-objekt

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

Baser: Plugin

En insticksmodul som implementerar läsning av metadata från en uppsättning filtyper.

file_types = {}¶: Uppsättning med filtyper som denna insticksmodul ska köra. Till exempel: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: Lista över plattformar som den här insticksmodulen fungerar på. Till exempel: ['windows', 'osx', 'linux']

version = (9, 12, 0)¶: Versionen för denna insticksmodul är n 3-tupel (major, minor, revision)

author = 'Kovid Goyal'¶: Författare av denna insticksmodul

type = 'Metadataskrivare'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

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

Ange metadata för filen som representeras av stream, ett filliknande objekt som kan läsas. Generera ett undantag om indata är felaktiga.

Parametrar:

type – Filtypen. Garanterat en av posterna i file_types.
mi – Ett calibre.ebooks.metadata.book.Metadata-objekt

Katalog insticksmodul ¶

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

Baser: Plugin

En insticksmodul som implementerar en kataloggenerator.

file_types = {}¶: Utmatningsfiltyp som denna insticksmodul ska köra. Till exempel: ’epub’ eller ’xml’

type = 'Kataloggenerator'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

cli_options = []¶

CLI-parseralternativ som är specifika för denna insticksmodul deklareras som 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()[source]¶: Om insticksmodulen inte är ett inbyggt, kopiera insticksmodulens .ui- och .py-filer från ZIP-filen till $TMPDIR. Flik kommer att genereras dynamiskt och läggas till dialogrutan Katalogalternativ i calibre.gui2.dialogs.catalog.py:Catalog

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

Kör insticksmodulen. Måste implementeras i underklasser. Det ska generera katalogen i det format som anges i file_types, återvänder den absoluta sökvägen till den genererade katalogfilen. Om ett fel uppstår bör det signalera ett undantag.

Den genererade katalogfilen ska genereras med temporary_file()-metoden.

Parametrar:

path_to_output – Absoluta sökvägen till den genererade katalogfilen.
opts – En ordbok av nyckelordsargument
db – Ett LibraryDatabase2-objekt

Insticksmoduler för metadatahämtning ¶

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

Baser: Plugin

type = 'Metadatakälla'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

author = 'Kovid Goyal'¶: Författare av denna insticksmodul

supported_platforms = ['windows', 'osx', 'linux']¶: Lista över plattformar som den här insticksmodulen fungerar på. Till exempel: ['windows', 'osx', 'linux']

capabilities = frozenset({})¶: Uppsättning funktioner som stöds av denna insticksmodul. Användbara funktioner är: ”identify”, ”cover”

touched_fields = frozenset({})¶: Lista med metadatafält som potentiellt kan hämtas av denna insticksmodul under identifieringsfasen

has_html_comments = False¶: Ange detta som True om din insticksmodul returnerar HTML-formaterade kommentarer

supports_gzip_transfer_encoding = False¶: Om detta ställs till True betyder det att webbläsarobjektet indikerar att det stöder gzip-överföringskodning. Detta kan hämtas snabbt, men se till att källan faktiskt stöder gzip-överföringskodningen korrekt först

ignore_ssl_errors = False¶: Ställ in detta till True för att ignorera HTTPS-certifikatfel när du ansluter till den här källan.

cached_cover_url_is_reliable = True¶: Cachelagrade omslags-URL:er kan ibland vara opålitliga, exempelvis genom att hämtningen misslyckas eller den returnerade bilden är ogiltig. Om detta ofta inträffar med källan anger du False

options = ()¶: En lista med Option-objekt. De används för att automatiskt skapa insticksmodulens konfigurationskomponent.

config_help_message = None¶: En sträng som visas högst upp på gränssnittskomponenten för denna insticksmodul

can_get_multiple_covers = False¶: Om True kan denna källa returnera flera omslag för en viss förfråga

auto_trim_covers = False¶: Om inställt till True beskärs hämtade omslag automatiskt med denna insticksmodul.

prefer_results_with_isbn = True¶: Om värdet är True, och denna källa returnerar flera resultat för en förfråga, av vilka några har ISBN och av vilka en del inte, så ignoreras resultaten utan ISBN

is_configured()[source]¶: Returnera False om din insticksmodul måste anpassas innan den kan användas. Till exempel kan den behöva ett användarnamn/lösenord/API-nyckel.

customization_help(gui=False)[source]¶

Returnera en hjälptext om hur insticksmodulen anpassas. Standardimplementeringen genererar NotImplementedError, vilket anger att modulen inte behöver anpassas.

Om du återimplementerar den här metoden i din underklass, kommer användaren att bli ombedd att skriva in en sträng som anpassning för denna insticksmodul. Den anpassning strängen kommer att finnas tillgänglig som self.site_customization.

Platsanpassning skulle kunna vara vad som helst, till exempel vägen till en välbehövlig binär på användarens dator.

Parametrar:: gui – Om True returneras HTML-hjälp, annars returneras oformaterad hjälptext.

config_widget()[source]¶

Implementera denna metod och save_settings() i din insticksmodul för att använda en anpassad konfigurationsdialog, snarare än att förlita sig på en enkel strängbaserad standardanpassning.

Om metoden implementeras måste den returnera en QWidget. Komponenten kan ha en valfri metod validate() utan argument, som anropas direkt efter att användaren klickat på OK. Ändringarna tillämpas endast om metoden returnerar True.

Om du av någon anledning inte kan utföra konfigurationen vid denna tid, returnera en tupel av två strängar (meddelande, detaljer), kommer dessa att visas som en varningsdialogruta för användaren och processen avbryts.

save_settings(config_widget)[source]¶

Spara inställningarna som anges av användaren med config_widget.

Parametrar:: config_widget – Gränssnittskomponenten som returneras av config_widget().

get_author_tokens(authors, only_first_author=True)[source]¶: Ta en lista över författare och returnera en lista med tokens som är användbara för en AND-sökförfråga. Denna funktion försöker returnera tokens i ordningen förnamn mellannamn efternamn, genom att anta att om ett kommatecken finns i författarnamnet, är namnet i efternamn, andra namnbildningar.

get_title_tokens(title, strip_joiners=True, strip_subtitle=False)[source]¶: Ta en titel och returnera en lista med symboler som är användbara för en OCH sökförfrågan. Exkluderar connectives (valfritt) och skiljetecken.

split_jobs(jobs, num)[source]¶: Dela upp en lista med jobb i högst num grupper, så jämnt som möjligt

test_fields(mi)[source]¶: Återgå till det första fältet från self.touched_fields som är null på mi objektet

clean_downloaded_metadata(mi)[source]¶: Anropa den här metoden i din insticksmodul för att identifiera metod att normalisera metadata innan metadataobjektet läggs i result_queue. Du kan naturligtvis använda en anpassad algoritm som matchar din metadatakälla.

get_book_url(identifiers)[source]¶: Returnera en 3-tupel eller None. Tupeln ska ha formen (identifier_type, identifier_value, URL). URL är adressen till den bok som motsvarar identifieraren hos den här källan. identifier_type och identifier_value anger identifierarens typ och värde. URL:en måste kunna öppnas av en användare i en webbläsare och är avsedd att fungera som en klickbar länk till bokens sida hos källan. Returnera None om ingen URL hittas. Metoden måste vara snabb och ge konsekventa resultat, så implementera den bara om URL:en kan konstrueras enligt ett känt schema från identifierarna.

get_book_url_name(idtype, idval, url)[source]¶: Returnera ett mänskligt läsbart namn från det återgivna värdet för get_book_url().

get_book_urls(identifiers)[source]¶: Åsidosätt den här metoden om du vill returnera flera URL:er för den här boken. Returnera en lista med 3-tupler. Som standard anropar den här metoden helt enkelt get_book_url().

get_cached_cover_url(identifiers)[source]¶

Returnera cachade omslags-URL:er för boken som identifieras av identifierarordboken eller None om det inte finns någon sådan URL.

Observera att den här metoden endast får returnera validerade URL:er, dvs. inte URL:er som kan resultera i en generisk omslagsbild eller ett fel som inte hittades.

id_from_url(url)[source]¶: Analysera en URL och returnera en tupel av formen: (identifier_type, identifier_value). Om URL:en inte matchar mönstret för metadatakällan, returnera None.

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

Returnera en funktion som används för att skapa en nyckel som kan sortera metadataobjekt genom deras relevans givet en sökförfråga (titel, författare, kännetecken).

Dessa nycklar används för att sortera resultatet av ett anrop till identify().

För mer information om standardalgoritmen, se: klass InternalMetadataCompareKeyGen. Återimplementera denna funktion i din insticksmodul om standardalgoritmen inte är lämplig.

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

Identifiera en bok med dess titel/författare/ISBN/etc.

Om en eller flera identifierare anges och ingen träff hittas och den här metadatakällan inte lagrar alla relaterade identifierare (till exempel alla ISBN av en bok), bör den här metoden försökas igen med bara titel och författare (förutsatt att de specificerades).

Om den här metadatakällan också innehåller omslag, bör URL:en till omslaget cachas så att ett efterföljande anrop till skaffa omslags-API:et med samma ISBN/specialidentifiering inte behöver hämta omslags-URL:en igen. Använd cache-API:et för detta.

Varje metadataobjekt infört i result_queue med denna metod måste ha en source_relevance attribut som är ett heltal som anger i vilken ordning resultaten återgavs av metadatakällan för den här förfrågan. Detta heltal kommer att användas av compare_identify_results(). Om ordningen är oviktigt, sätt den till noll för varje resultat.

Se till att all omslags-/ISBN-kartläggningsinformation cachelagras innan Metadata-objektet placeras i result_queue.

Parametrar:

log – En loggpost, använd den för att mata ut felsökningsinformation/fel
result_queue – Ett resultat Kö, resultaten läggas in i den. Varje resultat är ett metadataobjekt
abort – Om abort.is_set() returnerar True, avbryt vidare bearbetning och återvända så snart som möjligt
title – Titeln på boken, kan vara None
authors – En lista med författare av boken, kan vara None
identifiers – En ordbok av andra identifieringsuppgifter oftast {’isbn’:’1234…’}
timeout – Tidsbegränsning i sekunder, ingen nätverksförfrågan ska dröja längre än tidsbegränsningen.

Returer:

None om inga fel har inträffat, annars en Unicode-representation av felet som är lämplig för att visa för användaren

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

Hämta ett omslag och sätta det i result_queue. Parametrarna alla har samma betydelse som för identify(). Put (jaget, cover_data) i result_queue.

Den här metoden bör använda cachade omslags-URL:er för effektivitet när det är möjligt. När cachade data inte finns, anropar de flesta insticksmoduler helt enkelt identifiering och använder dess resultat.

Om parametern get_best_cover är True, och kan denna insticksmodul få flera omslag, det bör bara få det ”bästa”.

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

Skapa en slags nyckel för jämförelse av relevansen av metadataobjekt, ges en sökförfråga. Detta används endast för att jämföra resultat från samma metadatakälla, inte mellan olika informationskällor.

Sorteringsnyckeln säkerställer att en stigande ordning sortera är en sortera fallande relevans.

Algoritmen är:

Föredra resultat som har åtminstone en identifierare som är samma som för förfrågan

Föredra resultat med en cachad omslags-URL

Föredra resultat med alla tillgängliga fält ifyllda

Föredra resultat med samma språk som aktuella användarens gränssnittsspråk

Föredra resultat som är en exakt titelmatchning på förfrågan

Föredra resultat med längre kommentarer (mer än 10% längre)

Använd relevansen av resultatet som rapporterats av metadatakällans sökning
engine

Konvertering insticksmodul ¶

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

Baser: Plugin

InputFormatPlugins ansvarar för att konvertera ett dokument till HTML+OPF+CSS+etc. Resultatet av konverteringen måste kodas i UTF-8. Den viktigaste åtgärden händer i convert().

type = 'Konverteringsinmatning'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

supported_platforms = ['windows', 'osx', 'linux']¶: Lista över plattformar som den här insticksmodulen fungerar på. Till exempel: ['windows', 'osx', 'linux']

file_types = {}¶: Uppsättning med filtyper som denna insticksmodul ska köra Till exempel: set(['azw', 'mobi', 'prc'])

is_image_collection = False¶: Om värdet är True skapar denna inmatningsinsticksmodul en bildsamling med en bild per HTML-fil. Detta kan anges dynamiskt i konverteringsmetoden om inmatningsfilerna kan vara både bildsamlingar och andra typer av samlingar. Om du anger True måste du implementera metoden get_images(), som returnerar en lista över bilder.

core_usage = 1¶: Antal CPU-kärnor som används av denna insticksmodul. Ett värde av -1 betyder att den använder alla tillgängliga kärnor

for_viewer = False¶: Om värdet är True, kommer inmatning insticksmodulen specialbearbeta att göra sitt utmatning lämpligt för visning

output_encoding = 'utf-8'¶: Kodningen som denna inmatning insticksmodul skapar filer i. Ett värde på None betyder att kodningen är odefinierad och måste upptäckas var för sig

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: Alternativ som delas av alla inmatningsformatsinsticksmoduler. Åsidostätt inte i underklasser. Använd options i stället. Varje alternativ ska vara en instans av OptionRecommendation.

options = {}¶: Alternativ för att anpassa beteendet för denna insticksmodul. Varje alternativ ska vara en instans av OptionRecommendation.

recommendations = {}¶: En uppsättning av 3-tupler av formen (option_name, recommended_value, recommendation_level)

get_images()[source]¶: Returnera en lista med absoluta sökvägar till bilderna, om denna inmatning insticksmodul representerar en bildsamling. Listan med bilder är i samma ordning som bokryggen och innehållsförteckningen.

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

Denna metod måste implementeras i underklasser. Den måste returnera sökvägen till den skapade OPF-filen eller en OEBBook-instans. All utmatning ska ingå i den aktuella mappen. Om denna insticksmodul skapar filer utanför den aktuella mappen måste de tas bort/markeras för borttagning innan denna metod avslutas.

Parametrar:

stream – Ett filliknande objekt som innehåller indatafilen.
options – Alternativ för att anpassa konverteringen. Garanterat att ha attribut som motsvarar alla de alternativ som deklarerats av denna insticksmodul. Dessutom kommer det att ha en utförlig attribut som tar intergralvärden från noll och uppåt. Högre siffror innebär att vara mer utförlig. En annan användbar egenskap är input_profile det är en instans av calibre.customize.profiles.InputProfile.
file_ext – Filtypsändelsen (utan .) i inmatningsfilen. Det är garanterat att vara en av de file_types stöds av denna insticksmodul.
log – Ett calibre.utils.logging.Log objekt. All utmatning bör använda detta objekt.
accelerators – En ordbok för olika uppgifter inmatning insticksmodul kan få lätt som skulle kunna påskynda de efterföljande stegen i konverteringen.

postprocess_book(oeb, opts, log)[source]¶: Anropas för att tillåta inmatning insticksmodul för att utföra efterbehandling efter att boken har analyserats.

specialize(oeb, opts, log, output_fmt)[source]¶: Anropas för att tillåta inmatning insticksmodul att specialisera den analyserade boken för en viss utmatning format. Anropas efter postprocess_book och innan några omvandlingar utförs på den analyserade boken.

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[source]¶: Anropas för att skapa gränssnittskomponenten som används för att anpassa denna insticksmodul i calibre-användaregränssnittet. Gränssnittskomponenten måste vara en instans av klassen PluginWidget. Se inbyggda inmatningsinsticksmoduler för exempel.

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

Baser: Plugin

OutputFormatPlugins är ansvariga för att konvertera ett OEB-dokument (OPF+HTML) till e-bokutmatning.

OEB-dokumentet kan antas vara kodade i UTF-8. Den viktigaste åtgärden händer i convert().

type = 'Konverteringsutmatning'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

supported_platforms = ['windows', 'osx', 'linux']¶: Lista över plattformar som den här insticksmodulen fungerar på. Till exempel: ['windows', 'osx', 'linux']

file_type = None¶: Filtypen (ändelse utan främre punkt) att denna insticksmodul utmatning

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: Alternativ som delas av alla inmatningsformatsinsticksmoduler. Åsidostätt inte i underklasser. Använd options i stället. Varje alternativ ska vara en instans av OptionRecommendation.

options = {}¶: Alternativ för att anpassa beteendet för denna insticksmodul. Varje alternativ ska vara en instans av OptionRecommendation.

recommendations = {}¶: En uppsättning av 3-tupler av formen (option_name, recommended_value, recommendation_level)

property description¶

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

Skapa ett nytt strängobjekt från det givna objektet. Om kodning eller fel anges måste objektet exponera en databuffert som kommer att avkodas med den givna kodningen och felhanteraren. Annars returnerar resultatet av object.__str__() (om definierat) eller repr(object). kodning är som standard ’utf-8’. fel har som standard ”strikt”.

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

Återge innehållet i oeb_book (som är en instans av: calibre.ebooks.oeb.OEBBook) till filen som anges av utgång.

Parametrar:

output – Antingen ett filliknande objekt eller en sträng. En sträng är sökvägen till en mapp som kan finnas eller saknas; utmatningsinsticksmodulen ska skriva resultatet dit. Om värdet är ett filliknande objekt ska resultatet skrivas till objektet.
input_plugin – Inmatningsinsticksmodulen som användes i början av konverteringsprocessen.
opts – Konverteringsalternativ. Garanterat att ha attribut som motsvarar OptionRecommendations av denna insticksmodul.
log – Loggern. Skriv ut felsöknings/infomeddelanden etc. med hjälp av denna.

specialize_options(log, opts, input_fmt)[source]¶: Kan användas för att ändra värdena för konverteringsalternativ, som används av konverteringsprocessen.

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

Kan användas för att göra ändringar i CSS under CSS-utplattningsprocessen.

Parametrar:

item – Elementet (HTML-fil) som bearbetas
stylizer – Ett stiliseringsobjekt som innehåller de utplattade stilarna för posten. Du kan få stilen för alla element av stylizer.style(element).

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[source]¶: Anropas för att skapa gränssnittskomponenten för att anpassa denna insticksmodul i calibres användargranssnittet. Gränssnittskomponenten måste vara en instans av klassen PluginWidget. Se inbyggda utmatningsinsticksmoduler för exempel.

Enhetsdrivrutiner ¶

Basklass för alla drivrutiner är DevicePlugin. Men om din enhet exponerar sig som en USBMS-enhet till operativsystemet, bör du använda USBMS-klassen i stället eftersom den genomför all logik som behövs för att stödja dessa typer av enheter.

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

Baser: Plugin

Definierar gränssnitt som ska implementeras av bakomliggande system som kommunicerar med en e-bokläsenhet.

type = 'Enhetsgränssnitt'¶: Typen av denna insticksmodul. Används för kategorisera insticksmodul i användargränssnittet

FORMATS = ['lrf', 'rtf', 'pdf', 'txt']¶: Ordnad lista med format som stöds

VENDOR_ID: ClassVar[int | list[int] | dict[int, dict[int, list[int] | None]]] = 0¶

VENDOR_ID kan vara ett heltal, en lista med heltal eller en ordbok. Om värdet är en ordbok måste det vara en ordbok med ordböcker i följande form:

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

PRODUCT_ID: ClassVar[int | list[int]] = 0¶: Ett heltal eller en lista med heltal

BCD = None¶: BCD kan vara antingen None att inte skilja mellan enheter baserade på BCD, eller det kan vara en lista med BCD-numren för alla enheter som stöds av denna drivrutin.

THUMBNAIL_HEIGHT = 68¶: Höjd för omslagsminiatyrbilder på enheten

THUMBNAIL_COMPRESSION_QUALITY = 75¶: Komprimeringskvalitet för miniatyrbilder. Ställ in detta till närmare 100 för att få bättre kvalitet på miniatyrbilder med färre komprimeringsartefakter. Naturligtvis, miniatyrbilden blir större också.

WANTS_UPDATED_THUMBNAILS = False¶: Ange True om enheten stöder uppdatering av omslagsminiatyrer under sync_booklists. När värdet är True uppmanas device.py att uppdatera omslagsminiatyrerna när böcker matchas.

CAN_SET_METADATA = ['title', 'authors', 'collections']¶: Huruvida metadata om böckerna kan ställas in via GUI.

CAN_DO_DEVICE_DB_PLUGBOARD = False¶: Hurvida enheten kan hantera device_db-metadatapluggbrädor

path_sep = '/'¶: Sökvägsavskiljare för sökvägar till böcker på enheten

icon = 'reader.png'¶: Ikon för denna enhet

class UserAnnotation(type, value)¶

Baser: tuple

type¶: Alias för fält nummer 0

value¶: Alias för fält nummer 1

OPEN_FEEDBACK_MESSAGE = None¶: Det grafiska användargränssnittet visar detta som ett meddelande om inte None i statusfältet. Användbart om öppning kan ta lång tid

VIRTUAL_BOOK_EXTENSIONS = frozenset({})¶: En uppsättning filändelser som representerar ”virtuella böcker” på enheten och därför inte kan visas, sparas eller läggas till i biblioteket. Exempel: frozenset(['kobo'])

VIRTUAL_BOOK_EXTENSION_MESSAGE = None¶: Meddelande att visa för användare av virtuella boktillägg.

NUKE_COMMENTS = None¶: Om kommentarer ska tas bort ur den kopia av boken som skickas till enheten. Om värdet inte är None ska det vara en kort sträng som ersätter kommentarerna.

MANAGES_DEVICE_PRESENCE = False¶: Om True indikerar att den här drivrutinen helt hanterar enhetsupptäckt, utmatning och så vidare. Om du ställer in detta till True, måste du implementera detect_managed_devices och debug_managed_device_detection metoder. En drivrutin med denna inställning som True är ansvarig för att upptäckt av enheter, hantering av en svartlista över enheter, en lista över utmatade enheter och så vidare. calibre kommer med jämna mellanrum att anropa metoden detect_managed_devices() och om det returnerar en upptäckt enhet kommer calibre att anropa open(). open() kommer att anropas varje gång en enhet returneras även om tidigare anrop till open() misslyckades, därför måste drivrutinen bibehålla sin egen svartlista över misslyckade enheter. Likaså vid utmatning, kommer calibre att anropa eject() och sedan anta att nästa anrop till detect_managed_devices() returnerar None, anropar den post_yank_cleanup().

SLOW_DRIVEINFO = False¶: Om värder är True, kommer calibre att anropa get_driveinfo() metoden efter att boklistor har lästs för att få ”driveinfo”.

ASK_TO_ALLOW_CONNECT = False¶: Om värdet är True frågar calibre användaren första gången enheten upptäcks om enheten ska hanteras med calibre. Om du anger True måste du implementera get_device_uid(), ignore_connected_device(), get_user_blacklisted_devices() och set_user_blacklisted_devices().

user_feedback_after_callback = None¶: Ange detta som en ordbok av formen {’title’:title, ’msg’:msg, ’det_msg’:detailed_msg} för att låta calibre visa ett meddelande för användaren efter att vissa återanrop har körts, för närvarande endast upload_books. Var försiktig så att användaren inte får alltför många meddelanden. Variabeln kontrolleras efter varje återanrop, så ange den bara när det verkligen behövs.

classmethod get_open_popup_message()[source]¶: Det grafiska användargränssnittet visar detta som en icke-modal popup. Bör vara en instans av OpenPopupMessage

classmethod model_metadata() → tuple[ModelMetadata, ...][source]¶: Metadata om alla faktiska enhetsmodeller som denna drivrutin stöder

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

Returnera True, device_info om en enhet som hanteras av denna insticksmodul är ansluten.

Parametrar:: devices_on_system – Lista med för närvarande anslutna enheter

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

Anropas bara om MANAGES_DEVICE_PRESENCE är True.

Skanna efter enheter som drivrutinen kan hantera. Om en enhet hittas ska ett enhetsobjekt returneras. Objektet skickas till metoden open() som connected_device. Returnera None om ingen enhet hittas. Det returnerade objektet kan vara vad som helst; calibre använder det inte utan skickar det endast vidare till open().

Denna metod anropas periodiskt av användargränssnittet, så se till att den inte är för resurskrävande. Använd en cache för att undvika att upprepade gånger skanna systemet.

Parametrar:

devices_on_system – Uppsättning av USB-enheter hittade på systemet.
force_refresh – Om True och drivrutinen använder en cache för att förhindra upprepad skanning måste cachen tömmas.

debug_managed_device_detection(devices_on_system, output)[source]¶

Anropas bara om MANAGES_DEVICE_PRESENCE är True.

Skriv information om de enheter som identifierats i systemet till output, som är ett filliknande objekt.

Ska returnera True om en enhet upptäcktes och öppnades, annars False.

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

Parametrar:

key – Nyckeln för att låsa upp enheten
log_packets – Om True paketströmmen till/från enheten loggas
report_progress – Funktion som anropas med framsteg i procent (tal mellan 0 och 100) för olika uppgifter. Om den anropas med -1 betyder det att uppgiften inte har någon förloppsinformation
detected_device – Enhetsinformation från enhetsskannaren

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

Valfri metod för ytterligare kontroller av om drivrutinen kan hantera enheten. Om den inte kan det ska False returneras. Metoden anropas först efter att leverantörs-ID, produkt-ID och bcd har matchats, så den kan utföra relativt tidskrävande kontroller. Standardimplementeringen returnerar True. Metoden anropas endast i Windows. Se även can_handle().

Observera att för enheter baserade på USBMS denna metod delegerar som standard till can_handle(). Så du behöver bara åsidosätta can_handle() i din underklass av USBMS.

Parametrar:: usbdevice – En USB-enhet som returneras av calibre.devices.winusb.scan_usb_devices()

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

Unix-version av can_handle_windows().

Parametrar:: device_info – Är en tupel av (VID, pid, BCD, tillverkare, produkt, serienummer)

open(connected_device, library_uuid)[source]¶

Utför specifik initiering på alla enheter. Anropas efter att enheten har upptäckts men innan några andra funktioner kommunicerar med enheten. Till exempel: För enheter som presenterar sig som USB-masslagringsenheter, skulle denna metod vara ansvarig för montering av enheten eller om enheten har en automatisk montering, för att ta reda på var det har monterats. Metoden calibre.devices.usbms.device.Device.open() har en implementering av denna funktion som bör tjäna som ett gott exempel för USB-masslagringsenheter.

Denna metod kan indikera ett OpenFeedback-undantag för att visa ett meddelande till användaren.

Parametrar:

connected_device – Enheten som ska öppnas. Den anges som en tupel med (leverantörs-id, produkt-id, bcd, tillverkarnamn, produktnamn, enhetens serienummer). Vissa enheter saknar serienummer, och i Windows finns endast de tre första fälten; övriga är None.
library_uuid – UUID:et för det aktuella calibre-biblioteket. Kan vara None om det inte finns något bibliotek (till exempel när det används från kommandoraden).

eject()[source]¶

Avmontera/mata ut enheten från OS. Detta innebär inte kontroll om det finns väntande jobb som behöver kommuniceras med enheten.

OBS: Att denna metod inte kan anropas på samma tråd som resten av enhetsmetoderna.

post_yank_cleanup()[source]¶: Anropas om användaren rycker enheten utan att mata ut det först.

set_progress_reporter(report_progress)[source]¶

Ändra en funktion för att rapportera förloppsinformationen.

Parametrar:: report_progress – Funktion som anropas med framsteg i procent (tal mellan 0 och 100) för olika uppgifter. Om den anropas med -1 betyder det att uppgiften inte har någon förloppsinformation

get_device_information(end_session=True)[source]¶

Fråga enheten efter enhetsinformation . Se L{DeviceInfoQuery}.

Returer:: (enhetsnamn, enhetsversion, mjukvaruversion på enheten, MIME-typ) Tupeln kan valfritt ha ett femte element, som är en enhetsinformationsordbok. Se usbms.driver för ett exempel.

get_driveinfo()[source]¶: Returnera driveinfo-ordboken. Funktionen anropas vanligtvis från get_device_information(). Om det går långsamt att läsa in enhetsinformationen för drivrutinen bör den ange SLOW_DRIVEINFO. Då anropar calibre metoden efter att boklistorna har lästs in. Observera att den inte anropas från enhetstråden. Drivrutinen bör därför cachelagra enhetsinformationen i metoden books(), och den här funktionen ska returnera de cachelagrade uppgifterna.

card_prefix(end_session=True)[source]¶: Returnera en lista med två element som innehåller prefixen för sökvägarna på korten. Om ett kort inte finns anges None som kortets prefix. Exempel: (’/place’, ’/place2’) (None, ’place2’) (’place’, None) (None, None)

total_space(end_session=True)[source]¶

Få total utrymme på monteringspunkter:

Huvudminne
Minneskort A
Minneskort B

Returer:: En 3-elementlista med totalt utrymme i oktetter av (1, 2, 3). Om en viss enhet inte har någon av dessa platser den ska visa 0.

free_space(end_session=True)[source]¶

Få ledigt utrymme på monteringspunkter:

Huvudminne
Kort A
Kort B

Returer:: En 3-elementlista med fritt utrymme i oktetter av (1, 2, 3). Om en viss enhet inte har någon av dessa platser den ska returnera -1.

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

Returnera en lista med e-böcker på enheten.

Parametrar:: oncard – Om ”carda” eller ”cardb” returnerar en lista med e-böcker på det specifika minneskortet, annars returneras en lista med e-böcker i huvudminnet av enheten. Om ett kort är specificerad och inga böcker finns på kortet returneras en tomma listan.
Returer:: En BookList.

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

Överför en lista med böcker till enheten. Om en fil redan finns på enheten, ska den ersättas. Denna metod bör signalera ett FreeSpaceError om det inte finns tillräckligt med ledigt utrymme på enheten. Texten till FreeSpaceError måste innehålla ordet ”kort” om on_card inte None annars måste innehålla ordet ”minne”.

Parametrar:

files – En lista med sökvägar
names – En lista med filnamn som böckerna skulle ha när väl överförda till enheten. len(names) == len(files)
metadata – Om värdet inte är None är det en lista med Metadata-objekt. Metadata används för att avgöra var boken ska placeras på enheten. len(metadata) == len(files). Förutom det vanliga omslaget kan ett thumbnail-attribut finnas och bör då användas i första hand. Attributet har formen (width, height, cover_data as jpeg).

Returer:

En lista med 3-elements tupler. Listan är tänkt att skickas till add_books_to_metadata().

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

Lägg till platser i boklistorna. Denna funktion får inte kommunicera med enheten.

Parametrar:

locations – Resultat av ett anrop till L{upload_books}
metadata – Lista med Metadata-objekt, samma som för upload_books().
booklists – En tupel innehåller resultatet av anrop till (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=’cardb’)`).

delete_books(paths, end_session=True)[source]¶: Ta bort böcker i sökvägar på enhet.

classmethod remove_books_from_metadata(paths, booklists)[source]¶

Ta böcker från metadatalistan. Denna funktion får inte kommunicera med enheten.

Parametrar:

paths – sökvägar till böcker på enheten.
booklists – En tupel innehåller resultatet av anrop till (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=’cardb’)`).

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

Uppdatera metadata på enheten.

Parametrar:: booklists – En tupel innehåller resultatet av anrop till (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=’cardb’)`).

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

Läs filen på path på enheten och skriva den till utmatningsfilen.

Parametrar:: outfile – filobjekt som sys.stdout eller resultatet av ett open() anrop.

config_widget()[source]¶: Bör returnera en QWidget-gränssnittskomponent. QWidget-gränssnittskomponent innehåller inställningarna för enhetens gränssnitt

save_settings(config_widget)[source]¶: Ska spara inställningarna på disken. Tar gränssnittskomponenten skapad i config_widget() och sparar alla inställningar på disken.

classmethod settings()[source]¶: Ska returnera ett opts objekt. Den opts-objektet bör ha minst ett attribut format_map vilket är en ordnad lista med format för enheten.

set_plugboards(plugboards, pb_func)[source]¶

tillhandahåll drivrutinen den aktuella uppsättningen av pluggbrädor och en funktion för att välja pluggbräda. Denna metod anropas omedelbart före add_books och sync_booklists.

pb_func är anropbar med följande signatur:: def pb_func(device_name, format, pluggbrädor)

Du ger den det aktuella enhetsnamnet (antingen klassnamnet eller DEVICE_PLUGBOARD_NAME), formatet du är intresserad av (ett ”riktigt” format eller ”device_db”) och de pluggbrädor (du fick dem av set_plugboards, på samma plats som du fick den här metoden).

Returer:: None eller en enskild pluggbrädsinstans.

set_driveinfo_name(location_code, name)[source]¶

Ange enhetens namn i driveinfo-filen till ”namn”. Inställningen kvarstår tills filen återskapas eller namnet ändras igen.

Icke-diskenheter bör genomföra denna metod baserad på platskoder som returneras av get_device_information() metoden.

prepare_addable_books(paths)[source]¶

Tar en lista med sökvägar och returnerar en annan lista med sökvägar. Dessa pekar på versioner av böckerna som kan läggas till.

Om ett fel uppstår när en bok förbereds ska motsvarande position i den returnerade listan, i stället för en sökväg, innehålla en tupel med tre värden: (original_path, undantagsinstansen, traceback)

startup()[source]¶: Anropas när calibre starar enheten. Gör godtycklig initiering som krävs. Observera att flera instanser av klassen kan instansieras, och därför kan __init__ anropas flera gånger, men bara en instans kommer att anropa denna metod. Denna metod anropas på enhetens processtråd, inte på tråden för det grafiska gränssnittet.

shutdown()[source]¶: Anropas när calibre stängs, antingen för gott eller under förberedelser för omstart. Gör den sanering som krävs. Denna metod anropas på enhetens processtråd, inte tråden för det grafiska gränssnittet.

get_device_uid()[source]¶: Måste returnera ett unikt id för den för närvarande anslutna enheten (detta anropas omedelbart efter ett lyckat anrop till open()). Du måste implementera den här metoden om du ställer in ASK_TO_ALLOW_CONNECT = True

ignore_connected_device(uid)[source]¶: Metoden ska göra så att enheten som identifieras av uid (resultatet av ett anrop till get_device_uid()) ignoreras i fortsättningen. Du måste implementera metoden om du anger ASK_TO_ALLOW_CONNECT = True. Observera att funktionen anropas omedelbart efter open(). Om open() cachelagrar ett tillstånd bör drivrutinen därför återställa det.

get_user_blacklisted_devices()[source]¶: Returnera karta över enhet uid till kortnamn för alla enheter som användaren har begärt att få ignorerade.

set_user_blacklisted_devices(devices)[source]¶: Ställ in listan med enheters uid:er som ska ignoreras av denna drivrutin.

specialize_global_preferences(device_prefs)[source]¶: Implementera denna metod om din enhet vill åsidosätta en viss preferens. Du måste se till att alla anrops platser som vill ha en inställning som kan åsidosättas använder device_prefs [’något’] i stället för prefs[’något’]. Din metod ska anropa device_prefs.set_overrides(pref = val, pref = val, …). För närvarande används för: metadata management (prefs[’manage_device_metadata’])

set_library_info(library_name, library_uuid, field_metadata)[source]¶: Implementera den här metoden om du vill ha information om det aktuella calibre-biblioteket. Denna metod anropas vid start och när calibre-biblioteket ändras medan det är anslutet.

is_dynamically_controllable()[source]¶

Anropas av enhetshanteraren vid start av insticksmodul. Om den här metoden returnerar en sträng, då a) den stödjer enhetshanteraren dynamiska kontroll gränssnitt, och b) det namnet ska användas när man talar med insticksmodulen.