forked from py-pdf/pypdf
-
Notifications
You must be signed in to change notification settings - Fork 1
/
_page.py
2086 lines (1865 loc) · 80.7 KB
/
_page.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2006, Mathieu Fenniak
# Copyright (c) 2007, Ashish Kulkarni <kulkarni.ashish@gmail.com>
#
# All rights reserved.
#
# 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.
import math
import uuid
import warnings
from decimal import Decimal
from typing import (
Any,
Callable,
Dict,
Iterable,
Iterator,
List,
Optional,
Set,
Tuple,
Union,
cast,
)
from ._cmap import build_char_map, unknown_char_map
from ._utils import (
CompressedTransformationMatrix,
File,
TransformationMatrixType,
deprecate_no_replacement,
deprecate_with_replacement,
logger_warning,
matrix_multiply,
)
from .constants import ImageAttributes as IA
from .constants import PageAttributes as PG
from .constants import Ressources as RES
from .errors import PageSizeNotDefinedError
from .filters import _xobj_to_image
from .generic import (
ArrayObject,
ContentStream,
DictionaryObject,
EncodedStreamObject,
FloatObject,
IndirectObject,
NameObject,
NullObject,
NumberObject,
RectangleObject,
TextStringObject,
encode_pdfdocencoding,
)
CUSTOM_RTL_MIN: int = -1
CUSTOM_RTL_MAX: int = -1
CUSTOM_RTL_SPECIAL_CHARS: List[int] = []
def set_custom_rtl(
_min: Union[str, int, None] = None,
_max: Union[str, int, None] = None,
specials: Union[str, List[int], None] = None,
) -> Tuple[int, int, List[int]]:
"""
changes the Right-To-Left and special characters customed parameters:
_min -> CUSTOM_RTL_MIN : None does not change the value ; int or str(converted to ascii code) ; -1 by default
_max -> CUSTOM_RTL_MAX : None does not change the value ; int or str(converted to ascii code) ; -1 by default
those values define a range of custom characters that will be written right to left ;
[-1;-1] set no additional range to be converter
specials -> CUSTOM_RTL_SPECIAL_CHARS: None does not change the current value; str to be converted to list or list of ascii codes ; [] by default
list of codes that will inserted applying the current insertion order ; this consist normally in a list of punctuation characters
"""
global CUSTOM_RTL_MIN, CUSTOM_RTL_MAX, CUSTOM_RTL_SPECIAL_CHARS
if isinstance(_min, int):
CUSTOM_RTL_MIN = _min
elif isinstance(_min, str):
CUSTOM_RTL_MIN = ord(_min)
if isinstance(_max, int):
CUSTOM_RTL_MAX = _max
elif isinstance(_max, str):
CUSTOM_RTL_MAX = ord(_max)
if isinstance(specials, str):
CUSTOM_RTL_SPECIAL_CHARS = [ord(x) for x in specials]
elif isinstance(specials, list):
CUSTOM_RTL_SPECIAL_CHARS = specials
return CUSTOM_RTL_MIN, CUSTOM_RTL_MAX, CUSTOM_RTL_SPECIAL_CHARS
def _get_rectangle(self: Any, name: str, defaults: Iterable[str]) -> RectangleObject:
retval: Union[None, RectangleObject, IndirectObject] = self.get(name)
if isinstance(retval, RectangleObject):
return retval
if retval is None:
for d in defaults:
retval = self.get(d)
if retval is not None:
break
if isinstance(retval, IndirectObject):
retval = self.pdf.get_object(retval)
retval = RectangleObject(retval) # type: ignore
_set_rectangle(self, name, retval)
return retval
def getRectangle(
self: Any, name: str, defaults: Iterable[str]
) -> RectangleObject: # pragma: no cover
deprecate_no_replacement("getRectangle")
return _get_rectangle(self, name, defaults)
def _set_rectangle(self: Any, name: str, value: Union[RectangleObject, float]) -> None:
name = NameObject(name)
self[name] = value
def setRectangle(
self: Any, name: str, value: Union[RectangleObject, float]
) -> None: # pragma: no cover
deprecate_no_replacement("setRectangle")
_set_rectangle(self, name, value)
def _delete_rectangle(self: Any, name: str) -> None:
del self[name]
def deleteRectangle(self: Any, name: str) -> None: # pragma: no cover
deprecate_no_replacement("deleteRectangle")
del self[name]
def _create_rectangle_accessor(name: str, fallback: Iterable[str]) -> property:
return property(
lambda self: _get_rectangle(self, name, fallback),
lambda self, value: _set_rectangle(self, name, value),
lambda self: _delete_rectangle(self, name),
)
def createRectangleAccessor(
name: str, fallback: Iterable[str]
) -> property: # pragma: no cover
deprecate_no_replacement("createRectangleAccessor")
return _create_rectangle_accessor(name, fallback)
class Transformation:
"""
Specify a 2D transformation.
The transformation between two coordinate systems is represented by a 3-by-3
transformation matrix written as follows::
a b 0
c d 0
e f 1
Because a transformation matrix has only six elements that can be changed,
it is usually specified in PDF as the six-element array [ a b c d e f ].
Coordinate transformations are expressed as matrix multiplications::
a b 0
[ x′ y′ 1 ] = [ x y 1 ] × c d 0
e f 1
Usage
-----
>>> from PyPDF2 import Transformation
>>> op = Transformation().scale(sx=2, sy=3).translate(tx=10, ty=20)
>>> page.add_transformation(op)
"""
# 9.5.4 Coordinate Systems for 3D
# 4.2.2 Common Transformations
def __init__(self, ctm: CompressedTransformationMatrix = (1, 0, 0, 1, 0, 0)):
self.ctm = ctm
@property
def matrix(self) -> TransformationMatrixType:
return (
(self.ctm[0], self.ctm[1], 0),
(self.ctm[2], self.ctm[3], 0),
(self.ctm[4], self.ctm[5], 1),
)
@staticmethod
def compress(matrix: TransformationMatrixType) -> CompressedTransformationMatrix:
return (
matrix[0][0],
matrix[0][1],
matrix[1][0],
matrix[1][1],
matrix[2][0],
matrix[2][1],
)
def translate(self, tx: float = 0, ty: float = 0) -> "Transformation":
m = self.ctm
return Transformation(ctm=(m[0], m[1], m[2], m[3], m[4] + tx, m[5] + ty))
def scale(
self, sx: Optional[float] = None, sy: Optional[float] = None
) -> "Transformation":
"""
Scale the contents of a page towards the origin of the coordinate system.
Typically, that is the lower-left corner of the page. That can be
changed by translating the contents / the page boxes.
"""
if sx is None and sy is None:
raise ValueError("Either sx or sy must be specified")
if sx is None:
sx = sy
if sy is None:
sy = sx
assert sx is not None
assert sy is not None
op: TransformationMatrixType = ((sx, 0, 0), (0, sy, 0), (0, 0, 1))
ctm = Transformation.compress(matrix_multiply(self.matrix, op))
return Transformation(ctm)
def rotate(self, rotation: float) -> "Transformation":
rotation = math.radians(rotation)
op: TransformationMatrixType = (
(math.cos(rotation), math.sin(rotation), 0),
(-math.sin(rotation), math.cos(rotation), 0),
(0, 0, 1),
)
ctm = Transformation.compress(matrix_multiply(self.matrix, op))
return Transformation(ctm)
def __repr__(self) -> str:
return f"Transformation(ctm={self.ctm})"
def apply_on(
self, pt: Union[Tuple[Decimal, Decimal], Tuple[float, float], List[float]]
) -> Union[Tuple[float, float], List[float]]:
pt1 = (
float(pt[0]) * self.ctm[0] + float(pt[1]) * self.ctm[2] + self.ctm[4],
float(pt[0]) * self.ctm[1] + float(pt[1]) * self.ctm[3] + self.ctm[5],
)
return list(pt1) if isinstance(pt, list) else pt1
class PageObject(DictionaryObject):
"""
PageObject represents a single page within a PDF file.
Typically this object will be created by accessing the
:meth:`get_page()<PyPDF2.PdfReader.get_page>` method of the
:class:`PdfReader<PyPDF2.PdfReader>` class, but it is
also possible to create an empty page with the
:meth:`create_blank_page()<PyPDF2._page.PageObject.create_blank_page>` static method.
:param pdf: PDF file the page belongs to.
:param indirect_ref: Stores the original indirect reference to
this object in its source PDF
"""
def __init__(
self,
pdf: Optional[Any] = None, # PdfReader
indirect_ref: Optional[IndirectObject] = None,
) -> None:
from ._reader import PdfReader
DictionaryObject.__init__(self)
self.pdf: Optional[PdfReader] = pdf
self.indirect_ref = indirect_ref # type:ignore
def hash_value_data(self) -> bytes:
data = super().hash_value_data()
data += b"%d" % id(self)
return data
@property
def user_unit(self) -> float:
"""
A read-only positive number giving the size of user space units.
It is in multiples of 1/72 inch. Hence a value of 1 means a user space
unit is 1/72 inch, and a value of 3 means that a user space unit is
3/72 inch.
"""
return self.get(PG.USER_UNIT, 1)
@staticmethod
def create_blank_page(
pdf: Optional[Any] = None, # PdfReader
width: Union[float, Decimal, None] = None,
height: Union[float, Decimal, None] = None,
) -> "PageObject":
"""
Return a new blank page.
If ``width`` or ``height`` is ``None``, try to get the page size
from the last page of *pdf*.
:param pdf: PDF file the page belongs to
:param float width: The width of the new page expressed in default user
space units.
:param float height: The height of the new page expressed in default user
space units.
:return: the new blank page
:raises PageSizeNotDefinedError: if ``pdf`` is ``None`` or contains
no page
"""
page = PageObject(pdf)
# Creates a new page (cf PDF Reference 7.7.3.3)
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 len(pdf.pages) > 0:
lastpage = pdf.pages[len(pdf.pages) - 1]
width = lastpage.mediabox.width
height = lastpage.mediabox.height
else:
raise PageSizeNotDefinedError
page.__setitem__(
NameObject(PG.MEDIABOX), RectangleObject((0, 0, width, height)) # type: ignore
)
return page
@staticmethod
def createBlankPage(
pdf: Optional[Any] = None, # PdfReader
width: Union[float, Decimal, None] = None,
height: Union[float, Decimal, None] = None,
) -> "PageObject": # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`create_blank_page` instead.
"""
deprecate_with_replacement("createBlankPage", "create_blank_page")
return PageObject.create_blank_page(pdf, width, height)
@property
def images(self) -> List[File]:
"""
Get a list of all images of the page.
This requires pillow. You can install it via 'pip install PyPDF2[image]'.
For the moment, this does NOT include inline images. They will be added
in future.
"""
images_extracted: List[File] = []
if RES.XOBJECT not in self[PG.RESOURCES]: # type: ignore
return images_extracted
x_object = self[PG.RESOURCES][RES.XOBJECT].get_object() # type: ignore
for obj in x_object:
if x_object[obj][IA.SUBTYPE] == "/Image":
extension, byte_stream = _xobj_to_image(x_object[obj])
if extension is not None:
filename = f"{obj[1:]}{extension}"
images_extracted.append(File(name=filename, data=byte_stream))
return images_extracted
@property
def rotation(self) -> int:
"""
The VISUAL rotation of the page.
This number has to be a multiple of 90 degrees: 0,90,180,270
This property does not affect "/Contents"
"""
return int(self.get(PG.ROTATE, 0))
@rotation.setter
def rotation(self, r: Union[int, float]) -> None:
self[NameObject(PG.ROTATE)] = NumberObject((((int(r) + 45) // 90) * 90) % 360)
def transfer_rotation_to_content(self) -> None:
"""
Apply the rotation of the page to the content and the media/crop/... boxes.
It's recommended to apply this function before page merging.
"""
r = -self.rotation # rotation to apply is in the otherway
self.rotation = 0
mb = RectangleObject(self.mediabox)
trsf = (
Transformation()
.translate(
-float(mb.left + mb.width / 2), -float(mb.bottom + mb.height / 2)
)
.rotate(r)
)
pt1 = trsf.apply_on(mb.lower_left)
pt2 = trsf.apply_on(mb.upper_right)
trsf = trsf.translate(-min(pt1[0], pt2[0]), -min(pt1[1], pt2[1]))
self.add_transformation(trsf, False)
for b in ["/MediaBox", "/CropBox", "/BleedBox", "/TrimBox", "/ArtBox"]:
if b in self:
rr = RectangleObject(self[b]) # type: ignore
pt1 = trsf.apply_on(rr.lower_left)
pt2 = trsf.apply_on(rr.upper_right)
self[NameObject(b)] = RectangleObject(
(
min(pt1[0], pt2[0]),
min(pt1[1], pt2[1]),
max(pt1[0], pt2[0]),
max(pt1[1], pt2[1]),
)
)
def rotate(self, angle: int) -> "PageObject":
"""
Rotate a page clockwise by increments of 90 degrees.
:param int angle: Angle to rotate the page. Must be an increment
of 90 deg.
"""
if angle % 90 != 0:
raise ValueError("Rotation angle must be a multiple of 90")
rotate_obj = self.get(PG.ROTATE, 0)
current_angle = (
rotate_obj if isinstance(rotate_obj, int) else rotate_obj.get_object()
)
self[NameObject(PG.ROTATE)] = NumberObject(current_angle + angle)
return self
def rotate_clockwise(self, angle: int) -> "PageObject": # pragma: no cover
deprecate_with_replacement("rotate_clockwise", "rotate")
return self.rotate(angle)
def rotateClockwise(self, angle: int) -> "PageObject": # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`rotate_clockwise` instead.
"""
deprecate_with_replacement("rotateClockwise", "rotate")
return self.rotate(angle)
def rotateCounterClockwise(self, angle: int) -> "PageObject": # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`rotate_clockwise` with a negative argument instead.
"""
deprecate_with_replacement("rotateCounterClockwise", "rotate")
return self.rotate(-angle)
@staticmethod
def _merge_resources(
res1: DictionaryObject, res2: DictionaryObject, resource: Any
) -> Tuple[Dict[str, Any], Dict[str, Any]]:
new_res = DictionaryObject()
new_res.update(res1.get(resource, DictionaryObject()).get_object())
page2res = cast(
DictionaryObject, res2.get(resource, DictionaryObject()).get_object()
)
rename_res = {}
for key in list(page2res.keys()):
if key in new_res and new_res.raw_get(key) != page2res.raw_get(key):
newname = NameObject(key + str(uuid.uuid4()))
rename_res[key] = newname
new_res[newname] = page2res[key]
elif key not in new_res:
new_res[key] = page2res.raw_get(key)
return new_res, rename_res
@staticmethod
def _content_stream_rename(
stream: ContentStream, rename: Dict[Any, Any], pdf: Any # PdfReader
) -> ContentStream:
if not rename:
return stream
stream = ContentStream(stream, pdf)
for operands, _operator in stream.operations:
if isinstance(operands, list):
for i in range(len(operands)):
op = operands[i]
if isinstance(op, NameObject):
operands[i] = rename.get(op, op)
elif isinstance(operands, dict):
for i in operands:
op = operands[i]
if isinstance(op, NameObject):
operands[i] = rename.get(op, op)
else:
raise KeyError(f"type of operands is {type(operands)}")
return stream
@staticmethod
def _push_pop_gs(contents: Any, pdf: Any) -> ContentStream: # PdfReader
# adds a graphics state "push" and "pop" to the beginning and end
# of a content stream. This isolates it from changes such as
# transformation matricies.
stream = ContentStream(contents, pdf)
stream.operations.insert(0, ([], "q"))
stream.operations.append(([], "Q"))
return stream
@staticmethod
def _add_transformation_matrix(
contents: Any, pdf: Any, ctm: CompressedTransformationMatrix
) -> ContentStream: # PdfReader
# adds transformation matrix at the beginning of the given
# contents stream.
a, b, c, d, e, f = ctm
contents = ContentStream(contents, pdf)
contents.operations.insert(
0,
[
[
FloatObject(a),
FloatObject(b),
FloatObject(c),
FloatObject(d),
FloatObject(e),
FloatObject(f),
],
" cm",
],
)
return contents
def get_contents(self) -> Optional[ContentStream]:
"""
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 PG.CONTENTS in self:
return self[PG.CONTENTS].get_object() # type: ignore
else:
return None
def getContents(self) -> Optional[ContentStream]: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`get_contents` instead.
"""
deprecate_with_replacement("getContents", "get_contents")
return self.get_contents()
def merge_page(self, page2: "PageObject", expand: bool = False) -> None:
"""
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
be drawn after, or "on top" of this page.
:param PageObject page2: The page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param bool expand: If true, the current page dimensions will be
expanded to accommodate the dimensions of the page to be merged.
"""
self._merge_page(page2, expand=expand)
def mergePage(self, page2: "PageObject") -> None: # pragma: no cover
"""
.. deprecated:: 1.28.0
Use :meth:`merge_page` instead.
"""
deprecate_with_replacement("mergePage", "merge_page")
return self.merge_page(page2)
def _merge_page(
self,
page2: "PageObject",
page2transformation: Optional[Callable[[Any], ContentStream]] = None,
ctm: Optional[CompressedTransformationMatrix] = None,
expand: bool = False,
) -> None:
# First we work on merging the resource dictionaries. This allows us
# to find out what symbols in the content streams we might need to
# rename.
new_resources = DictionaryObject()
rename = {}
try:
original_resources = cast(DictionaryObject, self[PG.RESOURCES].get_object())
except KeyError:
original_resources = DictionaryObject()
try:
page2resources = cast(DictionaryObject, page2[PG.RESOURCES].get_object())
except KeyError:
page2resources = DictionaryObject()
new_annots = ArrayObject()
for page in (self, page2):
if PG.ANNOTS in page:
annots = page[PG.ANNOTS]
if isinstance(annots, ArrayObject):
for ref in annots:
new_annots.append(ref)
for res in (
RES.EXT_G_STATE,
RES.FONT,
RES.XOBJECT,
RES.COLOR_SPACE,
RES.PATTERN,
RES.SHADING,
RES.PROPERTIES,
):
new, newrename = PageObject._merge_resources(
original_resources, page2resources, res
)
if new:
new_resources[NameObject(res)] = new
rename.update(newrename)
# Combine /ProcSet sets.
new_resources[NameObject(RES.PROC_SET)] = ArrayObject(
frozenset(
original_resources.get(RES.PROC_SET, ArrayObject()).get_object()
).union(
frozenset(page2resources.get(RES.PROC_SET, ArrayObject()).get_object())
)
)
new_content_array = ArrayObject()
original_content = self.get_contents()
if original_content is not None:
new_content_array.append(
PageObject._push_pop_gs(original_content, self.pdf)
)
page2content = page2.get_contents()
if page2content is not None:
page2content = ContentStream(page2content, self.pdf)
rect = page2.trimbox
page2content.operations.insert(
0,
(
map(
FloatObject,
[
rect.left,
rect.bottom,
rect.width,
rect.height,
],
),
"re",
),
)
page2content.operations.insert(1, ([], "W"))
page2content.operations.insert(2, ([], "n"))
if page2transformation is not None:
page2content = page2transformation(page2content)
page2content = PageObject._content_stream_rename(
page2content, rename, self.pdf
)
page2content = PageObject._push_pop_gs(page2content, self.pdf)
new_content_array.append(page2content)
# if expanding the page to fit a new page, calculate the new media box size
if expand:
self._expand_mediabox(page2, ctm)
self[NameObject(PG.CONTENTS)] = ContentStream(new_content_array, self.pdf)
self[NameObject(PG.RESOURCES)] = new_resources
self[NameObject(PG.ANNOTS)] = new_annots
def _expand_mediabox(
self, page2: "PageObject", ctm: Optional[CompressedTransformationMatrix]
) -> None:
corners1 = (
self.mediabox.left.as_numeric(),
self.mediabox.bottom.as_numeric(),
self.mediabox.right.as_numeric(),
self.mediabox.top.as_numeric(),
)
corners2 = (
page2.mediabox.left.as_numeric(),
page2.mediabox.bottom.as_numeric(),
page2.mediabox.left.as_numeric(),
page2.mediabox.top.as_numeric(),
page2.mediabox.right.as_numeric(),
page2.mediabox.top.as_numeric(),
page2.mediabox.right.as_numeric(),
page2.mediabox.bottom.as_numeric(),
)
if ctm is not None:
ctm = tuple(float(x) for x in ctm) # type: ignore[assignment]
new_x = tuple(
ctm[0] * corners2[i] + ctm[2] * corners2[i + 1] + ctm[4]
for i in range(0, 8, 2)
)
new_y = tuple(
ctm[1] * corners2[i] + ctm[3] * corners2[i + 1] + ctm[5]
for i in range(0, 8, 2)
)
else:
new_x = corners2[0:8:2]
new_y = corners2[1:8:2]
lowerleft = (min(new_x), min(new_y))
upperright = (max(new_x), max(new_y))
lowerleft = (min(corners1[0], lowerleft[0]), min(corners1[1], lowerleft[1]))
upperright = (
max(corners1[2], upperright[0]),
max(corners1[3], upperright[1]),
)
self.mediabox.lower_left = lowerleft
self.mediabox.upper_right = upperright
def mergeTransformedPage(
self,
page2: "PageObject",
ctm: Union[CompressedTransformationMatrix, Transformation],
expand: bool = False,
) -> None: # pragma: no cover
"""
mergeTransformedPage is similar to merge_page, 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>`.
:param tuple ctm: a 6-element tuple containing the operands of the
transformation matrix
:param bool expand: Whether the page should be expanded to fit the dimensions
of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeTransformedPage(page2, ctm)",
"page2.add_transformation(ctm); page.merge_page(page2)",
)
if isinstance(ctm, Transformation):
ctm = ctm.ctm
ctm = cast(CompressedTransformationMatrix, ctm)
self._merge_page(
page2,
lambda page2Content: PageObject._add_transformation_matrix(
page2Content, page2.pdf, ctm # type: ignore[arg-type]
),
ctm,
expand,
)
def mergeScaledPage(
self, page2: "PageObject", scale: float, expand: bool = False
) -> None: # pragma: no cover
"""
mergeScaledPage is similar to merge_page, but the stream to be merged
is scaled by applying a transformation matrix.
:param PageObject page2: The page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float scale: The scaling factor
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeScaledPage(page2, scale, expand)",
"page2.add_transformation(Transformation().scale(scale)); page.merge_page(page2, expand)",
)
op = Transformation().scale(scale, scale)
self.mergeTransformedPage(page2, op, expand)
def mergeRotatedPage(
self, page2: "PageObject", rotation: float, expand: bool = False
) -> None: # pragma: no cover
"""
mergeRotatedPage is similar to merge_page, but the stream to be merged
is rotated by applying a transformation matrix.
:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float rotation: The angle of the rotation, in degrees
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeRotatedPage(page2, rotation, expand)",
"page2.add_transformation(Transformation().rotate(rotation)); page.merge_page(page2, expand)",
)
op = Transformation().rotate(rotation)
self.mergeTransformedPage(page2, op, expand)
def mergeTranslatedPage(
self, page2: "PageObject", tx: float, ty: float, expand: bool = False
) -> None: # pragma: no cover
"""
mergeTranslatedPage is similar to merge_page, but the stream to be
merged is translated by applying a transformation matrix.
:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float tx: The translation on X axis
:param float ty: The translation on Y axis
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeTranslatedPage(page2, tx, ty, expand)",
"page2.add_transformation(Transformation().translate(tx, ty)); page.merge_page(page2, expand)",
)
op = Transformation().translate(tx, ty)
self.mergeTransformedPage(page2, op, expand)
def mergeRotatedTranslatedPage(
self,
page2: "PageObject",
rotation: float,
tx: float,
ty: float,
expand: bool = False,
) -> None: # pragma: no cover
"""
mergeRotatedTranslatedPage is similar to merge_page, but the stream to
be merged is rotated and translated by applying a transformation matrix.
:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float tx: The translation on X axis
:param float ty: The translation on Y axis
:param float rotation: The angle of the rotation, in degrees
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeRotatedTranslatedPage(page2, rotation, tx, ty, expand)",
"page2.add_transformation(Transformation().rotate(rotation).translate(tx, ty)); page.merge_page(page2, expand)",
)
op = Transformation().translate(-tx, -ty).rotate(rotation).translate(tx, ty)
return self.mergeTransformedPage(page2, op, expand)
def mergeRotatedScaledPage(
self, page2: "PageObject", rotation: float, scale: float, expand: bool = False
) -> None: # pragma: no cover
"""
mergeRotatedScaledPage is similar to merge_page, but the stream to be
merged is rotated and scaled by applying a transformation matrix.
:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float rotation: The angle of the rotation, in degrees
:param float scale: The scaling factor
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeRotatedScaledPage(page2, rotation, scale, expand)",
"page2.add_transformation(Transformation().rotate(rotation).scale(scale)); page.merge_page(page2, expand)",
)
op = Transformation().rotate(rotation).scale(scale, scale)
self.mergeTransformedPage(page2, op, expand)
def mergeScaledTranslatedPage(
self,
page2: "PageObject",
scale: float,
tx: float,
ty: float,
expand: bool = False,
) -> None: # pragma: no cover
"""
mergeScaledTranslatedPage is similar to merge_page, but the stream to be
merged is translated and scaled by applying a transformation matrix.
:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float scale: The scaling factor
:param float tx: The translation on X axis
:param float ty: The translation on Y axis
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeScaledTranslatedPage(page2, scale, tx, ty, expand)",
"page2.add_transformation(Transformation().scale(scale).translate(tx, ty)); page.merge_page(page2, expand)",
)
op = Transformation().scale(scale, scale).translate(tx, ty)
return self.mergeTransformedPage(page2, op, expand)
def mergeRotatedScaledTranslatedPage(
self,
page2: "PageObject",
rotation: float,
scale: float,
tx: float,
ty: float,
expand: bool = False,
) -> None: # pragma: no cover
"""
mergeRotatedScaledTranslatedPage is similar to merge_page, but the
stream to be merged is translated, rotated and scaled by applying a
transformation matrix.
:param PageObject page2: the page to be merged into this one. Should be
an instance of :class:`PageObject<PageObject>`.
:param float tx: The translation on X axis
:param float ty: The translation on Y axis
:param float rotation: The angle of the rotation, in degrees
:param float scale: The scaling factor
:param bool expand: Whether the page should be expanded to fit the
dimensions of the page to be merged.
.. deprecated:: 1.28.0
Use :meth:`add_transformation` and :meth:`merge_page` instead.
"""
deprecate_with_replacement(
"page.mergeRotatedScaledTranslatedPage(page2, rotation, tx, ty, expand)",
"page2.add_transformation(Transformation().rotate(rotation).scale(scale)); page.merge_page(page2, expand)",
)
op = Transformation().rotate(rotation).scale(scale, scale).translate(tx, ty)
self.mergeTransformedPage(page2, op, expand)
def add_transformation(
self,
ctm: Union[Transformation, CompressedTransformationMatrix],
expand: bool = False,
) -> None:
"""
Apply a transformation matrix to the page.
:param tuple ctm: A 6-element tuple containing the operands of the
transformation matrix. Alternatively, a
:py:class:`Transformation<PyPDF2.Transformation>`
object can be passed.
See :doc:`/user/cropping-and-transforming`.
"""
if isinstance(ctm, Transformation):
ctm = ctm.ctm
content = self.get_contents()
if content is not None:
content = PageObject._add_transformation_matrix(content, self.pdf, ctm)
content = PageObject._push_pop_gs(content, self.pdf)
self[NameObject(PG.CONTENTS)] = content
# if expanding the page to fit a new page, calculate the new media box size
if expand:
corners = [