플러그인용 API 문서¶

강력한 플러그인을 만들기 위해 하위 클래스로 만들 수 있는 여러 추상 기본 클래스를 정의합니다. 유용한 클래스는 다음과 같습니다:

Plugin ¶

class calibre.customize.Plugin(plugin_path)[소스]¶

calibre 플러그인입니다. 유용한 멤버는 다음과 같습니다:

self.installation_type: 플러그인이 설치된 방식을 저장합니다.

self.plugin_path: 이 플러그인을 포함하는 ZIP 파일의 경로를
저장하며, 내장 플러그인인 경우에는 None입니다.

self.site_customization: 사용자가 입력한 사용자 지정 문자열을
저장합니다.

하위 클래스에서 재정의해야 하는 메서드:

initialize()

customization_help()

유용한 메서드:

임시_파일()

__enter__()

load_resources()

supported_platforms = []¶: 이 플러그인이 동작하는 플랫폼 목록입니다. 예: ['windows', 'osx', 'linux']

name = 'Trivial Plugin'¶: 이 플러그인의 이름입니다. 작동하게 하려면 Trivial Plugin 이외의 값으로 설정해야 합니다.

version = (1, 0, 0)¶: 이 플러그인의 버전입니다. 3-튜플(메이저, 마이너, 리비전) 형식입니다.

description = '아무것도 반응하지 않음'¶: 이 플러그인이 하는 일을 설명하는 짧은 문자열입니다.

author = '알 수 없음'¶: 이 플러그인의 작성자입니다.

priority = 1¶: 하나의 파일 형식에 대해 둘 이상의 플러그인이 존재하면, 우선순위가 높은 것부터 순서대로 실행됩니다. 우선순위가 높은 플러그인이 먼저 실행됩니다. 가능한 가장 높은 우선순위는 sys.maxsize 입니다. 기본 우선순위는 1입니다.

minimum_calibre_version = (0, 4, 118)¶: 이 플러그인이 필요로 하는 calibre의 최소 버전입니다.

installation_type = None¶: 이 플러그인이 설치된 방식입니다.

can_be_disabled = True¶: False이면 사용자가 이 플러그인을 비활성화할 수 없습니다. 신중하게 사용하십시오.

type = '기초'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

initialize()[소스]¶

calibre 플러그인이 초기화될 때 한 번 호출됩니다. 새 플러그인이 추가될 때마다 플러그인은 다시 초기화됩니다. 또한 책 추가와 같은 작업자 프로세스에서 플러그인이 실행되는 경우, 새로운 작업자 프로세스마다 플러그인이 초기화된다는 점에 유의하십시오.

여기에서 플러그인별 초기화를 수행하십시오. 예를 들어 플러그인 ZIP 파일에서 리소스를 추출할 수 있습니다. ZIP 파일의 경로는 self.plugin_path 에서 사용할 수 있습니다.

이 시점에는 self.site_customization 을 사용할 수 없습니다.

config_widget()[소스]¶

단순한 문자열 기반 기본 사용자 지정에 의존하는 대신, 사용자 지정 설정 대화상자를 사용하려면 플러그인에서 이 메서드와 save_settings() 를 구현하십시오.

이 메서드를 구현하는 경우 QWidget를 반환해야 합니다. 위젯에는 인수를 받지 않는 선택적 validate() 메서드가 있을 수 있으며, 사용자가 확인을 클릭한 직후 호출됩니다. 메서드가 True를 반환하는 경우에만 변경 사항이 적용됩니다.

어떤 이유로 지금 이 시점에 설정을 수행할 수 없다면 두 개의 문자열로 이루어진 튜플 (message, details)을 반환하십시오. 이 값은 사용자에게 경고 대화상자로 표시되며, 작업은 중단됩니다.

save_settings(config_widget)[소스]¶

config_widget로 사용자가 지정한 설정을 저장합니다.

매개변수:: config_widget – config_widget() 가 반환한 위젯입니다.

do_user_config(parent=None)[소스]¶: 이 메서드는 이 플러그인의 설정 대화상자를 표시합니다. 사용자가 확인을 클릭하면 True, 그렇지 않으면 False를 반환합니다. 변경 사항은 자동으로 적용됩니다.

load_resources(names)[소스]¶

이 플러그인이 ZIP 파일(사용자 추가 플러그인)로 제공되는 경우, 이 메서드를 사용해 ZIP 파일에서 리소스를 불러올 수 있습니다.

예를 들어 이미지를 불러오려면:

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

매개변수:: names – / 를 구분자로 사용한 ZIP 파일 내부 리소스 경로 목록
반환:: {name: file_contents} 형태의 사전입니다. ZIP 파일에서 찾지 못한 이름은 사전에 포함되지 않습니다.

customization_help(gui=False)[소스]¶

이 플러그인을 사용자 지정하는 방법에 대한 도움말 문자열을 반환합니다. 기본적으로는 NotImplementedError 를 발생시키며, 이는 플러그인에 사용자 지정이 필요 없음을 의미합니다.

하위 클래스에서 이 메서드를 재구현하면, 사용자는 이 플러그인의 사용자 지정을 위한 문자열을 입력하라는 요청을 받습니다. 사용자 지정 문자열은 self.site_customization 에서 사용할 수 있습니다.

사이트 사용자 지정은 무엇이든 될 수 있습니다. 예를 들어 사용자의 컴퓨터에 있는 필요한 바이너리의 경로일 수 있습니다.

매개변수:: gui – True이면 HTML 도움말을 반환하고, 그렇지 않으면 일반 텍스트 도움말을 반환합니다.

temporary_file(suffix)[소스]¶

파일 시스템상의 임시 파일인 파일 유사 객체를 반환합니다. 이 파일은 닫은 뒤에도 계속 사용 가능하며, 인터프리터가 종료될 때만 제거됩니다. 생성된 임시 파일의 전체 경로에 접근하려면 반환된 객체의 name 멤버를 사용하십시오.

매개변수:: suffix – 임시 파일에 붙을 접미사입니다.

cli_main(args)[소스]¶: 이 메서드는 플러그인 명령줄 인터페이스의 기본 진입점입니다. 사용자가 calibre-debug -r “Plugin Name” 을 실행할 때 호출됩니다. 전달된 모든 인수는 args 변수에 들어 있습니다.

FileTypePlugin ¶

class calibre.customize.FileTypePlugin(plugin_path)[소스]¶

기반 클래스: Plugin

특정 파일 형식 집합과 연관된 플러그인입니다.

file_types = {}¶: 이 플러그인을 실행해야 하는 파일 형식 집합입니다. 모든 파일 형식에 대해 실행하려면 ‘*’를 사용하십시오. 예: {'lit', 'mobi', 'prc'}

on_import = False¶: True이면 책이 데이터베이스에 추가될 때 이 플러그인이 실행됩니다.

on_postimport = False¶: True이면 책이 데이터베이스에 추가된 뒤 이 플러그인이 실행됩니다. 이 경우 플러그인의 postimport 및 postadd 메서드가 호출됩니다.

on_postconvert = False¶: True이면 책이 변환된 뒤 이 플러그인이 실행됩니다. 이 경우 플러그인의 postconvert 메서드가 호출됩니다.

on_postdelete = False¶: True이면 데이터베이스에서 책 파일이 삭제된 뒤 이 플러그인이 실행됩니다. 이 경우 플러그인의 postdelete 메서드가 호출됩니다.

on_preprocess = False¶: True이면 변환 직전에 이 플러그인이 실행됩니다.

on_postprocess = False¶: True이면 변환 출력 플러그인이 생성한 최종 파일에 대해 변환 후 이 플러그인이 실행됩니다.

type = '파일 유형'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

run(path_to_ebook)[소스]¶

플러그인을 실행합니다. 하위 클래스에서 구현해야 합니다. 전자책에 필요한 수정 작업을 수행한 뒤 수정된 전자책의 절대 경로를 반환해야 합니다. 수정이 필요 없다면 원본 전자책의 경로를 반환해야 합니다. 오류가 발생하면 Exception을 일으켜야 합니다. 기본 구현은 원본 전자책의 경로를 그대로 반환합니다. 파일 형식 플러그인이 실행되기 전 원본 파일의 경로는 self.original_path_to_file 에서 사용할 수 있습니다.

수정된 전자책 파일은 temporary_file() 메서드로 만들어야 합니다.

매개변수:: path_to_ebook – 전자책의 절대 경로입니다.
반환:: 수정된 전자책의 절대 경로입니다.

postimport(book_id, book_format, db)[소스]¶

가져오기 후, 즉 책 파일이 데이터베이스에 추가된 뒤 호출됩니다. 이는 책 레코드가 처음 생성될 때 호출되는 postadd() 와는 다릅니다. 이 메서드는 책 레코드에 새 파일이 추가될 때마다 호출됩니다. 새로 추가된 파일의 내용을 바탕으로 책 레코드를 수정하는 데 유용합니다.

매개변수:

book_id – 추가된 책의 데이터베이스 id입니다.
book_format – 추가된 책의 파일 형식입니다.
db – 라이브러리 데이터베이스입니다.

postconvert(book_id, book_format, db)[소스]¶

변환 후, 즉 변환 결과 책 파일이 데이터베이스에 추가된 뒤 호출됩니다. 책 추가 후가 아니라 변환 후에만 실행됩니다. 새로 추가된 파일의 내용을 바탕으로 책 레코드를 수정하는 데 유용합니다.

매개변수:

book_id – 추가된 책의 데이터베이스 id입니다.
book_format – 추가된 책의 파일 형식입니다.
db – 라이브러리 데이터베이스입니다.

postdelete(book_id, book_format, db)[소스]¶

삭제 후, 즉 책 파일이 데이터베이스에서 삭제된 뒤 호출됩니다. 책 레코드가 삭제될 때는 실행되지 않고, 책에서 하나 이상의 형식이 삭제될 때만 실행됩니다. 삭제된 파일 형식을 바탕으로 책 레코드를 수정하는 데 유용합니다.

매개변수:

book_id – 추가된 책의 데이터베이스 id입니다.
book_format – 추가된 책의 파일 형식입니다.
db – 라이브러리 데이터베이스입니다.

postadd(book_id, fmt_map, db)[소스]¶

추가 후, 즉 책이 DB에 추가된 뒤 호출됩니다. 이는 단일 책 파일이 책에 추가된 뒤 호출되는 postimport() 와는 다릅니다. postadd() 는 하나 이상의 책 파일을 포함할 수 있는 전체 책 레코드가 처음 생성될 때만 호출됩니다. 책이 calibre에 처음 추가될 때 데이터베이스의 책 레코드를 수정하고 싶다면 유용합니다.

매개변수:

book_id – 추가된 책의 데이터베이스 id입니다.
fmt_map – 파일 형식에서 추가된 경로로의 매핑입니다. 경우에 따라 파일이 스트림으로 추가되기도 하므로, 실제로 존재하는 파일을 가리킬 수도 있고 아닐 수도 있습니다. 이 경우 더미 값이나 존재하지 않는 경로일 수 있습니다.
db – 라이브러리 데이터베이스

메타데이터 플러그인 ¶

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

기반 클래스: Plugin

여러 파일 형식에서 메타데이터를 읽는 기능을 구현하는 플러그인입니다.

file_types = {}¶: 이 플러그인을 실행해야 하는 파일 형식 집합입니다. 예: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: 이 플러그인이 동작하는 플랫폼 목록입니다. 예: ['windows', 'osx', 'linux']

version = (9, 7, 0)¶: 이 플러그인의 버전입니다. 3-튜플(메이저, 마이너, 리비전) 형식입니다.

author = 'Kovid Goyal'¶: 이 플러그인의 작성자입니다.

type = '메타데이터 읽기도구'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

get_metadata(stream, type)[소스]¶

stream(읽기를 지원하는 파일 유사 객체)으로 표현된 파일의 메타데이터를 반환합니다. 입력 데이터에 오류가 있으면 예외를 발생시킵니다.

매개변수:: type – 파일 형식입니다. file_types 의 항목 가운데 하나임이 보장됩니다.
반환:: calibre.ebooks.metadata.book.Metadata 객체입니다.

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

기반 클래스: Plugin

여러 파일 형식에서 메타데이터를 읽는 기능을 구현하는 플러그인입니다.

file_types = {}¶: 이 플러그인을 실행해야 하는 파일 형식 집합입니다. 예: set(['lit', 'mobi', 'prc'])

supported_platforms = ['windows', 'osx', 'linux']¶: 이 플러그인이 동작하는 플랫폼 목록입니다. 예: ['windows', 'osx', 'linux']

version = (9, 7, 0)¶: 이 플러그인의 버전입니다. 3-튜플(메이저, 마이너, 리비전) 형식입니다.

author = 'Kovid Goyal'¶: 이 플러그인의 작성자입니다.

type = '메타데이터 쓰기도구'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

set_metadata(stream, mi, type)[소스]¶

stream(읽기를 지원하는 파일 유사 객체)으로 표현된 파일의 메타데이터를 설정합니다. 입력 데이터에 오류가 있으면 예외를 발생시킵니다.

매개변수:

type – 파일 형식입니다. file_types 의 항목 가운데 하나임이 보장됩니다.
mi – calibre.ebooks.metadata.book.Metadata 객체입니다.

카탈로그 플러그인 ¶

class calibre.customize.CatalogPlugin(plugin_path)[소스]¶

기반 클래스: Plugin

범주 생성도구를 구현하는 플러그인입니다.

file_types = {}¶: 이 플러그인이 실행되어야 하는 출력 파일 형식입니다. 예: ‘epub’ 또는 ‘xml’

type = '범주 생성도구'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

cli_options = []¶

이 플러그인 전용 CLI 파서 옵션으로, 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 는 calibre.db.cli.cmd_catalog:option_parser() 에서 파싱됩니다.

initialize()[소스]¶: 플러그인이 내장 플러그인이 아니라면, 플러그인의 .ui 및 .py 파일을 ZIP 파일에서 $TMPDIR로 복사합니다. 탭은 동적으로 생성되어 calibre.gui2.dialogs.catalog.py:Catalog 의 카탈로그 옵션 대화상자에 추가됩니다.

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

플러그인을 실행합니다. 하위 클래스에서 구현해야 합니다. file_types 에 지정된 형식으로 카탈로그를 생성하고, 생성된 카탈로그 파일의 절대 경로를 반환해야 합니다. 오류가 발생하면 Exception을 일으켜야 합니다.

생성된 카탈로그 파일은 temporary_file() 메서드로 만들어야 합니다.

매개변수:

path_to_output – 생성된 카탈로그 파일의 절대 경로입니다.
opts – 키워드 인수 사전입니다.
db – LibraryDatabase2 객체입니다.

메타데이터 다운로드 플러그인 ¶

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

기반 클래스: Plugin

type = '메타데이터 출처'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

author = 'Kovid Goyal'¶: 이 플러그인의 작성자입니다.

supported_platforms = ['windows', 'osx', 'linux']¶: 이 플러그인이 동작하는 플랫폼 목록입니다. 예: ['windows', 'osx', 'linux']

capabilities = frozenset({})¶: 이 플러그인이 지원하는 기능 집합입니다. 유용한 기능에는 ‘identify’, ‘cover’ 가 있습니다.

touched_fields = frozenset({})¶: 식별 단계 동안 이 플러그인이 잠재적으로 내려받을 수 있는 메타데이터 필드 목록입니다.

has_html_comments = False¶: 플러그인이 HTML 형식의 설명을 반환한다면 True로 설정하십시오.

supports_gzip_transfer_encoding = False¶: 이를 True로 설정하면 브라우저 객체가 gzip 전송 인코딩을 지원한다고 표시합니다. 이렇게 하면 다운로드가 빨라질 수 있지만, 먼저 소스가 gzip 전송 인코딩을 올바르게 지원하는지 확인하십시오.

ignore_ssl_errors = False¶: 이 소스에 연결할 때 HTTPS 인증서 오류를 무시하려면 True로 설정하십시오.

cached_cover_url_is_reliable = True¶: 캐시된 표지 URL은 때때로 신뢰할 수 없습니다(예: 다운로드가 실패하거나 반환된 이미지가 잘못되었을 수 있음). 이 소스에서 그런 경우가 자주 발생한다면 False로 설정하십시오.

options = ()¶: Option 객체 목록입니다. 이 플러그인의 설정 위젯을 자동으로 구성하는 데 사용됩니다.

config_help_message = None¶: 이 플러그인의 설정 위젯 상단에 표시되는 문자열입니다.

can_get_multiple_covers = False¶: True이면 이 소스는 주어진 질의에 대해 여러 표지를 반환할 수 있습니다.

auto_trim_covers = False¶: True로 설정하면 이 플러그인으로 다운로드한 표지는 자동으로 다듬어집니다.

prefer_results_with_isbn = True¶: True로 설정되어 있고, 이 소스가 어떤 질의에 대해 여러 결과를 반환하는데 일부에는 ISBN이 있고 일부에는 ISBN이 없다면, ISBN이 없는 결과는 무시됩니다.

is_configured()[소스]¶: 플러그인을 사용하기 전에 설정이 필요하다면 False를 반환하십시오. 예를 들어 사용자 이름/비밀번호/API 키가 필요할 수 있습니다.

customization_help()[소스]¶

이 플러그인을 사용자 지정하는 방법에 대한 도움말 문자열을 반환합니다. 기본적으로는 NotImplementedError 를 발생시키며, 이는 플러그인에 사용자 지정이 필요 없음을 의미합니다.

하위 클래스에서 이 메서드를 재구현하면, 사용자는 이 플러그인의 사용자 지정을 위한 문자열을 입력하라는 요청을 받습니다. 사용자 지정 문자열은 self.site_customization 에서 사용할 수 있습니다.

사이트 사용자 지정은 무엇이든 될 수 있습니다. 예를 들어 사용자의 컴퓨터에 있는 필요한 바이너리의 경로일 수 있습니다.

매개변수:: gui – True이면 HTML 도움말을 반환하고, 그렇지 않으면 일반 텍스트 도움말을 반환합니다.

config_widget()[소스]¶

단순한 문자열 기반 기본 사용자 지정에 의존하는 대신, 사용자 지정 설정 대화상자를 사용하려면 플러그인에서 이 메서드와 save_settings() 를 구현하십시오.

이 메서드를 구현하는 경우 QWidget를 반환해야 합니다. 위젯에는 인수를 받지 않는 선택적 validate() 메서드가 있을 수 있으며, 사용자가 확인을 클릭한 직후 호출됩니다. 메서드가 True를 반환하는 경우에만 변경 사항이 적용됩니다.

어떤 이유로 지금 이 시점에 설정을 수행할 수 없다면 두 개의 문자열로 이루어진 튜플 (message, details)을 반환하십시오. 이 값은 사용자에게 경고 대화상자로 표시되며, 작업은 중단됩니다.

save_settings(config_widget)[소스]¶

config_widget로 사용자가 지정한 설정을 저장합니다.

매개변수:: config_widget – config_widget() 가 반환한 위젯입니다.

get_author_tokens(authors, only_first_author=True)[소스]¶: 저자 목록을 가져오고 AND 검색어에 유용한 토큰 목록을 반환합니다. 이 함수는 쉼표가 저자 이름에 있으면 이름이 성에 있고 다른 이름 형식이라고 가정하여 이름 중간 이름 성 순서로 토큰을 반환하려고 합니다.

get_title_tokens(title, strip_joiners=True, strip_subtitle=False)[소스]¶: 제목을 가져와 AND 검색어에 유용한 토큰 목록을 반환합니다. 접속사(선택 사항) 및 구두점은 제외됩니다.

split_jobs(jobs, num)[소스]¶: 작업 목록을 가능한 한 고르게, 최대 num 개의 그룹으로 나눕니다.

test_fields(mi)[소스]¶: mi 객체에서 null 인 self.touched_fields 의 첫 번째 필드를 반환합니다.

clean_downloaded_metadata(mi)[소스]¶: Metadata 객체를 result_queue 에 넣기 전에 메타데이터를 정규화하려면 플러그인의 identify 메서드에서 이 메서드를 호출하십시오. 물론 메타데이터 소스에 맞는 사용자 정의 알고리즘을 사용해도 됩니다.

get_book_url(identifiers)[소스]¶: 3-튜플 또는 None을 반환합니다. 3-튜플의 형식은 (identifier_type, identifier_value, URL) 입니다. URL은 이 소스에서 identifiers 로 식별된 책의 URL입니다. identifier_type 과 identifier_value 는 URL에 해당하는 식별자를 지정합니다. 이 URL은 사람이 브라우저로 열어볼 수 있어야 합니다. 사용자가 이 소스의 책 페이지를 쉽게 방문할 수 있는 클릭 가능한 링크를 제공하기 위한 것입니다. URL을 찾지 못하면 None을 반환하십시오. 이 메서드는 빠르고 일관되어야 하므로, 식별자로부터 알려진 규칙에 따라 URL을 구성할 수 있을 때만 구현하십시오.

get_book_url_name(idtype, idval, url)[소스]¶: get_book_url() 의 반환값에서 사람이 읽기 쉬운 이름을 반환합니다.

get_book_urls(identifiers)[소스]¶: 이 책에 대해 여러 URL을 반환하고 싶다면 이 메서드를 재정의하십시오. 3-튜플 목록을 반환하십시오. 기본적으로 이 메서드는 단순히 get_book_url() 을 호출합니다.

get_cached_cover_url(identifiers)[소스]¶

identifiers 사전으로 식별된 책의 캐시된 표지 URL을 반환합니다. 해당 URL이 없으면 None을 반환합니다.

이 메서드는 검증된 URL만 반환해야 한다는 점에 유의하십시오. 즉 일반 표지 이미지나 not found 오류를 일으킬 수 있는 URL은 반환해서는 안 됩니다.

id_from_url(url)[소스]¶: URL을 해석하여 (identifier_type, identifier_value) 형식의 튜플을 반환합니다. URL이 메타데이터 소스의 패턴과 맞지 않으면 None을 반환합니다.

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

검색 쿼리(제목, 저자, 식별자)에 따라 메타데이터 객체를 관련성에 따라 정렬할 수 있는 키를 생성하는 데 사용되는 함수를 반환합니다.

이 키들은 identify() 호출 결과를 정렬하는 데 사용됩니다.

기본 알고리즘에 대한 자세한 내용은 InternalMetadataCompareKeyGen 을 참조하십시오. 기본 알고리즘이 적합하지 않다면 플러그인에서 이 함수를 재구현하십시오.

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

제목/저자/ISBN 등을 사용해 책을 식별합니다.

식별자(identifier)가 지정되었는데 일치 항목을 찾지 못했고, 이 메타데이터 소스가 관련 식별자를 모두 저장하지 않는 경우(예: 책의 모든 ISBN), 제목과 저자만으로 다시 시도해야 합니다(둘이 지정되어 있다면).

이 메타데이터 소스가 표지도 제공한다면, 동일한 ISBN/특수 식별자로 get covers API 를 다시 호출할 때 표지 URL을 다시 가져올 필요가 없도록 표지 URL을 캐시에 저장해야 합니다. 이를 위해 캐시 API 를 사용하십시오.

이 메서드가 result_queue 에 넣는 모든 Metadata 객체에는 source_relevance 속성이 있어야 하며, 이는 이 질의에 대해 메타데이터 소스가 결과를 반환한 순서를 나타내는 정수입니다. 이 정수는 compare_identify_results() 에서 사용됩니다. 순서가 중요하지 않다면 모든 결과에 대해 0으로 설정하십시오.

Metadata 객체를 result_queue 에 넣기 전에 표지/ISBN 매핑 정보가 모두 캐시되었는지 확인하십시오.

매개변수:

log – 로그 객체입니다. 디버깅 정보/오류를 출력하는 데 사용하십시오.
result_queue – 결과 Queue 입니다. 결과를 여기에 넣어야 합니다. 각 결과는 Metadata 객체입니다.
abort – abort.is_set() 가 True를 반환하면 추가 처리를 중단하고 가능한 한 빨리 반환하십시오.
title – 책 제목이며, None일 수 있습니다.
authors – 책 저자 목록이며, None일 수 있습니다.
identifiers – 기타 식별자 사전으로, 가장 흔한 예는 {‘isbn’:’1234…’} 입니다.
timeout – 초 단위 시간 제한입니다. 어떤 네트워크 요청도 timeout 보다 오래 멈춰 있어서는 안 됩니다.

반환:

오류가 없으면 None, 그렇지 않으면 사용자에게 표시하기에 적합한 오류의 유니코드 표현입니다.

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

표지를 다운로드하여 result_queue 에 넣습니다. 매개변수의 의미는 모두 identify() 와 같습니다. (self, cover_data) 를 result_queue 에 넣으십시오.

가능하면 효율을 위해 이 메서드는 캐시된 표지 URL을 사용해야 합니다. 캐시 데이터가 없을 때는 대부분의 플러그인이 단순히 identify 를 호출하고 그 결과를 사용합니다.

get_best_cover 매개변수가 True이고 이 플러그인이 여러 표지를 가져올 수 있다면, “가장 좋은” 표지만 가져와야 합니다.

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

주어진 검색어에서 메타데이터 객체의 관련성을 비교하기 위한 정렬 키를 생성합니다. 이것은 다른 소스가 아닌 동일한 메타데이터 소스의 결과를 비교하는 데만 사용됩니다.

정렬 키는 오름차순 정렬이 관련성 내림차순 정렬이 되도록 보장합니다.

알고리즘은 다음과 같습니다:

질의와 동일한 식별자가 하나 이상 있는 결과를 우선합니다.

캐시된 표지 URL이 있는 결과를 우선합니다.

사용 가능한 필드가 모두 채워진 결과를 우선합니다.

현재 사용자 인터페이스 언어와 같은 언어를 가진 결과를 우선합니다.

질의와 제목이 정확히 일치하는 결과를 우선합니다.

설명이 더 긴 결과를 우선합니다(10% 이상 더 긴 경우).

메타데이터 소스의 검색이 보고한 결과의 관련성을 사용합니다.
엔진

변환 플러그인 ¶

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

기반 클래스: Plugin

InputFormatPlugins 는 문서를 HTML+OPF+CSS+기타 형식으로 변환하는 역할을 합니다. 변환 결과는 반드시 UTF-8 로 인코딩되어야 합니다. 주요 동작은 convert() 에서 이루어집니다.

type = '변환 입력'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

supported_platforms = ['windows', 'osx', 'linux']¶: 이 플러그인이 동작하는 플랫폼 목록입니다. 예: ['windows', 'osx', 'linux']

file_types = {}¶: 이 플러그인을 실행해야 하는 파일 형식 집합입니다. 예: set(['azw', 'mobi', 'prc'])

is_image_collection = False¶: True이면 이 입력 플러그인은 HTML 파일마다 하나씩 이미지를 모은 컬렉션을 생성합니다. 입력 파일이 이미지 컬렉션일 수도 있고 아닐 수도 있다면 convert 메서드에서 동적으로 설정할 수 있습니다. 이를 True로 설정했다면 이미지 목록을 반환하는 get_images() 메서드를 구현해야 합니다.

core_usage = 1¶: 이 플러그인이 사용하는 CPU 코어 수입니다. 값이 -1이면 사용 가능한 모든 코어를 사용합니다.

for_viewer = False¶: True로 설정하면 입력 플러그인이 출력 결과를 보기용으로 적합하게 만들기 위해 특별 처리를 수행합니다.

output_encoding = 'utf-8'¶: 이 입력 플러그인이 파일을 생성할 때 사용하는 인코딩입니다. None이면 인코딩이 정의되지 않았으므로 각각 개별적으로 감지해야 합니다.

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: 모든 입력 형식 플러그인이 공유하는 옵션입니다. 하위 클래스에서 재정의하지 마십시오. 대신 options 를 사용하십시오. 모든 옵션은 OptionRecommendation 의 인스턴스여야 합니다.

options = {}¶: 이 플러그인의 동작을 사용자 지정하는 옵션입니다. 모든 옵션은 OptionRecommendation 의 인스턴스여야 합니다.

recommendations = {}¶: (option_name, recommended_value, recommendation_level) 형식의 3-튜플 집합입니다.

get_images()[소스]¶: 이 입력 플러그인이 이미지 컬렉션을 나타내는 경우, 이미지의 절대 경로 목록을 반환합니다. 이미지 목록의 순서는 spine 및 TOC 와 동일합니다.

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

이 메서드는 하위 클래스에서 구현해야 합니다. 생성된 OPF 파일의 경로나 OEBBook 인스턴스를 반환해야 합니다. 모든 출력은 현재 폴더 안에 있어야 합니다. 이 플러그인이 현재 폴더 밖에 파일을 만든다면, 이 메서드가 반환되기 전에 해당 파일을 삭제하거나 삭제 대상으로 표시해야 합니다.

매개변수:

stream – 입력 파일을 담고 있는 파일 유사 객체입니다.
options – 변환 과정을 사용자 지정하는 옵션입니다. 이 플러그인이 선언한 모든 옵션에 대응하는 속성을 가진다는 것이 보장됩니다. 또한 0 이상의 정수 값을 가지는 verbose 속성도 있습니다. 숫자가 클수록 더 자세한 출력을 의미합니다. 또 하나 유용한 속성은 calibre.customize.profiles.InputProfile 의 인스턴스인 input_profile 입니다.
file_ext – 입력 파일의 확장자(. 제외)입니다. 이 플러그인이 지원하는 file_types 중 하나임이 보장됩니다.
log – calibre.utils.logging.Log 객체입니다. 모든 출력은 이 객체를 사용해야 합니다.
accelerators – 입력 플러그인이 쉽게 얻을 수 있어 변환의 다음 단계들을 빠르게 할 수 있는 여러 정보의 사전입니다.

postprocess_book(oeb, opts, log)[소스]¶: 입력 플러그인이 책이 파싱된 뒤 후처리를 수행할 수 있도록 호출됩니다.

specialize(oeb, opts, log, output_fmt)[소스]¶: 특정 출력 형식에 맞게 파싱된 책을 입력 플러그인이 특화할 수 있도록 호출됩니다. postprocess_book 이후, 파싱된 책에 어떤 변환도 수행되기 전에 호출됩니다.

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[소스]¶: calibre GUI 에서 이 플러그인을 설정하는 데 사용할 위젯을 만들기 위해 호출됩니다. 위젯은 PluginWidget 클래스의 인스턴스여야 합니다. 예시는 내장 입력 플러그인을 참조하십시오.

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

기반 클래스: Plugin

OutputFormatPlugins 는 OEB 문서(OPF+HTML)를 출력 전자책으로 변환하는 역할을 합니다.

OEB 문서는 UTF-8 로 인코딩되어 있다고 가정할 수 있습니다. 주요 동작은 convert() 에서 이루어집니다.

type = '변환 출력'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

supported_platforms = ['windows', 'osx', 'linux']¶: 이 플러그인이 동작하는 플랫폼 목록입니다. 예: ['windows', 'osx', 'linux']

file_type = None¶: 이 플러그인이 출력하는 파일 형식(앞에 마침표가 없는 확장자)입니다.

common_options = {<calibre.customize.conversion.OptionRecommendation object>}¶: 모든 입력 형식 플러그인이 공유하는 옵션입니다. 하위 클래스에서 재정의하지 마십시오. 대신 options 를 사용하십시오. 모든 옵션은 OptionRecommendation 의 인스턴스여야 합니다.

options = {}¶: 이 플러그인의 동작을 사용자 지정하는 옵션입니다. 모든 옵션은 OptionRecommendation 의 인스턴스여야 합니다.

recommendations = {}¶: (option_name, recommended_value, recommendation_level) 형식의 3-튜플 집합입니다.

property description¶

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

주어진 객체로부터 새 문자열 객체를 만듭니다. encoding 또는 errors 가 지정된 경우, 객체는 지정한 인코딩과 오류 처리기로 디코드할 수 있는 데이터 버퍼를 제공해야 합니다. 그렇지 않으면 object.__str__() 의 결과(정의되어 있다면) 또는 repr(object) 를 반환합니다. encoding 의 기본값은 ‘utf-8’ 이고, errors 의 기본값은 ‘strict’ 입니다.

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

oeb_book`( :class:`calibre.ebooks.oeb.OEBBook 인스턴스)의 내용을 output 으로 지정한 파일에 렌더링합니다.

매개변수:

output – 파일 유사 객체이거나 문자열입니다. 문자열이면 존재할 수도 있고 아닐 수도 있는 폴더의 경로입니다. 출력 플러그인은 그 폴더에 결과를 써야 합니다. 파일 유사 객체라면 출력 플러그인은 그 파일에 결과를 써야 합니다.
input_plugin – 변환 파이프라인의 시작에서 사용된 입력 플러그인입니다.
opts – 변환 옵션입니다. 이 플러그인의 OptionRecommendations 에 대응하는 속성을 가진다는 것이 보장됩니다.
log – 로거입니다. 디버그/정보 메시지 등을 여기에 출력하십시오.

specialize_options(log, opts, input_fmt)[소스]¶: 변환 파이프라인이 사용하는 변환 옵션 값을 바꾸는 데 사용할 수 있습니다.

specialize_css_for_output(log, opts, item, stylizer)[소스]¶

CSS 평탄화 과정에서 CSS 를 변경하는 데 사용할 수 있습니다.

매개변수:

item – 처리 중인 항목(HTML 파일)
stylizer – item 의 평탄화된 스타일을 담고 있는 Stylizer 객체입니다. stylizer.style(element) 로 임의의 요소에 대한 스타일을 얻을 수 있습니다.

gui_configuration_widget(parent, get_option_by_name, get_option_help, db, book_id=None)[소스]¶: calibre GUI 에서 이 플러그인을 설정하는 데 사용할 위젯을 만들기 위해 호출됩니다. 위젯은 PluginWidget 클래스의 인스턴스여야 합니다. 예시는 내장 출력 플러그인을 참조하십시오.

장치 드라이버 ¶

모든 장치 드라이버의 기본 클래스는 DevicePlugin 입니다. 그러나 장치가 운영 체제에 USBMS 드라이브로 노출된다면, 이러한 종류의 장치를 지원하는 데 필요한 모든 논리를 구현한 USBMS 클래스를 대신 사용해야 합니다.

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

기반 클래스: Plugin

전자책 리더기와 통신하는 백엔드가 구현해야 할 인터페이스를 정의합니다.

type = '장치 인터페이스'¶: 이 플러그인의 유형입니다. GUI에서 플러그인을 분류하는 데 사용됩니다.

FORMATS = ['lrf', 'rtf', 'pdf', 'txt']¶: 지원하는 형식의 정렬된 목록

VENDOR_ID = 0¶

VENDOR_ID 는 정수, 정수 목록 또는 사전이 될 수 있습니다. 사전인 경우에는 다음 형식의 사전들의 사전이어야 합니다:

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

PRODUCT_ID = 0¶: 정수 또는 정수 목록

BCD = None¶: BCD 는 BCD를 기준으로 장치를 구분하지 않으려면 None 일 수 있고, 이 드라이버가 지원하는 모든 장치의 BCD 번호 목록일 수도 있습니다.

THUMBNAIL_HEIGHT = 68¶: 장치의 썸네일 높이

THUMBNAIL_COMPRESSION_QUALITY = 75¶: 썸네일의 압축 품질입니다. 100에 가깝게 설정할수록 압축 아티팩트가 줄어 더 나은 품질의 썸네일을 얻을 수 있습니다. 물론 썸네일 크기도 커집니다.

WANTS_UPDATED_THUMBNAILS = False¶: sync_booklists 중 표지 썸네일 업데이트를 장치가 지원한다면 True로 설정하십시오. True로 설정하면 book matching 중 device.py 가 표지 썸네일을 새로 고치도록 요청합니다.

CAN_SET_METADATA = ['title', 'authors', 'collections']¶: 책의 메타데이터를 GUI를 통해 설정할 수 있는지 여부입니다.

CAN_DO_DEVICE_DB_PLUGBOARD = False¶: 장치가 device_db 메타데이터 plugboard 를 처리할 수 있는지 여부입니다.

path_sep = '/'¶: 장치의 책 경로에 사용하는 경로 구분자입니다.

icon = 'reader.png'¶: 이 장치의 아이콘입니다.

UserAnnotation¶: :py:class:`~calibre.devices.interface.Annotation`의 별칭

OPEN_FEEDBACK_MESSAGE = None¶: None이 아니면 GUI가 상태 표시줄에 메시지로 표시합니다. 여는 데 시간이 오래 걸릴 때 유용합니다.

VIRTUAL_BOOK_EXTENSIONS = frozenset({})¶: 장치에서 “가상 책” 으로 취급되어 보기/저장/라이브러리 추가가 불가능한 확장자 집합입니다. 예: frozenset(['kobo'])

VIRTUAL_BOOK_EXTENSION_MESSAGE = None¶: 가상 책 확장자에 대해 사용자에게 표시할 메시지입니다.

NUKE_COMMENTS = None¶: 장치로 보낸 책 사본의 설명을 제거할지 여부입니다. None이 아니라면, 설명을 대체할 짧은 문자열이어야 합니다.

MANAGES_DEVICE_PRESENCE = False¶: True이면 이 드라이버가 장치 감지, 꺼내기 등을 완전히 관리한다는 뜻입니다. 이를 True로 설정했다면 detect_managed_devices 와 debug_managed_device_detection 메서드를 반드시 구현해야 합니다. 이 값이 true 인 드라이버는 장치 감지, 장치 블랙리스트, 꺼낸 장치 목록 등을 관리할 책임이 있습니다. calibre 는 주기적으로 detect_managed_devices() 메서드를 호출하며, 감지된 장치를 반환하면 open() 을 호출합니다. 이전 open() 호출이 실패했더라도 장치가 반환될 때마다 open() 이 호출되므로, 드라이버는 실패한 장치의 자체 블랙리스트를 유지해야 합니다. 마찬가지로 꺼낼 때 calibre 는 eject() 를 호출하고, 다음 detect_managed_devices() 호출이 None을 반환한다고 가정하면 post_yank_cleanup() 을 호출합니다.

SLOW_DRIVEINFO = False¶: True로 설정하면 calibre 는 책 목록이 로드된 뒤 driveinfo 를 얻기 위해 get_driveinfo() 메서드를 호출합니다.

ASK_TO_ALLOW_CONNECT = False¶: True로 설정하면, 장치가 처음 감지되었을 때 calibre 가 사용자가 calibre 로 이 장치를 관리할지 물어봅니다. 이를 True로 설정했다면 get_device_uid(), ignore_connected_device(), get_user_blacklisted_devices(), set_user_blacklisted_devices() 를 구현해야 합니다.

user_feedback_after_callback = None¶: 어떤 콜백이 실행된 뒤(현재는 upload_books 만) calibre 가 사용자에게 팝업 메시지를 띄우게 하려면 {‘title’:title, ‘msg’:msg, ‘det_msg’:detailed_msg} 형식의 사전으로 설정하십시오. 사용자에게 너무 많은 메시지를 남발하지 않도록 주의하십시오. 이 변수는 모든 콜백 뒤에 검사되므로, 정말 필요할 때만 설정하십시오.

classmethod get_open_popup_message()[소스]¶: GUI가 비모달 팝업으로 표시합니다. OpenPopupMessage 의 인스턴스여야 합니다.

classmethod model_metadata() → tuple[ModelMetadata, ...][소스]¶: 이 드라이버가 지원하는 실제 장치 모델 전체에 대한 메타데이터입니다.

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

현재 이 플러그인이 처리하는 장치가 연결되어 있다면 True, device_info 를 반환합니다.

매개변수:: devices_on_system – 현재 연결된 장치 목록

detect_managed_devices(devices_on_system, force_refresh=False)[소스]¶

MANAGES_DEVICE_PRESENCE 가 True일 때만 호출됩니다.

이 드라이버가 처리할 수 있는 장치를 검색합니다. 장치를 찾으면 장치 객체를 반환해야 합니다. 이 객체는 connected_device 로 open() 메서드에 전달됩니다. 장치를 찾지 못하면 None을 반환하십시오. 반환되는 객체는 무엇이든 될 수 있으며 calibre 는 이를 사용하지 않고 open() 에만 전달합니다.

이 메서드는 GUI에서 주기적으로 호출되므로 너무 많은 리소스를 사용하지 않도록 하십시오. 반복적인 시스템 검색을 피하려면 캐시를 사용하십시오.

매개변수:

devices_on_system – 시스템에서 발견된 USB 장치 집합입니다.
force_refresh – 드라이버가 반복 검색 방지를 위해 캐시를 사용한다면, True일 때 캐시를 비워야 합니다.

debug_managed_device_detection(devices_on_system, output)[소스]¶

MANAGES_DEVICE_PRESENCE 가 True일 때만 호출됩니다.

시스템에서 감지된 장치에 대한 정보를 output(파일 유사 객체)에 기록해야 합니다.

장치가 감지되어 성공적으로 열렸다면 True, 그렇지 않으면 False를 반환해야 합니다.

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

매개변수:

key – 장치 잠금을 해제하기 위한 키
log_packets – True이면 장치로 오가는 패킷 스트림이 기록됩니다.
report_progress – 여러 작업에 대해 % 진행률(0에서 100 사이의 숫자)을 받아 호출되는 함수입니다. -1로 호출되면 해당 작업에는 진행률 정보가 없다는 뜻입니다.
detected_device – 장치 스캐너에서 가져온 장치 정보입니다.

can_handle_windows(usbdevice, debug=False)[소스]¶

이 드라이버가 해당 장치를 처리할 수 있는지 추가 검사하기 위한 선택적 메서드입니다. 처리할 수 없다면 False를 반환해야 합니다. 이 메서드는 vendor, product id, bcd 가 일치한 뒤에만 호출되므로 비교적 시간이 드는 검사를 수행할 수 있습니다. 기본 구현은 True를 반환합니다. 이 메서드는 Windows 에서만 호출됩니다. can_handle() 도 참조하십시오.

USBMS 기반 장치의 경우 이 메서드는 기본적으로 can_handle() 에 위임된다는 점에 유의하십시오. 따라서 USBMS 하위 클래스에서는 can_handle() 만 재정의하면 됩니다.

매개변수:: usbdevice – calibre.devices.winusb.scan_usb_devices() 가 반환한 usbdevice 입니다.

can_handle(device_info, debug=False)[소스]¶

can_handle_windows() 의 Unix 버전입니다.

매개변수:: device_info – (vid, pid, bcd, 제조사, 제품명, 일련 번호) 튜플입니다.

open(connected_device, library_uuid)[소스]¶

장치별 초기화를 수행합니다. 장치가 감지된 뒤이지만 장치와 통신하는 다른 함수보다 먼저 호출됩니다. 예를 들어 장치가 USB 대용량 저장소로 자신을 나타내는 경우, 이 메서드는 장치를 마운트하거나 자동 마운트된 경우 어디에 마운트되었는지 찾는 역할을 합니다. calibre.devices.usbms.device.Device.open() 메서드에는 USB 대용량 저장 장치에 대한 좋은 예시가 되는 구현이 있습니다.

이 메서드는 사용자에게 메시지를 표시하기 위해 OpenFeedback 예외를 발생시킬 수 있습니다.

매개변수:

connected_device – 열려고 하는 장치입니다. (vendor id, product id, bcd, 제조사 이름, 제품명, 장치 일련 번호) 튜플입니다. 하지만 일부 장치에는 일련 번호가 없고, Windows 에서는 처음 세 필드만 있으며 나머지는 None 입니다.
library_uuid – 현재 calibre 라이브러리의 UUID 입니다. 라이브러리가 없으면(예: 명령줄에서 사용할 때) None 일 수 있습니다.

eject()[소스]¶

OS에서 장치를 마운트 해제 / 꺼냅니다. 장치와 통신해야 하는 대기 중 GUI 작업이 있는지는 확인하지 않습니다.

참고: 이 메서드는 다른 장치 메서드들과 동일한 스레드에서 호출되지 않을 수 있습니다.

post_yank_cleanup()[소스]¶: 사용자가 먼저 꺼내지 않고 장치를 갑자기 분리했을 때 호출됩니다.

set_progress_reporter(report_progress)[소스]¶

진행률 정보를 보고할 함수를 설정합니다.

매개변수:: report_progress – 여러 작업에 대해 % 진행률(0에서 100 사이의 숫자)을 받아 호출되는 함수입니다. -1로 호출되면 해당 작업에는 진행률 정보가 없다는 뜻입니다.

get_device_information(end_session=True)[소스]¶

장치에 장치 정보를 요청합니다. L{DeviceInfoQuery} 를 참조하십시오.

반환:: (장치 이름, 장치 버전, 장치의 소프트웨어 버전, MIME 형식) 튜플입니다. 선택적으로 다섯 번째 요소로 드라이브 정보 사전을 가질 수 있습니다. 예시는 usbms.driver 를 참조하십시오.

get_driveinfo()[소스]¶: driveinfo 사전을 반환합니다. 보통 get_device_information() 에서 호출되지만, 이 드라이버에서 driveinfo 로딩이 느리다면 SLOW_DRIVEINFO 를 설정해야 합니다. 이 경우 이 메서드는 책 목록이 로드된 뒤 calibre 가 호출합니다. 이 메서드는 장치 스레드에서 호출되지 않으므로, 드라이버는 books() 메서드에서 드라이브 정보를 캐시하고 이 함수는 캐시된 데이터를 반환해야 합니다.

card_prefix(end_session=True)[소스]¶: 카드 경로 접두사의 2요소 목록을 반환합니다. 카드가 없으면 해당 카드의 접두사는 None 입니다. 예: (‘/place’, ‘/place2’) (None, ‘place2’) (‘place’, None) (None, None)

total_space(end_session=True)[소스]¶

마운트 지점의 총 사용 가능 공간을 가져옵니다:

주 메모리
메모리 카드 A
메모리 카드 B

반환:: (1, 2, 3) 위치의 총 공간(바이트)으로 이루어진 3요소 목록입니다. 특정 장치에 이 위치가 없으면 0을 반환해야 합니다.

free_space(end_session=True)[소스]¶

마운트 지점의 남은 공간을 가져옵니다:

주 메모리
카드 A
카드 B

반환:: (1, 2, 3) 위치의 남은 공간(바이트)으로 이루어진 3요소 목록입니다. 특정 장치에 이 위치가 없으면 -1을 반환해야 합니다.

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

장치에 있는 전자책 목록을 반환합니다.

매개변수:: oncard – ‘carda’ 또는 ‘cardb’ 이면 해당 저장 카드의 전자책 목록을 반환하고, 그렇지 않으면 장치의 주 메모리에 있는 전자책 목록을 반환합니다. 카드를 지정했는데 카드에 책이 없으면 빈 목록을 반환합니다.
반환:: BookList 입니다.

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

책 목록을 장치에 업로드합니다. 장치에 이미 파일이 있다면 교체해야 합니다. 장치에 여유 공간이 충분하지 않으면 이 메서드는 FreeSpaceError 를 발생시켜야 합니다. FreeSpaceError 의 텍스트에는 on_card 가 None 이 아니면 반드시 “card” 라는 단어가, 그렇지 않으면 반드시 “memory” 라는 단어가 포함되어야 합니다.

매개변수:

files – 경로 목록
names – 장치에 업로드된 뒤 책이 가지게 될 파일명 목록입니다. len(names) == len(files)
metadata – None이 아니면 Metadata 객체 목록입니다. 아이디어는 이 메타데이터를 사용해 장치의 어느 위치에 책을 둘지 결정하는 것입니다. len(metadata) == len(files). 일반 표지(표지 경로) 외에 thumbnail 속성이 있을 수도 있으며, 있을 경우 이를 우선 사용해야 합니다. thumbnail 속성의 형식은 (너비, 높이, jpeg 형식의 cover_data) 입니다.

반환:

3요소 튜플 목록입니다. 이 목록은 add_books_to_metadata() 에 전달하기 위한 것입니다.

classmethod add_books_to_metadata(locations, metadata, booklists)[소스]¶

booklist 에 위치를 추가합니다. 이 함수는 장치와 통신해서는 안 됩니다.

매개변수:

locations – L{upload_books} 호출 결과
metadata – upload_books() 와 동일한 Metadata 객체 목록입니다.
booklists – (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=’cardb’)`) 호출 결과를 담은 튜플입니다.

delete_books(paths, end_session=True)[소스]¶: 장치 경로에 있는 책을 삭제합니다.

classmethod remove_books_from_metadata(paths, booklists)[소스]¶

메타데이터 목록에서 책을 제거합니다. 이 함수는 장치와 통신해서는 안 됩니다.

매개변수:

paths – 장치에 있는 책의 경로입니다.
booklists – (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=’cardb’)`) 호출 결과를 담은 튜플입니다.

sync_booklists(booklists, end_session=True)[소스]¶

장치의 메타데이터를 업데이트합니다.

매개변수:: booklists – (books(oncard=None)(), books(oncard='carda')(), :meth`books(oncard=’cardb’)`) 호출 결과를 담은 튜플입니다.

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

장치의 path 에 있는 파일을 읽어 outfile 에 씁니다.

매개변수:: outfile – sys.stdout 같은 파일 객체 또는 open() 호출 결과입니다.

classmethod config_widget()[소스]¶: QWidget 를 반환해야 합니다. QWidget 에는 장치 인터페이스 설정이 포함됩니다.

classmethod save_settings(settings_widget)[소스]¶: 설정을 디스크에 저장해야 합니다. config_widget() 가 만든 위젯을 받아 모든 설정을 디스크에 저장합니다.

classmethod settings()[소스]¶: opts 객체를 반환해야 합니다. opts 객체에는 최소한 장치의 형식 우선순위 목록인 format_map 속성이 있어야 합니다.

set_plugboards(plugboards, pb_func)[소스]¶

현재 plugboard 집합과 특정 plugboard 를 선택하는 함수를 드라이버에 제공합니다. 이 메서드는 add_books 및 sync_booklists 직전에 호출됩니다.

pb_func 는 다음 시그니처를 가진 호출 가능 객체입니다:: def pb_func(device_name, format, plugboards)

현재 장치 이름(클래스 이름 또는 DEVICE_PLUGBOARD_NAME), 관심 있는 형식(‘실제’ 형식 또는 ‘device_db’), 그리고 plugboards(set_plugboards 에서 받은 동일한 객체)를 전달합니다.

반환:: None 또는 단일 plugboard 인스턴스입니다.

set_driveinfo_name(location_code, name)[소스]¶

driveinfo 파일의 장치 이름을 ‘name’ 으로 설정합니다. 이 설정은 파일이 다시 생성되거나 이름이 다시 변경될 때까지 유지됩니다.

디스크가 아닌 장치는 get_device_information() 메서드가 반환하는 위치 코드에 따라 이 메서드를 구현해야 합니다.

prepare_addable_books(paths)[소스]¶

경로 목록을 받아, 책을 추가할 수 있는 버전의 경로 목록을 반환합니다.

책 준비 중 오류가 발생하면, 반환 목록에서 그 책의 위치에는 경로 대신 3-튜플 (original_path, 예외 인스턴스, traceback) 이 들어 있어야 합니다.

startup()[소스]¶: calibre 가 장치를 시작할 때 호출됩니다. 필요한 초기화를 수행하십시오. 이 클래스의 여러 인스턴스가 생성될 수 있으므로 __init__ 가 여러 번 호출될 수 있지만, 이 메서드는 그중 한 인스턴스에서만 호출됩니다. 이 메서드는 GUI 스레드가 아니라 장치 스레드에서 호출됩니다.

shutdown()[소스]¶: calibre 가 완전히 종료되거나 재시작 준비를 위해 종료될 때 호출됩니다. 필요한 정리 작업을 수행하십시오. 이 메서드는 GUI 스레드가 아니라 장치 스레드에서 호출됩니다.

get_device_uid()[소스]¶: 현재 연결된 장치의 고유 id를 반환해야 합니다(open() 이 성공한 직후 호출됨). ASK_TO_ALLOW_CONNECT = True 로 설정했다면 이 메서드를 반드시 구현해야 합니다.

ignore_connected_device(uid)[소스]¶: 앞으로 uid(get_device_uid() 호출 결과)로 식별된 장치를 무시해야 합니다. ASK_TO_ALLOW_CONNECT = True 로 설정했다면 이 메서드를 반드시 구현해야 합니다. 이 함수는 open() 직후 호출되므로, open() 이 어떤 상태를 캐시한다면 드라이버는 그 상태를 재설정해야 합니다.

get_user_blacklisted_devices()[소스]¶: 사용자가 무시하도록 요청한 모든 장치에 대해 장치 uid 를 친숙한 이름으로 매핑한 값을 반환합니다.

set_user_blacklisted_devices(devices)[소스]¶: 이 드라이버가 무시해야 할 장치 uid 목록을 설정합니다.

specialize_global_preferences(device_prefs)[소스]¶: 장치가 특정 환경설정을 재정의하려는 경우 이 메서드를 구현하십시오. 재정의될 수 있는 환경설정을 원하는 모든 호출 지점이 prefs[‘something’] 대신 device_prefs[‘something’] 을 사용하도록 해야 합니다. 이 메서드는 device_prefs.set_overrides(pref=val, pref=val, …) 를 호출해야 합니다. 현재 사용되는 예: 메타데이터 관리 (prefs[‘manage_device_metadata’])

set_library_info(library_name, library_uuid, field_metadata)[소스]¶: 현재 calibre 라이브러리에 대한 정보가 필요하다면 이 메서드를 구현하십시오. 이 메서드는 시작 시와 연결된 상태에서 calibre 라이브러리가 바뀔 때 호출됩니다.

is_dynamically_controllable()[소스]¶

장치 관리자가 플러그인을 시작할 때 호출됩니다. 이 메서드가 문자열을 반환하면 a) 장치 관리자의 동적 제어 인터페이스를 지원하고, b) 그 이름이 플러그인과 통신할 때 사용됩니다.