Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

STY: Documentation, Variable names #839

Merged
merged 5 commits into from
Apr 30, 2022
Merged

STY: Documentation, Variable names #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
de69c50
STY: Documentation, Variable names
MartinThoma Apr 30, 2022
a37c0ff
pytest style
MartinThoma Apr 30, 2022
cee15f0
constants
MartinThoma Apr 30, 2022
2cfa3a0
Ignore B007
MartinThoma Apr 30, 2022
3d9bd5a
Merge branch 'main' into style-improvements
MartinThoma Apr 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 54 additions & 49 deletions PyPDF2/_page.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,9 @@ def createRectangleAccessor(name, fallback):

class PageObject(DictionaryObject):
"""
This class represents a single page within a PDF file. Typically this
object will be created by accessing the
PageObject represents a single page within a PDF file.

Typically this object will be created by accessing the
:meth:`getPage()<PyPDF2.PdfFileReader.getPage>` method of the
:class:`PdfFileReader<PyPDF2.PdfFileReader>` class, but it is
also possible to create an empty page with the
Expand All @@ -107,7 +108,8 @@ def __init__(self, pdf=None, indirectRef=None):
@staticmethod
def createBlankPage(pdf=None, width=None, height=None):
"""
Returns a new blank page.
Return a new blank page.

If ``width`` or ``height`` is ``None``, try to get the page size
from the last page of *pdf*.

Expand All @@ -124,8 +126,8 @@ def createBlankPage(pdf=None, width=None, height=None):
page = PageObject(pdf)

# Creates a new page (cf PDF Reference 7.7.3.3)
page.__setitem__(NameObject("/Type"), NameObject("/Page"))
page.__setitem__(NameObject("/Parent"), NullObject())
page.__setitem__(NameObject(PG.TYPE), NameObject("/Page"))
page.__setitem__(NameObject(PG.PARENT), NullObject())
page.__setitem__(NameObject(PG.RESOURCES), DictionaryObject())
if width is None or height is None:
if pdf is not None and pdf.getNumPages() > 0:
Expand All @@ -142,7 +144,7 @@ def createBlankPage(pdf=None, width=None, height=None):

def rotateClockwise(self, angle):
"""
Rotates a page clockwise by increments of 90 degrees.
Rotate a page clockwise by increments of 90 degrees.

:param int angle: Angle to rotate the page. Must be an increment
of 90 deg.
Expand All @@ -154,7 +156,7 @@ def rotateClockwise(self, angle):

def rotateCounterClockwise(self, angle):
"""
Rotates a page counter-clockwise by increments of 90 degrees.
Rotate a page counter-clockwise by increments of 90 degrees.

:param int angle: Angle to rotate the page. Must be an increment
of 90 deg.
Expand All @@ -165,11 +167,11 @@ def rotateCounterClockwise(self, angle):
return self

def _rotate(self, angle):
rotate_obj = self.get("/Rotate", 0)
rotate_obj = self.get(PG.ROTATE, 0)
current_angle = (
rotate_obj if isinstance(rotate_obj, int) else rotate_obj.getObject()
)
self[NameObject("/Rotate")] = NumberObject(current_angle + angle)
self[NameObject(PG.ROTATE)] = NumberObject(current_angle + angle)

@staticmethod
def _mergeResources(res1, res2, resource):
Expand Down Expand Up @@ -240,19 +242,21 @@ def _addTransformationMatrix(contents, pdf, ctm):

def getContents(self):
"""
Accesses the page contents.
Access the page contents.

:return: the ``/Contents`` object, or ``None`` if it doesn't exist.
``/Contents`` is optional, as described in PDF Reference 7.7.3.3
"""
if "/Contents" in self:
return self["/Contents"].getObject()
if PG.CONTENTS in self:
return self[PG.CONTENTS].getObject()
else:
return None

def mergePage(self, page2):
"""
Merges the content streams of two pages into one. Resource references
Merge the content streams of two pages into one.

Resource references
(i.e. fonts) are maintained from both pages. The mediabox/cropbox/etc
of this page are not altered. The parameter page's content stream will
be added to the end of this page's content stream, meaning that it will
Expand Down Expand Up @@ -282,13 +286,13 @@ def _mergePage(self, page2, page2transformation=None, ctm=None, expand=False):
new_annots.append(ref)

for res in (
"/ExtGState",
RES.EXT_G_STATE,
RES.FONT,
RES.XOBJECT,
RES.COLOR_SPACE,
"/Pattern",
"/Shading",
"/Properties",
RES.PATTERN,
RES.SHADING,
RES.PROPERTIES,
):
new, newrename = PageObject._mergeResources(
original_resources, page2resources, res
Expand All @@ -298,11 +302,11 @@ def _mergePage(self, page2, page2transformation=None, ctm=None, expand=False):
rename.update(newrename)

# Combine /ProcSet sets.
new_resources[NameObject(RES.PROCSET)] = ArrayObject(
new_resources[NameObject(RES.PROC_SET)] = ArrayObject(
frozenset(
original_resources.get(RES.PROCSET, ArrayObject()).getObject()
original_resources.get(RES.PROC_SET, ArrayObject()).getObject()
).union(
frozenset(page2resources.get(RES.PROCSET, ArrayObject()).getObject())
frozenset(page2resources.get(RES.PROC_SET, ArrayObject()).getObject())
)
)

Expand Down Expand Up @@ -382,14 +386,14 @@ def _mergePage(self, page2, page2transformation=None, ctm=None, expand=False):
self.mediaBox.setLowerLeft(lowerleft)
self.mediaBox.setUpperRight(upperright)

self[NameObject("/Contents")] = ContentStream(new_content_array, self.pdf)
self[NameObject(PG.CONTENTS)] = ContentStream(new_content_array, self.pdf)
self[NameObject(PG.RESOURCES)] = new_resources
self[NameObject(PG.ANNOTS)] = new_annots

def mergeTransformedPage(self, page2, ctm, expand=False):
"""
This is similar to mergePage, but a transformation matrix is
applied to the merged stream.
mergeTransformedPage is similar to mergePage, but a transformation
matrix is applied to the merged stream.

:param PageObject page2: The page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand All @@ -409,8 +413,8 @@ def mergeTransformedPage(self, page2, ctm, expand=False):

def mergeScaledPage(self, page2, scale, expand=False):
"""
This is similar to mergePage, but the stream to be merged is scaled
by appling a transformation matrix.
mergeScaledPage is similar to mergePage, but the stream to be merged
is scaled by appling a transformation matrix.

:param PageObject page2: The page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand All @@ -423,8 +427,8 @@ def mergeScaledPage(self, page2, scale, expand=False):

def mergeRotatedPage(self, page2, rotation, expand=False):
"""
This is similar to mergePage, but the stream to be merged is rotated
by appling a transformation matrix.
mergeRotatedPage is similar to mergePage, but the stream to be merged
is rotated by appling a transformation matrix.

:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand All @@ -448,8 +452,8 @@ def mergeRotatedPage(self, page2, rotation, expand=False):

def mergeTranslatedPage(self, page2, tx, ty, expand=False):
"""
This is similar to mergePage, but the stream to be merged is translated
by appling a transformation matrix.
mergeTranslatedPage is similar to mergePage, but the stream to be
merged is translated by appling a transformation matrix.

:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand All @@ -462,8 +466,8 @@ def mergeTranslatedPage(self, page2, tx, ty, expand=False):

def mergeRotatedTranslatedPage(self, page2, rotation, tx, ty, expand=False):
"""
This is similar to mergePage, but the stream to be merged is rotated
and translated by appling a transformation matrix.
mergeRotatedTranslatedPage is similar to mergePage, but the stream to
be merged is rotated and translated by appling a transformation matrix.

:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand Down Expand Up @@ -493,8 +497,8 @@ def mergeRotatedTranslatedPage(self, page2, rotation, tx, ty, expand=False):

def mergeRotatedScaledPage(self, page2, rotation, scale, expand=False):
"""
This is similar to mergePage, but the stream to be merged is rotated
and scaled by appling a transformation matrix.
mergeRotatedScaledPage is similar to mergePage, but the stream to be
merged is rotated and scaled by appling a transformation matrix.

:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand All @@ -520,8 +524,8 @@ def mergeRotatedScaledPage(self, page2, rotation, scale, expand=False):

def mergeScaledTranslatedPage(self, page2, scale, tx, ty, expand=False):
"""
This is similar to mergePage, but the stream to be merged is translated
and scaled by appling a transformation matrix.
mergeScaledTranslatedPage is similar to mergePage, but the stream to be
merged is translated and scaled by appling a transformation matrix.

:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand All @@ -546,8 +550,9 @@ def mergeRotatedScaledTranslatedPage(
self, page2, rotation, scale, tx, ty, expand=False
):
"""
This is similar to mergePage, but the stream to be merged is translated,
rotated and scaled by appling a transformation matrix.
mergeRotatedScaledTranslatedPage is similar to mergePage, but the
stream to be merged is translated, rotated and scaled by appling a
transformation matrix.

:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
Expand Down Expand Up @@ -577,7 +582,7 @@ def mergeRotatedScaledTranslatedPage(

def addTransformation(self, ctm):
"""
Applies a transformation matrix to the page.
Apply a transformation matrix to the page.

:param tuple ctm: A 6-element tuple containing the operands of the
transformation matrix.
Expand All @@ -588,11 +593,11 @@ def addTransformation(self, ctm):
original_content, self.pdf, ctm
)
new_content = PageObject._pushPopGS(new_content, self.pdf)
self[NameObject("/Contents")] = new_content
self[NameObject(PG.CONTENTS)] = new_content

def scale(self, sx, sy):
"""
Scales a page by the given factors by appling a transformation
Scale a page by the given factors by appling a transformation
matrix to its content and updating the page size.

:param float sx: The scaling factor on horizontal axis.
Expand All @@ -607,8 +612,8 @@ def scale(self, sx, sy):
float(self.mediaBox.getUpperRight_y()) * sy,
]
)
if "/VP" in self:
viewport = self["/VP"]
if PG.VP in self:
viewport = self[PG.VP]
if isinstance(viewport, ArrayObject):
bbox = viewport[0]["/BBox"]
else:
Expand All @@ -622,15 +627,15 @@ def scale(self, sx, sy):
]
)
if isinstance(viewport, ArrayObject):
self[NameObject("/VP")][NumberObject(0)][
self[NameObject(PG.VP)][NumberObject(0)][
NameObject("/BBox")
] = scaled_bbox
else:
self[NameObject("/VP")][NameObject("/BBox")] = scaled_bbox
self[NameObject(PG.VP)][NameObject("/BBox")] = scaled_bbox

def scaleBy(self, factor):
"""
Scales a page by the given factor by appling a transformation
Scale a page by the given factor by appling a transformation
matrix to its content and updating the page size.

:param float factor: The scaling factor (for both X and Y axis).
Expand All @@ -639,7 +644,7 @@ def scaleBy(self, factor):

def scaleTo(self, width, height):
"""
Scales a page to the specified dimentions by appling a
Scale a page to the specified dimentions by appling a
transformation matrix to its content and updating the page size.

:param float width: The new width.
Expand All @@ -655,7 +660,7 @@ def scaleTo(self, width, height):

def compressContentStreams(self):
"""
Compresses the size of this page by joining all content streams and
Compress the size of this page by joining all content streams and
applying a FlateDecode filter.

However, it is possible that this function will perform no action if
Expand All @@ -665,7 +670,7 @@ def compressContentStreams(self):
if content is not None:
if not isinstance(content, ContentStream):
content = ContentStream(content, self.pdf)
self[NameObject("/Contents")] = content.flateEncode()
self[NameObject(PG.CONTENTS)] = content.flateEncode()

def extractText(self, Tj_sep="", TJ_sep=""):
"""
Expand All @@ -679,7 +684,7 @@ def extractText(self, Tj_sep="", TJ_sep=""):
:return: a unicode string object.
"""
text = u_("")
content = self["/Contents"].getObject()
content = self[PG.CONTENTS].getObject()
if not isinstance(content, ContentStream):
content = ContentStream(content, self.pdf)
# Note: we check all strings are TextStringObjects. ByteStringObjects
Expand Down
Loading