summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Schauer <josch@debian.org>2015-10-10 00:55:44 +0200
committerJohannes Schauer <josch@debian.org>2015-10-10 00:55:44 +0200
commita4f43aea0f0af03190e95a431a96722325d8ee9e (patch)
treea780de0e239b4645c0aee1c9d85be7f01f885e73
parenta1959ba9c0c9f3881c3e593e5aef1046750880f2 (diff)
import new upstream version 0.2
-rw-r--r--.gitignore52
-rw-r--r--.travis.yml17
-rw-r--r--LICENSE.txt45
-rw-r--r--MANIFEST.in2
-rw-r--r--README.rst745
-rw-r--r--README.txt3
-rwxr-xr-xexamples/4up.py66
-rwxr-xr-xexamples/alter.py1
-rwxr-xr-xexamples/booklet.py60
-rwxr-xr-xexamples/cat.py35
-rwxr-xr-xexamples/extract.py27
-rw-r--r--examples/find_pdfrw.py33
-rwxr-xr-xexamples/metadata.py39
-rwxr-xr-xexamples/poster.py70
-rwxr-xr-xexamples/print_two.py44
-rwxr-xr-xexamples/rl1/4up.py1
-rwxr-xr-xexamples/rl1/booklet.py3
-rw-r--r--examples/rl1/find_pdfrw.py33
-rwxr-xr-xexamples/rl1/platypus_pdf_template.py30
-rwxr-xr-xexamples/rl1/subset.py7
-rwxr-xr-xexamples/rl2/copy.py2
-rw-r--r--examples/rl2/decodegraphics.py114
-rw-r--r--examples/rl2/find_pdfrw.py33
-rwxr-xr-xexamples/rotate.py4
-rwxr-xr-xexamples/subset.py1
-rwxr-xr-xexamples/unspread.py32
-rwxr-xr-xexamples/watermark.py123
-rw-r--r--pdfrw/__init__.py22
-rw-r--r--pdfrw/buildxobj.py201
-rw-r--r--pdfrw/compress.py13
-rw-r--r--pdfrw/errors.py15
-rw-r--r--pdfrw/findobjs.py138
-rw-r--r--pdfrw/objects/__init__.py19
-rw-r--r--pdfrw/objects/pdfarray.py28
-rw-r--r--pdfrw/objects/pdfdict.py84
-rw-r--r--pdfrw/objects/pdfindirect.py6
-rw-r--r--pdfrw/objects/pdfname.py83
-rw-r--r--pdfrw/objects/pdfobject.py5
-rw-r--r--pdfrw/objects/pdfstring.py31
-rw-r--r--pdfrw/pagemerge.py242
-rw-r--r--pdfrw/pdfreader.py388
-rwxr-xr-xpdfrw/pdfwriter.py176
-rw-r--r--pdfrw/py23_diffs.py46
-rw-r--r--pdfrw/tokens.py92
-rw-r--r--pdfrw/toreportlab.py19
-rw-r--r--pdfrw/uncompress.py90
-rw-r--r--releasing.txt10
-rw-r--r--setup.cfg5
-rw-r--r--setup.py38
-rwxr-xr-xtests/checkdiffs.py81
-rw-r--r--tests/expected.py41
-rw-r--r--tests/expected.txt140
-rw-r--r--tests/myprofile.py5
-rwxr-xr-xtests/test_examples.py195
-rw-r--r--tests/test_pdfstring.py6
-rwxr-xr-xtests/test_roundtrip.py132
56 files changed, 3109 insertions, 864 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6260e55
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,52 @@
+# Development artifacts
+diffs.txt
+examples/*.pdf
+examples/rl*/*.pdf
+tests/*.pdf
+examples/pdfrw
+examples/rl*/pdfrw
+tests/pdfrw
+tests/static_pdfs
+tests/ramdisk
+tests/saved_results
+wiki/
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# Distribution / packaging
+.Python
+env/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+lib64
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+pyvenv.cfg
+pip-selfcheck.json
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Sphinx documentation
+docs/_build/
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..caa88f5
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,17 @@
+language: python
+python:
+ - "2.6"
+ - "2.7"
+ - "3.3"
+ - "3.4"
+ - "nightly"
+# command to install dependencies
+before_install:
+ - "git clone https://github.com/pmaupin/static_pdfs tests/static_pdfs"
+install:
+ - "pip install ."
+ - "pip install reportlab || true"
+ - "pip install zlib || true"
+ - "pip install unittest2 || true"
+# command to run tests
+script: "cd tests; /usr/bin/env PYTHONPATH=. py.test"
diff --git a/LICENSE.txt b/LICENSE.txt
index 7439b9c..8d3c13d 100644
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -1,6 +1,20 @@
-pdfrw (pdfrw.googlecode.com)
+pdfrw (github.com/pmaupin/pdfrw)
-Copyright (c) 2006-2012 Patrick Maupin
+The majority of pdfrw was written by Patrick Maupin and is licensed
+under the MIT license (reproduced below). Other contributors include
+Attila Tajti and Nerijus Mika. It appears that some of the decompression
+code was based on the decompressor from PyPDF2, which was written by
+Mathieu Fenniak and licensed under the BSD license (also reproduced below).
+
+Please add any missing authors here:
+
+Copyright (c) 2006-2015 Patrick Maupin. All rights reserved.
+Copyright (c) 2006 Mathieu Fenniak. All rights reserved.
+Copyright (c) 2010 Attila Tajti. All rights reserved.
+Copyright (c) 2012 Nerijus Mika. All rights reserved.
+
+
+MIT License:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +33,30 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
+
+
+BSD License:
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+* The name of the author may not be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..f90ac68
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,2 @@
+include *.txt *.in *.rst
+recursive-include examples *.txt *.py
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..2c91345
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,745 @@
+=============
+pdfrw 0.2b1
+=============
+
+:Author: Patrick Maupin
+
+.. contents::
+ :backlinks: none
+
+.. sectnum::
+
+Introduction
+============
+
+**pdfrw** is a Python library and utility that reads and writes PDF files:
+
+* Version 0.2 is tested and works on Python 2.6, 2.7, 3.3, and 3.4.
+* Operations include subsetting, merging, rotating, modifying metadata, etc.
+* The fastest pure Python PDF parser available
+* Has been used for years by a printer in pre-press production
+* Can be used with rst2pdf to faithfully reproduce vector images
+* Can be used either standalone, or in conjunction with `reportlab`__
+ to reuse existing PDFs in new ones
+* Permissively licensed
+
+__ http://www.reportlab.org/
+
+
+pdfrw will faithfully reproduce vector formats without
+rasterization, so the rst2pdf package has used pdfrw
+for PDF and SVG images by default since March 2010.
+
+pdfrw can also be used in conjunction with reportlab, in order
+to re-use portions of existing PDFs in new PDFs created with
+reportlab.
+
+
+Examples
+=========
+
+The library comes with several examples that show operation both with
+and without reportlab.
+
+
+All examples
+------------------
+
+The examples directory has a few scripts which use the library.
+Note that if these examples do not work with your PDF, you should
+try to use pdftk to uncompress and/or unencrypt them first.
+
+* `4up.py`__ will shrink pages down and place 4 of them on
+ each output page.
+* `alter.py`__ shows an example of modifying metadata, without
+ altering the structure of the PDF.
+* `booklet.py`__ shows an example of creating a 2-up output
+ suitable for printing and folding (e.g on tabloid size paper).
+* `cat.py`__ shows an example of concatenating multiple PDFs together.
+* `extract.py`__ will extract images and Form XObjects (embedded pages)
+ from existing PDFs to make them easier to use and refer to from
+ new PDFs (e.g. with reportlab or rst2pdf).
+* `poster.py`__ increases the size of a PDF so it can be printed
+ as a poster.
+* `print_two.py`__ Allows creation of 8.5 X 5.5" booklets by slicing
+ 8.5 X 11" paper apart after printing.
+* `rotate.py`__ Rotates all or selected pages in a PDF.
+* `subset.py`__ Creates a new PDF with only a subset of pages from the
+ original.
+* `unspread.py`__ Takes a 2-up PDF, and splits out pages.
+* `watermark.py`__ Adds a watermark PDF image over or under all the pages
+ of a PDF.
+* `rl1/4up.py`__ Another 4up example, using reportlab canvas for output.
+* `rl1/booklet.py`__ Another booklet example, using reportlab canvas for
+ output.
+* `rl1/subset.py`__ Another subsetting example, using reportlab canvas for
+ output.
+* `rl1/platypus_pdf_template.py`__ Aother watermarking example, using
+ reportlab canvas and generated output for the document. Contributed
+ by user asannes.
+* `rl2`__ Experimental code for parsing graphics. Needs work.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/4up.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/alter.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/booklet.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/cat.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/extract.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/poster.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/print_two.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rotate.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/subset.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/unspread.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/watermark.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rl1/4up.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rl1/booklet.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rl1/subset.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rl1/platypus_pdf_template.py
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rl2/
+
+Notes on selected examples
+------------------------------------
+
+Reorganizing pages and placing them two-up
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A printer with a fancy printer and/or a full-up copy of Acrobat can
+easily turn your small PDF into a little booklet (for example, print 4
+letter-sized pages on a single 11" x 17").
+
+But that assumes several things, including that the personnel know how
+to operate the hardware and software. `booklet.py`__ lets you turn your PDF
+into a preformatted booklet, to give them fewer chances to mess it up.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/booklet.py
+
+Adding or modifying metadata
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The `cat.py`__ example will accept multiple input files on the command
+line, concatenate them and output them to output.pdf, after adding some
+nonsensical metadata to the output PDF file.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/cat.py
+
+The `alter.py`__ example alters a single metadata item in a PDF,
+and writes the result to a new PDF.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/alter.py
+
+
+One difference is that, since **cat** is creating a new PDF structure,
+and **alter** is attempting to modify an existing PDF structure, the
+PDF produced by alter (and also by watermark.py) *should* be
+more faithful to the original (except for the desired changes).
+
+For example, the alter.py navigation should be left intact, whereas with
+cat.py it will be stripped.
+
+
+Rotating and doubling
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you ever want to print something that is like a small booklet, but
+needs to be spiral bound, you either have to do some fancy rearranging,
+or just waste half your paper.
+
+The `print_two.py`__ example program will, for example, make two side-by-side
+copies each page of of your PDF on a each output sheet.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/print_two.py
+
+But, every other page is flipped, so that you can print double-sided and
+the pages will line up properly and be pre-collated.
+
+Graphics stream parsing proof of concept
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The `copy.py`__ script shows a simple example of reading in a PDF, and
+using the decodegraphics.py module to try to write the same information
+out to a new PDF through a reportlab canvas. (If you know about reportlab,
+you know that if you can faithfully render a PDF to a reportlab canvas, you
+can do pretty much anything else with that PDF you want.) This kind of
+low level manipulation should be done only if you really need to.
+decodegraphics is really more than a proof of concept than anything
+else. For most cases, just use the Form XObject capability, as shown in
+the examples/rl1/booklet.py demo.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/examples/rl2/copy.py
+
+pdfrw philosophy
+==================
+
+Core library
+-------------
+
+The philosophy of the library portion of pdfrw is to provide intuitive
+functions to read, manipulate, and write PDF files. There should be
+minimal leakage between abstraction layers, although getting useful
+work done makes "pure" functionality separation difficult.
+
+A key concept supported by the library is the use of Form XObjects,
+which allow easy embedding of pieces of one PDF into another.
+
+Addition of core support to the library is typically done carefully
+and thoughtfully, so as not to clutter it up with too many special
+cases.
+
+There are a lot of incorrectly formatted PDFs floating around; support
+for these is added in some cases. The decision is often based on what
+acroread and okular do with the PDFs; if they can display them properly,
+then eventually pdfrw should, too, if it is not too difficult or costly.
+
+Contributions are welcome; one user has contributed some decompression
+filters and the ability to process PDF 1.5 stream objects. Additional
+functionality that would obviously be useful includes additional
+decompression filters, the ability to process password-protected PDFs,
+and the ability to output linearized PDFs.
+
+Examples
+--------
+
+The philosophy of the examples is to provide small, easily-understood
+examples that showcase pdfrw functionality.
+
+
+PDF files and Python
+======================
+
+Introduction
+------------
+
+In general, PDF files conceptually map quite well to Python. The major
+objects to think about are:
+
+- **strings**. Most things are strings. These also often decompose
+ naturally into
+- **lists of tokens**. Tokens can be combined to create higher-level
+ objects like
+- **arrays** and
+- **dictionaries** and
+- **Contents streams** (which can be more streams of tokens)
+
+Difficulties
+------------
+
+The apparent primary difficulty in mapping PDF files to Python is the
+PDF file concept of "indirect objects." Indirect objects provide
+the efficiency of allowing a single piece of data to be referred to
+from more than one containing object, but probably more importantly,
+indirect objects provide a way to get around the chicken and egg
+problem of circular object references when mapping arbitrary data
+structures to files. To flatten out a circular reference, an indirect
+object is *referred to* instead of being *directly included* in another
+object. PDF files have a global mechanism for locating indirect objects,
+and they all have two reference numbers (a reference number and a
+"generation" number, in case you wanted to append to the PDF file
+rather than just rewriting the whole thing).
+
+pdfrw automatically handles indirect references on reading in a PDF
+file. When pdfrw encounters an indirect PDF file object, the
+corresponding Python object it creates will have an 'indirect' attribute
+with a value of True. When writing a PDF file, if you have created
+arbitrary data, you just need to make sure that circular references are
+broken up by putting an attribute named 'indirect' which evaluates to
+True on at least one object in every cycle.
+
+Another PDF file concept that doesn't quite map to regular Python is a
+"stream". Streams are dictionaries which each have an associated
+unformatted data block. pdfrw handles streams by placing a special
+attribute on a subclassed dictionary.
+
+Usage Model
+-----------
+
+The usage model for pdfrw treats most objects as strings (it takes their
+string representation when writing them to a file). The two main
+exceptions are the PdfArray object and the PdfDict object.
+
+PdfArray is a subclass of list with two special features. First,
+an 'indirect' attribute allows a PdfArray to be written out as
+an indirect PDF object. Second, pdfrw reads files lazily, so
+PdfArray knows about, and resolves references to other indirect
+objects on an as-needed basis.
+
+PdfDict is a subclass of dict that also has an indirect attribute
+and lazy reference resolution as well. (And the subclassed
+IndirectPdfDict has indirect automatically set True).
+
+But PdfDict also has an optional associated stream. The stream object
+defaults to None, but if you assign a stream to the dict, it will
+automatically set the PDF /Length attribute for the dictionary.
+
+Finally, since PdfDict instances are indexed by PdfName objects (which
+always start with a /) and since most (all?) standard Adobe PdfName
+objects use names formatted like "/CamelCase", it makes sense to allow
+access to dictionary elements via object attribute accesses as well as
+object index accesses. So usage of PdfDict objects is normally via
+attribute access, although non-standard names (though still with a
+leading slash) can be accessed via dictionary index lookup.
+
+Reading PDFs
+~~~~~~~~~~~~~~~
+
+The PdfReader object is a subclass of PdfDict, which allows easy access
+to an entire document::
+
+ >>> from pdfrw import PdfReader
+ >>> x = PdfReader('source.pdf')
+ >>> x.keys()
+ ['/Info', '/Size', '/Root']
+ >>> x.Info
+ {'/Producer': '(cairo 1.8.6 (http://cairographics.org))',
+ '/Creator': '(cairo 1.8.6 (http://cairographics.org))'}
+ >>> x.Root.keys()
+ ['/Type', '/Pages']
+
+Info, Size, and Root are retrieved from the trailer of the PDF file.
+
+In addition to the tree structure, pdfrw creates a special attribute
+named *pages*, that is a list of all the pages in the document. pdfrw
+creates the *pages* attribute as a simplification for the user, because
+the PDF format allows arbitrarily complicated nested dictionaries to
+describe the page order. Each entry in the *pages* list is the PdfDict
+object for one of the pages in the file, in order.
+
+::
+
+ >>> len(x.pages)
+ 1
+ >>> x.pages[0]
+ {'/Parent': {'/Kids': [{...}], '/Type': '/Pages', '/Count': '1'},
+ '/Contents': {'/Length': '11260', '/Filter': None},
+ '/Resources': ... (Lots more stuff snipped)
+ >>> x.pages[0].Contents
+ {'/Length': '11260', '/Filter': None}
+ >>> x.pages[0].Contents.stream
+ 'q\n1 1 1 rg /a0 gs\n0 0 0 RG 0.657436
+ w\n0 J\n0 j\n[] 0.0 d\n4 M q' ... (Lots more stuff snipped)
+
+Writing PDFs
+~~~~~~~~~~~~~~~
+
+As you can see, it is quite easy to dig down into a PDF document. But
+what about when it's time to write it out?
+
+::
+
+ >>> from pdfrw import PdfWriter
+ >>> y = PdfWriter()
+ >>> y.addpage(x.pages[0])
+ >>> y.write('result.pdf')
+
+That's all it takes to create a new PDF. You may still need to read the
+`Adobe PDF reference manual`__ to figure out what needs to go *into*
+the PDF, but at least you don't have to sweat actually building it
+and getting the file offsets right.
+
+__ http://www.adobe.com/devnet/acrobat/pdfs/pdf_reference_1-7.pdf
+
+Manipulating PDFs in memory
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For the most part, pdfrw tries to be agnostic about the contents of
+PDF files, and support them as containers, but to do useful work,
+something a little higher-level is required, so pdfrw works to
+understand a bit about the contents of the containers. For example:
+
+- PDF pages. pdfrw knows enough to find the pages in PDF files you read
+ in, and to write a set of pages back out to a new PDF file.
+- Form XObjects. pdfrw can take any page or rectangle on a page, and
+ convert it to a Form XObject, suitable for use inside another PDF
+ file. It knows enough about these to perform scaling, rotation,
+ and positioning.
+- reportlab objects. pdfrw can recursively create a set of reportlab
+ objects from its internal object format. This allows, for example,
+ Form XObjects to be used inside reportlab, so that you can reuse
+ content from an existing PDF file when building a new PDF with
+ reportlab.
+
+There are several examples that demonstrate these features in
+the example code directory.
+
+Missing features
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Even as a pure PDF container library, pdfrw comes up a bit short. It
+does not currently support:
+
+- Most compression/decompression filters
+- encryption
+
+`pdftk`__ is a wonderful command-line
+tool that can convert your PDFs to remove encryption and compression.
+However, in most cases, you can do a lot of useful work with PDFs
+without actually removing compression, because only certain elements
+inside PDFs are actually compressed.
+
+__ https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/
+
+Library internals
+==================
+
+Introduction
+------------
+
+**pdfrw** currently consists of 19 modules organized into a main
+package and one sub-package.
+
+The `__init.py__`__ module does the usual thing of importing a few
+major attributes from some of the submodules, and the `errors.py`__
+module supports logging and exception generation.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/__init__.py
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/errors.py
+
+
+PDF object model support
+--------------------------
+
+The `objects`__ sub-package contains one module for each of the
+internal representations of the kinds of basic objects that exist
+in a PDF file, with the `objects/__init__.py`__ module in that
+package simply gathering them up and making them available to the
+main pdfrw package.
+
+One feature that all the PDF object classes have in common is the
+inclusion of an 'indirect' attribute. If 'indirect' exists and evaluates
+to True, then when the object is written out, it is written out as an
+indirect object. That is to say, it is addressable in the PDF file, and
+could be referenced by any number (including zero) of container objects.
+This indirect object capability saves space in PDF files by allowing
+objects such as fonts to be referenced from multiple pages, and also
+allows PDF files to contain internal circular references. This latter
+capability is used, for example, when each page object has a "parent"
+object in its dictionary.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/__init__.py
+
+Ordinary objects
+~~~~~~~~~~~~~~~~
+
+The `objects/pdfobject.py`__ module contains the PdfObject class, which is
+a subclass of str, and is the catch-all object for any PDF file elements
+that are not explicitly represented by other objects, as described below.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/pdfobject.py
+
+Name objects
+~~~~~~~~~~~~
+
+The `objects/pdfname.py`__ module contains the PdfName singleton object,
+which will convert a string into a PDF name by prepending a slash. It can
+be used either by calling it or getting an attribute, e.g.::
+
+ PdfName.Rotate == PdfName('Rotate') == PdfObject('/Rotate')
+
+In the example above, there is a slight difference between the objects
+returned from PdfName, and the object returned from PdfObject. The
+PdfName objects are actually objects of class "BasePdfName". This
+is important, because only these may be used as keys in PdfDict objects.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/pdfname.py
+
+String objects
+~~~~~~~~~~~~~~
+
+The `objects/pdfstring.py`__
+module contains the PdfString class, which is a subclass of str that is
+used to represent encoded strings in a PDF file. The class has encode
+and decode methods for the strings.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/pdfstring.py
+
+
+Array objects
+~~~~~~~~~~~~~
+
+The `objects/pdfarray.py`__
+module contains the PdfArray class, which is a subclass of list that is
+used to represent arrays in a PDF file. A regular list could be used
+instead, but use of the PdfArray class allows for an indirect attribute
+to be set, and also allows for proxying of unresolved indirect objects
+(that haven't been read in yet) in a manner that is transparent to pdfrw
+clients.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/pdfarray.py
+
+Dict objects
+~~~~~~~~~~~~
+
+The `objects/pdfdict.py`__
+module contains the PdfDict class, which is a subclass of dict that is
+used to represent dictionaries in a PDF file. A regular dict could be
+used instead, but the PdfDict class matches the requirements of PDF
+files more closely:
+
+* Transparent (from the library client's viewpoint) proxying
+ of unresolved indirect objects
+* Return of None for non-existent keys (like dict.get)
+* Mapping of attribute accesses to the dict itself
+ (pdfdict.Foo == pdfdict[NameObject('Foo')])
+* Automatic management of following stream and /Length attributes
+ for content dictionaries
+* Indirect attribute
+* Other attributes may be set for private internal use of the
+ library and/or its clients.
+* Support for searching parent dictionaries for PDF "inheritable"
+ attributes.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/pdfdict.py
+
+If a PdfDict has an associated data stream in the PDF file, the stream
+is accessed via the 'stream' (all lower-case) attribute. Setting the
+stream attribute on the PdfDict will automatically set the /Length attribute
+as well. If that is not what is desired (for example if the the stream
+is compressed), then _stream (same name with an underscore) may be used
+to associate the stream with the PdfDict without setting the length.
+
+To set private attributes (that will not be written out to a new PDF
+file) on a dictionary, use the 'private' attribute::
+
+ mydict.private.foo = 1
+
+Once the attribute is set, it may be accessed directly as an attribute
+of the dictionary::
+
+ foo = mydict.foo
+
+Some attributes of PDF pages are "inheritable." That is, they may
+belong to a parent dictionary (or a parent of a parent dictionary, etc.)
+The "inheritable" attribute allows for easy discovery of these::
+
+ mediabox = mypage.inheritable.MediaBox
+
+
+Proxy objects
+~~~~~~~~~~~~~
+
+The `objects/pdfindirect.py`__
+module contains the PdfIndirect class, which is a non-transparent proxy
+object for PDF objects that have not yet been read in and resolved from
+a file. Although these are non-transparent inside the library, client code
+should never see one of these -- they exist inside the PdfArray and PdfDict
+container types, but are resolved before being returned to a client of
+those types.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/objects/pdfindirect.py
+
+
+File reading, tokenization and parsing
+--------------------------------------
+
+`pdfreader.py`__
+contains the PdfReader class, which can read a PDF file (or be passed a
+file object or already read string) and parse it. It uses the PdfTokens
+class in `tokens.py`__ for low-level tokenization.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/pdfreader.py
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/tokens.py
+
+
+The PdfReader class does not, in general, parse into containers (e.g.
+inside the content streams). There is a proof of concept for doing that
+inside the examples/rl2 subdirectory, but that is slow and not well-developed,
+and not useful for most applications.
+
+An instance of the PdfReader class is an instance of a PdfDict -- the
+trailer dictionary of the PDF file, to be exact. It will have a private
+attribute set on it that is named 'pages' that is a list containing all
+the pages in the file.
+
+When instantiating a PdfReader object, there are options available
+for decompressing all the objects in the file. pdfrw does not currently
+have very many options for decompression, so this is not all that useful,
+except in the specific case of compressed object streams.
+
+Also, there are no options for decryption yet. If you have PDF files
+that are encrypted or heavily compressed, you may find that using another
+program like pdftk on them can make them readable by pdfrw.
+
+In general, the objects are read from the file lazily, but this is not
+currently true with compressed object streams -- all of these are decompressed
+and read in when the PdfReader is instantiated.
+
+
+File output
+-----------
+
+`pdfwriter.py`__
+contains the PdfWriter class, which can create and output a PDF file.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/pdfwriter.py
+
+There are a few options available when creating and using this class.
+
+In the simplest case, an instance of PdfWriter is instantiated, and
+then pages are added to it from one or more source files (or created
+programmatically), and then the write method is called to dump the
+results out to a file.
+
+If you have a source PDF and do not want to disturb the structure
+of it too badly, then you may pass its trailer directly to PdfWriter
+rather than letting PdfWriter construct one for you. There is an
+example of this (alter.py) in the examples directory.
+
+
+Advanced features
+-----------------
+
+`buildxobj.py`__
+contains functions to build Form XObjects out of pages or rectangles on
+pages. These may be reused in new PDFs essentially as if they were images.
+
+buildxobj is careful to cache any page used so that it only appears in
+the output once.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/buildxobj.py
+
+
+`toreportlab.py`__
+provides the makerl function, which will translate pdfrw objects into a
+format which can be used with `reportlab <http://www.reportlab.org/>`__.
+It is normally used in conjunction with buildxobj, to be able to reuse
+parts of existing PDFs when using reportlab.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/toreportlab.py
+
+
+`pagemerge.py`__ builds on the foundation laid by buildxobj. It
+contains classes to create a new page (or overlay an existing page)
+using one or more rectangles from other pages. There are examples
+showing its use for watermarking, scaling, 4-up output, splitting
+each page in 2, etc.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/pagemerge.py
+
+`findobjs.py`__ contains code that can find specific kinds of objects
+inside a PDF file. The extract.py example uses this module to create
+a new PDF that places each image and Form XObject from a source PDF onto
+its own page, e.g. for easy reuse with some of the other examples or
+with reportlab.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/findobjs.py
+
+
+Miscellaneous
+----------------
+
+`compress.py`__ and `uncompress.py`__
+contains compression and decompression functions. Very few filters are
+currently supported, so an external tool like pdftk might be good if you
+require the ability to decompress (or, for that matter, decrypt) PDF
+files.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/compress.py
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/uncompress.py
+
+
+`py23_diffs.py`__ contains code to help manage the differences between
+Python 2 and Python 3.
+
+__ https://github.com/pmaupin/pdfrw/tree/master/pdfrw/py23_diffs.py
+
+Testing
+===============
+
+The tests associated with pdfrw require a large number of PDFs,
+which are not distributed with the library.
+
+To run the tests:
+
+* Download or clone the full package from github.com/pmaupin/pdfrw
+* cd into the tests directory, and then clone the package
+ github.com/pmaupin/static_pdfs into a subdirectory (also named
+ static_pdfs).
+* Now the tests may be run from that directory using unittest, or
+ py.test, or nose.
+* travisci is used at github, and runs the tests with py.test
+
+Other libraries
+=====================
+
+Pure Python
+-----------
+
+- `reportlab <http://www.reportlab.org/>`__
+
+ reportlab is must-have software if you want to programmatically
+ generate arbitrary PDFs.
+
+- `pyPdf <https://github.com/mstamy2/PyPDF2>`__
+
+ pyPdf is, in some ways, very full-featured. It can do decompression
+ and decryption and seems to know a lot about items inside at least
+ some kinds of PDF files. In comparison, pdfrw knows less about
+ specific PDF file features (such as metadata), but focuses on trying
+ to have a more Pythonic API for mapping the PDF file container
+ syntax to Python, and (IMO) has a simpler and better PDF file
+ parser. The Form XObject capability of pdfrw means that, in many
+ cases, it does not actually need to decompress objects -- they
+ can be left compressed.
+
+- `pdftools <http://www.boddie.org.uk/david/Projects/Python/pdftools/index.html>`__
+
+ pdftools feels large and I fell asleep trying to figure out how it
+ all fit together, but many others have done useful things with it.
+
+- `pagecatcher <http://www.reportlab.com/docs/pagecatcher-ds.pdf>`__
+
+ My understanding is that pagecatcher would have done exactly what I
+ wanted when I built pdfrw. But I was on a zero budget, so I've never
+ had the pleasure of experiencing pagecatcher. I do, however, use and
+ like `reportlab <http://www.reportlab.org/>`__ (open source, from
+ the people who make pagecatcher) so I'm sure pagecatcher is great,
+ better documented and much more full-featured than pdfrw.
+
+- `pdfminer <http://www.unixuser.org/~euske/python/pdfminer/index.html>`__
+
+ This looks like a useful, actively-developed program. It is quite
+ large, but then, it is trying to actively comprehend a full PDF
+ document. From the website:
+
+ "PDFMiner is a suite of programs that help extracting and analyzing
+ text data of PDF documents. Unlike other PDF-related tools, it
+ allows to obtain the exact location of texts in a page, as well as
+ other extra information such as font information or ruled lines. It
+ includes a PDF converter that can transform PDF files into other
+ text formats (such as HTML). It has an extensible PDF parser that
+ can be used for other purposes instead of text analysis."
+
+non-pure-Python libraries
+-------------------------
+
+- `pyPoppler <https://launchpad.net/poppler-python/>`__ can read PDF
+ files.
+- `pycairo <http://www.cairographics.org/pycairo/>`__ can write PDF
+ files.
+
+Other tools
+-----------
+
+- `pdftk <https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/>`__ is a wonderful command
+ line tool for basic PDF manipulation. It complements pdfrw extremely
+ well, supporting many operations such as decryption and decompression
+ that pdfrw cannot do.
+
+Release information
+=======================
+
+Revisions:
+
+0.2 -- Released 21 June, 2015. Supports Python 2.6, 2.7, 3.3, and 3.4.
+
+ - Several bugs have been fixed
+ - New regression test functionally tests core with dozens of
+ PDFs, and also tests examples.
+ - Core has been ported and tested on Python3 by round-tripping
+ several difficult files and observing binary matching results
+ across the different Python versions.
+ - Still only minimal support for compression and no support
+ for encryption or newer PDF features. (pdftk is useful
+ to put PDFs in a form that pdfrw can use.)
+
+0.1 -- Released to PyPI in 2012. Supports Python 2.5 - 2.7
+
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 843347f..0000000
--- a/README.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-pdfrw reads and writes PDF files.
-
-More info at http://code.google.com/p/pdfrw
diff --git a/examples/4up.py b/examples/4up.py
index 491af14..ad2bd3b 100755
--- a/examples/4up.py
+++ b/examples/4up.py
@@ -1,51 +1,33 @@
#!/usr/bin/env python
'''
-usage: 4up.py my.pdf firstpage lastpage
-
-Creates 4up.my.pdf
+usage: 4up.py my.pdf
+Creates 4up.my.pdf with a single output page for every
+4 input pages.
'''
import sys
import os
-import find_pdfrw
-from pdfrw import PdfReader, PdfWriter, PdfDict, PdfName, PdfArray
-from pdfrw.buildxobj import pagexobj
-
-def get4(allpages):
- # Pull a maximum of 4 pages off the list
- pages = [pagexobj(x) for x in allpages[:4]]
- del allpages[:4]
-
- x_max = max(page.BBox[2] for page in pages)
- y_max = max(page.BBox[3] for page in pages)
-
- stream = []
- xobjdict = PdfDict()
- for index, page in enumerate(pages):
- x = x_max * (index & 1) / 2.0
- y = y_max * (index <= 1) / 2.0
- index = '/P%s' % index
- stream.append('q 0.5 0 0 0.5 %s %s cm %s Do Q\n' % (x, y, index))
- xobjdict[index] = page
-
- return PdfDict(
- Type = PdfName.Page,
- Contents = PdfDict(stream=''.join(stream)),
- MediaBox = PdfArray([0, 0, x_max, y_max]),
- Resources = PdfDict(XObject = xobjdict),
- )
-
-def go(inpfn, outfn):
- pages = PdfReader(inpfn).pages
- writer = PdfWriter()
- while pages:
- writer.addpage(get4(pages))
- writer.write(outfn)
-
-if __name__ == '__main__':
- inpfn, = sys.argv[1:]
- outfn = '4up.' + os.path.basename(inpfn)
- go(inpfn, outfn)
+from pdfrw import PdfReader, PdfWriter, PageMerge
+
+
+def get4(srcpages):
+ scale = 0.5
+ srcpages = PageMerge() + srcpages
+ x_increment, y_increment = (scale * i for i in srcpages.xobj_box[2:])
+ for i, page in enumerate(srcpages):
+ page.scale(scale)
+ page.x = x_increment if i & 1 else 0
+ page.y = 0 if i & 2 else y_increment
+ return srcpages.render()
+
+
+inpfn, = sys.argv[1:]
+outfn = '4up.' + os.path.basename(inpfn)
+pages = PdfReader(inpfn).pages
+writer = PdfWriter()
+for index in range(0, len(pages), 4):
+ writer.addpage(get4(pages[index:index + 4]))
+writer.write(outfn)
diff --git a/examples/alter.py b/examples/alter.py
index 1c6d4e1..45b9c76 100755
--- a/examples/alter.py
+++ b/examples/alter.py
@@ -12,7 +12,6 @@ Demonstrates making a slight alteration to a preexisting PDF file.
import sys
import os
-import find_pdfrw
from pdfrw import PdfReader, PdfWriter
inpfn, = sys.argv[1:]
diff --git a/examples/booklet.py b/examples/booklet.py
index 0b3be74..4758b08 100755
--- a/examples/booklet.py
+++ b/examples/booklet.py
@@ -5,61 +5,35 @@ usage: booklet.py my.pdf
Creates booklet.my.pdf
-Pages organized in a form suitable for booklet printing.
-
+Pages organized in a form suitable for booklet printing, e.g.
+to print 4 8.5x11 pages using a single 11x17 sheet (double-sided).
'''
import sys
import os
-import find_pdfrw
-from pdfrw import PdfReader, PdfWriter, PdfDict, PdfArray, PdfName, IndirectPdfDict
-from pdfrw.buildxobj import pagexobj
-
-def fixpage(*pages):
- pages = [pagexobj(x) for x in pages]
+from pdfrw import PdfReader, PdfWriter, PageMerge
- class PageStuff(tuple):
- pass
- x = y = 0
- for i, page in enumerate(pages):
- index = '/P%s' % i
- shift_right = x and '1 0 0 1 %s 0 cm ' % x or ''
- stuff = PageStuff((index, page))
- stuff.stream = 'q %s%s Do Q\n' % (shift_right, index)
- x += page.BBox[2]
- y = max(y, page.BBox[3])
- pages[i] = stuff
-
- # Multiple copies of first page used as a placeholder to
- # get blank page on back.
- for p1, p2 in zip(pages, pages[1:]):
- if p1[1] is p2[1]:
- pages.remove(p1)
+def fixpage(*pages):
+ result = PageMerge() + (x for x in pages if x is not None)
+ result[-1].x += result[0].w
+ return result.render()
- return IndirectPdfDict(
- Type = PdfName.Page,
- Contents = PdfDict(stream=''.join(page.stream for page in pages)),
- MediaBox = PdfArray([0, 0, x, y]),
- Resources = PdfDict(
- XObject = PdfDict(pages),
- ),
- )
inpfn, = sys.argv[1:]
outfn = 'booklet.' + os.path.basename(inpfn)
-pages = PdfReader(inpfn).pages
+ipages = PdfReader(inpfn).pages
-# Use page1 as a marker to print a blank at the end
-if len(pages) & 1:
- pages.append(pages[0])
+# Make sure we have an even number
+if len(ipages) & 1:
+ ipages.append(None)
-bigpages = []
-while len(pages) > 2:
- bigpages.append(fixpage(pages.pop(), pages.pop(0)))
- bigpages.append(fixpage(pages.pop(0), pages.pop()))
+opages = []
+while len(ipages) > 2:
+ opages.append(fixpage(ipages.pop(), ipages.pop(0)))
+ opages.append(fixpage(ipages.pop(0), ipages.pop()))
-bigpages += pages
+opages += ipages
-PdfWriter().addpages(bigpages).write(outfn)
+PdfWriter().addpages(opages).write(outfn)
diff --git a/examples/cat.py b/examples/cat.py
new file mode 100755
index 0000000..86cf643
--- /dev/null
+++ b/examples/cat.py
@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+'''
+usage: cat.py <first.pdf> [<next.pdf> ...]
+
+Creates cat.<first.pdf>
+
+This file demonstrates two features:
+
+1) Concatenating multiple input PDFs.
+
+2) adding metadata to the PDF.
+
+'''
+
+import sys
+import os
+
+from pdfrw import PdfReader, PdfWriter, IndirectPdfDict
+
+inputs = sys.argv[1:]
+assert inputs
+outfn = 'cat.' + os.path.basename(inputs[0])
+
+writer = PdfWriter()
+for inpfn in inputs:
+ writer.addpages(PdfReader(inpfn).pages)
+
+writer.trailer.Info = IndirectPdfDict(
+ Title='your title goes here',
+ Author='your name goes here',
+ Subject='what is it all about?',
+ Creator='some script goes here',
+)
+writer.write(outfn)
diff --git a/examples/extract.py b/examples/extract.py
new file mode 100755
index 0000000..3756b4f
--- /dev/null
+++ b/examples/extract.py
@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+
+'''
+usage: extract.py <some.pdf>
+
+Locates Form XObjects and Image XObjects within the PDF,
+and creates a new PDF containing these -- one per page.
+
+Resulting file will be named extract.<some.pdf>
+
+'''
+
+import sys
+import os
+
+from pdfrw import PdfReader, PdfWriter
+from pdfrw.findobjs import page_per_xobj
+
+
+inpfn, = sys.argv[1:]
+outfn = 'extract.' + os.path.basename(inpfn)
+pages = list(page_per_xobj(PdfReader(inpfn).pages, margin=0.5*72))
+if not pages:
+ raise IndexError("No XObjects found")
+writer = PdfWriter()
+writer.addpages(pages)
+writer.write(outfn)
diff --git a/examples/find_pdfrw.py b/examples/find_pdfrw.py
deleted file mode 100644
index f69d412..0000000
--- a/examples/find_pdfrw.py
+++ /dev/null
@@ -1,33 +0,0 @@
-'''
- find_xxx.py -- Find the place in the tree where xxx lives.
-
- Ways to use:
- 1) Make a copy, change 'xxx' in package to be your name; or
- 2) Under Linux, just ln -s to where this is in the right tree
-
- Created by Pat Maupin, who doesn't consider it big enough to be worth copyrighting
-'''
-
-import sys
-import os
-
-myname = __name__[5:] # remove 'find_'
-myname = os.path.join(myname, '__init__.py')
-
-def trypath(newpath):
- path = None
- while path != newpath:
- path = newpath
- if os.path.exists(os.path.join(path, myname)):
- return path
- newpath = os.path.dirname(path)
-
-root = trypath(__file__) or trypath(os.path.realpath(__file__))
-
-if root is None:
- print
- print 'Warning: %s: Could not find path to development package %s' % (__file__, myname)
- print ' The import will either fail or will use system-installed libraries'
- print
-elif root not in sys.path:
- sys.path.append(root)
diff --git a/examples/metadata.py b/examples/metadata.py
deleted file mode 100755
index 9c69108..0000000
--- a/examples/metadata.py
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/usr/bin/env python
-
-'''
-usage: metadata.py <first.pdf> [<next.pdf> ...]
-
-Creates output.pdf
-
-This file demonstrates two features:
-
-1) Concatenating multiple input PDFs.
-
-2) adding metadata to the PDF.
-
-If you do not need to add metadata, look at subset.py, which
-has a simpler interface to PdfWriter.
-
-'''
-
-import sys
-import os
-
-import find_pdfrw
-from pdfrw import PdfReader, PdfWriter, IndirectPdfDict
-
-inputs = sys.argv[1:]
-assert inputs
-outfn = 'output.pdf'
-
-writer = PdfWriter()
-for inpfn in inputs:
- writer.addpages(PdfReader(inpfn.pages)
-
-writer.trailer.Info = IndirectPdfDict(
- Title = 'your title goes here',
- Author = 'your name goes here',
- Subject = 'what is it all about?',
- Creator = 'some script goes here',
-)
-writer.write(outfn)
diff --git a/examples/poster.py b/examples/poster.py
index ee58282..7f1c1c2 100755
--- a/examples/poster.py
+++ b/examples/poster.py
@@ -7,51 +7,37 @@ Shows how to change the size on a PDF.
Motivation:
-My daughter needed to create a 48" x 36" poster, but her Mac version of Powerpoint
-only wanted to output 8.5" x 11" for some reason.
+My daughter needed to create a 48" x 36" poster, but her Mac
+version of Powerpoint only wanted to output 8.5" x 11" for
+some reason.
+
+So she did an 8.5x11" output with 0.5" margin all around
+(actual size of useful area 7.5x10") and we scaled it
+up by 4.8.
+
+We also copy the Info dict to the new PDF.
'''
import sys
import os
-import find_pdfrw
-from pdfrw import PdfReader, PdfWriter, PdfDict, PdfName, PdfArray, IndirectPdfDict
-from pdfrw.buildxobj import pagexobj
-
-def adjust(page):
- page = pagexobj(page)
- assert page.BBox == [0, 0, 11 * 72, int(8.5 * 72)], page.BBox
- margin = 72 // 2
- old_x, old_y = page.BBox[2] - 2 * margin, page.BBox[3] - 2 * margin
-
- new_x, new_y = 48 * 72, 36 * 72
- ratio = 1.0 * new_x / old_x
- assert ratio == 1.0 * new_y / old_y
-
- index = '/BasePage'
- x = -margin * ratio
- y = -margin * ratio
- stream = 'q %0.2f 0 0 %0.2f %s %s cm %s Do Q\n' % (ratio, ratio, x, y, index)
- xobjdict = PdfDict()
- xobjdict[index] = page
-
- return PdfDict(
- Type = PdfName.Page,
- Contents = PdfDict(stream=stream),
- MediaBox = PdfArray([0, 0, new_x, new_y]),
- Resources = PdfDict(XObject = xobjdict),
- )
-
-def go(inpfn, outfn):
- reader = PdfReader(inpfn)
- page, = reader.pages
- writer = PdfWriter()
- writer.addpage(adjust(page))
- writer.trailer.Info = IndirectPdfDict(reader.Info)
- writer.write(outfn)
-
-if __name__ == '__main__':
- inpfn, = sys.argv[1:]
- outfn = 'poster.' + os.path.basename(inpfn)
- go(inpfn, outfn)
+from pdfrw import PdfReader, PdfWriter, PageMerge, IndirectPdfDict
+
+
+def adjust(page, margin=36, scale=4.8):
+ info = PageMerge().add(page)
+ x1, y1, x2, y2 = info.xobj_box
+ viewrect = (margin, margin, x2 - x1 - 2 * margin, y2 - y1 - 2 * margin)
+ page = PageMerge().add(page, viewrect=viewrect)
+ page[0].scale(scale)
+ return page.render()
+
+
+inpfn, = sys.argv[1:]
+outfn = 'poster.' + os.path.basename(inpfn)
+reader = PdfReader(inpfn)
+writer = PdfWriter()
+writer.addpage(adjust(reader.pages[0]))
+writer.trailer.Info = IndirectPdfDict(reader.Info or {})
+writer.write(outfn)
diff --git a/examples/print_two.py b/examples/print_two.py
index d168f68..c54eaee 100755
--- a/examples/print_two.py
+++ b/examples/print_two.py
@@ -7,52 +7,26 @@ Creates print_two.my.pdf
This is only useful when you can cut down sheets of paper to make two
small documents. Works for double-sided only right now.
-
'''
import sys
import os
-import find_pdfrw
-from pdfrw import PdfReader, PdfWriter, PdfArray, IndirectPdfDict
+from pdfrw import PdfReader, PdfWriter, PageMerge
+
def fixpage(page, count=[0]):
count[0] += 1
- evenpage = not (count[0] & 1)
-
- # For demo purposes, just go with the MediaBox and toast the others
- box = [float(x) for x in page.MediaBox]
- assert box[0] == box[1] == 0, "demo won't work on this PDF"
-
- for key, value in sorted(page.iteritems()):
- if 'box' in key.lower():
- del page[key]
-
- startsize = tuple(box[2:])
- finalsize = box[3], 2 * box[2]
- page.MediaBox = PdfArray((0, 0) + finalsize)
- page.Rotate = (int(page.Rotate or 0) + 90) % 360
-
- contents = page.Contents
- if contents is None:
- return page
- contents = isinstance(contents, dict) and [contents] or contents
-
- prefix = '0 1 -1 0 %s %s cm\n' % (finalsize[0], 0)
- if evenpage:
- prefix = '1 0 0 1 %s %s cm\n' % (0, finalsize[1]/2) + prefix
- first_prefix = 'q\n-1 0 0 -1 %s %s cm\n' % finalsize + prefix
- second_prefix = '\nQ\n' + prefix
- first_prefix = IndirectPdfDict(stream=first_prefix)
- second_prefix = IndirectPdfDict(stream=second_prefix)
- contents = PdfArray(([second_prefix] + contents) * 2)
- contents[0] = first_prefix
- page.Contents = contents
- return page
+ oddpage = (count[0] & 1)
+
+ result = PageMerge()
+ for rotation in (180 + 180 * oddpage, 180 * oddpage):
+ result.add(page, rotate=rotation)
+ result[1].x = result[0].w
+ return result.render()
inpfn, = sys.argv[1:]
outfn = 'print_two.' + os.path.basename(inpfn)
pages = PdfReader(inpfn).pages
-
PdfWriter().addpages(fixpage(x) for x in pages).write(outfn)
diff --git a/examples/rl1/4up.py b/examples/rl1/4up.py
index 385103a..49f766e 100755
--- a/examples/rl1/4up.py
+++ b/examples/rl1/4up.py
@@ -15,7 +15,6 @@ import os
from reportlab.pdfgen.canvas import Canvas
-import find_pdfrw
from pdfrw import PdfReader
from pdfrw.buildxobj import pagexobj
from pdfrw.toreportlab import makerl
diff --git a/examples/rl1/booklet.py b/examples/rl1/booklet.py
index 23f8a72..e7764a0 100755
--- a/examples/rl1/booklet.py
+++ b/examples/rl1/booklet.py
@@ -15,7 +15,6 @@ import os
from reportlab.pdfgen.canvas import Canvas
-import find_pdfrw
from pdfrw import PdfReader
from pdfrw.buildxobj import pagexobj
from pdfrw.toreportlab import makerl
@@ -43,7 +42,7 @@ def make_pdf(outfn, xobjpairs):
x += xobj.BBox[2]
y = max(y, xobj.BBox[3])
- canvas.setPageSize((x,y))
+ canvas.setPageSize((x, y))
# Handle blank back page
if len(xobjlist) > 1 and xobjlist[0] == xobjlist[-1]:
diff --git a/examples/rl1/find_pdfrw.py b/examples/rl1/find_pdfrw.py
deleted file mode 100644
index f69d412..0000000
--- a/examples/rl1/find_pdfrw.py
+++ /dev/null
@@ -1,33 +0,0 @@
-'''
- find_xxx.py -- Find the place in the tree where xxx lives.
-
- Ways to use:
- 1) Make a copy, change 'xxx' in package to be your name; or
- 2) Under Linux, just ln -s to where this is in the right tree
-
- Created by Pat Maupin, who doesn't consider it big enough to be worth copyrighting
-'''
-
-import sys
-import os
-
-myname = __name__[5:] # remove 'find_'
-myname = os.path.join(myname, '__init__.py')
-
-def trypath(newpath):
- path = None
- while path != newpath:
- path = newpath
- if os.path.exists(os.path.join(path, myname)):
- return path
- newpath = os.path.dirname(path)
-
-root = trypath(__file__) or trypath(os.path.realpath(__file__))
-
-if root is None:
- print
- print 'Warning: %s: Could not find path to development package %s' % (__file__, myname)
- print ' The import will either fail or will use system-installed libraries'
- print
-elif root not in sys.path:
- sys.path.append(root)
diff --git a/examples/rl1/platypus_pdf_template.py b/examples/rl1/platypus_pdf_template.py
index 8c85794..7e4769a 100755
--- a/examples/rl1/platypus_pdf_template.py
+++ b/examples/rl1/platypus_pdf_template.py
@@ -1,17 +1,18 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
-usage: platypus_pdf_template.py output.pdf pdf_file_to_use_as_template.pdf
+usage: platypus_pdf_template.py source.pdf
-Example of using pdfrw to use a pdf (page one) as the background for all
-other pages together with platypus.
+Creates platypus.source.pdf
-There is a table of contents in this example for completeness sake.
+Example of using pdfrw to use page 1 of a source PDF as the background
+for other pages programmatically generated with Platypus.
Contributed by user asannes
"""
import sys
+import os
from reportlab.platypus import PageTemplate, BaseDocTemplate, Frame
from reportlab.platypus import NextPageTemplate, Paragraph, PageBreak
@@ -21,7 +22,6 @@ from reportlab.rl_config import defaultPageSize
from reportlab.lib.units import inch
from reportlab.graphics import renderPDF
-import find_pdfrw
from pdfrw import PdfReader
from pdfrw.buildxobj import pagexobj
from pdfrw.toreportlab import makerl
@@ -29,6 +29,7 @@ from pdfrw.toreportlab import makerl
PAGE_WIDTH = defaultPageSize[0]
PAGE_HEIGHT = defaultPageSize[1]
+
class MyTemplate(PageTemplate):
"""The kernel of this example, where we use pdfrw to fill in the
background of a page before writing to it. This could be used to fill
@@ -57,6 +58,7 @@ class MyTemplate(PageTemplate):
canvas.doForm(rl_obj)
canvas.restoreState()
+
class MyDocTemplate(BaseDocTemplate):
"""Used to apply heading to table of contents."""
@@ -70,20 +72,22 @@ class MyDocTemplate(BaseDocTemplate):
self.canv.bookmarkPage(key)
self.notify('TOCEntry', [1, text, self.page, key])
+
def create_toc():
"""Creates the table of contents"""
table_of_contents = TableOfContents()
table_of_contents.dotsMinLevel = 0
- header1 = ParagraphStyle(name = 'Heading1', fontSize = 16, leading = 16)
- header2 = ParagraphStyle(name = 'Heading2', fontSize = 14, leading = 14)
+ header1 = ParagraphStyle(name='Heading1', fontSize=16, leading=16)
+ header2 = ParagraphStyle(name='Heading2', fontSize=14, leading=14)
table_of_contents.levelStyles = [header1, header2]
return [table_of_contents, PageBreak()]
+
def create_pdf(filename, pdf_template_filename):
"""Create the pdf, with all the contents"""
- pdf_report = open(filename, "w")
+ pdf_report = open(filename, "wb")
document = MyDocTemplate(pdf_report)
- templates = [ MyTemplate(pdf_template_filename, name='background') ]
+ templates = [MyTemplate(pdf_template_filename, name='background')]
document.addPageTemplates(templates)
styles = getSampleStyleSheet()
@@ -99,8 +103,6 @@ def create_pdf(filename, pdf_template_filename):
if __name__ == '__main__':
- try:
- output, template = sys.argv[1:]
- create_pdf(output, template)
- except ValueError:
- print "Usage: %s <output> <template>" % (sys.argv[0])
+ template, = sys.argv[1:]
+ output = 'platypus_pdf_template.' + os.path.basename(template)
+ create_pdf(output, template)
diff --git a/examples/rl1/subset.py b/examples/rl1/subset.py
index 8b2bf08..c05056c 100755
--- a/examples/rl1/subset.py
+++ b/examples/rl1/subset.py
@@ -17,7 +17,6 @@ import os
from reportlab.pdfgen.canvas import Canvas
-import find_pdfrw
from pdfrw import PdfReader
from pdfrw.buildxobj import pagexobj
from pdfrw.toreportlab import makerl
@@ -25,14 +24,14 @@ from pdfrw.toreportlab import makerl
def go(inpfn, firstpage, lastpage):
firstpage, lastpage = int(firstpage), int(lastpage)
- outfn = 'subset_%s_to_%s.%s' % (firstpage, lastpage, os.path.basename(inpfn))
+ outfn = 'subset.' + os.path.basename(inpfn)
pages = PdfReader(inpfn).pages
- pages = [pagexobj(x) for x in pages[firstpage-1:lastpage]]
+ pages = [pagexobj(x) for x in pages[firstpage - 1:lastpage]]
canvas = Canvas(outfn)
for page in pages:
- canvas.setPageSize(tuple(page.BBox[2:]))
+ canvas.setPageSize((page.BBox[2], page.BBox[3]))
canvas.doForm(makerl(canvas, page))
canvas.showPage()
diff --git a/examples/rl2/copy.py b/examples/rl2/copy.py
index 20dad71..66fe0c6 100755
--- a/examples/rl2/copy.py
+++ b/examples/rl2/copy.py
@@ -20,7 +20,7 @@ from pdfrw import PdfReader, PdfWriter, PdfArray
inpfn, = sys.argv[1:]
outfn = 'copy.' + os.path.basename(inpfn)
-pages = PdfReader(inpfn).pages
+pages = PdfReader(inpfn, decompress=True).pages
canvas = Canvas(outfn, pageCompression=0)
for page in pages:
diff --git a/examples/rl2/decodegraphics.py b/examples/rl2/decodegraphics.py
index 9fa5a05..e2f3a9f 100644
--- a/examples/rl2/decodegraphics.py
+++ b/examples/rl2/decodegraphics.py
@@ -1,4 +1,4 @@
-# A part of pdfrw (pdfrw.googlecode.com)
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
@@ -13,13 +13,13 @@ Better to use Form XObjects for most things (see the example in rl1).
'''
from inspect import getargspec
-import find_pdfrw
from pdfrw import PdfTokens
-from pdfrw.pdfobjects import PdfString
+from pdfrw.objects import PdfString
#############################################################################
# Graphics parsing
+
def parse_array(self, token='[', params=None):
mylist = []
for token in self.tokens:
@@ -28,105 +28,134 @@ def parse_array(self, token='[', params=None):
mylist.append(token)
self.params.append(mylist)
+
def parse_savestate(self, token='q', params=''):
self.canv.saveState()
+
def parse_restorestate(self, token='Q', params=''):
self.canv.restoreState()
+
def parse_transform(self, token='cm', params='ffffff'):
self.canv.transform(*params)
+
def parse_linewidth(self, token='w', params='f'):
self.canv.setLineWidth(*params)
+
def parse_linecap(self, token='J', params='i'):
self.canv.setLineCap(*params)
+
def parse_linejoin(self, token='j', params='i'):
self.canv.setLineJoin(*params)
+
def parse_miterlimit(self, token='M', params='f'):
self.canv.setMiterLimit(*params)
+
def parse_dash(self, token='d', params='as'): # Array, string
self.canv.setDash(*params)
+
def parse_intent(self, token='ri', params='n'):
# TODO: add logging
pass
+
def parse_flatness(self, token='i', params='i'):
# TODO: add logging
pass
+
def parse_gstate(self, token='gs', params='n'):
# TODO: add logging
# Could parse stuff we care about from here later
pass
+
def parse_move(self, token='m', params='ff'):
if self.gpath is None:
self.gpath = self.canv.beginPath()
self.gpath.moveTo(*params)
self.current_point = params
+
def parse_line(self, token='l', params='ff'):
self.gpath.lineTo(*params)
self.current_point = params
+
def parse_curve(self, token='c', params='ffffff'):
self.gpath.curveTo(*params)
self.current_point = params[-2:]
+
def parse_curve1(self, token='v', params='ffff'):
parse_curve(self, token, tuple(self.current_point) + tuple(params))
+
def parse_curve2(self, token='y', params='ffff'):
parse_curve(self, token, tuple(params) + tuple(params[-2:]))
+
def parse_close(self, token='h', params=''):
self.gpath.close()
+
def parse_rect(self, token='re', params='ffff'):
if self.gpath is None:
self.gpath = self.canv.beginPath()
self.gpath.rect(*params)
self.current_point = params[-2:]
+
def parse_stroke(self, token='S', params=''):
finish_path(self, 1, 0, 0)
+
def parse_close_stroke(self, token='s', params=''):
self.gpath.close()
finish_path(self, 1, 0, 0)
+
def parse_fill(self, token='f', params=''):
finish_path(self, 0, 1, 1)
+
def parse_fill_compat(self, token='F', params=''):
finish_path(self, 0, 1, 1)
+
def parse_fill_even_odd(self, token='f*', params=''):
finish_path(self, 0, 1, 0)
+
def parse_fill_stroke_even_odd(self, token='B*', params=''):
finish_path(self, 1, 1, 0)
+
def parse_fill_stroke(self, token='B', params=''):
finish_path(self, 1, 1, 1)
+
def parse_close_fill_stroke_even_odd(self, token='b*', params=''):
self.gpath.close()
finish_path(self, 1, 1, 0)
+
def parse_close_fill_stroke(self, token='b', params=''):
self.gpath.close()
finish_path(self, 1, 1, 1)
+
def parse_nop(self, token='n', params=''):
finish_path(self, 0, 0, 0)
+
def finish_path(self, stroke, fill, fillmode):
if self.gpath is not None:
canv = self.canv
@@ -135,39 +164,49 @@ def finish_path(self, stroke, fill, fillmode):
canv._fillMode = oldmode
self.gpath = None
+
def parse_clip_path(self, token='W', params=''):
# TODO: add logging
pass
+
def parse_clip_path_even_odd(self, token='W*', params=''):
# TODO: add logging
pass
+
def parse_stroke_gray(self, token='G', params='f'):
self.canv.setStrokeGray(*params)
+
def parse_fill_gray(self, token='g', params='f'):
self.canv.setFillGray(*params)
+
def parse_stroke_rgb(self, token='RG', params='fff'):
self.canv.setStrokeColorRGB(*params)
+
def parse_fill_rgb(self, token='rg', params='fff'):
self.canv.setFillColorRGB(*params)
+
def parse_stroke_cmyk(self, token='K', params='ffff'):
self.canv.setStrokeColorCMYK(*params)
+
def parse_fill_cmyk(self, token='k', params='ffff'):
self.canv.setFillColorCMYK(*params)
#############################################################################
# Text parsing
+
def parse_begin_text(self, token='BT', params=''):
assert self.tpath is None
self.tpath = self.canv.beginText()
+
def parse_text_transform(self, token='Tm', params='ffffff'):
path = self.tpath
@@ -177,20 +216,23 @@ def parse_text_transform(self, token='Tm', params='ffffff'):
except AttributeError:
pass
else:
- if code[-1] == '1 0 0 1 0 0 Tm':
+ if code[-1] == '1 0 0 1 0 0 Tm':
code.pop()
path.setTextTransform(*params)
+
def parse_setfont(self, token='Tf', params='nf'):
fontinfo = self.fontdict[params[0]]
self.tpath._setFont(fontinfo.name, params[1])
self.curfont = fontinfo
+
def parse_text_out(self, token='Tj', params='t'):
text = params[0].decode(self.curfont.remap, self.curfont.twobyte)
self.tpath.textOut(text)
+
def parse_TJ(self, token='TJ', params='a'):
remap = self.curfont.remap
twobyte = self.curfont.twobyte
@@ -204,41 +246,52 @@ def parse_TJ(self, token='TJ', params='a'):
text = ''.join(result)
self.tpath.textOut(text)
+
def parse_end_text(self, token='ET', params=''):
assert self.tpath is not None
self.canv.drawText(self.tpath)
- self.tpath=None
+ self.tpath = None
+
def parse_move_cursor(self, token='Td', params='ff'):
self.tpath.moveCursor(params[0], -params[1])
+
def parse_set_leading(self, token='TL', params='f'):
self.tpath.setLeading(*params)
+
def parse_text_line(self, token='T*', params=''):
self.tpath.textLine()
+
def parse_set_char_space(self, token='Tc', params='f'):
self.tpath.setCharSpace(*params)
+
def parse_set_word_space(self, token='Tw', params='f'):
self.tpath.setWordSpace(*params)
+
def parse_set_hscale(self, token='Tz', params='f'):
self.tpath.setHorizScale(params[0] - 100)
+
def parse_set_rise(self, token='Ts', params='f'):
self.tpath.setRise(*params)
+
def parse_xobject(self, token='Do', params='n'):
# TODO: Need to do this
pass
+
class FontInfo(object):
''' Pretty basic -- needs a lot of work to work right for all fonts
'''
lookup = {
- 'BitstreamVeraSans' : 'Helvetica', # WRONG -- have to learn about font stuff...
+ # WRONG -- have to learn about font stuff...
+ 'BitstreamVeraSans': 'Helvetica',
}
def __init__(self, source):
@@ -254,16 +307,19 @@ class FontInfo(object):
assert not len(info) & 1
info2 = []
for x in info:
- assert x[0] == '<' and x[-1] == '>' and len(x) in (4,6), x
+ assert x[0] == '<' and x[-1] == '>' and len(x) in (4, 6), x
i = int(x[1:-1], 16)
info2.append(i)
- self.remap = dict((x,chr(y)) for (x,y) in zip(info2[::2], info2[1::2])).get
+ self.remap = dict((x, chr(y)) for (x, y) in
+ zip(info2[::2], info2[1::2])).get
self.twobyte = len(info[0]) > 4
#############################################################################
# Control structures
+
def findparsefuncs():
+
def checkname(n):
assert n.startswith('/')
return n
@@ -276,8 +332,10 @@ def findparsefuncs():
assert isinstance(t, PdfString)
return t
- fixparam = dict(f=float, i=int, n=checkname, a=checkarray, s=str, t=checktext)
+ fixparam = dict(f=float, i=int, n=checkname, a=checkarray,
+ s=str, t=checktext)
fixcache = {}
+
def fixlist(params):
try:
result = fixcache[params]
@@ -288,12 +346,12 @@ def findparsefuncs():
dispatch = {}
expected_args = 'self token params'.split()
- for key, func in globals().iteritems():
+ for key, func in globals().items():
if key.startswith('parse_'):
args, varargs, keywords, defaults = getargspec(func)
- assert args == expected_args and varargs is None \
- and keywords is None and len(defaults) == 2, \
- (key, args, varargs, keywords, defaults)
+ assert (args == expected_args and varargs is None and
+ keywords is None and len(defaults) == 2), (
+ key, args, varargs, keywords, defaults)
token, params = defaults
if params is not None:
params = fixlist(params)
@@ -301,6 +359,7 @@ def findparsefuncs():
assert dispatch.setdefault(token, value) is value, repr(token)
return dispatch
+
class _ParseClass(object):
dispatch = findparsefuncs()
@@ -309,14 +368,16 @@ class _ParseClass(object):
self = cls()
contents = page.Contents
if contents.Filter is not None:
- raise SystemExit('Cannot parse graphics -- page encoded with %s' % contents.Filter)
+ raise SystemExit('Cannot parse graphics -- page encoded with %s'
+ % contents.Filter)
dispatch = cls.dispatch.get
self.tokens = tokens = iter(PdfTokens(contents.stream))
self.params = params = []
self.canv = canvas
self.gpath = None
self.tpath = None
- self.fontdict = dict((x,FontInfo(y)) for (x, y) in page.Resources.Font.iteritems())
+ self.fontdict = dict((x, FontInfo(y)) for
+ (x, y) in page.Resources.Font.iteritems())
for token in self.tokens:
info = dispatch(token)
@@ -330,35 +391,40 @@ class _ParseClass(object):
delta = len(params) - len(paraminfo)
if delta:
if delta < 0:
- print 'Operator %s expected %s parameters, got %s' % (token, len(paraminfo), params)
+ print ('Operator %s expected %s parameters, got %s' %
+ (token, len(paraminfo), params))
params[:] = []
continue
else:
- print "Unparsed parameters/commands:", params[:delta]
+ print ("Unparsed parameters/commands: %s" % params[:delta])
del params[:delta]
paraminfo = zip(paraminfo, params)
try:
- params[:] = [x(y) for (x,y) in paraminfo]
+ params[:] = [x(y) for (x, y) in paraminfo]
except:
- for i, (x,y) in enumerate(paraminfo):
+ for i, (x, y) in enumerate(paraminfo):
try:
x(y)
except:
- raise # For now
+ raise # For now
continue
func(self, token, params)
params[:] = []
-def debugparser(undisturbed = set('parse_array'.split())):
+
+def debugparser(undisturbed=set('parse_array'.split())):
def debugdispatch():
def getvalue(oldval):
name = oldval[0].__name__
+
def myfunc(self, token, params):
- print '%s called %s(%s)' % (token, name, ', '.join(str(x) for x in params))
+ print ('%s called %s(%s)' % (token, name,
+ ', '.join(str(x) for x in params)))
if name in undisturbed:
myfunc = oldval[0]
return myfunc, oldval[1]
- return dict((x, getvalue(y)) for (x,y) in _ParseClass.dispatch.iteritems())
+ return dict((x, getvalue(y))
+ for (x, y) in _ParseClass.dispatch.iteritems())
class _DebugParse(_ParseClass):
dispatch = debugdispatch()
@@ -374,5 +440,5 @@ if __name__ == '__main__':
fname, = sys.argv[1:]
pdf = PdfReader(fname)
for i, page in enumerate(pdf.pages):
- print '\nPage %s ------------------------------------' % i
+ print ('\nPage %s ------------------------------------' % i)
parse(page)
diff --git a/examples/rl2/find_pdfrw.py b/examples/rl2/find_pdfrw.py
deleted file mode 100644
index f69d412..0000000
--- a/examples/rl2/find_pdfrw.py
+++ /dev/null
@@ -1,33 +0,0 @@
-'''
- find_xxx.py -- Find the place in the tree where xxx lives.
-
- Ways to use:
- 1) Make a copy, change 'xxx' in package to be your name; or
- 2) Under Linux, just ln -s to where this is in the right tree
-
- Created by Pat Maupin, who doesn't consider it big enough to be worth copyrighting
-'''
-
-import sys
-import os
-
-myname = __name__[5:] # remove 'find_'
-myname = os.path.join(myname, '__init__.py')
-
-def trypath(newpath):
- path = None
- while path != newpath:
- path = newpath
- if os.path.exists(os.path.join(path, myname)):
- return path
- newpath = os.path.dirname(path)
-
-root = trypath(__file__) or trypath(os.path.realpath(__file__))
-
-if root is None:
- print
- print 'Warning: %s: Could not find path to development package %s' % (__file__, myname)
- print ' The import will either fail or will use system-installed libraries'
- print
-elif root not in sys.path:
- sys.path.append(root)
diff --git a/examples/rotate.py b/examples/rotate.py
index 4277940..8b10d05 100755
--- a/examples/rotate.py
+++ b/examples/rotate.py
@@ -13,7 +13,6 @@ Creates rotate.my.pdf with selected pages rotated. Rotates all by default.
import sys
import os
-import find_pdfrw
from pdfrw import PdfReader, PdfWriter
inpfn = sys.argv[1]
@@ -34,7 +33,8 @@ if not ranges:
for onerange in ranges:
onerange = (onerange + onerange[-1:])[:2]
for pagenum in range(onerange[0]-1, onerange[1]):
- pages[pagenum].Rotate = (int(pages[pagenum].inheritable.Rotate or 0) + rotate) % 360
+ pages[pagenum].Rotate = (int(pages[pagenum].inheritable.Rotate or
+ 0) + rotate) % 360
outdata = PdfWriter()
outdata.trailer = trailer
diff --git a/examples/subset.py b/examples/subset.py
index e7f8ec6..30a577a 100755
--- a/examples/subset.py
+++ b/examples/subset.py
@@ -11,7 +11,6 @@ Creates subset.my.pdf
import sys
import os
-import find_pdfrw
from pdfrw import PdfReader, PdfWriter
inpfn = sys.argv[1]
diff --git a/examples/unspread.py b/examples/unspread.py
new file mode 100755
index 0000000..4b3bc5d
--- /dev/null
+++ b/examples/unspread.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+
+'''
+usage: unspread.py my.pdf
+
+Creates unspread.my.pdf
+
+Chops each page in half, e.g. if a source were
+created in booklet form, you could extract individual
+pages.
+'''
+
+import sys
+import os
+
+from pdfrw import PdfReader, PdfWriter, PageMerge
+
+
+def splitpage(src):
+ ''' Split a page into two (left and right)
+ '''
+ # Yield a result for each half of the page
+ for x_pos in (0, 0.5):
+ yield PageMerge().add(src, viewrect=(x_pos, 0, 0.5, 1)).render()
+
+
+inpfn, = sys.argv[1:]
+outfn = 'unspread.' + os.path.basename(inpfn)
+writer = PdfWriter()
+for page in PdfReader(inpfn).pages:
+ writer.addpages(splitpage(page))
+writer.write(outfn)
diff --git a/examples/watermark.py b/examples/watermark.py
index a4d933c..96b686b 100755
--- a/examples/watermark.py
+++ b/examples/watermark.py
@@ -3,112 +3,31 @@
'''
Simple example of watermarking using form xobjects (pdfrw).
-usage: watermark.py my.pdf single_page.pdf
+usage: watermark.py [-u] my.pdf single_page.pdf
Creates watermark.my.pdf, with every page overlaid with
-first page from single_page.pdf
+first page from single_page.pdf. If -u is selected, watermark
+will be placed underneath page (painted first).
+
+NB: At one point, this example was extremely complicated, with
+ multiple options. That only led to errors in implementation,
+ so it has been re-simplified in order to show basic principles
+ of the library operation and to match the other examples better.
'''
import sys
import os
-import find_pdfrw
-from pdfrw import PdfReader, PdfWriter, PdfDict, PdfName, IndirectPdfDict, PdfArray
-from pdfrw.buildxobj import pagexobj
-
-def fixpage(page, watermark):
-
- # Find the page's resource dictionary. Create if none
- resources = page.inheritable.Resources
- if resources is None:
- resources = page.Resources = PdfDict()
-
- # Find or create the parent's xobject dictionary
- xobjdict = resources.XObject
- if xobjdict is None:
- xobjdict = resources.XObject = PdfDict()
-
- # Allow for an infinite number of cascaded watermarks
- index = 0
- while 1:
- watermark_name = '/Watermark.%d' % index
- if watermark_name not in xobjdict:
- break
- index += 1
- xobjdict[watermark_name] = watermark
-
- # Turn the contents into an array if it is not already one
- contents = page.Contents
- if not isinstance(contents, PdfArray):
- contents = page.Contents = PdfArray([contents])
-
- # Save initial state before executing page
- contents.insert(0, IndirectPdfDict(stream='q\n'))
-
- # Restore initial state and append the watermark
- contents.append(IndirectPdfDict(stream='Q %s Do\n' % watermark_name))
- return page
-
-def watermark(input_fname, watermark_fname, output_fname=None):
- outfn = output_fname or ('watermark.' + os.path.basename(input_fname))
- w = pagexobj(PdfReader(watermark_fname).pages[0])
- pages = PdfReader(input_fname).pages
- PdfWriter().addpages([fixpage(x, w) for x in pages]).write(outfn)
- return outfn
-
-def fix_pdf(fname, watermark_fname, indir, outdir):
- from os import mkdir, path
- if not path.exists(outdir):
- mkdir(outdir)
- watermark = pagexobj(PdfReader(watermark_fname).pages[0])
- trailer = PdfReader(path.join(indir, fname))
- for page in trailer.pages:
- fixpage(page, watermark)
- PdfWriter().write(path.join(outdir, fname), trailer)
- return len(trailer.pages)
-
-def batch_watermark(pdfdir, watermark_fname, outputdir='tmp'):
- import traceback
- from glob import glob
- from os import path
- fnames=glob(pdfdir+"/*.pdf")
- total_pages = 0
- good_files = 0
-
- for fname in fnames:
- fname = fname.replace(pdfdir+'/','')
- try:
- total_pages += fix_pdf(fname, watermark_fname, pdfdir, outputdir)
- good_files += 1
- print "%s OK" %fname
- except Exception:
- print "%s Failed miserably" %fname
- print traceback.format_exc()[:2000]
- #raise
-
- print "success %.2f%% %s pages" %((float(good_files)/len(fnames))*100, total_pages)
-
-if __name__ == "__main__":
-
- from optparse import OptionParser
- parser = OptionParser(description = __doc__)
- parser.add_option('-i', dest='input_fname', help='file name to be watermarked (pdf)')
- parser.add_option('-w', dest='watermark_fname', help='watermark file name (pdf)')
- parser.add_option('-d', dest='pdfdir', help='watermark all pdf files in this directory')
- parser.add_option('-o', dest='outdir', help='outputdir used with option -d', default='tmp')
- options, args = parser.parse_args()
-
- if options.input_fname and options.watermark_fname:
- watermark = pagexobj(PdfReader(options.watermark_fname).pages[0])
- outfn = 'watermark.' + os.path.basename(options.input_fname)
- pages = PdfReader(options.input_fname).pages
-
- PdfWriter().addpages([fixpage(x, watermark) for x in pages]).write(outfn)
-
- elif options.pdfdir and options.watermark_fname:
- batch_watermark(options.pdfdir, options.watermark_fname, options.outdir)
-
- else:
- parser.print_help()
-
- \ No newline at end of file
+from pdfrw import PdfReader, PdfWriter, PageMerge
+
+argv = sys.argv[1:]
+underneath = '-u' in argv
+if underneath:
+ del argv[argv.index('-u')]
+inpfn, wmarkfn = argv
+outfn = 'watermark.' + os.path.basename(inpfn)
+wmark = PageMerge().add(PdfReader(wmarkfn).pages[0])[0]
+trailer = PdfReader(inpfn)
+for page in trailer.pages:
+ PageMerge(page).add(wmark, prepend=underneath).render()
+PdfWriter().write(outfn, trailer)
diff --git a/pdfrw/__init__.py b/pdfrw/__init__.py
index 3ca61d7..a36a8cb 100644
--- a/pdfrw/__init__.py
+++ b/pdfrw/__init__.py
@@ -1,16 +1,22 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
-__version__ = '0.1'
+from .pdfwriter import PdfWriter
+from .pdfreader import PdfReader
+from .objects import (PdfObject, PdfName, PdfArray,
+ PdfDict, IndirectPdfDict, PdfString)
+from .tokens import PdfTokens
+from .errors import PdfParseError
+from .pagemerge import PageMerge
-from pdfrw.pdfwriter import PdfWriter
-from pdfrw.pdfreader import PdfReader
-from pdfrw.objects import PdfObject, PdfName, PdfArray, PdfDict, IndirectPdfDict, PdfString
-from pdfrw.tokens import PdfTokens
-from pdfrw.errors import PdfParseError
+__version__ = '0.2'
# Add a tiny bit of compatibility to pyPdf
PdfFileReader = PdfReader
PdfFileWriter = PdfWriter
+
+__all__ = [PdfWriter, PdfReader, PdfObject, PdfName, PdfArray,
+ PdfTokens, PdfParseError, PdfDict, IndirectPdfDict,
+ PdfString, PageMerge]
diff --git a/pdfrw/buildxobj.py b/pdfrw/buildxobj.py
index ba34f61..d210c67 100644
--- a/pdfrw/buildxobj.py
+++ b/pdfrw/buildxobj.py
@@ -1,5 +1,5 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -28,26 +28,52 @@ Reference for content: Adobe PDF reference, sixth edition, version 1.7
Form xobjects discussed chapter 4.9, page 355
'''
-from pdfrw.objects import PdfDict, PdfArray, PdfName
-from pdfrw.pdfreader import PdfReader
-from pdfrw.errors import log
+from .objects import PdfDict, PdfArray, PdfName
+from .pdfreader import PdfReader
+from .errors import log, PdfNotImplementedError
+from .py23_diffs import iteritems
+
class ViewInfo(object):
''' Instantiate ViewInfo with a uri, and it will parse out
the filename, page, and viewrect into object attributes.
+
+ Note 1:
+ Viewrects follow the adobe definition. (See reference
+ above). They are arrays of 4 numbers:
+
+ - Distance from left of document in points
+ - Distance from top (NOT bottom) of document in points
+ - Width of rectangle in points
+ - Height of rectangle in points
+
+ Note 2:
+ For simplicity, Viewrects can also be specified
+ in fractions of the document. If every number in
+ the viewrect is between 0 and 1 inclusive, then
+ viewrect elements 0 and 2 are multiplied by the
+ mediabox width before use, and viewrect elements
+ 1 and 3 are multiplied by the mediabox height before
+ use.
+
+ Note 3:
+ By default, an XObject based on the view will be
+ cacheable. It should not be cacheable if the XObject
+ will be subsequently modified.
'''
doc = None
docname = None
page = None
viewrect = None
rotate = None
+ cacheable = True
def __init__(self, pageinfo='', **kw):
- pageinfo=pageinfo.split('#',1)
+ pageinfo = pageinfo.split('#', 1)
if len(pageinfo) == 2:
pageinfo[1:] = pageinfo[1].replace('&', '#').split('#')
for key in 'page viewrect'.split():
- if pageinfo[0].startswith(key+'='):
+ if pageinfo[0].startswith(key + '='):
break
else:
self.docname = pageinfo.pop(0)
@@ -63,10 +89,11 @@ class ViewInfo(object):
setattr(self, key, [float(x) for x in value])
else:
log.error('Unknown option: %s', key)
- for key, value in kw.iteritems():
+ for key, value in iteritems(kw):
assert hasattr(self, key), key
setattr(self, key, value)
+
def get_rotation(rotate):
''' Return clockwise rotation code:
0 = unrotated
@@ -80,10 +107,11 @@ def get_rotation(rotate):
return 0
if rotate % 90 != 0:
return 0
- return rotate / 90
+ return rotate // 90
+
def rotate_point(point, rotation):
- ''' Rotate an (x,y) coordinate clockwise by a
+ ''' Rotate an (x,y) coordinate clockwise by a
rotation code specifying a multiple of 90 degrees.
'''
if rotation & 1:
@@ -92,6 +120,7 @@ def rotate_point(point, rotation):
point = -point[0], -point[1]
return point
+
def rotate_rect(rect, rotation):
''' Rotate both points within the rectangle, then normalize
the rectangle by returning the new lower left, then new
@@ -101,68 +130,133 @@ def rotate_rect(rect, rotation):
return (min(rect[0], rect[2]), min(rect[1], rect[3]),
max(rect[0], rect[2]), max(rect[1], rect[3]))
+
def getrects(inheritable, pageinfo, rotation):
''' Given the inheritable attributes of a page and
the desired pageinfo rectangle, return the page's
media box and the calculated boundary (clip) box.
'''
mbox = tuple([float(x) for x in inheritable.MediaBox])
+ cbox = tuple([float(x) for x in (inheritable.CropBox or mbox)])
vrect = pageinfo.viewrect
- if vrect is None:
- cbox = tuple([float(x) for x in (inheritable.CropBox or mbox)])
- else:
+ if vrect is not None:
# Rotate the media box to match what the user sees,
# figure out the clipping box, then rotate back
- mleft, mbot, mright, mtop = rotate_rect(mbox, rotation)
+ mleft, mbot, mright, mtop = rotate_rect(cbox, rotation)
x, y, w, h = vrect
+
+ # Support operations in fractions of a page
+ if 0 <= min(vrect) < max(vrect) <= 1:
+ mw = mright - mleft
+ mh = mtop - mbot
+ x *= mw
+ w *= mw
+ y *= mh
+ h *= mh
+
cleft = mleft + x
ctop = mtop - y
cright = cleft + w
cbot = ctop - h
- cbox = max(mleft, cleft), max(mbot, cbot), min(mright, cright), min(mtop, ctop)
+ cbox = (max(mleft, cleft), max(mbot, cbot),
+ min(mright, cright), min(mtop, ctop))
cbox = rotate_rect(cbox, -rotation)
return mbox, cbox
-def _cache_xobj(contents, resources, mbox, bbox, rotation):
+def _build_cache(contents, allow_compressed):
+ ''' Build a new dictionary holding the stream,
+ and save it along with private cache info.
+ Assumes validity has been pre-checked if
+ we have a non-None xobj_copy.
+ '''
+ try:
+ xobj_copy = contents.xobj_copy
+ except AttributeError:
+ # Should have a PdfArray here...
+ array = contents
+ private = contents
+ else:
+ # Should have a PdfDict here -- might or might not have cache copy
+ if xobj_copy is not None:
+ return xobj_copy
+ array = [contents]
+ private = contents.private
+
+ # The spec says nothing about nested arrays. Will
+ # assume that's not a problem until we encounter them...
+
+ xobj_copy = PdfDict(array[0])
+ xobj_copy.private.xobj_cachedict = {}
+ private.xobj_copy = xobj_copy
+
+ if len(array) > 1:
+ newstream = '\n'.join(x.stream for x in array)
+ newlength = sum(int(x.Length) for x in array) + len(array) - 1
+ assert newlength == len(newstream)
+ xobj_copy.stream = newstream
+
+ # Cannot currently cope with different kinds of
+ # compression in the array, so just disallow it.
+ allow_compressed = False
+
+ if not allow_compressed:
+ # Make sure there are no compression parameters
+ for cdict in array:
+ keys = [x[0] for x in iteritems(cdict)]
+ if len(keys) != 1:
+ raise PdfNotImplementedError(
+ 'Xobjects with compression parameters not supported: %s' %
+ keys)
+ return xobj_copy
+
+
+def _cache_xobj(contents, resources, mbox, bbox, rotation, cacheable=True):
''' Return a cached Form XObject, or create a new one and cache it.
Adds private members x, y, w, h
'''
cachedict = contents.xobj_cachedict
- if cachedict is None:
- cachedict = contents.private.xobj_cachedict = {}
cachekey = mbox, bbox, rotation
- result = cachedict.get(cachekey)
+ result = cachedict.get(cachekey) if cacheable else None
if result is None:
- func = (_get_fullpage, _get_subpage)[mbox != bbox]
+ # If we are not getting a full page, or if we are going to
+ # modify the results, first retrieve an underlying Form XObject
+ # that represents the entire page, so that we are not copying
+ # the full page data into the new file multiple times
+ func = (_get_fullpage, _get_subpage)[mbox != bbox or not cacheable]
result = PdfDict(
- func(contents, resources, mbox, bbox, rotation),
- Type = PdfName.XObject,
- Subtype = PdfName.Form,
- FormType = 1,
- BBox = PdfArray(bbox),
+ func(contents, resources, mbox),
+ Type=PdfName.XObject,
+ Subtype=PdfName.Form,
+ FormType=1,
+ BBox=PdfArray(bbox),
)
rect = bbox
if rotation:
- matrix = rotate_point((1, 0), rotation) + rotate_point((0, 1), rotation)
+ matrix = (rotate_point((1, 0), rotation) +
+ rotate_point((0, 1), rotation))
result.Matrix = PdfArray(matrix + (0, 0))
rect = rotate_rect(rect, rotation)
- result.private.x = rect[0]
- result.private.y = rect[1]
- result.private.w = rect[2] - rect[0]
- result.private.h = rect[3] - rect[1]
- cachedict[cachekey] = result
+ private = result.private
+ private.x = rect[0]
+ private.y = rect[1]
+ private.w = rect[2] - rect[0]
+ private.h = rect[3] - rect[1]
+ if cacheable:
+ cachedict[cachekey] = result
return result
-def _get_fullpage(contents, resources, mbox, bbox, rotation):
+
+def _get_fullpage(contents, resources, mbox):
''' fullpage is easy. Just copy the contents,
set up the resources, and let _cache_xobj handle the
rest.
'''
return PdfDict(contents, Resources=resources)
-def _get_subpage(contents, resources, mbox, bbox, rotation):
+
+def _get_subpage(contents, resources, mbox):
''' subpages *could* be as easy as full pages, but we
choose to complicate life by creating a Form XObject
for the page, and then one that references it for
@@ -170,37 +264,44 @@ def _get_subpage(contents, resources, mbox, bbox, rotation):
items from the page.
'''
return PdfDict(
- stream = '/FullPage Do\n',
- Resources = PdfDict(
- XObject = PdfDict(
- FullPage = _cache_xobj(contents, resources, mbox, mbox, 0)
+ stream='/FullPage Do\n',
+ Resources=PdfDict(
+ XObject=PdfDict(
+ FullPage=_cache_xobj(contents, resources, mbox, mbox, 0)
)
)
)
+
def pagexobj(page, viewinfo=ViewInfo(), allow_compressed=True):
''' pagexobj creates and returns a Form XObject for
a given view within a page (Defaults to entire page.)
+
+ pagexobj is passed a page and a viewrect.
'''
inheritable = page.inheritable
resources = inheritable.Resources
rotation = get_rotation(inheritable.Rotate)
mbox, bbox = getrects(inheritable, viewinfo, rotation)
rotation += get_rotation(viewinfo.rotate)
- contents = page.Contents
- # Make sure the only attribute is length
- # All the filters must have been executed
- assert int(contents.Length) == len(contents.stream)
- if not allow_compressed:
- assert len([x for x in contents.iteritems()]) == 1
- return _cache_xobj(contents, resources, mbox, bbox, rotation)
-
+ contents = _build_cache(page.Contents, allow_compressed)
+ return _cache_xobj(contents, resources, mbox, bbox, rotation,
+ viewinfo.cacheable)
def docxobj(pageinfo, doc=None, allow_compressed=True):
- ''' docxobj creates and returns an actual Form XObject.
+ ''' docinfo reads a page out of a document and uses
+ pagexobj to create the Form XObject based on
+ the page.
+
+ This is a convenience function for things like
+ rst2pdf that want to be able to pass in textual
+ filename/location descriptors and don't want to
+ know about using PdfReader.
+
Can work standalone, or in conjunction with
the CacheXObj class (below).
+
'''
if not isinstance(pageinfo, ViewInfo):
pageinfo = ViewInfo(pageinfo)
@@ -215,7 +316,8 @@ def docxobj(pageinfo, doc=None, allow_compressed=True):
elif pageinfo.doc is not None:
doc = pageinfo.doc
else:
- doc = pageinfo.doc = PdfReader(pageinfo.docname, decompress = not allow_compressed)
+ doc = pageinfo.doc = PdfReader(pageinfo.docname,
+ decompress=not allow_compressed)
assert isinstance(doc, PdfReader)
sourcepage = doc.pages[(pageinfo.page or 1) - 1]
@@ -227,6 +329,11 @@ class CacheXObj(object):
and to keep from making the output too much
bigger than it ought to be by replicating
unnecessary object copies.
+
+ This is a convenience function for things like
+ rst2pdf that want to be able to pass in textual
+ filename/location descriptors and don't want to
+ know about using PdfReader.
'''
def __init__(self, decompress=False):
''' Set decompress true if you need
diff --git a/pdfrw/compress.py b/pdfrw/compress.py
index e2b16c5..0479131 100644
--- a/pdfrw/compress.py
+++ b/pdfrw/compress.py
@@ -1,5 +1,5 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -7,10 +7,11 @@ Currently, this sad little file only knows how to decompress
using the flate (zlib) algorithm. Maybe more later, but it's
not a priority for me...
'''
-import zlib
-from pdfrw.objects import PdfDict, PdfName
-from pdfrw.errors import log
-from pdfrw.uncompress import streamobjects
+
+from .objects import PdfName
+from .uncompress import streamobjects
+from .py23_diffs import zlib
+
def compress(mylist):
flate = PdfName.FlateDecode
diff --git a/pdfrw/errors.py b/pdfrw/errors.py
index 4759656..263cd4d 100644
--- a/pdfrw/errors.py
+++ b/pdfrw/errors.py
@@ -1,5 +1,5 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -7,25 +7,32 @@ PDF Exceptions and error handling
'''
import logging
-from exceptions import Exception
logging.basicConfig(
format='[%(levelname)s] %(filename)s:%(lineno)d %(message)s',
- level=logging.WARNING)
+ level=logging.WARNING)
log = logging.getLogger('pdfrw')
class PdfError(Exception):
"Abstract base class of exceptions thrown by this module"
+
def __init__(self, msg):
self.msg = msg
+
def __str__(self):
return self.msg
+
class PdfParseError(PdfError):
"Error thrown by parser/tokenizer"
+
class PdfOutputError(PdfError):
"Error thrown by PDF writer"
+
+
+class PdfNotImplementedError(PdfError):
+ "Error thrown on missing features"
diff --git a/pdfrw/findobjs.py b/pdfrw/findobjs.py
new file mode 100644
index 0000000..f19ebdf
--- /dev/null
+++ b/pdfrw/findobjs.py
@@ -0,0 +1,138 @@
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2015 Patrick Maupin, Austin, Texas
+# MIT license -- See LICENSE.txt for details
+
+''' This module contains a function to find all the XObjects
+ in a document, and another function that will wrap them
+ in page objects.
+'''
+
+from .objects import PdfDict, PdfArray, PdfName
+from .pdfwriter import user_fmt
+
+
+def find_objects(source, valid_types=(PdfName.XObject, None),
+ valid_subtypes=(PdfName.Form, PdfName.Image),
+ no_follow=(PdfName.Parent,),
+ isinstance=isinstance, id=id, sorted=sorted,
+ reversed=reversed, PdfDict=PdfDict):
+ '''
+ Find all the objects of a particular kind in a document
+ or array. Defaults to looking for Form and Image XObjects.
+
+ This could be done recursively, but some PDFs
+ are quite deeply nested, so we do it without
+ recursion.
+
+ Note that we don't know exactly where things appear on pages,
+ but we aim for a sort order that is (a) mostly in document order,
+ and (b) reproducible. For arrays, objects are processed in
+ array order, and for dicts, they are processed in key order.
+ '''
+ container = (PdfDict, PdfArray)
+
+ # Allow passing a list of pages, or a dict
+ if isinstance(source, PdfDict):
+ source = [source]
+ else:
+ source = list(source)
+
+ visited = set()
+ source.reverse()
+ while source:
+ obj = source.pop()
+ if not isinstance(obj, container):
+ continue
+ myid = id(obj)
+ if myid in visited:
+ continue
+ visited.add(myid)
+ if isinstance(obj, PdfDict):
+ if obj.Type in valid_types and obj.Subtype in valid_subtypes:
+ yield obj
+ obj = [y for (x, y) in sorted(obj.iteritems())
+ if x not in no_follow]
+ else:
+ # TODO: This forces resolution of any indirect objects in
+ # the array. It may not be necessary. Don't know if
+ # reversed() does any voodoo underneath the hood.
+ # It's cheap enough for now, but might be removeable.
+ obj and obj[0]
+ source.extend(reversed(obj))
+
+
+def wrap_object(obj, width, margin):
+ ''' Wrap an xobj in its own page object.
+ '''
+ fmt = 'q %s 0 0 %s %s %s cm /MyImage Do Q'
+ contents = PdfDict(indirect=True)
+ subtype = obj.Subtype
+ if subtype == PdfName.Form:
+ contents._stream = obj.stream
+ contents.Length = obj.Length
+ contents.Filter = obj.Filter
+ contents.DecodeParms = obj.DecodeParms
+ resources = obj.Resources
+ mbox = obj.BBox
+ elif subtype == PdfName.Image: # Image
+ xoffset = margin[0]
+ yoffset = margin[1]
+ cw = width - margin[0] - margin[2]
+ iw, ih = float(obj.Width), float(obj.Height)
+ ch = 1.0 * cw / iw * ih
+ height = ch + margin[1] + margin[3]
+ p = tuple(user_fmt(x) for x in (cw, ch, xoffset, yoffset))
+ contents.stream = fmt % p
+ resources = PdfDict(XObject=PdfDict(MyImage=obj))
+ mbox = PdfArray((0, 0, width, height))
+ else:
+ raise TypeError("Expected Form or Image XObject")
+
+ return PdfDict(
+ indirect=True,
+ Type=PdfName.Page,
+ MediaBox=mbox,
+ Resources=resources,
+ Contents=contents,
+ )
+
+
+def trivial_xobjs(maxignore=300):
+ ''' Ignore XObjects that trivially contain other XObjects.
+ '''
+ ignore = set('q Q cm Do'.split())
+ Image = PdfName.Image
+
+ def check(obj):
+ if obj.Subtype == Image:
+ return False
+ s = obj.stream
+ if len(s) < maxignore:
+ s = (x for x in s.split() if not x.startswith('/') and
+ x not in ignore)
+ s = (x.replace('.', '').replace('-', '') for x in s)
+ if not [x for x in s if not x.isdigit()]:
+ return True
+ return check
+
+
+def page_per_xobj(xobj_iter, width=8.5 * 72, margin=0.0 * 72,
+ image_only=False, ignore=trivial_xobjs(),
+ wrap_object=wrap_object):
+ ''' page_per_xobj wraps every XObj found
+ in its own page object.
+ width and margin are used to set image sizes.
+ '''
+ try:
+ iter(margin)
+ except:
+ margin = [margin]
+ while len(margin) < 4:
+ margin *= 2
+
+ if isinstance(xobj_iter, (list, dict)):
+ xobj_iter = find_objects(xobj_iter)
+ for obj in xobj_iter:
+ if not ignore(obj):
+ if not image_only or obj.Subtype == PdfName.IMage:
+ yield wrap_object(obj, width, margin)
diff --git a/pdfrw/objects/__init__.py b/pdfrw/objects/__init__.py
index a3fb78b..1746dfe 100644
--- a/pdfrw/objects/__init__.py
+++ b/pdfrw/objects/__init__.py
@@ -1,5 +1,5 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -8,9 +8,12 @@ objects are arrays and dicts. Either of these can be
indirect or not, and dicts could have an associated
stream.
'''
-from pdfrw.objects.pdfname import PdfName
-from pdfrw.objects.pdfdict import PdfDict, IndirectPdfDict
-from pdfrw.objects.pdfarray import PdfArray
-from pdfrw.objects.pdfobject import PdfObject
-from pdfrw.objects.pdfstring import PdfString
-from pdfrw.objects.pdfindirect import PdfIndirect
+from .pdfname import PdfName
+from .pdfdict import PdfDict, IndirectPdfDict
+from .pdfarray import PdfArray
+from .pdfobject import PdfObject
+from .pdfstring import PdfString
+from .pdfindirect import PdfIndirect
+
+__all__ = [PdfName, PdfDict, IndirectPdfDict, PdfArray,
+ PdfObject, PdfString, PdfIndirect]
diff --git a/pdfrw/objects/pdfarray.py b/pdfrw/objects/pdfarray.py
index 8cf6bbb..b662755 100644
--- a/pdfrw/objects/pdfarray.py
+++ b/pdfrw/objects/pdfarray.py
@@ -1,13 +1,15 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
-from pdfrw.objects.pdfindirect import PdfIndirect
-from pdfrw.objects.pdfobject import PdfObject
+from .pdfindirect import PdfIndirect
+from .pdfobject import PdfObject
+
def _resolved():
pass
+
class PdfArray(list):
''' A PdfArray maps the PDF file array object into a Python list.
It has an indirect attribute which defaults to False.
@@ -19,9 +21,8 @@ class PdfArray(list):
self.extend(source)
def _resolver(self, isinstance=isinstance, enumerate=enumerate,
- listiter=list.__iter__,
- PdfIndirect=PdfIndirect, resolved=_resolved,
- PdfNull=PdfObject('null')):
+ listiter=list.__iter__, PdfIndirect=PdfIndirect,
+ resolved=_resolved, PdfNull=PdfObject('null')):
for index, value in enumerate(list.__iter__(self)):
if isinstance(value, PdfIndirect):
value = value.real_value()
@@ -34,9 +35,12 @@ class PdfArray(list):
self._resolve()
return listget(self, index)
- def __getslice__(self, index, listget=list.__getslice__):
- self._resolve()
- return listget(self, index)
+ try:
+ def __getslice__(self, i, j, listget=list.__getslice__):
+ self._resolve()
+ return listget(self, i, j)
+ except AttributeError:
+ pass
def __iter__(self, listiter=list.__iter__):
self._resolve()
@@ -45,15 +49,19 @@ class PdfArray(list):
def count(self, item):
self._resolve()
return list.count(self, item)
+
def index(self, item):
self._resolve()
return list.index(self, item)
+
def remove(self, item):
self._resolve()
return list.remove(self, item)
+
def sort(self, *args, **kw):
self._resolve()
return list.sort(self, *args, **kw)
+
def pop(self, *args):
self._resolve()
return list.pop(self, *args)
diff --git a/pdfrw/objects/pdfdict.py b/pdfrw/objects/pdfdict.py
index 1b3f6a0..fc28492 100644
--- a/pdfrw/objects/pdfdict.py
+++ b/pdfrw/objects/pdfdict.py
@@ -1,18 +1,24 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
-from pdfrw.objects.pdfname import PdfName
-from pdfrw.objects.pdfindirect import PdfIndirect
-from pdfrw.objects.pdfobject import PdfObject
+from .pdfname import PdfName, BasePdfName
+from .pdfindirect import PdfIndirect
+from .pdfobject import PdfObject
+from ..py23_diffs import iteritems
+from ..errors import PdfParseError
+
class _DictSearch(object):
''' Used to search for inheritable attributes.
'''
+
def __init__(self, basedict):
self.basedict = basedict
+
def __getattr__(self, name, PdfName=PdfName):
return self[PdfName(name)]
+
def __getitem__(self, name, set=set, getattr=getattr, id=id):
visited = set()
mydict = self.basedict
@@ -27,28 +33,35 @@ class _DictSearch(object):
if mydict is None:
return
+
class _Private(object):
''' Used to store private attributes (not output to PDF files)
on PdfDict classes
'''
+
def __init__(self, pdfdict):
vars(self)['pdfdict'] = pdfdict
+
def __setattr__(self, name, value):
vars(self.pdfdict)[name] = value
+
class PdfDict(dict):
- ''' PdfDict objects are subclassed dictionaries with the following features:
+ ''' PdfDict objects are subclassed dictionaries
+ with the following features:
- Every key in the dictionary starts with "/"
- A dictionary item can be deleted by assigning it to None
- - Keys that (after the initial "/") conform to Python naming conventions
- can also be accessed (set and retrieved) as attributes of the dictionary.
- E.g. mydict.Page is the same thing as mydict['/Page']
+ - Keys that (after the initial "/") conform to Python
+ naming conventions can also be accessed (set and retrieved)
+ as attributes of the dictionary. E.g. mydict.Page is the
+ same thing as mydict['/Page']
- - Private attributes (not in the PDF space) can be set on the dictionary
- object attribute dictionary by using the private attribute:
+ - Private attributes (not in the PDF space) can be set
+ on the dictionary object attribute dictionary by using
+ the private attribute:
mydict.private.foo = 3
mydict.foo = 5
@@ -61,11 +74,11 @@ class PdfDict(dict):
- PdfDicts have the following read-only properties:
- - private -- as discussed above, provides write access to dictionary's
- attributes
- - inheritable -- this creates and returns a "view" attribute that
- will search through the object hierarchy for any desired
- attribute, such as /Rotate or /MediaBox
+ - private -- as discussed above, provides write access to
+ dictionary's attributes
+ - inheritable -- this creates and returns a "view" attribute
+ that will search through the object hierarchy for
+ any desired attribute, such as /Rotate or /MediaBox
- PdfDicts also have the following special attributes:
- indirect is not stored in the PDF dictionary, but in the object's
@@ -84,13 +97,15 @@ class PdfDict(dict):
indirect = False
stream = None
- _special = dict(indirect = ('indirect', False),
- stream = ('stream', True),
- _stream = ('stream', False),
- )
+ _special = dict(indirect=('indirect', False),
+ stream=('stream', True),
+ _stream=('stream', False),
+ )
- def __setitem__(self, name, value, setter=dict.__setitem__):
- assert name.startswith('/'), name
+ def __setitem__(self, name, value, setter=dict.__setitem__,
+ BasePdfName=BasePdfName, isinstance=isinstance):
+ if not isinstance(name, BasePdfName):
+ raise PdfParseError('Dict key %s is not a PdfName' % repr(name))
if value is not None:
setter(self, name, value)
elif name in self:
@@ -104,7 +119,7 @@ class PdfDict(dict):
if isinstance(args, PdfDict):
self.indirect = args.indirect
self._stream = args.stream
- for key, value in kw.iteritems():
+ for key, value in iteritems(kw):
setattr(self, key, value)
def __getattr__(self, name, PdfName=PdfName):
@@ -114,8 +129,10 @@ class PdfDict(dict):
'''
return self.get(PdfName(name))
- def get(self, key, dictget=dict.get, isinstance=isinstance, PdfIndirect=PdfIndirect):
- ''' Get a value out of the dictionary, after resolving any indirect objects.
+ def get(self, key, dictget=dict.get, isinstance=isinstance,
+ PdfIndirect=PdfIndirect):
+ ''' Get a value out of the dictionary,
+ after resolving any indirect objects.
'''
value = dictget(self, key)
if isinstance(value, PdfIndirect):
@@ -125,7 +142,8 @@ class PdfDict(dict):
def __getitem__(self, key):
return self.get(key)
- def __setattr__(self, name, value, special=_special.get, PdfName=PdfName, vars=vars):
+ def __setattr__(self, name, value, special=_special.get,
+ PdfName=PdfName, vars=vars):
''' Set an attribute on the dictionary. Handle the keywords
indirect, stream, and _stream specially (for content objects)
'''
@@ -139,28 +157,37 @@ class PdfDict(dict):
notnone = value is not None
self.Length = notnone and PdfObject(len(value)) or None
- def iteritems(self, dictiter=dict.iteritems, isinstance=isinstance, PdfIndirect=PdfIndirect):
+ def iteritems(self, dictiter=iteritems,
+ isinstance=isinstance, PdfIndirect=PdfIndirect,
+ BasePdfName=BasePdfName):
''' Iterate over the dictionary, resolving any unresolved objects
'''
for key, value in list(dictiter(self)):
if isinstance(value, PdfIndirect):
self[key] = value = value.real_value()
if value is not None:
- assert key.startswith('/'), (key, value)
+ if not isinstance(key, BasePdfName):
+ raise PdfParseError('Dict key %s is not a PdfName' %
+ repr(key))
yield key, value
def items(self):
return list(self.iteritems())
+
def itervalues(self):
for key, value in self.iteritems():
yield value
+
def values(self):
return list((value for key, value in self.iteritems()))
+
def keys(self):
return list((key for key, value in self.iteritems()))
+
def __iter__(self):
for key, value in self.iteritems():
yield key
+
def iterkeys(self):
return iter(self)
@@ -197,6 +224,7 @@ class PdfDict(dict):
return _Private(self)
private = property(private)
+
class IndirectPdfDict(PdfDict):
''' IndirectPdfDict is a convenience class. You could
create a direct PdfDict and then set indirect = True on it,
diff --git a/pdfrw/objects/pdfindirect.py b/pdfrw/objects/pdfindirect.py
index 38de985..4df8ac3 100644
--- a/pdfrw/objects/pdfindirect.py
+++ b/pdfrw/objects/pdfindirect.py
@@ -1,10 +1,12 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
+
class _NotLoaded(object):
pass
+
class PdfIndirect(tuple):
''' A placeholder for an object that hasn't been read in yet.
The object itself is the (object number, generation number) tuple.
diff --git a/pdfrw/objects/pdfname.py b/pdfrw/objects/pdfname.py
index 1adae9d..1fdf5b5 100644
--- a/pdfrw/objects/pdfname.py
+++ b/pdfrw/objects/pdfname.py
@@ -1,17 +1,80 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
-from pdfrw.objects.pdfobject import PdfObject
+import re
+
+from ..errors import log
+
+warn = log.warning
+
+
+class BasePdfName(str):
+ ''' A PdfName is an identifier that starts with
+ a slash.
+
+ If a PdfName has illegal space or delimiter characters,
+ then it will be decorated with an "encoded" attribute that
+ has those characters properly escaped as #<hex><hex>
+
+ The "encoded" attribute is what is sent out to a PDF file,
+ the non-encoded main object is what is compared for equality
+ in a PDF dictionary.
+ '''
+
+ indirect = False
+
+ whitespace = '\x00 \t\f\r\n'
+ delimiters = '()<>{}[]/%'
+ forbidden = list(whitespace) + list('\\' + x for x in delimiters)
+ remap = dict((x, '#%02X' % ord(x)) for x in (whitespace + delimiters))
+ split_to_encode = re.compile('(%s)' % '|'.join(forbidden)).split
+ split_to_decode = re.compile(r'\#([0-9A-Fa-f]{2})').split
+
+ def __new__(cls, name, pre_encoded=True, remap=remap,
+ join=''.join, new=str.__new__, chr=chr, int=int,
+ split_to_encode=split_to_encode,
+ split_to_decode=split_to_decode,
+ ):
+ ''' We can build a PdfName from scratch, or from
+ a pre-encoded name (e.g. coming in from a file).
+ '''
+ # Optimization for normal case
+ if name[1:].isalnum():
+ return new(cls, name)
+ encoded = name
+ if pre_encoded:
+ if '#' in name:
+ substrs = split_to_decode(name)
+ substrs[1::2] = (chr(int(x, 16)) for x in substrs[1::2])
+ name = join(substrs)
+ else:
+ encoded = split_to_encode(encoded)
+ encoded[3::2] = (remap[x] for x in encoded[3::2])
+ encoded = join(encoded)
+ self = new(cls, name)
+ if encoded != name:
+ self.encoded = encoded
+ return self
+
+
+# We could have used a metaclass, but this matches what
+# we were doing historically.
class PdfName(object):
- ''' PdfName is a simple way to get a PDF name from a string:
+ ''' Two simple ways to get a PDF name from a string:
+
+ x = PdfName.FooBar
+ x = pdfName('FooBar')
+
+ Either technique will return "/FooBar"
- PdfName.FooBar == PdfObject('/FooBar')
'''
- def __getattr__(self, name):
- return self(name)
- def __call__(self, name, PdfObject=PdfObject):
- return PdfObject('/' + name)
-PdfName = PdfName()
+ def __getattr__(self, name, BasePdfName=BasePdfName):
+ return BasePdfName('/' + name, False)
+
+ def __call__(self, name, BasePdfName=BasePdfName):
+ return BasePdfName('/' + name, False)
+
+PdfName = PdfName()
diff --git a/pdfrw/objects/pdfobject.py b/pdfrw/objects/pdfobject.py
index 8a0fc88..7317395 100644
--- a/pdfrw/objects/pdfobject.py
+++ b/pdfrw/objects/pdfobject.py
@@ -1,7 +1,8 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
+
class PdfObject(str):
''' A PdfObject is a textual representation of any PDF file object
other than an array, dict or string. It has an indirect attribute
diff --git a/pdfrw/objects/pdfstring.py b/pdfrw/objects/pdfstring.py
index 7a7d1e4..5c35d70 100644
--- a/pdfrw/objects/pdfstring.py
+++ b/pdfrw/objects/pdfstring.py
@@ -1,9 +1,10 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
import re
+
class PdfString(str):
''' A PdfString is an encoded string. It has a decode
method to get the actual string data out, and there
@@ -12,18 +13,20 @@ class PdfString(str):
defaults to being a direct object.
'''
indirect = False
- unescape_dict = {'\\b':'\b', '\\f':'\f', '\\n':'\n',
- '\\r':'\r', '\\t':'\t',
- '\\\r\n': '', '\\\r':'', '\\\n':'',
- '\\\\':'\\', '\\':'',
- }
- unescape_pattern = r'(\\\\|\\b|\\f|\\n|\\r|\\t|\\\r\n|\\\r|\\\n|\\[0-9]+|\\)'
+ unescape_dict = {'\\b': '\b', '\\f': '\f', '\\n': '\n',
+ '\\r': '\r', '\\t': '\t',
+ '\\\r\n': '', '\\\r': '', '\\\n': '',
+ '\\\\': '\\', '\\': '',
+ }
+ unescape_pattern = (r'(\\\\|\\b|\\f|\\n|\\r|\\t'
+ r'|\\\r\n|\\\r|\\\n|\\[0-9]+|\\)')
unescape_func = re.compile(unescape_pattern).split
hex_pattern = '([a-fA-F0-9][a-fA-F0-9]|[a-fA-F0-9])'
hex_func = re.compile(hex_pattern).split
- hex_pattern2 = '([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]|[a-fA-F0-9][a-fA-F0-9]|[a-fA-F0-9])'
+ hex_pattern2 = ('([a-fA-F0-9][a-fA-F0-9][a-fA-F0-9][a-fA-F0-9]|'
+ '[a-fA-F0-9][a-fA-F0-9]|[a-fA-F0-9])')
hex_func2 = re.compile(hex_pattern2).split
hex_funcs = hex_func, hex_func2
@@ -50,7 +53,9 @@ class PdfString(str):
data = self.hex_funcs[twobytes](data)
chars = data[1::2]
other = data[0::2]
- assert other[0] == '<' and other[-1] == '>' and ''.join(other) == '<>', self
+ assert (other[0] == '<' and
+ other[-1] == '>' and
+ ''.join(other) == '<>'), self
return ''.join([remap(int(x, 16)) for x in chars])
def decode(self, remap=chr, twobytes=False):
@@ -62,12 +67,8 @@ class PdfString(str):
def encode(cls, source, usehex=False):
assert not usehex, "Not supported yet"
- if isinstance(source, unicode):
- source = source.encode('utf-8')
- else:
- source = str(source)
source = source.replace('\\', '\\\\')
source = source.replace('(', '\\(')
source = source.replace(')', '\\)')
- return cls('(' +source + ')')
+ return cls('(' + source + ')')
encode = classmethod(encode)
diff --git a/pdfrw/pagemerge.py b/pdfrw/pagemerge.py
new file mode 100644
index 0000000..de1d69b
--- /dev/null
+++ b/pdfrw/pagemerge.py
@@ -0,0 +1,242 @@
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2015 Patrick Maupin, Austin, Texas
+# MIT license -- See LICENSE.txt for details
+
+'''
+This module contains code to edit pages. Sort of a canvas, I
+suppose, but I wouldn't want to call it that and get people all
+excited or anything.
+
+No, this is just for doing basic things like merging/splitting
+apart pages, watermarking, etc. All it does is allow converting
+pages (or parts of pages) into Form XObject rectangles, and then
+plopping those down on new or pre-existing pages.
+'''
+
+from .objects import PdfDict, PdfArray, PdfName
+from .buildxobj import pagexobj, ViewInfo
+
+NullInfo = ViewInfo()
+
+
+class RectXObj(PdfDict):
+ ''' This class facilitates doing positioning (moving and scaling)
+ of Form XObjects within their containing page, by modifying
+ the Form XObject's transformation matrix.
+
+ By default, this class keeps the aspect ratio locked. For
+ example, if your object is foo, you can write 'foo.w = 200',
+ and it will scale in both the x and y directions.
+
+ To unlock the aspect ration, you have to do a tiny bit of math
+ and call the scale function.
+ '''
+ def __init__(self, page, viewinfo=NullInfo, **kw):
+ ''' The page is a page returned by PdfReader. It will be
+ turned into a cached Form XObject (so that multiple
+ rectangles can be extracted from it if desired), and then
+ another Form XObject will be built using it and the viewinfo
+ (which should be a ViewInfo class). The viewinfo includes
+ source coordinates (from the top/left) and rotation information.
+
+ Once the object has been built, its destination coordinates
+ may be examined and manipulated by using x, y, w, h, and
+ scale. The destination coordinates are in the normal
+ PDF programmatic system (starting at bottom left).
+ '''
+ if kw:
+ if viewinfo is not NullInfo:
+ raise ValueError("Cannot modify preexisting ViewInfo")
+ viewinfo = ViewInfo(**kw)
+ viewinfo.cacheable = False
+ base = pagexobj(page, viewinfo)
+ self.update(base)
+ self.indirect = True
+ self.stream = base.stream
+ private = self.private
+ private._rect = [base.x, base.y, base.w, base.h]
+ matrix = self.Matrix
+ if matrix is None:
+ matrix = self.Matrix = PdfArray((1, 0, 0, 1, 0, 0))
+ private._matrix = matrix # Lookup optimization
+ # Default to lower-left corner
+ self.x = 0
+ self.y = 0
+
+ @property
+ def x(self):
+ ''' X location (from left) of object in points
+ '''
+ return self._rect[0]
+
+ @property
+ def y(self):
+ ''' Y location (from bottom) of object in points
+ '''
+ return self._rect[1]
+
+ @property
+ def w(self):
+ ''' Width of object in points
+ '''
+ return self._rect[2]
+
+ @property
+ def h(self):
+ ''' Height of object in points
+ '''
+ return self._rect[3]
+
+ def __setattr__(self, name, value, next=PdfDict.__setattr__,
+ mine=set('x y w h'.split())):
+ ''' The underlying __setitem__ won't let us use a property
+ setter, so we have to fake one.
+ '''
+ if name not in mine:
+ return next(self, name, value)
+ if name in 'xy':
+ r_index, m_index = (0, 4) if name == 'x' else (1, 5)
+ self._rect[r_index], old = value, self._rect[r_index]
+ self._matrix[m_index] += value - old
+ else:
+ index = 2 + (value == 'h')
+ self.scale(value / self._rect[index])
+
+ def scale(self, x_scale, y_scale=None):
+ ''' Current scaling deals properly with things that
+ have been rotated in 90 degree increments
+ (via the ViewMerge object given when instantiating).
+ '''
+ if y_scale is None:
+ y_scale = x_scale
+ x, y, w, h = rect = self._rect
+ ao, bo, co, do, eo, fo = matrix = self._matrix
+ an = ao * x_scale
+ bn = bo * y_scale
+ cn = co * x_scale
+ dn = do * y_scale
+ en = x + (eo - x) * 1.0 * (an + cn) / (ao + co)
+ fn = y + (fo - y) * 1.0 * (bn + dn) / (bo + do)
+ matrix[:] = an, bn, cn, dn, en, fn
+ rect[:] = x, y, w * x_scale, h * y_scale
+
+ @property
+ def box(self):
+ ''' Return the bounding box for the object
+ '''
+ x, y, w, h = self._rect
+ return PdfArray([x, y, x + w, y + h])
+
+
+class PageMerge(list):
+ ''' A PageMerge object can have 0 or 1 underlying pages
+ (that get edited with the results of the merge)
+ and 0-n RectXObjs that can be applied before or
+ after the underlying page.
+ '''
+ page = None
+ mbox = None
+ cbox = None
+ resources = None
+ rotate = None
+ contents = None
+
+ def __init__(self, page=None):
+ if page is not None:
+ self.setpage(page)
+
+ def setpage(self, page):
+ if page.Type != PdfName.Page:
+ raise TypeError("Expected page")
+ self.append(None) # Placeholder
+ self.page = page
+ inheritable = page.inheritable
+ self.mbox = inheritable.MediaBox
+ self.cbox = inheritable.CropBox
+ self.resources = inheritable.Resources
+ self.rotate = inheritable.Rotate
+ self.contents = page.Contents
+
+ def __add__(self, other):
+ if isinstance(other, dict):
+ other = [other]
+ for other in other:
+ self.add(other)
+ return self
+
+ def add(self, obj, prepend=False, **kw):
+ if kw:
+ obj = RectXObj(obj, **kw)
+ elif obj.Type == PdfName.Page:
+ obj = RectXObj(obj)
+ if prepend:
+ self.insert(0, obj)
+ else:
+ self.append(obj)
+ return self
+
+ def render(self):
+ def do_xobjs(xobj_list):
+ content = []
+ for obj in xobj_list:
+ index = PdfName('pdfrw_%d' % (key_offset + len(xobjs)))
+ if xobjs.setdefault(index, obj) is not obj:
+ raise KeyError("XObj key %s already in use" % index)
+ content.append('%s Do' % index)
+ return PdfDict(indirect=True, stream='\n'.join(content))
+
+ mbox = self.mbox
+ cbox = self.cbox
+ page = self.page
+ old_contents = self.contents
+ resources = self.resources or PdfDict()
+
+ key_offset = 0
+ xobjs = resources.XObject
+ if xobjs is None:
+ xobjs = resources.XObject = PdfDict()
+ else:
+ allkeys = xobjs.keys()
+ if allkeys:
+ keys = (x for x in allkeys if x.startswith('/pdfrw_'))
+ keys = (x for x in keys if x[6:].isdigit())
+ keys = sorted(keys, key=lambda x: int(x[6:]))
+ key_offset = (int(keys[-1][6:]) + 1) if keys else 0
+ key_offset -= len(allkeys)
+
+ if old_contents is None:
+ new_contents = do_xobjs(self)
+ else:
+ isdict = isinstance(old_contents, PdfDict)
+ old_contents = [old_contents] if isdict else old_contents
+ new_contents = PdfArray()
+ index = self.index(None)
+ if index:
+ new_contents.append(do_xobjs(self[:index]))
+ new_contents.extend(old_contents)
+ index += 1
+ if index < len(self):
+ new_contents.append(do_xobjs(self[index:]))
+
+ if mbox is None:
+ cbox = None
+ mbox = self.xobj_box
+ mbox[0] = min(0, mbox[0])
+ mbox[1] = min(0, mbox[1])
+
+ page = PdfDict(indirect=True) if page is None else page
+ page.Type = PdfName.Page
+ page.Resources = resources
+ page.MediaBox = mbox
+ page.CropBox = cbox
+ page.Rotate = self.rotate
+ page.Contents = new_contents
+ return page
+
+ @property
+ def xobj_box(self):
+ ''' Return the smallest box that encloses every object
+ in the list.
+ '''
+ a, b, c, d = zip(*(xobj.box for xobj in self))
+ return PdfArray((min(a), min(b), max(c), max(d)))
diff --git a/pdfrw/pdfreader.py b/pdfrw/pdfreader.py
index ffbc237..0baf0eb 100644
--- a/pdfrw/pdfreader.py
+++ b/pdfrw/pdfreader.py
@@ -1,5 +1,6 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
+# Copyright (C) 2012-2015 Nerijus Mika
# MIT license -- See LICENSE.txt for details
'''
@@ -10,16 +11,18 @@ document pages are stored in a list in the pages attribute
of the object.
'''
import gc
+import binascii
+import collections
+import itertools
-from pdfrw.errors import PdfParseError, log
-from pdfrw.tokens import PdfTokens
-from pdfrw.objects import PdfDict, PdfArray, PdfName, PdfObject, PdfIndirect
-from pdfrw.uncompress import uncompress
+from .errors import PdfParseError, log
+from .tokens import PdfTokens
+from .objects import PdfDict, PdfArray, PdfName, PdfObject, PdfIndirect
+from .uncompress import uncompress
+from .py23_diffs import convert_load, iteritems
-class PdfReader(PdfDict):
- warned_bad_stream_start = False # Use to keep from spewing warnings
- warned_bad_stream_end = False # Use to keep from spewing warnings
+class PdfReader(PdfDict):
def findindirect(self, objnum, gennum, PdfIndirect=PdfIndirect, int=int):
''' Return a previously loaded indirect object, or create
@@ -64,7 +67,9 @@ class PdfReader(PdfDict):
tok = next()
while tok != '>>':
if not tok.startswith('/'):
- source.exception('Expected PDF /name object')
+ source.error('Expected PDF /name object')
+ tok = next()
+ continue
key = tok
value = next()
func = specialget(value)
@@ -74,8 +79,11 @@ class PdfReader(PdfDict):
else:
tok = next()
if value.isdigit() and tok.isdigit():
- if next() != 'R':
- source.exception('Expected "R" following two integers')
+ tok2 = next()
+ if tok2 != 'R':
+ source.error('Expected "R" following two integers')
+ tok = tok2
+ continue
value = self.findindirect(value, tok)
tok = next()
result[key] = value
@@ -92,7 +100,7 @@ class PdfReader(PdfDict):
'''
source.exception('Unexpected delimiter')
- def findstream(self, obj, tok, source, PdfDict=PdfDict, isinstance=isinstance, len=len):
+ def findstream(self, obj, tok, source, len=len):
''' Figure out if there is a content stream
following an object, and return the start
pointer to the content stream if so.
@@ -102,9 +110,6 @@ class PdfReader(PdfDict):
be an indirect object.)
'''
- isdict = isinstance(obj, PdfDict)
- if not isdict or tok != 'stream':
- source.exception("Expected 'endobj'%s token", isdict and " or 'stream'" or '')
fdata = source.fdata
startstream = source.tokstart + len(tok)
gotcr = fdata[startstream] == '\r'
@@ -113,28 +118,29 @@ class PdfReader(PdfDict):
startstream += gotlf
if not gotlf:
if not gotcr:
- source.exception(r'stream keyword not followed by \n')
- if not self.warned_bad_stream_start:
- source.warning(r"stream keyword terminated by \r without \n")
- self.private.warned_bad_stream_start = True
+ source.error(r'stream keyword not followed by \n')
+ else:
+ source.warning(r"stream keyword terminated "
+ r"by \r without \n")
return startstream
- def readstream(self, obj, startstream, source,
- streamending = 'endstream endobj'.split(), int=int):
+ def readstream(self, obj, startstream, source, exact_required=False,
+ streamending='endstream endobj'.split(), int=int):
fdata = source.fdata
- length = int(obj.Length)
+ length = int(obj.Length)
source.floc = target_endstream = startstream + length
endit = source.multiple(2)
obj._stream = fdata[startstream:target_endstream]
if endit == streamending:
return
+ if exact_required:
+ source.exception('Expected endstream endobj')
+
# The length attribute does not match the distance between the
# stream and endstream keywords.
- do_warn, self.warned_bad_stream_end = self.warned_bad_stream_end, False
-
- #TODO: Extract maxstream from dictionary of object offsets
+ # TODO: Extract maxstream from dictionary of object offsets
# and use rfind instead of find.
maxstream = len(fdata) - 20
endstream = fdata.find('endstream', startstream, maxstream)
@@ -143,19 +149,23 @@ class PdfReader(PdfDict):
if endstream < 0:
source.error('Could not find endstream')
return
- if length == room + 1 and fdata[startstream-2:startstream] == '\r\n':
+ if (length == room + 1 and
+ fdata[startstream - 2:startstream] == '\r\n'):
source.warning(r"stream keyword terminated by \r without \n")
- obj._stream = fdata[startstream-1:target_endstream-1]
+ obj._stream = fdata[startstream - 1:target_endstream - 1]
return
source.floc = endstream
if length > room:
- source.error('stream /Length attribute (%d) appears to be too big (size %d) -- adjusting',
- length, room)
+ source.error('stream /Length attribute (%d) appears to '
+ 'be too big (size %d) -- adjusting',
+ length, room)
obj.stream = fdata[startstream:endstream]
return
if fdata[target_endstream:endstream].rstrip():
- source.error('stream /Length attribute (%d) might be smaller than data size (%d)',
- length, room)
+ source.error('stream /Length attribute (%d) appears to '
+ 'be too small (size %d) -- adjusting',
+ length, room)
+ obj.stream = fdata[startstream:endstream]
return
endobj = fdata.find('endobj', endstream, maxstream)
if endobj < 0:
@@ -166,14 +176,15 @@ class PdfReader(PdfDict):
return
source.error('Illegal endstream/endobj combination')
- def loadindirect(self, key):
+ def loadindirect(self, key, PdfDict=PdfDict,
+ isinstance=isinstance):
result = self.indirect_objects.get(key)
if not isinstance(result, PdfIndirect):
return result
source = self.source
offset = int(self.source.obj_offsets.get(key, '0'))
if not offset:
- log.warning("Did not find PDF object %s" % (key,))
+ source.warning("Did not find PDF object %s", key)
return None
# Read the object header and validate it
@@ -189,12 +200,15 @@ class PdfReader(PdfDict):
source.next()
objheader = '%d %d obj' % (objnum, gennum)
fdata = source.fdata
- offset2 = fdata.find('\n' + objheader) + 1 or fdata.find('\r' + objheader) + 1
- if not offset2 or fdata.find(fdata[offset2-1] + objheader, offset2) > 0:
- source.warning("Expected indirect object '%s'" % objheader)
+ offset2 = (fdata.find('\n' + objheader) + 1 or
+ fdata.find('\r' + objheader) + 1)
+ if (not offset2 or
+ fdata.find(fdata[offset2 - 1] + objheader, offset2) > 0):
+ source.warning("Expected indirect object '%s'", objheader)
return None
- source.warning("Indirect object %s found at incorrect offset %d (expected offset %d)" %
- (objheader, offset2, offset))
+ source.warning("Indirect object %s found at incorrect "
+ "offset %d (expected offset %d)",
+ objheader, offset2, offset)
source.floc = offset2 + len(objheader)
# Read the object, and call special code if it starts
@@ -208,20 +222,99 @@ class PdfReader(PdfDict):
self.deferred_objects.remove(key)
# Mark the object as indirect, and
- # add it to the list of streams if it starts a stream
+ # just return it if it is a simple object.
obj.indirect = key
tok = source.next()
- if tok != 'endobj':
+ if tok == 'endobj':
+ return obj
+
+ # Should be a stream. Either that or it's broken.
+ isdict = isinstance(obj, PdfDict)
+ if isdict and tok == 'stream':
self.readstream(obj, self.findstream(obj, tok, source), source)
+ return obj
+
+ # Houston, we have a problem, but let's see if it
+ # is easily fixable. Leaving out a space before endobj
+ # is apparently an easy mistake to make on generation
+ # (Because it won't be noticed unless you are specifically
+ # generating an indirect object that doesn't end with any
+ # sort of delimiter.) It is so common that things like
+ # okular just handle it.
+
+ if isinstance(obj, PdfObject) and obj.endswith('endobj'):
+ source.error('No space or delimiter before endobj')
+ obj = PdfObject(obj[:-6])
+ else:
+ source.error("Expected 'endobj'%s token",
+ isdict and " or 'stream'" or '')
+ obj = PdfObject('')
+
+ obj.indirect = key
+ self.indirect_objects[key] = obj
return obj
- def findxref(fdata):
+ def read_all(self):
+ deferred = self.deferred_objects
+ prev = set()
+ while 1:
+ new = deferred - prev
+ if not new:
+ break
+ prev |= deferred
+ for key in new:
+ self.loadindirect(key)
+
+ def uncompress(self):
+ self.read_all()
+ uncompress(self.indirect_objects.values())
+
+ def load_stream_objects(self, object_streams):
+ # read object streams
+ objs = []
+ for num in object_streams:
+ obj = self.findindirect(num, 0).real_value()
+ assert obj.Type == '/ObjStm'
+ objs.append(obj)
+
+ # read objects from stream
+ if objs:
+ uncompress(objs)
+ for obj in objs:
+ objsource = PdfTokens(obj.stream, 0, False)
+ snext = objsource.next
+ offsets = {}
+ firstoffset = int(obj.First)
+ num = snext()
+ while num.isdigit():
+ offset = int(snext())
+ offsets[int(num)] = firstoffset + offset
+ num = snext()
+ for num, offset in iteritems(offsets):
+ # Read the object, and call special code if it starts
+ # an array or dictionary
+ objsource.floc = offset
+ sobj = snext()
+ func = self.special.get(sobj)
+ if func is not None:
+ sobj = func(objsource)
+
+ key = (num, 0)
+ self.indirect_objects[key] = sobj
+ if key in self.deferred_objects:
+ self.deferred_objects.remove(key)
+
+ # Mark the object as indirect, and
+ # add it to the list of streams if it starts a stream
+ sobj.indirect = key
+
+ def findxref(self, fdata):
''' Find the cross reference section at the end of a file
'''
startloc = fdata.rfind('startxref')
if startloc < 0:
raise PdfParseError('Did not find "startxref" at end of file')
- source = PdfTokens(fdata, startloc, False)
+ source = PdfTokens(fdata, startloc, False, self.verbose)
tok = source.next()
assert tok == 'startxref' # (We just checked this...)
tableloc = source.next_default()
@@ -229,19 +322,67 @@ class PdfReader(PdfDict):
source.exception('Expected table location')
if source.next_default().rstrip().lstrip('%') != 'EOF':
source.exception('Expected %%EOF')
- return startloc, PdfTokens(fdata, int(tableloc), True)
- findxref = staticmethod(findxref)
+ return startloc, PdfTokens(fdata, int(tableloc), True, self.verbose)
- def parsexref(self, source, int=int, range=range):
+ def parse_xref_stream(self, source, int=int, range=range,
+ enumerate=enumerate, islice=itertools.islice,
+ defaultdict=collections.defaultdict,
+ hexlify=binascii.hexlify):
''' Parse (one of) the cross-reference file section(s)
'''
- fdata = source.fdata
+
+ def readint(s, lengths):
+ lengths = itertools.cycle(lengths)
+ offset = 0
+ for length in itertools.cycle(lengths):
+ next = offset + length
+ yield int(hexlify(s[offset:next]), 16) if length else None
+ offset = next
+
setdefault = source.obj_offsets.setdefault
- add_offset = source.all_offsets.append
next = source.next
+ # check for xref stream object
+ objid = source.multiple(3)
+ ok = len(objid) == 3
+ ok = ok and objid[0].isdigit()
+ ok = ok and objid[1] == 'obj'
+ ok = ok and objid[2] == '<<'
+ if not ok:
+ source.exception('Expected xref stream start')
+ obj = self.readdict(source)
+ if obj.Type != PdfName.XRef:
+ source.exception('Expected dict type of /XRef')
tok = next()
- if tok != 'xref':
- source.exception('Expected "xref" keyword')
+ self.readstream(obj, self.findstream(obj, tok, source), source, True)
+ if not uncompress([obj], True):
+ source.exception('Could not decompress Xref stream')
+ num_pairs = obj.Index or PdfArray(['0', obj.Size])
+ num_pairs = [int(x) for x in num_pairs]
+ num_pairs = zip(num_pairs[0::2], num_pairs[1::2])
+ entry_sizes = [int(x) for x in obj.W]
+ if len(entry_sizes) != 3:
+ source.exception('Invalid entry size')
+ object_streams = defaultdict(list)
+ get = readint(obj.stream, entry_sizes)
+ for objnum, size in num_pairs:
+ for cnt in range(size):
+ xtype, p1, p2 = islice(get, 3)
+ if xtype in (1, None):
+ if p1:
+ setdefault((objnum, p2 or 0), p1)
+ elif xtype == 2:
+ object_streams[p1].append((objnum, p2))
+ objnum += 1
+
+ obj.private.object_streams = object_streams
+ return obj
+
+ def parse_xref_table(self, source, int=int, range=range):
+ ''' Parse (one of) the cross-reference file section(s)
+ '''
+ setdefault = source.obj_offsets.setdefault
+ next = source.next
+ # plain xref table
start = source.floc
try:
while 1:
@@ -256,13 +397,13 @@ class PdfReader(PdfDict):
if inuse == 'n':
if offset != 0:
setdefault((objnum, generation), offset)
- add_offset(offset)
elif inuse != 'f':
raise ValueError
except:
pass
try:
- # Table formatted incorrectly. See if we can figure it out anyway.
+ # Table formatted incorrectly.
+ # See if we can figure it out anyway.
end = source.fdata.rindex('trailer', start)
table = source.fdata[start:end].splitlines()
for line in table:
@@ -270,24 +411,41 @@ class PdfReader(PdfDict):
if len(tokens) == 2:
objnum = int(tokens[0])
elif len(tokens) == 3:
- offset, generation, inuse = int(tokens[0]), int(tokens[1]), tokens[2]
+ offset, generation, inuse = (int(tokens[0]),
+ int(tokens[1]), tokens[2])
if offset != 0 and inuse == 'n':
setdefault((objnum, generation), offset)
- add_offset(offset)
objnum += 1
elif tokens:
- log.error('Invalid line in xref table: %s' % repr(line))
+ log.error('Invalid line in xref table: %s' %
+ repr(line))
raise ValueError
log.warning('Badly formatted xref table')
source.floc = end
- source.next()
+ next()
except:
source.floc = start
source.exception('Invalid table format')
+ def parsexref(self, source):
+ ''' Parse (one of) the cross-reference file section(s)
+ '''
+ next = source.next
+ tok = next()
+ if tok.isdigit():
+ return self.parse_xref_stream(source), True
+ elif tok == 'xref':
+ self.parse_xref_table(source)
+ tok = next()
+ if tok != '<<':
+ source.exception('Expected "<<" starting catalog')
+ return self.readdict(source), False
+ else:
+ source.exception('Expected "xref" keyword or xref stream object')
+
def readpages(self, node):
- pagename=PdfName.Page
- pagesname=PdfName.Pages
+ pagename = PdfName.Page
+ pagesname = PdfName.Pages
catalogname = PdfName.Catalog
typename = PdfName.Type
kidname = PdfName.Kids
@@ -306,20 +464,23 @@ class PdfReader(PdfDict):
for node in readnode(node[pagesname]):
yield node
else:
- log.error('Expected /Page or /Pages dictionary, got %s' % repr(node))
+ log.error('Expected /Page or /Pages dictionary, got %s' %
+ repr(node))
try:
return list(readnode(node))
- except (AttributeError, TypeError), s:
+ except (AttributeError, TypeError) as s:
log.error('Invalid page tree: %s' % s)
return []
- def __init__(self, fname=None, fdata=None, decompress=False, disable_gc=True):
+ def __init__(self, fname=None, fdata=None, decompress=False,
+ disable_gc=True, verbose=True):
+ self.private.verbose = verbose
# Runs a lot faster with GC off.
disable_gc = disable_gc and gc.isenabled()
+ if disable_gc:
+ gc.disable()
try:
- if disable_gc:
- gc.disable()
if fname is not None:
assert fdata is None
# Allow reading preexisting streams like pyPdf
@@ -331,8 +492,9 @@ class PdfReader(PdfDict):
fdata = f.read()
f.close()
except IOError:
- raise PdfParseError('Could not read PDF file %s' % fname)
-
+ raise PdfParseError('Could not read PDF file %s' %
+ fname)
+ fdata = convert_load(fdata)
assert fdata is not None
if not fdata.startswith('%PDF-'):
startloc = fdata.find('%PDF-')
@@ -342,11 +504,15 @@ class PdfReader(PdfDict):
lines = fdata.lstrip().splitlines()
if not lines:
raise PdfParseError('Empty PDF file!')
- raise PdfParseError('Invalid PDF header: %s' % repr(lines[0]))
+ raise PdfParseError('Invalid PDF header: %s' %
+ repr(lines[0]))
+
+ self.private.version = fdata[5:8]
endloc = fdata.rfind('%EOF')
if endloc < 0:
- raise PdfParseError('EOF mark not found: %s' % repr(fdata[-20:]))
+ raise PdfParseError('EOF mark not found: %s' %
+ repr(fdata[-20:]))
endloc += 6
junk = fdata[endloc:]
fdata = fdata[:endloc]
@@ -363,46 +529,53 @@ class PdfReader(PdfDict):
for tok in r'\ ( ) < > { } ] >> %'.split():
self.special[tok] = self.badtoken
-
startloc, source = self.findxref(fdata)
private.source = source
- xref_table_list = []
- source.all_offsets = []
+
+ # Find all the xref tables/streams, and
+ # then deal with them backwards.
+ xref_list = []
while 1:
source.obj_offsets = {}
- # Loop through all the cross-reference tables
- self.parsexref(source)
- tok = source.next()
- if tok != '<<':
- source.exception('Expected "<<" starting catalog')
-
- newdict = self.readdict(source)
-
- token = source.next()
- if token != 'startxref' and not xref_table_list:
- source.warning('Expected "startxref" at end of xref table')
-
- # Loop if any previously-written tables.
- prev = newdict.Prev
+ trailer, is_stream = self.parsexref(source)
+ prev = trailer.Prev
if prev is None:
+ token = source.next()
+ if token != 'startxref' and not xref_list:
+ source.warning('Expected "startxref" '
+ 'at end of xref table')
break
- if not xref_table_list:
- newdict.Prev = None
- original_indirect = self.indirect_objects.copy()
- original_newdict = newdict
+ xref_list.append((source.obj_offsets, trailer, is_stream))
source.floc = int(prev)
- xref_table_list.append(source.obj_offsets)
- self.indirect_objects.clear()
-
- if xref_table_list:
- for update in reversed(xref_table_list):
- source.obj_offsets.update(update)
- self.indirect_objects.clear()
- self.indirect_objects.update(original_indirect)
- newdict = original_newdict
- self.update(newdict)
-
- #self.read_all_indirect(source)
+
+ if is_stream:
+ self.load_stream_objects(trailer.object_streams)
+
+ while xref_list:
+ later_offsets, later_trailer, is_stream = xref_list.pop()
+ source.obj_offsets.update(later_offsets)
+ if is_stream:
+ trailer.update(later_trailer)
+ self.load_stream_objects(later_trailer.object_streams)
+ else:
+ trailer = later_trailer
+
+ trailer.Prev = None
+
+ if (trailer.Version and
+ float(trailer.Version) > float(self.version)):
+ self.private.version = trailer.Version
+
+ if is_stream:
+ self.Root = trailer.Root
+ self.Info = trailer.Info
+ self.ID = trailer.ID
+ self.Size = trailer.Size
+ self.Encrypt = trailer.Encrypt
+ else:
+ self.update(trailer)
+
+ # self.read_all_indirect(source)
private.pages = self.readpages(self.Root)
if decompress:
self.uncompress()
@@ -416,18 +589,3 @@ class PdfReader(PdfDict):
# For compatibility with pyPdf
def getPage(self, pagenum):
return self.pages[pagenum]
-
- def read_all(self):
- deferred = self.deferred_objects
- prev = set()
- while 1:
- new = deferred - prev
- if not new:
- break
- prev |= deferred
- for key in new:
- self.loadindirect(key)
-
- def uncompress(self):
- self.read_all()
- uncompress(self.indirect_objects.itervalues())
diff --git a/pdfrw/pdfwriter.py b/pdfrw/pdfwriter.py
index 42740dc..644bb30 100755
--- a/pdfrw/pdfwriter.py
+++ b/pdfrw/pdfwriter.py
@@ -1,7 +1,5 @@
-#!/usr/bin/env python
-
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -17,32 +15,50 @@ and
addpage() assumes that the pages are part of a valid
tree/forest of PDF objects.
'''
+import gc
-try:
- set
-except NameError:
- from sets import Set as set
-
-from pdfrw.objects import PdfName, PdfArray, PdfDict, IndirectPdfDict, PdfObject, PdfString
-from pdfrw.compress import compress as do_compress
-from pdfrw.errors import PdfOutputError, log
+from .objects import (PdfName, PdfArray, PdfDict, IndirectPdfDict,
+ PdfObject, PdfString)
+from .compress import compress as do_compress
+from .errors import PdfOutputError, log
+from .py23_diffs import iteritems, convert_store
NullObject = PdfObject('null')
NullObject.indirect = True
NullObject.Type = 'Null object'
+
+def user_fmt(obj, isinstance=isinstance, float=float, str=str,
+ basestring=str, encode=PdfString.encode):
+ ''' This function may be replaced by the user for
+ specialized formatting requirements.
+ '''
+
+ if isinstance(obj, basestring):
+ return encode(obj)
+
+ # PDFs don't handle exponent notation
+ if isinstance(obj, float):
+ return ('%.9f' % obj).rstrip('0').rstrip('.')
+
+ return str(obj)
+
+
def FormatObjects(f, trailer, version='1.3', compress=True, killobj=(),
- id=id, isinstance=isinstance, getattr=getattr,len=len,
- sum=sum, set=set, str=str, basestring=basestring,
- hasattr=hasattr, repr=repr, enumerate=enumerate,
- list=list, dict=dict, tuple=tuple,
- do_compress=do_compress, PdfArray=PdfArray,
- PdfDict=PdfDict, PdfObject=PdfObject, encode=PdfString.encode):
+ user_fmt=user_fmt, do_compress=do_compress,
+ convert_store=convert_store, iteritems=iteritems,
+ id=id, isinstance=isinstance, getattr=getattr, len=len,
+ sum=sum, set=set, str=str, hasattr=hasattr, repr=repr,
+ enumerate=enumerate, list=list, dict=dict, tuple=tuple,
+ PdfArray=PdfArray, PdfDict=PdfDict, PdfObject=PdfObject):
''' FormatObjects performs the actual formatting and disk write.
Should be a class, was a class, turned into nested functions
for performace (to reduce attribute lookups).
'''
+ def f_write(s):
+ f.write(convert_store(s))
+
def add(obj):
''' Add an object to our list, if it's an indirect
object. Just format it if not.
@@ -58,7 +74,9 @@ def FormatObjects(f, trailer, version='1.3', compress=True, killobj=(),
if not indirect:
if objid in visited:
- log.warning('Replicating direct %s object, should be indirect for optimal file size' % type(obj))
+ log.warning('Replicating direct %s object, '
+ 'should be indirect for optimal file size' %
+ type(obj))
obj = type(obj)(obj)
objid = id(obj)
visiting(objid)
@@ -83,7 +101,7 @@ def FormatObjects(f, trailer, version='1.3', compress=True, killobj=(),
objnum = len(objlist) + 1
objlist_append(None)
indirect_dict[objid] = objnum
- deferred.append((objnum-1, obj))
+ deferred.append((objnum - 1, obj))
return '%s 0 R' % objnum
def format_array(myarray, formatter):
@@ -119,30 +137,32 @@ def FormatObjects(f, trailer, version='1.3', compress=True, killobj=(),
elif isinstance(obj, PdfDict):
if compress and obj.stream:
do_compress([obj])
+ pairs = sorted((x, y, getattr(x, 'encoded', x))
+ for (x, y) in obj.iteritems())
myarray = []
- dictkeys = [str(x) for x in obj.keys()]
- dictkeys.sort()
- for key in dictkeys:
- myarray.append(key)
- myarray.append(add(obj[key]))
+ for key, value, encoding in pairs:
+ myarray.append(encoding)
+ myarray.append(add(value))
result = format_array(myarray, '<<%s>>')
stream = obj.stream
if stream is not None:
- result = '%s\nstream\n%s\nendstream' % (result, stream)
+ result = ('%s\nstream\n%s\nendstream' %
+ (result, stream))
return result
obj = (PdfArray, PdfDict)[isinstance(obj, dict)](obj)
continue
- if not hasattr(obj, 'indirect') and isinstance(obj, basestring):
- return encode(obj)
- return str(getattr(obj, 'encoded', obj))
+ # We assume that an object with an indirect
+ # attribute knows how to represent itself to us.
+ if hasattr(obj, 'indirect'):
+ return str(getattr(obj, 'encoded', obj))
+ return user_fmt(obj)
def format_deferred():
while deferred:
index, obj = deferred.pop()
objlist[index] = format_obj(obj)
-
indirect_dict = {}
indirect_dict_get = indirect_dict.get
objlist = []
@@ -152,14 +172,17 @@ def FormatObjects(f, trailer, version='1.3', compress=True, killobj=(),
leaving = visited.remove
space_join = ' '.join
lf_join = '\n '.join
- f_write = f.write
deferred = []
- # Don't reference old catalog or pages objects -- swap references to new ones.
- swapobj = {PdfName.Catalog:trailer.Root, PdfName.Pages:trailer.Root.Pages, None:trailer}.get
- swapobj = [(objid, swapobj(obj.Type)) for objid, obj in killobj.iteritems()]
- swapobj = dict((objid, obj is None and NullObject or obj) for objid, obj in swapobj).get
+ # Don't reference old catalog or pages objects --
+ # swap references to new ones.
+ swapobj = {PdfName.Catalog: trailer.Root,
+ PdfName.Pages: trailer.Root.Pages, None: trailer}.get
+ swapobj = [(objid, swapobj(obj.Type))
+ for objid, obj in iteritems(killobj)]
+ swapobj = dict((objid, obj is None and NullObject or obj)
+ for objid, obj in swapobj).get
for objid in killobj:
assert swapobj(objid) is not None
@@ -197,9 +220,11 @@ def FormatObjects(f, trailer, version='1.3', compress=True, killobj=(),
f_write('%010d %05d %s\r\n' % x)
f_write('trailer\n\n%s\nstartxref\n%s\n%%%%EOF\n' % (trailer, offset))
+
class PdfWriter(object):
_trailer = None
+ canonicalize = False
def __init__(self, version='1.3', compress=False):
self.pagearray = PdfArray()
@@ -211,15 +236,15 @@ class PdfWriter(object):
self._trailer = None
if page.Type != PdfName.Page:
raise PdfOutputError('Bad /Type: Expected %s, found %s'
- % (PdfName.Page, page.Type))
- inheritable = page.inheritable # searches for resources
+ % (PdfName.Page, page.Type))
+ inheritable = page.inheritable # searches for resources
self.pagearray.append(
IndirectPdfDict(
page,
- Resources = inheritable.Resources,
- MediaBox = inheritable.MediaBox,
- CropBox = inheritable.CropBox,
- Rotate = inheritable.Rotate,
+ Resources=inheritable.Resources,
+ MediaBox=inheritable.MediaBox,
+ CropBox=inheritable.CropBox,
+ Rotate=inheritable.Rotate,
)
)
@@ -247,21 +272,26 @@ class PdfWriter(object):
if trailer is not None:
return trailer
+ if self.canonicalize:
+ self.make_canonical()
+
# Create the basic object structure of the PDF file
trailer = PdfDict(
- Root = IndirectPdfDict(
- Type = PdfName.Catalog,
- Pages = IndirectPdfDict(
- Type = PdfName.Pages,
- Count = PdfObject(len(self.pagearray)),
- Kids = self.pagearray
+ Root=IndirectPdfDict(
+ Type=PdfName.Catalog,
+ Pages=IndirectPdfDict(
+ Type=PdfName.Pages,
+ Count=PdfObject(len(self.pagearray)),
+ Kids=self.pagearray
)
)
)
- # Make all the pages point back to the page dictionary
+ # Make all the pages point back to the page dictionary and
+ # ensure they are indirect references
pagedict = trailer.Root.Pages
for page in pagedict.Kids:
page.Parent = pagedict
+ page.indirect = True
self._trailer = trailer
return trailer
@@ -270,26 +300,42 @@ class PdfWriter(object):
trailer = property(_get_trailer, _set_trailer)
- def write(self, fname, trailer=None):
+ def write(self, fname, trailer=None, user_fmt=user_fmt,
+ disable_gc=True):
trailer = trailer or self.trailer
# Dump the data. We either have a filename or a preexisting
# file object.
preexisting = hasattr(fname, 'write')
f = preexisting and fname or open(fname, 'wb')
- FormatObjects(f, trailer, self.version, self.compress, self.killobj)
- if not preexisting:
- f.close()
-
-if __name__ == '__main__':
- import logging
- log.setLevel(logging.DEBUG)
- import pdfreader
- x = pdfreader.PdfReader('source.pdf')
- y = PdfWriter()
- for i, page in enumerate(x.pages):
- print ' Adding page', i+1, '\r',
- y.addpage(page)
- print
- y.write('result.pdf')
- print
+ if disable_gc:
+ gc.disable()
+
+ try:
+ FormatObjects(f, trailer, self.version, self.compress,
+ self.killobj, user_fmt=user_fmt)
+ finally:
+ if not preexisting:
+ f.close()
+ if disable_gc:
+ gc.enable()
+
+ def make_canonical(self):
+ ''' Canonicalizes a PDF. Assumes everything
+ is a Pdf object already.
+ '''
+ visited = set()
+ workitems = list(self.pagearray)
+ while workitems:
+ obj = workitems.pop()
+ objid = id(obj)
+ if objid in visited:
+ continue
+ visited.add(objid)
+ obj.indirect = False
+ if isinstance(obj, (PdfArray, PdfDict)):
+ obj.indirect = True
+ if isinstance(obj, PdfArray):
+ workitems += obj
+ else:
+ workitems += obj.values()
diff --git a/pdfrw/py23_diffs.py b/pdfrw/py23_diffs.py
new file mode 100644
index 0000000..a0e0318
--- /dev/null
+++ b/pdfrw/py23_diffs.py
@@ -0,0 +1,46 @@
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
+# MIT license -- See LICENSE.txt for details
+
+# Deal with Python2/3 differences
+
+try:
+ import zlib
+except ImportError:
+ zlib = None
+
+try:
+ unicode = unicode
+except NameError:
+
+ def convert_load(s):
+ return s.decode('Latin-1')
+
+ def convert_store(s):
+ return s.encode('Latin-1')
+
+ def from_array(a):
+ return a.tobytes()
+
+else:
+
+ def convert_load(s):
+ return s
+
+ def convert_store(s):
+ return s
+
+ def from_array(a):
+ return a.tostring()
+
+nextattr, = (x for x in dir(iter([])) if 'next' in x)
+
+try:
+ iteritems = dict.iteritems
+except AttributeError:
+ iteritems = dict.items
+
+try:
+ xrange = xrange
+except NameError:
+ xrange = range
diff --git a/pdfrw/tokens.py b/pdfrw/tokens.py
index 8067490..5b061d5 100644
--- a/pdfrw/tokens.py
+++ b/pdfrw/tokens.py
@@ -1,5 +1,5 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2012 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -10,12 +10,13 @@ sixth edition, for PDF version 1.7, dated November 2006.
'''
-from __future__ import generators
-
import re
import itertools
-from pdfrw.objects import PdfString, PdfObject
-from pdfrw.errors import log, PdfParseError
+from .objects import PdfString, PdfObject
+from .objects.pdfname import BasePdfName
+from .errors import log, PdfParseError
+from .py23_diffs import nextattr
+
def linepos(fdata, loc):
line = fdata.count('\n', 0, loc) + 1
@@ -23,6 +24,7 @@ def linepos(fdata, loc):
col = loc - max(fdata.rfind('\n', 0, loc), fdata.rfind('\r', 0, loc))
return line, col
+
class PdfTokens(object):
# Table 3.1, page 50 of reference, defines whitespace
@@ -35,7 +37,8 @@ class PdfTokens(object):
# "normal" stuff is all but delimiters or whitespace.
- p_normal = r'(?:[^\\%s%s]+|\\[^%s])+' % (whitespace, delimiters, whitespace)
+ p_normal = r'(?:[^\\%s%s]+|\\[^%s])+' % (whitespace, delimiters,
+ whitespace)
p_comment = r'\%%[^%s]*' % eol
@@ -54,10 +57,12 @@ class PdfTokens(object):
p_catchall = '[^%s]' % whitespace
- pattern = '|'.join([p_normal, p_name, p_hex_string, p_dictdelim, p_literal_string, p_comment, p_catchall])
- findtok = re.compile('(%s)[%s]*' % (pattern, whitespace), re.DOTALL).finditer
- findparen = re.compile('(%s)[%s]*' % (p_literal_string_extend, whitespace), re.DOTALL).finditer
- splitname = re.compile(r'\#([0-9A-Fa-f]{2})').split
+ pattern = '|'.join([p_normal, p_name, p_hex_string, p_dictdelim,
+ p_literal_string, p_comment, p_catchall])
+ findtok = re.compile('(%s)[%s]*' % (pattern, whitespace),
+ re.DOTALL).finditer
+ findparen = re.compile('(%s)[%s]*' % (p_literal_string_extend,
+ whitespace), re.DOTALL).finditer
def _cacheobj(cache, obj, constructor):
''' This caching relies on the constructors
@@ -71,23 +76,10 @@ class PdfTokens(object):
cache[result] = result
return result
- def fixname(self, cache, token, constructor, splitname=splitname, join=''.join, cacheobj=_cacheobj):
- ''' Inside name tokens, a '#' character indicates that
- the next two bytes are hex characters to be used
- to form the 'real' character.
- '''
- substrs = splitname(token)
- if '#' in join(substrs[::2]):
- self.warning('Invalid /Name token')
- return token
- substrs[1::2] = (chr(int(x, 16)) for x in substrs[1::2])
- result = cacheobj(cache, join(substrs), constructor)
- result.encoded = token
- return result
-
def _gettoks(self, startloc, cacheobj=_cacheobj,
- delimiters=delimiters, findtok=findtok, findparen=findparen,
- PdfString=PdfString, PdfObject=PdfObject):
+ delimiters=delimiters, findtok=findtok,
+ findparen=findparen, PdfString=PdfString,
+ PdfObject=PdfObject, BasePdfName=BasePdfName):
''' Given a source data string and a location inside it,
gettoks generates tokens. Each token is a tuple of the form:
<starting file loc>, <ending file loc>, <token string>
@@ -102,7 +94,6 @@ class PdfTokens(object):
'''
fdata = self.fdata
current = self.current = [(startloc, startloc)]
- namehandler = (cacheobj, self.fixname)
cache = {}
while 1:
for match in findtok(fdata, current[0][1]):
@@ -114,7 +105,10 @@ class PdfTokens(object):
elif firstch in '/<(%':
if firstch == '/':
# PDF Name
- token = namehandler['#' in token](cache, token, PdfObject)
+ encoded = token
+ token = cache.get(encoded)
+ if token is None:
+ token = cache[token] = BasePdfName(encoded)
elif firstch == '<':
# << dict delim, or < hex string >
if token[1:2] != '<':
@@ -126,12 +120,12 @@ class PdfTokens(object):
# they are present, we exit the for loop
# and get back in with a new starting location.
ends = None # For broken strings
- if fdata[match.end(1)-1] != ')':
+ if fdata[match.end(1) - 1] != ')':
nest = 2
m_start, loc = tokspan
for match in findparen(fdata, loc):
loc = match.end(1)
- ending = fdata[loc-1] == ')'
+ ending = fdata[loc - 1] == ')'
nest += 1 - ending * 2
if not nest:
break
@@ -140,12 +134,14 @@ class PdfTokens(object):
token = fdata[m_start:loc]
current[0] = m_start, match.end()
if nest:
- # There is one possible recoverable error seen in
- # the wild -- some stupid generators don't escape (.
- # If this happens, just terminate on first unescaped ).
- # The string won't be quite right, but that's a science
+ # There is one possible recoverable error
+ # seen in the wild -- some stupid generators
+ # don't escape (. If this happens, just
+ # terminate on first unescaped ). The string
+ # won't be quite right, but that's a science
# fair project for another time.
- (self.error, self.exception)[not ends]('Unterminated literal string')
+ (self.error, self.exception)[not ends](
+ 'Unterminated literal string')
loc, ends, nest = ends
token = fdata[m_start:loc] + ')' * nest
current[0] = m_start, ends
@@ -155,7 +151,8 @@ class PdfTokens(object):
if self.strip_comments:
continue
else:
- self.exception('Tokenizer logic incorrect -- should never get here')
+ self.exception(('Tokenizer logic incorrect -- '
+ 'should never get here'))
yield token
if current[0] is not tokspan:
@@ -165,11 +162,12 @@ class PdfTokens(object):
break
raise StopIteration
- def __init__(self, fdata, startloc=0, strip_comments=True):
+ def __init__(self, fdata, startloc=0, strip_comments=True, verbose=True):
self.fdata = fdata
self.strip_comments = strip_comments
self.iterator = iterator = self._gettoks(startloc)
- self.next = iterator.next
+ self.msgs_dumped = None if verbose else set()
+ self.next = getattr(iterator, nextattr)
def setstart(self, startloc):
''' Change the starting location.
@@ -206,6 +204,11 @@ class PdfTokens(object):
return default
def msg(self, msg, *arg):
+ dumped = self.msgs_dumped
+ if dumped is not None:
+ if msg in dumped:
+ return
+ dumped.add(msg)
if arg:
msg %= arg
fdata = self.fdata
@@ -215,14 +218,19 @@ class PdfTokens(object):
tok = fdata[begin:end].rstrip()
if len(tok) > 30:
tok = tok[:26] + ' ...'
- return '%s (line=%d, col=%d, token=%s)' % (msg, line, col, repr(tok))
+ return ('%s (line=%d, col=%d, token=%s)' %
+ (msg, line, col, repr(tok)))
return '%s (line=%d, col=%d)' % (msg, line, col)
def warning(self, *arg):
- log.warning(self.msg(*arg))
+ s = self.msg(*arg)
+ if s:
+ log.warning(s)
def error(self, *arg):
- log.error(self.msg(*arg))
+ s = self.msg(*arg)
+ if s:
+ log.error(s)
def exception(self, *arg):
raise PdfParseError(self.msg(*arg))
diff --git a/pdfrw/toreportlab.py b/pdfrw/toreportlab.py
index 2517817..9f77d26 100644
--- a/pdfrw/toreportlab.py
+++ b/pdfrw/toreportlab.py
@@ -1,5 +1,5 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
# MIT license -- See LICENSE.txt for details
'''
@@ -52,7 +52,8 @@ Notes:
'''
from reportlab.pdfbase import pdfdoc as rldocmodule
-from pdfrw.objects import PdfDict, PdfArray, PdfName
+from .objects import PdfDict, PdfArray, PdfName
+from .py23_diffs import convert_store
RLStream = rldocmodule.PDFStream
RLDict = rldocmodule.PDFDictionary
@@ -71,12 +72,13 @@ def _makedict(rldoc, pdfobj):
return rlobj
+
def _makestream(rldoc, pdfobj, xobjtype=PdfName.XObject):
rldict = RLDict()
- rlobj = RLStream(rldict, pdfobj.stream)
+ rlobj = RLStream(rldict, convert_store(pdfobj.stream))
if pdfobj.Type == xobjtype:
- shortname = 'pdfrw_%s' % (rldoc.objectcounter+1)
+ shortname = 'pdfrw_%s' % (rldoc.objectcounter + 1)
fullname = rldoc.getXObjectName(shortname)
else:
shortname = fullname = None
@@ -88,6 +90,7 @@ def _makestream(rldoc, pdfobj, xobjtype=PdfName.XObject):
return result
+
def _makearray(rldoc, pdfobj):
rlobj = rlarray = RLArray([])
if pdfobj.indirect:
@@ -101,9 +104,12 @@ def _makearray(rldoc, pdfobj):
return rlobj
+
def _makestr(rldoc, pdfobj):
assert isinstance(pdfobj, (float, int, str)), repr(pdfobj)
- return pdfobj
+ # TODO: Add fix for float like in pdfwriter
+ return str(getattr(pdfobj, 'encoded', pdfobj))
+
def makerl_recurse(rldoc, pdfobj):
docdict = getattr(pdfobj, 'derived_rl_obj', None)
@@ -126,6 +132,7 @@ def makerl_recurse(rldoc, pdfobj):
func = _makestr
return func(rldoc, pdfobj)
+
def makerl(canv, pdfobj):
try:
rldoc = canv._doc
diff --git a/pdfrw/uncompress.py b/pdfrw/uncompress.py
index 2d5f53b..6780d5d 100644
--- a/pdfrw/uncompress.py
+++ b/pdfrw/uncompress.py
@@ -1,23 +1,34 @@
-# A part of pdfrw (pdfrw.googlecode.com)
-# Copyright (C) 2006-2009 Patrick Maupin, Austin, Texas
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
+# Copyright (C) 2012-2015 Nerijus Mika
# MIT license -- See LICENSE.txt for details
-
+# Copyright (c) 2006, Mathieu Fenniak
+# BSD license -- see LICENSE.txt for details
'''
-Currently, this sad little file only knows how to decompress
-using the flate (zlib) algorithm. Maybe more later, but it's
-not a priority for me...
+A small subset of decompression filters. Should add more later.
+
+I believe, after looking at the code, that portions of the flate
+PNG predictor were originally transcribed from PyPDF2, which is
+probably an excellent source of additional filters.
'''
-import zlib
-from pdfrw.objects import PdfDict, PdfName
-from pdfrw.errors import log
+import array
+from .objects import PdfDict, PdfName
+from .errors import log
+from .py23_diffs import zlib, xrange, from_array, convert_load, convert_store
+
def streamobjects(mylist, isinstance=isinstance, PdfDict=PdfDict):
for obj in mylist:
if isinstance(obj, PdfDict) and obj.stream is not None:
yield obj
-def uncompress(mylist, warnings=set(), flate = PdfName.FlateDecode,
- decompress=zlib.decompressobj, isinstance=isinstance, list=list, len=len):
+# Hack so we can import if zlib not available
+decompressobj = zlib if zlib is None else zlib.decompressobj
+
+
+def uncompress(mylist, leave_raw=False, warnings=set(),
+ flate=PdfName.FlateDecode, decompress=decompressobj,
+ isinstance=isinstance, list=list, len=len):
ok = True
for obj in streamobjects(mylist):
ftype = obj.Filter
@@ -27,26 +38,69 @@ def uncompress(mylist, warnings=set(), flate = PdfName.FlateDecode,
# todo: multiple filters
ftype = ftype[0]
parms = obj.DecodeParms
- if ftype != flate or parms is not None:
- msg = 'Not decompressing: cannot use filter %s with parameters %s' % (repr(ftype), repr(parms))
+ if ftype != flate:
+ msg = ('Not decompressing: cannot use filter %s'
+ ' with parameters %s') % (repr(ftype), repr(parms))
if msg not in warnings:
warnings.add(msg)
log.warning(msg)
ok = False
else:
dco = decompress()
- error = None
try:
- data = dco.decompress(obj.stream)
- except Exception, s:
+ data = dco.decompress(convert_store(obj.stream))
+ except Exception as s:
error = str(s)
+ else:
+ error = None
+ if parms:
+ predictor = int(parms.Predictor or 1)
+ if 10 <= predictor <= 15:
+ data, error = flate_png(data, parms)
+ elif predictor != 1:
+ error = ('Unsupported flatedecode predictor %s' %
+ repr(predictor))
if error is None:
assert not dco.unconsumed_tail
if dco.unused_data.strip():
- error = 'Unconsumed compression data: %s' % repr(dco.unused_data[:20])
+ error = ('Unconsumed compression data: %s' %
+ repr(dco.unused_data[:20]))
if error is None:
obj.Filter = None
- obj.stream = data
+ obj.stream = data if leave_raw else convert_load(data)
else:
log.error('%s %s' % (error, repr(obj.indirect)))
+ ok = False
return ok
+
+
+def flate_png(data, parms):
+ ''' PNG prediction is used to make certain kinds of data
+ more compressible. Before the compression, each data
+ byte is either left the same, or is set to be a delta
+ from the previous byte, or is set to be a delta from
+ the previous row. This selection is done on a per-row
+ basis, and is indicated by a compression type byte
+ prepended to each row of data.
+
+ Within more recent PDF files, it is normal to use
+ this technique for Xref stream objects, which are
+ quite regular.
+ '''
+ columns = int(parms.Columns)
+ data = array.array('B', data)
+ rowlen = columns + 1
+ assert len(data) % rowlen == 0
+ rows = xrange(0, len(data), rowlen)
+ for row_index in rows:
+ offset = data[row_index]
+ if offset >= 2:
+ if offset > 2:
+ return None, 'Unsupported PNG filter %d' % offset
+ offset = rowlen if row_index else 0
+ if offset:
+ for index in xrange(row_index + 1, row_index + rowlen):
+ data[index] = (data[index] + data[index - offset]) % 256
+ for row_index in reversed(rows):
+ data.pop(row_index)
+ return from_array(data), None
diff --git a/releasing.txt b/releasing.txt
new file mode 100644
index 0000000..a108184
--- /dev/null
+++ b/releasing.txt
@@ -0,0 +1,10 @@
+Notes on releasing, which is not yet fully automated:
+
+1) Update version number both in __init__ and in setup
+
+2) Use pyroma
+
+3) https://packaging.python.org/en/latest/distributing.html
+
+a) python setup.py sdist bdist_wheel
+b) twine upload dist/*
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..79bc678
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,5 @@
+[bdist_wheel]
+# This flag says that the code is written to work on both Python 2 and Python
+# 3. If at all possible, it is good practice to do this. If you cannot, you
+# will need to generate wheels for each Python version that you support.
+universal=1
diff --git a/setup.py b/setup.py
index 84fc9cf..7d94f95 100644
--- a/setup.py
+++ b/setup.py
@@ -1,38 +1,38 @@
#!/usr/bin/env python
-from distutils.core import setup
+from setuptools import setup
+from pdfrw import __version__ as version
+from pdfrw.py23_diffs import convert_load
setup(
name='pdfrw',
- version='0.1',
+ version=version,
description='PDF file reader/writer library',
- long_description='''
-pdfrw lets you read and write PDF files, including
-compositing multiple pages together (e.g. to do watermarking,
-or to copy an image or diagram from one PDF to another),
-and can output by itself, or in conjunction with reportlab.
-
-pdfrw will faithfully reproduce vector formats without
-rasterization, so the rst2pdf package has used pdfrw
-by default for PDF and SVG images by default since
-March 2010. Several small examples are provided.
-''',
+ long_description=convert_load(open("README.rst", 'rb').read()),
author='Patrick Maupin',
author_email='pmaupin@gmail.com',
- platforms="Independent",
- url='http://code.google.com/p/pdfrw/',
+ platforms='Independent',
+ url='https://github.com/pmaupin/pdfrw',
packages=['pdfrw', 'pdfrw.objects'],
- license="MIT",
+ license='MIT',
classifiers=[
'Development Status :: 4 - Beta',
- 'Environment :: Console',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python',
+ 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 2.6',
+ 'Programming Language :: Python :: 2.7',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.3',
+ 'Programming Language :: Python :: 3.4',
+
'Topic :: Multimedia :: Graphics :: Graphics Conversion',
'Topic :: Software Development :: Libraries',
- 'Topic :: Utilities'
+ 'Topic :: Text Processing',
+ 'Topic :: Printing',
+ 'Topic :: Utilities',
],
- keywords='pdf vector graphics',
+ keywords='pdf vector graphics PDF nup watermark split join merge',
)
diff --git a/tests/checkdiffs.py b/tests/checkdiffs.py
new file mode 100755
index 0000000..4d11888
--- /dev/null
+++ b/tests/checkdiffs.py
@@ -0,0 +1,81 @@
+#! /usr/bin/env python2
+
+import sys
+import os
+import subprocess
+import hashlib
+
+import expected
+import static_pdfs
+
+source_pdfs = static_pdfs.pdffiles[0]
+source_pdfs = dict((os.path.basename(x), x) for x in source_pdfs)
+
+result_dir = expected.result_dir
+
+for subdir in sorted(os.listdir(result_dir)):
+ dstd = os.path.join(result_dir, subdir)
+ if not os.path.isdir(dstd):
+ continue
+ for pdffile in sorted(os.listdir(dstd)):
+ testname = '%s/%s' % (subdir, pdffile)
+ srcf = source_pdfs.get(pdffile)
+ dstf = os.path.join(dstd, pdffile)
+ if pdffile not in source_pdfs:
+ print('\n Skipping %s -- source not found' % testname)
+ continue
+
+ with open(dstf, 'rb') as f:
+ data = f.read()
+ hash = hashlib.md5(data).hexdigest()
+ skipset = set((hash, 'skip', 'xfail', 'fail', '!' + hash))
+ if expected.results[testname] & skipset:
+ print('\n Skipping %s -- marked done' % testname)
+ continue
+ if os.path.exists('foobar.pdf'):
+ os.remove('foobar.pdf')
+ builtdiff = False
+ while 1:
+ sys.stdout.write('''
+ Test case %s
+
+ c = compare using imagemagick and okular
+ f = display foobar.pdf (result from comparison)
+ o = display results with okular
+ a = display results with acrobat
+
+ s = mark 'skip' and go to next PDF
+ g = mark as good and go to next PDF
+ b = mark as bad and go to next PDF
+ n = next pdf without marking
+ q = quit
+--> ''' % testname)
+ sel = raw_input()
+ if sel == 'q':
+ raise SystemExit(0)
+ if sel == 'n':
+ break
+ if sel == 'c':
+ subprocess.call(('compare', '-verbose', srcf, dstf,
+ 'foobar.pdf'))
+ builtdiff = True
+ continue
+ if sel == 'f':
+ subprocess.call(('okular', 'foobar.pdf'))
+ continue
+ if sel == 'o':
+ subprocess.call(('okular', srcf, dstf))
+ continue
+ if sel == 'a':
+ if builtdiff:
+ subprocess.call(('acroread', srcf, dstf, 'foobar.pdf'))
+ else:
+ subprocess.call(('acroread', srcf, dstf))
+ continue
+
+ if sel in 'sgb':
+ results = (hash if sel == 'g' else
+ ' skip' if sel == 's' else '!'+hash)
+ with open(expected.expectedf, 'a') as f:
+ f.write('%s %s\n' % (testname, results))
+ break
diff --git a/tests/expected.py b/tests/expected.py
new file mode 100644
index 0000000..a65c989
--- /dev/null
+++ b/tests/expected.py
@@ -0,0 +1,41 @@
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2006-2015 Patrick Maupin, Austin, Texas
+# MIT license -- See LICENSE.txt for details
+
+'''
+ Read expected.txt, which should be in the format:
+
+ testname/srcname.pdf validhash
+
+ More than one validhash is allowed (on separate lines),
+ and hash-delimited comments are allowed.
+'''
+
+import os
+import collections
+from pdfrw.py23_diffs import convert_load
+
+root_dir = os.path.dirname(__file__)
+result_dir = 'tmp_results'
+if os.path.exists('ramdisk'):
+ result_dir = os.path.join('ramdisk', result_dir)
+result_dir = os.path.join(root_dir, result_dir)
+
+for sourcef in ('mytests.txt', 'expected.txt'):
+ expectedf = os.path.join(root_dir, sourcef)
+ if os.path.exists(expectedf):
+ break
+
+
+def results():
+ results = collections.defaultdict(set)
+ with open(expectedf, 'rb') as f:
+ for line in f:
+ line = convert_load(line)
+ line = line.split('#', 1)[0].split()
+ if not line:
+ continue
+ key, value = line
+ results[key].add(value)
+ return results
+results = results()
diff --git a/tests/expected.txt b/tests/expected.txt
new file mode 100644
index 0000000..64eecdd
--- /dev/null
+++ b/tests/expected.txt
@@ -0,0 +1,140 @@
+# Example programs
+
+examples/4up_b1c400de699af29ea3f1983bb26870ab 1b73c612c40b5082d955ed72f63644bd
+examples/alter_b1c400de699af29ea3f1983bb26870ab 3c3ee465f45a685ba7098691be05a5ab
+examples/booklet_b1c400de699af29ea3f1983bb26870ab d711b74110eefb4e9e6bf1a5bea16bfe
+examples/extract_1975ef8db7355b1d691bc79d0749574b b4f5ee36a288da970ed040a9a733c8b0
+examples/extract_c5c895deecf7a7565393587e0d61be2b 539aad09ef80907bb396c3260eb87d7b
+examples/extract_d711b74110eefb4e9e6bf1a5bea16bfe 26ddfd09c6e6002228f06782c8544ac4
+examples/print_two_b1c400de699af29ea3f1983bb26870ab 73c8a16aba44548c2c06dae6e2551961
+examples/subset_b1c400de699af29ea3f1983bb26870ab_1-3_5 880a9578197130273ccb51265af08029
+examples/unspread_d711b74110eefb4e9e6bf1a5bea16bfe 780a9abe26a9de0b5b95ee22c4835e4b
+
+examples/cat_b1c400de699af29ea3f1983bb26870ab_06c86654f9a77e82f9adaa0086fc391c 62bb9b746ff5932d3f1b88942d36a81d
+examples/rotate_707e3e2d17cbe9ec2273414b3b63f333_270_1-4_7-8_10-50_52-56 841c980dfadf2cc47ad86e4649ca69b6
+examples/watermark_b1c400de699af29ea3f1983bb26870ab_06c86654f9a77e82f9adaa0086fc391c 41989bb2cb6225c6e14262ff5d4f151f
+examples/watermark_b1c400de699af29ea3f1983bb26870ab_06c86654f9a77e82f9adaa0086fc391c_-u e43e3ac0afe1cc242549424755dbf612
+
+# All these are in the poster test
+examples/subset_1975ef8db7355b1d691bc79d0749574b_21 5057f345f1a1109a0e54276a68e8f8df
+examples/rotate_5057f345f1a1109a0e54276a68e8f8df_90_1 881f4dc8dcf069e707bf61af95492d86
+examples/poster_881f4dc8dcf069e707bf61af95492d86 a34be06d22105b6c02394a9f278fec0d
+
+examples/rl1/4up_b1c400de699af29ea3f1983bb26870ab 959d6246ad8bda72bd023e8681216d17
+examples/rl1/booklet_b1c400de699af29ea3f1983bb26870ab 45b4ae29a038271896b7264bbed63bdf
+examples/rl1/subset_b1c400de699af29ea3f1983bb26870ab_3_5 822bce1cb9e053f1f3f6b922bf27fab8
+examples/rl1/platypus_pdf_template_b1c400de699af29ea3f1983bb26870ab 97ad6a8ca3fe7cc4e1f0ffb8475355e9
+
+# List things that need work here (typically cause exceptions)
+
+# Bad info dict -- works otherwise
+
+simple/b1c400de699af29ea3f1983bb26870ab.pdf ecf2e28de18a724b53670c0d5637ec28
+repaginate/b1c400de699af29ea3f1983bb26870ab.pdf 4d7d6c5f6e14c6eac1dfc055cebfa499
+
+# 07b0ba4 is missing an object. Best we can do is report it
+# (and we do)
+
+repaginate/07b0ba4cff1c6ff73fd468b04b013457.pdf 993c763e085bce7ecc941ba104f4c892
+simple/07b0ba4cff1c6ff73fd468b04b013457.pdf 499b9c1b1e1c76b7c5c0d5e3b62889e3
+
+#b107 has a single page, but with an empty contents dict.
+
+repaginate/b107669d1dd69eabb89765fabb2cb321.pdf 0652d2da25b50cad75863d0e2bbaa878
+simple/b107669d1dd69eabb89765fabb2cb321.pdf 56025c06ab8633575ddc6c6990d2fbf1
+
+# Encrypted files
+
+repaginate/0ae80b493bc21e6de99f2ff6bbb8bc2c.pdf skip
+repaginate/6e122f618c27f3aa9a689423e3be6b8d.pdf skip
+repaginate/7dc787639aa6765214e9ff5494d231ed.pdf skip
+repaginate/b4b27aaa1f9c7c524298e98be279bebb.pdf skip
+repaginate/b5b6c6405d7b48418bccf97277957664.pdf skip
+repaginate/bd0ef57aec16ded45bd89d61b54af0be.pdf skip
+repaginate/dbb807a878ac1da6b91ac15c9de4e209.pdf skip
+simple/0ae80b493bc21e6de99f2ff6bbb8bc2c.pdf skip
+simple/6e122f618c27f3aa9a689423e3be6b8d.pdf skip
+simple/7dc787639aa6765214e9ff5494d231ed.pdf skip
+simple/b4b27aaa1f9c7c524298e98be279bebb.pdf skip
+simple/b5b6c6405d7b48418bccf97277957664.pdf skip
+simple/bd0ef57aec16ded45bd89d61b54af0be.pdf skip
+simple/dbb807a878ac1da6b91ac15c9de4e209.pdf skip
+
+
+
+# List good hashes for round-trips here.
+
+repaginate/06c86654f9a77e82f9adaa0086fc391c.pdf 848966fe40a1e3de842f82700dc6d67b
+repaginate/08f69084d72dabc5dfdcf5c1ff2a719f.pdf b8c60878b0e0ce81cb6e8777038166b1
+repaginate/09715ec1a7b0f3a7ae02b3046f627b9f.pdf daf7cff9c0a15bbb347489f9fbda25f8
+repaginate/0a61de50b5ee0ea4d5d69c95dab817a3.pdf c6cd38b1131c4b856f60ebfcf51da6f5
+repaginate/1975ef8db7355b1d691bc79d0749574b.pdf 53e5510be27db134edf3cf23873914af
+repaginate/1c2af1d2b0db6cac3c8e558a26efd38b.pdf 20dc3be2affe9082564c01b1146d7598
+repaginate/1f5dd128c3757420a881a155f2f8ace3.pdf 019aead1450842406a04c508243e5161
+repaginate/22628a7ed578b622520325673ab2a4f2.pdf 255776a6956918c7b324dede711680ae
+repaginate/2ac7c68e26a8ef797aead15e4875cc6d.pdf e7344551183415d6257e2cab2aef4a61
+repaginate/295d26e61a85635433f8e4b768953f60.pdf 13ece51f4d2ad25707982765abbcd789
+repaginate/2fac0d9a189ca5fcef8626153d050be8.pdf 95fe3d9258ace5bdccb95a55c2c8cb22
+repaginate/319c998910453bc44d40c7748cd2cb79.pdf c1a19d1acc3f172711bdbea000cf392e
+repaginate/35df0b8cff4afec0c08f08c6a5bc9857.pdf 3568e1c885a461b350c790ec5b729af3
+repaginate/365b9c95574ee8944370fe286905d0e8.pdf 84e5fc0d4f30ff8db05780fd244d9cf0
+repaginate/4805fdcd7e142e8df3c04c6ba06025af.pdf 3b5b8254dc99c2f0f62fe2afa42fad4e
+repaginate/49e31fd074eca6af981d78d42d0078ec.pdf 77fd3fa86c7c0166a373b66cfef357d2
+repaginate/536dfc6fbadd87c03eb59375d091eb53.pdf d0b7467d7bd6c7f73b7764b06c0be1aa
+repaginate/569f8094597bbe5b58efc3a7c6e14e87.pdf 6b0ab50c247ca43b70b2b2f27ee2c1a2
+repaginate/5f0cff36d0ad74536a6513a98a755016.pdf b65c2557988db8625c0761bab1d131f1
+repaginate/5f265db2736850782aeaba2571a3c749.pdf 9bb5644ede0ee7cf99642729eda76686
+repaginate/6a42c8c79b807bf164d31071749e07b0.pdf 33a231263e1a4203338b7b1052fc0091
+repaginate/6f3a4de5c68ba3b5093e9b54b7c4e9f4.pdf 93419e831e436d9093a153f35d3441c3
+repaginate/7037a992b80b60f0294016037baa9292.pdf dd41b0104f185206b51e7ffe5b07d261
+repaginate/707e3e2d17cbe9ec2273414b3b63f333.pdf 6c65526ab372d72cb185933e3d2584ef
+repaginate/71a751ce2d93a6a5d6ff21735b701fb7.pdf a825f06c934319b93474902fcf300cd2
+repaginate/72eb207b8f882618899aa7a65d3cecda.pdf 0b64f19a8a39fadfa2a3eec3f1a01233
+repaginate/97ba0a239cefa0dc727c2f1be050ec6c.pdf a94fe7183ce8979174b2ac16dcd9b1ea
+repaginate/9d8626d18b1d8807d271e6ffc409446a.pdf cdfcf8add1af9e612ba1a2ee06a6a273
+repaginate/9f98322c243fe67726d56ccfa8e0885b.pdf 69503ac140a1e4f1322f9350646e3dae
+repaginate/c55eb9a13859a7fbddd8af9c16eba3a7.pdf b0d1f3925423f9c3ecf4a47baa949f75
+repaginate/c5c895deecf7a7565393587e0d61be2b.pdf 59e350c6f7d7b89fab36a4019bb526fd
+repaginate/d2f0b2086160d4f3d325c79a5dc1fb4d.pdf 3623b7f200818c63cb6838f9678a4840
+repaginate/d6fd9567078b48c86710e9c49173781f.pdf 874b532f61139261f71afb5987dd2a68
+repaginate/e9ab02aa769f4c040a6fa52f00d6e3f0.pdf 7d3c3ae13cc7d53e7fa6ef046e15dbaa
+repaginate/ec00d5825f47b9d0faa953b1709163c3.pdf 8e6a481476c2b3bdd64ce8e36f8fe273
+repaginate/ed81787b83cc317c9f049643b853bea3.pdf 4636b68f294302417b81aaaadde1c73d
+
+simple/06c86654f9a77e82f9adaa0086fc391c.pdf 6e2a2e063de895d28dfea9aacb9fe469
+simple/08f69084d72dabc5dfdcf5c1ff2a719f.pdf 5a41601f6033356539e623091a3f79ef
+simple/0a61de50b5ee0ea4d5d69c95dab817a3.pdf 182712dd5be8aebd29decb57cf530334
+simple/09715ec1a7b0f3a7ae02b3046f627b9f.pdf c4e4b3b725bd5fc3b008f1ac6251ad1c
+simple/1975ef8db7355b1d691bc79d0749574b.pdf 475c28c9588f3a7f6110d30f391758c4
+simple/1c2af1d2b0db6cac3c8e558a26efd38b.pdf 3f17f19fd92adf01998bb13a0ee52b92
+simple/1f5dd128c3757420a881a155f2f8ace3.pdf b0d01f9d6ac156326aeb14b940aa73e7
+simple/22628a7ed578b622520325673ab2a4f2.pdf 1163cec415728899e997a29be465d02d
+simple/295d26e61a85635433f8e4b768953f60.pdf fe3b8960c7f877db05c7cd12c9c6e097
+simple/2ac7c68e26a8ef797aead15e4875cc6d.pdf 2623eae06eada9587574f8ddd7fc80fa
+simple/2fac0d9a189ca5fcef8626153d050be8.pdf 458501ecda909b00262b9654f0b09ebf
+simple/319c998910453bc44d40c7748cd2cb79.pdf 8c84e36ec1db8c1dbfaa312646e000b4
+simple/35df0b8cff4afec0c08f08c6a5bc9857.pdf 0a2926c23ad916c449d5dadcfa9d38ef
+simple/365b9c95574ee8944370fe286905d0e8.pdf cf3bfac41f410bf5bd657e3f906dfbc6
+simple/4805fdcd7e142e8df3c04c6ba06025af.pdf 3b5b8254dc99c2f0f62fe2afa42fad4e
+simple/49e31fd074eca6af981d78d42d0078ec.pdf 2c316537a5b0917634cbbdc5b91511df
+simple/536dfc6fbadd87c03eb59375d091eb53.pdf 319851765c70ba103c4191f7ec2148db
+simple/569f8094597bbe5b58efc3a7c6e14e87.pdf 025f1bf95cc537c36b8c3a044758b86c
+simple/5f0cff36d0ad74536a6513a98a755016.pdf 8476fd75e75394fcbbe02816d0640e7d
+simple/5f265db2736850782aeaba2571a3c749.pdf d4d2e93ab22e866c86e32da84421f6f9
+simple/6a42c8c79b807bf164d31071749e07b0.pdf 221fec351c925a43f5f409fe03d90013
+simple/6f3a4de5c68ba3b5093e9b54b7c4e9f4.pdf fe8dd16dd7fef40338140e0610d0cbbf
+simple/7037a992b80b60f0294016037baa9292.pdf 6a2ef24e5f74dd74969ff8cefdfc6a05
+simple/707e3e2d17cbe9ec2273414b3b63f333.pdf 4bdf1e57a96ce42717110b4e55098c1a
+simple/71a751ce2d93a6a5d6ff21735b701fb7.pdf a825f06c934319b93474902fcf300cd2
+simple/72eb207b8f882618899aa7a65d3cecda.pdf 4ce7ff29531cc417c26389af28dc1c5e
+simple/97ba0a239cefa0dc727c2f1be050ec6c.pdf c24873bab85b8ecc7c5433d8d802bceb
+simple/9d8626d18b1d8807d271e6ffc409446a.pdf 2358d654bf20d2b9d179ab009a615c4e
+simple/9f98322c243fe67726d56ccfa8e0885b.pdf 9290b4c32f005e1e4c7f431955246c4c
+simple/c55eb9a13859a7fbddd8af9c16eba3a7.pdf 6b406128e0ed1ac23dc5a0ee34d1f717
+simple/c5c895deecf7a7565393587e0d61be2b.pdf 2cc3c75e56d5dd562ca5b1f994bd9d5c
+simple/d2f0b2086160d4f3d325c79a5dc1fb4d.pdf 2083f0e55cf06d88df02956a21bfef23
+simple/d6fd9567078b48c86710e9c49173781f.pdf 77464ec5cfdacb61a73b506bc4945631
+simple/e9ab02aa769f4c040a6fa52f00d6e3f0.pdf 5bc96989bc4f4b6438da953443336124
+simple/ec00d5825f47b9d0faa953b1709163c3.pdf 708f66049169c28ac39b0553908dc318
+simple/ed81787b83cc317c9f049643b853bea3.pdf c227d627217dc6808c50e80063734d27
+
diff --git a/tests/myprofile.py b/tests/myprofile.py
new file mode 100644
index 0000000..af18a64
--- /dev/null
+++ b/tests/myprofile.py
@@ -0,0 +1,5 @@
+import cProfile
+import unittest
+import test_roundtrip
+
+cProfile.run('unittest.main(test_roundtrip)')
diff --git a/tests/test_examples.py b/tests/test_examples.py
new file mode 100755
index 0000000..baa98a6
--- /dev/null
+++ b/tests/test_examples.py
@@ -0,0 +1,195 @@
+#! /usr/bin/env python
+
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2015 Patrick Maupin, Austin, Texas
+# MIT license -- See LICENSE.txt for details
+
+'''
+Run from the directory above like so:
+
+ python -m tests.test_examples
+
+A PDF that has been determined to be good or bad
+should be added to expected.txt with either a good
+checksum, or just the word "fail".
+
+These tests are incomplete, but they allow us to try
+out various PDFs. There is a collection of difficult
+PDFs available on github.
+
+In order to use them:
+
+ 1) Insure that github.com/pmaupin/static_pdfs is on your path.
+
+ 2) Use the imagemagick compare program to look at differences
+ between the static_pdfs/global directory and the tmp_results
+ directory after you run this.
+
+
+'''
+import sys
+import os
+import hashlib
+import subprocess
+import static_pdfs
+import expected
+
+from pdfrw.py23_diffs import convert_store
+from pdfrw import PdfReader, PdfWriter
+
+try:
+ import unittest2 as unittest
+except ImportError:
+ import unittest
+
+
+prog_dir = os.path.join(expected.root_dir, '..', 'examples', '%s.py')
+prog_dir = os.path.abspath(prog_dir)
+dstdir = os.path.join(expected.result_dir, 'examples')
+hashfile = os.path.join(expected.result_dir, 'hashes.txt')
+
+lookup = static_pdfs.pdffiles[0]
+lookup = dict((os.path.basename(x)[:-4], x) for x in lookup)
+
+
+class TestOnePdf(unittest.TestCase):
+
+ def do_test(self, params, prev_results=[''], scrub=False):
+ params = params.split()
+ hashkey = 'examples/%s' % '_'.join(params)
+ params = [lookup.get(x, x) for x in params]
+ progname = params[0]
+ params[0] = prog_dir % progname
+ srcf = params[1]
+ params.insert(0, sys.executable)
+ subdir, progname = os.path.split(progname)
+ subdir = os.path.join(dstdir, subdir)
+ if not os.path.exists(subdir):
+ os.makedirs(subdir)
+ os.chdir(subdir)
+ dstf = '%s.%s' % (progname, os.path.basename(srcf))
+ scrub = scrub and dstf
+ dstf = dstf if not scrub else 'final.%s' % dstf
+ hash = '------no-file-generated---------'
+ expects = expected.results[hashkey]
+
+ # If the test has been deliberately skipped,
+ # we are done. Otherwise, execute it even
+ # if we don't know about it yet, so we have
+ # results to compare.
+
+ result = 'fail'
+ size = 0
+ try:
+ if 'skip' in expects:
+ result = 'skip requested'
+ return self.skipTest(result)
+ elif 'xfail' in expects:
+ result = 'xfail requested'
+ return self.fail(result)
+
+ exists = os.path.exists(dstf)
+ if expects or not exists:
+ if exists:
+ os.remove(dstf)
+ if scrub and os.path.exists(scrub):
+ os.remove(scrub)
+ subprocess.call(params)
+ if scrub:
+ PdfWriter().addpages(PdfReader(scrub).pages).write(dstf)
+ with open(dstf, 'rb') as f:
+ data = f.read()
+ size = len(data)
+ if data:
+ hash = hashlib.md5(data).hexdigest()
+ lookup[hash] = dstf
+ prev_results[0] = hash
+ else:
+ os.remove(dstf)
+ if expects:
+ if len(expects) == 1:
+ expects, = expects
+ self.assertEqual(hash, expects)
+ else:
+ self.assertIn(hash, expects)
+ result = 'pass'
+ else:
+ result = 'skip'
+ self.skipTest('No hash available')
+ finally:
+ result = '%8d %-20s %s %s\n' % (size, result, hashkey, hash)
+ with open(hashfile, 'ab') as f:
+ f.write(convert_store(result))
+
+ def test_4up(self):
+ self.do_test('4up b1c400de699af29ea3f1983bb26870ab')
+
+ def test_booklet_unspread(self):
+ prev = [None]
+ self.do_test('booklet b1c400de699af29ea3f1983bb26870ab', prev)
+ if prev[0] is not None:
+ self.do_test('unspread ' + prev[0])
+ self.do_test('extract ' + prev[0])
+
+ def test_print_two(self):
+ self.do_test('print_two b1c400de699af29ea3f1983bb26870ab')
+
+ def test_watermarks(self):
+ self.do_test('watermark b1c400de699af29ea3f1983bb26870ab '
+ '06c86654f9a77e82f9adaa0086fc391c')
+ self.do_test('watermark b1c400de699af29ea3f1983bb26870ab '
+ '06c86654f9a77e82f9adaa0086fc391c -u')
+
+ def test_subset(self):
+ self.do_test('subset b1c400de699af29ea3f1983bb26870ab 1-3 5')
+
+ def test_alter(self):
+ self.do_test('alter b1c400de699af29ea3f1983bb26870ab')
+
+ def test_cat(self):
+ self.do_test('cat b1c400de699af29ea3f1983bb26870ab '
+ '06c86654f9a77e82f9adaa0086fc391c')
+
+ def test_rotate(self):
+ self.do_test('rotate 707e3e2d17cbe9ec2273414b3b63f333 '
+ '270 1-4 7-8 10-50 52-56')
+
+ def test_poster(self):
+ prev = [None]
+ self.do_test('subset 1975ef8db7355b1d691bc79d0749574b 21', prev)
+ self.do_test('rotate %s 90 1' % prev[0], prev)
+ self.do_test('poster %s' % prev[0], prev)
+
+ def test_extract(self):
+ self.do_test('extract 1975ef8db7355b1d691bc79d0749574b')
+ self.do_test('extract c5c895deecf7a7565393587e0d61be2b')
+
+ def test_rl1_4up(self):
+ if sys.version_info < (2, 7):
+ return
+ self.do_test('rl1/4up b1c400de699af29ea3f1983bb26870ab',
+ scrub=True)
+
+ def test_rl1_booklet(self):
+ if sys.version_info < (2, 7):
+ return
+ self.do_test('rl1/booklet b1c400de699af29ea3f1983bb26870ab',
+ scrub=True)
+
+ def test_rl1_subset(self):
+ if sys.version_info < (2, 7):
+ return
+ self.do_test('rl1/subset b1c400de699af29ea3f1983bb26870ab 3 5',
+ scrub=True)
+
+ def test_rl1_platypus(self):
+ if sys.version_info < (2, 7):
+ return
+ self.do_test('rl1/platypus_pdf_template b1c400de699af29ea3f1983bb26870ab',
+ scrub=True)
+
+def main():
+ unittest.main()
+
+if __name__ == '__main__':
+ main()
diff --git a/tests/test_pdfstring.py b/tests/test_pdfstring.py
index 4dcd2df..fce47ef 100644
--- a/tests/test_pdfstring.py
+++ b/tests/test_pdfstring.py
@@ -1,3 +1,5 @@
+#! /usr/bin/env python
+
'''
Run from the directory above like so:
python -m tests.test_pdfstring
@@ -12,11 +14,11 @@ class TestEncoding(unittest.TestCase):
@staticmethod
def decode(value):
- return pdfrw.pdfobjects.PdfString(value).decode()
+ return pdfrw.objects.PdfString(value).decode()
@staticmethod
def encode(value):
- return str(pdfrw.pdfobjects.PdfString.encode(value))
+ return str(pdfrw.objects.PdfString.encode(value))
@classmethod
def encode_decode(cls, value):
diff --git a/tests/test_roundtrip.py b/tests/test_roundtrip.py
new file mode 100755
index 0000000..cb3645e
--- /dev/null
+++ b/tests/test_roundtrip.py
@@ -0,0 +1,132 @@
+#! /usr/bin/env python
+
+# A part of pdfrw (https://github.com/pmaupin/pdfrw)
+# Copyright (C) 2015 Patrick Maupin, Austin, Texas
+# MIT license -- See LICENSE.txt for details
+
+'''
+Run from the directory above like so:
+
+ python -m tests.test_roundtrip
+
+A PDF that has been determined to be good or bad
+should be added to expected.txt with either a good
+checksum, or just the word "fail".
+
+These tests are incomplete, but they allow us to try
+out various PDFs. There is a collection of difficult
+PDFs available on github.
+
+In order to use them:
+
+ 1) Insure that github.com/pmaupin/static_pdfs is on your path.
+
+ 2) Use the imagemagick compare program to look at differences
+ between the static_pdfs/global directory and the tmp_results
+ directory after you run this.
+
+
+'''
+import os
+import hashlib
+import pdfrw
+import static_pdfs
+import expected
+
+from pdfrw.py23_diffs import convert_store
+
+try:
+ import unittest2 as unittest
+except ImportError:
+ import unittest
+
+
+class TestOnePdf(unittest.TestCase):
+
+ def roundtrip(self, testname, basename, srcf, decompress=False,
+ compress=False, repaginate=False):
+ dstd = os.path.join(expected.result_dir, testname)
+ if not os.path.exists(dstd):
+ os.makedirs(dstd)
+ dstf = os.path.join(dstd, basename)
+ hashfile = os.path.join(expected.result_dir, 'hashes.txt')
+ hashkey = '%s/%s' % (testname, basename)
+ hash = '------no-file-generated---------'
+ expects = expected.results[hashkey]
+
+ # If the test has been deliberately skipped,
+ # we are done. Otherwise, execute it even
+ # if we don't know about it yet, so we have
+ # results to compare.
+
+ result = 'fail'
+ size = 0
+ try:
+ if 'skip' in expects:
+ result = 'skip requested'
+ return self.skipTest(result)
+ elif 'xfail' in expects:
+ result = 'xfail requested'
+ return self.fail(result)
+
+ exists = os.path.exists(dstf)
+ if expects or not exists:
+ if exists:
+ os.remove(dstf)
+ trailer = pdfrw.PdfReader(srcf, decompress=decompress,
+ verbose=False)
+ if trailer.Encrypt:
+ result = 'skip -- encrypt'
+ hash = '------skip-encrypt-no-file------'
+ return self.skipTest('File encrypted')
+ writer = pdfrw.PdfWriter(compress=compress)
+ if repaginate:
+ writer.addpages(trailer.pages)
+ trailer = None
+ writer.write(dstf, trailer)
+ with open(dstf, 'rb') as f:
+ data = f.read()
+ size = len(data)
+ if data:
+ hash = hashlib.md5(data).hexdigest()
+ else:
+ os.remove(dstf)
+ if expects:
+ if len(expects) == 1:
+ expects, = expects
+ self.assertEqual(hash, expects)
+ else:
+ self.assertIn(hash, expects)
+ result = 'pass'
+ else:
+ result = 'skip'
+ self.skipTest('No hash available')
+ finally:
+ result = '%8d %-20s %s %s\n' % (size, result, hashkey, hash)
+ with open(hashfile, 'ab') as f:
+ f.write(convert_store(result))
+
+
+def build_tests():
+ def test_closure(*args, **kw):
+ def test(self):
+ self.roundtrip(*args, **kw)
+ return test
+ for mytest, repaginate in (
+ ('simple', False),
+ ('repaginate', True)
+ ):
+ for srcf in static_pdfs.pdffiles[0]:
+ basename = os.path.basename(srcf)
+ test_name = 'test_%s_%s' % (mytest, basename)
+ test = test_closure(mytest, basename, srcf,
+ repaginate=repaginate)
+ setattr(TestOnePdf, test_name, test)
+build_tests()
+
+
+def main():
+ unittest.main()
+
+if __name__ == '__main__':
+ main()