Это старая версия документа.
Содержание
Документация к pyPDF (в процессе перевода на русский)
Destination(title, page, typ, *args) (класс)
Класс олицетворяет пункт назначения в PDF файле. |
DocumentInformation() (класс)
Класс предоставляет элементарные метаданные, содержащиеся в PDF файле. |
PageObject(pdf) (класс)
Класс олицетворяет страницу из PDF файла, одну страницу. |
PdfFileReader(stream) (класс)
Инициализирует объект PdfFileReader.
|
PdfFileWriter() (класс)
Этот класс поддерживает запись PDF файлов на диск, которые сделаны другим классом: PdfFileReader. |
Класс Destination
Destination(title, page, typ, *args) (class)
Класс олицетворяет пункт назначения в PDF файле. Смотрите раздел 8.2.1 спецификации PDF 1.6, для того, чтобы понять, что такое пункт назначения.1) Вырезка из спецификации PDF. Оригинальный текст можно увидеть в сносках.
8.2 Навигация на уровне документа Особенности, описанные в этом разделе позволяют приложениям для чтения PDF предоставлять пользователю интерактивный, глобальный обзор документа в какой-либо из этих форм:2)
Каждый элемент структуры или каждая миниатюра может быть связана с соответствующим пунктом_назначения в документе, в смысле, пользователь может попасть прямо в пункт_назначения с помощью клика мыши. 5) Раздел 8.2.1 вы можете найти здесь, так как он слишком объемный. Стабильность: Добавлено в версии 1.10, будет существовать в будущих 1.х выпусках. |
bottom
Read-only property accessing the bottom vertical coordinate.
|
left
Read-only property accessing the left horizontal coordinate.
|
page
Read-only property accessing the destination page.
|
right
Read-only property accessing the right horizontal coordinate.
|
title
Read-only property accessing the destination title.
|
top
Read-only property accessing the top vertical coordinate.
|
typ
Read-only property accessing the destination type.
|
zoom
Read-only property accessing the zoom factor.
|
Класс DocumentInformation
DocumentInformation() (класс)
Класс предоставляет элементарные метаданные, содержащиеся в PDF файле. По состоянию на pyPDF v1.10, все текстовые свойства метаданных документа имеют два свойства свойства класса, например author и author_raw. Не-raw свойство всегда возвращает TextStringObject, делая его идеальным в случае, если нужно отобразить метаданные. Raw-свойство может иногда возвращать ByteStringObject, если pyPDF не в состоянии определить кодировку текстовой строки; это требует дополнительной аккуратности от разработчика и, как следствие, редкого использования. |
author
Read-only свойство, дающее доступ к автору документа.
Добавлено в версии 1.6, будет существовать в будущих 1.х выпусках. Модифицировано в версии 1.10, чтобы всегда возвращалась строка в unicode (TextStringObject). |
creator
Read-only свойство, дающее доступ к создателю документа. Если документ был сконвертирован в PDF из другого формата, то это имя приложения (например, OpenOffice), которое сделало оригинальный документ, из которого данный был сконвертирован.
Добавлено в версии 1.6, будет существовать в будущих 1.х выпусках. Модифицировано в версии 1.10, чтобы всегда возвращалась строка в unicode (TextStringObject). |
producer
Read-only свойство, дающее доступ к создателю документа. Если документ был сконвертирован в PDF из другого формата, то это имя приложения (например, OSX Quartz), которое сконвертировало оригинальный документ в PDF.
Добавлено в версии 1.6, будет существовать в будущих 1.х выпусках. Модифицировано в версии 1.10, чтобы всегда возвращалась строка в unicode (TextStringObject). |
subject
Read-only свойство, дающее доступ к теме документа.
Добавлено в версии 1.6, будет существовать в будущих 1.х выпусках. Модифицировано в версии 1.10, чтобы всегда возвращалась строка в unicode |
title
Read-only свойство, дающее доступ к заголовку документа.
Добавлено в версии 1.6, будет существовать в будущих 1.х выпусках. Модифицировано в версии 1.10, чтобы всегда возвращалась строка в unicode |
Класс PageObject
PageObject(pdf) (класс)
This class represents a single page within a PDF file. Typically this object will be created by accessing the {@link #PdfFileReader.getPage getPage} function of the {@link #PdfFileReader PdfFileReader} class. |
artBox
A rectangle (RectangleObject), expressed in default user space units, defining the extent of the page's meaningful content as intended by the page's creator.
|
bleedBox
A rectangle (RectangleObject), expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production enviroment.
|
compressContentStreams()
Compresses the size of this page by joining all content streams and applying a FlateDecode filter.
|
cropBox
A rectangle (RectangleObject), expressed in default user space units, defining the visible region of default user space. When the page is displayed or printed, its contents are to be clipped (cropped) to this rectangle and then imposed on the output medium in some implementation-defined manner. Default value: same as MediaBox.
|
extractText()
Locate all text drawing commands, in the order they are provided in the content stream, and extract the text. This works well for some PDF files, but poorly for others, depending on the generator used. This will be refined in the future. Do not rely on the order of text coming out of this function, as it will change if this function is made more sophisticated.
|
mediaBox
A rectangle (RectangleObject), expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed.
|
mergePage(page2)
Merges the content streams of two pages into one. Resource references (i.e. fonts) are maintained from both pages. The mediabox/cropbox/etc of this page are not altered. The parameter page's content stream will be added to the end of this page's content stream, meaning that it will be drawn after, or «on top» of this page.
|
rotateClockwise(angle)
Rotates a page clockwise by increments of 90 degrees.
|
rotateCounterClockwise(angle)
Rotates a page counter-clockwise by increments of 90 degrees.
|
trimBox
A rectangle (RectangleObject), expressed in default user space units, defining the intended dimensions of the finished page after trimming.
|
Класс PdfFileReader
PdfFileReader(stream) (class)
Инициализирует PdfFileReader объект. Данная операция может занять некоторое время, пока таблицы перекрестных ссылок считываются из
Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках. |
decrypt(password)
Когда используется зашифрованный/защищенный PDF файл со стандартным обработчиком шифрования, эта функция позволит дешифровать файл. Она проверяет переданный пароль на соответствие «пользовательскому» и «паролю владельца», и сохраняет полученный ключ для дешифровки, если какой-либо пароль подошел. Неважно какой пароль подошел. Оба пароля предлагают верный ключ дешифровки, который позволит использовать документ с помощью этой библиотеки.
Стабильность: Добавлено в версии 1.8. Будет существовать во всех 1.х выпусках. |
documentInfo
Read-only свойство, которое предоставляет доступ к функции getDocumentInfo. Стабильность: Добавлено в версии 1.7. Будет существовать во всех 1.х выпусках. |
getDocumentInfo()
Извлекает информационный словарь из PDF документа, если такой существует. Заметьте, что некоторые файлы используют потоки метаданных вместо информационных словарей, и эти потоки не будут доступны с помощью этой функции. Возвращает экземпляр DocumentInformation или None, если ничего не существует.
Стабильность: Добавлено в версии 1.6. Будет существовать во всех 1.х выпусках. |
getNamedDestinations(tree=None, retval=None)
Retrieves the named destinations present in the document.
Стабильность: Добавлено в версии 1.10. Будет существовать во всех 1.х выпусках. |
getNumPages()
Подсчитывает количество страниц в данном PDF файле.
Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках. |
getOutlines(node=None, outlines=None)
Retrieves the document outline present in the document.
Стабильность: Добавлено в версии 1.10. Будет существовать во всех 1.х выпусках. |
getPage(pageNumber)
Извлекает страницу с определенным номером из PDF файла.
Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках. |
isEncrypted
Read-only boolean property showing whether this PDF file is encrypted. Note that this property, if true, will remain true even after the {@link #PdfFileReader.decrypt decrypt} function is called. |
namedDestinations
Read-only property that accesses the {@link #PdfFileReader.getNamedDestinations getNamedDestinations} function. Стабильность: Добавлено в версии 1.10. Будет существовать во всех 1.х выпусках. |
numPages
Read-only property that accesses the {@link #PdfFileReader.getNumPages getNumPages} function. Стабильность: Добавлено в версии 1.7. Будет существовать во всех 1.х выпусках. |
outlines
Read-only property that accesses the {@link #PdfFileReader.getOutlines getOutlines} function. Стабильность: Добавлено в версии 1.10. Будет существовать во всех 1.х выпусках. |
pages
Read-only property that emulates a list based upon the {@link #PdfFileReader.getNumPages getNumPages} and {@link #PdfFileReader.getPage getPage} functions. Стабильность: Добавлено в версии 1.7. Будет существовать во всех 1.х выпусках. |
Класс PdfFileWriter
PdfFileWriter() (class)
Этот класс поддерживает запись PDF объектов на диск, которые сделаны классом PdfFileReader. |
addPage(page)
Добавляет страницу к этому PDF файлу. Страница обычно получена от экземпляра PdfFileReader.
Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках. |
encrypt(user_pwd, owner_pwd=None, use_128bit=True)
Шифрует данный PDF файл с помощью стандартного обработчика шифрования PDF. 7)
|
write(stream)
Записывает коллекцию страниц, добавленных а объект для вывода, как PDF файл.
Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках. |