The DocumentInformation Class
- class PyPDF2.DocumentInformation[source]
Bases:
PyPDF2.generic.DictionaryObject
A class representing the basic document metadata provided in a PDF File. This class is accessible through
getDocumentInfo()
All text properties of the document metadata have two properties, eg. author and author_raw. The non-raw property will always return a
TextStringObject
, making it ideal for a case where the metadata is being displayed. The raw property can sometimes return aByteStringObject
, if PyPDF2 was unable to decode the string’s text encoding; this requires additional safety in the caller and therefore is not as commonly accessed.- property author
Read-only property accessing the document’s author. Returns a unicode string (
TextStringObject
) orNone
if the author is not specified.
- property author_raw
The “raw” version of author; can return a
ByteStringObject
.
- property creator
Read-only property accessing the document’s creator. If the document was converted to PDF from another format, this is the name of the application (e.g. OpenOffice) that created the original document from which it was converted. Returns a unicode string (
TextStringObject
) orNone
if the creator is not specified.
- property creator_raw
The “raw” version of creator; can return a
ByteStringObject
.
- property producer
Read-only property accessing the document’s producer. If the document was converted to PDF from another format, this is the name of the application (for example, OSX Quartz) that converted it to PDF. Returns a unicode string (
TextStringObject
) orNone
if the producer is not specified.
- property producer_raw
The “raw” version of producer; can return a
ByteStringObject
.
- property subject
Read-only property accessing the document’s subject. Returns a unicode string (
TextStringObject
) orNone
if the subject is not specified.
- property subject_raw
The “raw” version of subject; can return a
ByteStringObject
.
- property title
Read-only property accessing the document’s title. Returns a unicode string (
TextStringObject
) orNone
if the title is not specified.
- property title_raw
The “raw” version of title; can return a
ByteStringObject
.