forked from scanny/python-pptx
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpackage.py
More file actions
222 lines (184 loc) · 7.67 KB
/
package.py
File metadata and controls
222 lines (184 loc) · 7.67 KB
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
"""Overall .pptx package."""
from __future__ import annotations
from typing import IO, Iterator
from pptx.opc.constants import RELATIONSHIP_TYPE as RT
from pptx.opc.package import OpcPackage
from pptx.opc.packuri import PackURI
from pptx.parts.coreprops import CorePropertiesPart
from pptx.parts.image import Image, ImagePart
from pptx.parts.media import MediaPart
from pptx.util import lazyproperty
class Package(OpcPackage):
"""An overall .pptx package."""
@lazyproperty
def core_properties(self) -> CorePropertiesPart:
"""Instance of |CoreProperties| holding read/write Dublin Core doc properties.
Creates a default core properties part if one is not present (not common).
"""
try:
return self.part_related_by(RT.CORE_PROPERTIES)
except KeyError:
core_props = CorePropertiesPart.default(self)
self.relate_to(core_props, RT.CORE_PROPERTIES)
return core_props
def get_or_add_image_part(self, image_file: str | IO[bytes]):
"""
Return an |ImagePart| object containing the image in *image_file*. If
the image part already exists in this package, it is reused,
otherwise a new one is created.
"""
return self._image_parts.get_or_add_image_part(image_file)
def get_or_add_media_part(self, media):
"""Return a |MediaPart| object containing the media in *media*.
If a media part for this media bytestream ("file") is already present
in this package, it is reused, otherwise a new one is created.
"""
return self._media_parts.get_or_add_media_part(media)
def next_image_partname(self, ext: str) -> PackURI:
"""Return a |PackURI| instance representing the next available image partname.
Partname uses the next available sequence number. *ext* is used as the extention on the
returned partname.
"""
def first_available_image_idx():
image_idxs = sorted(
[
part.partname.idx
for part in self.iter_parts()
if (
part.partname.startswith("/ppt/media/image")
and part.partname.idx is not None
)
]
)
for i, image_idx in enumerate(image_idxs):
idx = i + 1
if idx < image_idx:
return idx
return len(image_idxs) + 1
idx = first_available_image_idx()
return PackURI("/ppt/media/image%d.%s" % (idx, ext))
def next_media_partname(self, ext):
"""Return |PackURI| instance for next available media partname.
Partname is first available, starting at sequence number 1. Empty
sequence numbers are reused. *ext* is used as the extension on the
returned partname.
"""
def first_available_media_idx():
media_idxs = sorted(
[
part.partname.idx
for part in self.iter_parts()
if part.partname.startswith("/ppt/media/media")
]
)
for i, media_idx in enumerate(media_idxs):
idx = i + 1
if idx < media_idx:
return idx
return len(media_idxs) + 1
idx = first_available_media_idx()
return PackURI("/ppt/media/media%d.%s" % (idx, ext))
@property
def presentation_part(self):
"""
Reference to the |Presentation| instance contained in this package.
"""
return self.main_document_part
@lazyproperty
def _image_parts(self):
"""
|_ImageParts| object providing access to the image parts in this
package.
"""
return _ImageParts(self)
@lazyproperty
def _media_parts(self):
"""Return |_MediaParts| object for this package.
The media parts object provides access to all the media parts in this
package.
"""
return _MediaParts(self)
class _ImageParts(object):
"""Provides access to the image parts in a package."""
def __init__(self, package):
super(_ImageParts, self).__init__()
self._package = package
def __iter__(self) -> Iterator[ImagePart]:
"""Generate a reference to each |ImagePart| object in the package."""
image_parts = []
for rel in self._package.iter_rels():
if rel.is_external:
continue
if rel.reltype != RT.IMAGE:
continue
image_part = rel.target_part
if image_part in image_parts:
continue
image_parts.append(image_part)
yield image_part
def get_or_add_image_part(self, image_file: str | IO[bytes]) -> ImagePart:
"""Return |ImagePart| object containing the image in `image_file`.
`image_file` can be either a path to an image file or a file-like object
containing an image. If an image part containing this same image already exists,
that instance is returned, otherwise a new image part is created.
"""
image = Image.from_file(image_file)
image_part = self._find_by_sha1(image.sha1)
return image_part if image_part else ImagePart.new(self._package, image)
def _find_by_sha1(self, sha1: str) -> ImagePart | None:
"""
Return an |ImagePart| object belonging to this package or |None| if
no matching image part is found. The image part is identified by the
SHA1 hash digest of the image binary it contains.
"""
for image_part in self:
# ---skip unknown/unsupported image types, like SVG---
if not hasattr(image_part, "sha1"):
continue
if image_part.sha1 == sha1:
return image_part
return None
class _MediaParts(object):
"""Provides access to the media parts in a package.
Supports iteration and :meth:`get()` using the media object SHA1 hash as
its key.
"""
def __init__(self, package):
super(_MediaParts, self).__init__()
self._package = package
def __iter__(self):
"""Generate a reference to each |MediaPart| object in the package."""
# A media part can appear in more than one relationship (and commonly
# does in the case of video). Use media_parts to keep track of those
# that have been "yielded"; they can be skipped if they occur again.
media_parts = []
for rel in self._package.iter_rels():
if rel.is_external:
continue
if rel.reltype not in (RT.MEDIA, RT.VIDEO):
continue
media_part = rel.target_part
if media_part in media_parts:
continue
media_parts.append(media_part)
yield media_part
def get_or_add_media_part(self, media):
"""Return a |MediaPart| object containing the media in *media*.
If this package already contains a media part for the same
bytestream, that instance is returned, otherwise a new media part is
created.
"""
media_part = self._find_by_sha1(media.sha1)
if media_part is None:
media_part = MediaPart.new(self._package, media)
return media_part
def _find_by_sha1(self, sha1):
"""Return |MediaPart| object having *sha1* hash or None if not found.
All media parts belonging to this package are considered. A media
part is identified by the SHA1 hash digest of its bytestream
("file").
"""
for media_part in self:
if media_part.sha1 == sha1:
return media_part
return None