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
|
import decimal
from typing import Any, List, Tuple, Union
from .._utils import deprecation_no_replacement, deprecation_with_replacement
from ._base import FloatObject, NumberObject
from ._data_structures import ArrayObject
class RectangleObject(ArrayObject):
"""
This class is used to represent *page boxes* in PyPDF2. These boxes include:
* :attr:`artbox <PyPDF2._page.PageObject.artbox>`
* :attr:`bleedbox <PyPDF2._page.PageObject.bleedbox>`
* :attr:`cropbox <PyPDF2._page.PageObject.cropbox>`
* :attr:`mediabox <PyPDF2._page.PageObject.mediabox>`
* :attr:`trimbox <PyPDF2._page.PageObject.trimbox>`
"""
def __init__(
self, arr: Union["RectangleObject", Tuple[float, float, float, float]]
) -> None:
# must have four points
assert len(arr) == 4
# automatically convert arr[x] into NumberObject(arr[x]) if necessary
ArrayObject.__init__(self, [self._ensure_is_number(x) for x in arr]) # type: ignore
def _ensure_is_number(self, value: Any) -> Union[FloatObject, NumberObject]:
if not isinstance(value, (NumberObject, FloatObject)):
value = FloatObject(value)
return value
def scale(self, sx: float, sy: float) -> "RectangleObject":
return RectangleObject(
(
float(self.left) * sx,
float(self.bottom) * sy,
float(self.right) * sx,
float(self.top) * sy,
)
)
def ensureIsNumber(
self, value: Any
) -> Union[FloatObject, NumberObject]: # pragma: no cover
deprecation_no_replacement("ensureIsNumber", "3.0.0")
return self._ensure_is_number(value)
def __repr__(self) -> str:
return f"RectangleObject({repr(list(self))})"
@property
def left(self) -> FloatObject:
return self[0]
@left.setter
def left(self, f: float) -> None:
self[0] = FloatObject(f)
@property
def bottom(self) -> FloatObject:
return self[1]
@bottom.setter
def bottom(self, f: float) -> None:
self[1] = FloatObject(f)
@property
def right(self) -> FloatObject:
return self[2]
@right.setter
def right(self, f: float) -> None:
self[2] = FloatObject(f)
@property
def top(self) -> FloatObject:
return self[3]
@top.setter
def top(self, f: float) -> None:
self[3] = FloatObject(f)
def getLowerLeft_x(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getLowerLeft_x", "left", "3.0.0")
return self.left
def getLowerLeft_y(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getLowerLeft_y", "bottom", "3.0.0")
return self.bottom
def getUpperRight_x(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getUpperRight_x", "right", "3.0.0")
return self.right
def getUpperRight_y(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getUpperRight_y", "top", "3.0.0")
return self.top
def getUpperLeft_x(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getUpperLeft_x", "left", "3.0.0")
return self.left
def getUpperLeft_y(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getUpperLeft_y", "top", "3.0.0")
return self.top
def getLowerRight_x(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getLowerRight_x", "right", "3.0.0")
return self.right
def getLowerRight_y(self) -> FloatObject: # pragma: no cover
deprecation_with_replacement("getLowerRight_y", "bottom", "3.0.0")
return self.bottom
@property
def lower_left(self) -> Tuple[decimal.Decimal, decimal.Decimal]:
"""
Property to read and modify the lower left coordinate of this box
in (x,y) form.
"""
return self.left, self.bottom
@lower_left.setter
def lower_left(self, value: List[Any]) -> None:
self[0], self[1] = (self._ensure_is_number(x) for x in value)
@property
def lower_right(self) -> Tuple[decimal.Decimal, decimal.Decimal]:
"""
Property to read and modify the lower right coordinate of this box
in (x,y) form.
"""
return self.right, self.bottom
@lower_right.setter
def lower_right(self, value: List[Any]) -> None:
self[2], self[1] = (self._ensure_is_number(x) for x in value)
@property
def upper_left(self) -> Tuple[decimal.Decimal, decimal.Decimal]:
"""
Property to read and modify the upper left coordinate of this box
in (x,y) form.
"""
return self.left, self.top
@upper_left.setter
def upper_left(self, value: List[Any]) -> None:
self[0], self[3] = (self._ensure_is_number(x) for x in value)
@property
def upper_right(self) -> Tuple[decimal.Decimal, decimal.Decimal]:
"""
Property to read and modify the upper right coordinate of this box
in (x,y) form.
"""
return self.right, self.top
@upper_right.setter
def upper_right(self, value: List[Any]) -> None:
self[2], self[3] = (self._ensure_is_number(x) for x in value)
def getLowerLeft(
self,
) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("getLowerLeft", "lower_left", "3.0.0")
return self.lower_left
def getLowerRight(
self,
) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("getLowerRight", "lower_right", "3.0.0")
return self.lower_right
def getUpperLeft(
self,
) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("getUpperLeft", "upper_left", "3.0.0")
return self.upper_left
def getUpperRight(
self,
) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("getUpperRight", "upper_right", "3.0.0")
return self.upper_right
def setLowerLeft(self, value: Tuple[float, float]) -> None: # pragma: no cover
deprecation_with_replacement("setLowerLeft", "lower_left", "3.0.0")
self.lower_left = value # type: ignore
def setLowerRight(self, value: Tuple[float, float]) -> None: # pragma: no cover
deprecation_with_replacement("setLowerRight", "lower_right", "3.0.0")
self[2], self[1] = (self._ensure_is_number(x) for x in value)
def setUpperLeft(self, value: Tuple[float, float]) -> None: # pragma: no cover
deprecation_with_replacement("setUpperLeft", "upper_left", "3.0.0")
self[0], self[3] = (self._ensure_is_number(x) for x in value)
def setUpperRight(self, value: Tuple[float, float]) -> None: # pragma: no cover
deprecation_with_replacement("setUpperRight", "upper_right", "3.0.0")
self[2], self[3] = (self._ensure_is_number(x) for x in value)
@property
def width(self) -> decimal.Decimal:
return self.right - self.left
def getWidth(self) -> decimal.Decimal: # pragma: no cover
deprecation_with_replacement("getWidth", "width", "3.0.0")
return self.width
@property
def height(self) -> decimal.Decimal:
return self.top - self.bottom
def getHeight(self) -> decimal.Decimal: # pragma: no cover
deprecation_with_replacement("getHeight", "height", "3.0.0")
return self.height
@property
def lowerLeft(self) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("lowerLeft", "lower_left", "3.0.0")
return self.lower_left
@lowerLeft.setter
def lowerLeft(
self, value: Tuple[decimal.Decimal, decimal.Decimal]
) -> None: # pragma: no cover
deprecation_with_replacement("lowerLeft", "lower_left", "3.0.0")
self.lower_left = value
@property
def lowerRight(self) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("lowerRight", "lower_right", "3.0.0")
return self.lower_right
@lowerRight.setter
def lowerRight(
self, value: Tuple[decimal.Decimal, decimal.Decimal]
) -> None: # pragma: no cover
deprecation_with_replacement("lowerRight", "lower_right", "3.0.0")
self.lower_right = value
@property
def upperLeft(self) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("upperLeft", "upper_left", "3.0.0")
return self.upper_left
@upperLeft.setter
def upperLeft(
self, value: Tuple[decimal.Decimal, decimal.Decimal]
) -> None: # pragma: no cover
deprecation_with_replacement("upperLeft", "upper_left", "3.0.0")
self.upper_left = value
@property
def upperRight(self) -> Tuple[decimal.Decimal, decimal.Decimal]: # pragma: no cover
deprecation_with_replacement("upperRight", "upper_right", "3.0.0")
return self.upper_right
@upperRight.setter
def upperRight(
self, value: Tuple[decimal.Decimal, decimal.Decimal]
) -> None: # pragma: no cover
deprecation_with_replacement("upperRight", "upper_right", "3.0.0")
self.upper_right = value
|
