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
|
###############################################################################
#
# Metadata - A class for writing the Excel XLSX Metadata file.
#
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2013-2025, John McNamara, jmcnamara@cpan.org
#
from . import xmlwriter
class Metadata(xmlwriter.XMLwriter):
"""
A class for writing the Excel XLSX Metadata file.
"""
###########################################################################
#
# Public API.
#
###########################################################################
def __init__(self):
"""
Constructor.
"""
super().__init__()
self.has_dynamic_functions = False
self.has_embedded_images = False
self.num_embedded_images = 0
###########################################################################
#
# Private API.
#
###########################################################################
def _assemble_xml_file(self):
# Assemble and write the XML file.
if self.num_embedded_images > 0:
self.has_embedded_images = True
# Write the XML declaration.
self._xml_declaration()
# Write the metadata element.
self._write_metadata()
# Write the metadataTypes element.
self._write_metadata_types()
# Write the futureMetadata elements.
if self.has_dynamic_functions:
self._write_cell_future_metadata()
if self.has_embedded_images:
self._write_value_future_metadata()
# Write the cellMetadata element.
if self.has_dynamic_functions:
self._write_cell_metadata()
if self.has_embedded_images:
self._write_value_metadata()
self._xml_end_tag("metadata")
# Close the file.
self._xml_close()
###########################################################################
#
# XML methods.
#
###########################################################################
def _write_metadata(self):
# Write the <metadata> element.
xmlns = "http://schemas.openxmlformats.org/spreadsheetml/2006/main"
schema = "http://schemas.microsoft.com/office/spreadsheetml"
attributes = [("xmlns", xmlns)]
if self.has_embedded_images:
attributes.append(("xmlns:xlrd", schema + "/2017/richdata"))
if self.has_dynamic_functions:
attributes.append(("xmlns:xda", schema + "/2017/dynamicarray"))
self._xml_start_tag("metadata", attributes)
def _write_metadata_types(self):
# Write the <metadataTypes> element.
count = 0
if self.has_dynamic_functions:
count += 1
if self.has_embedded_images:
count += 1
attributes = [("count", count)]
self._xml_start_tag("metadataTypes", attributes)
# Write the metadataType element.
if self.has_dynamic_functions:
self._write_cell_metadata_type()
if self.has_embedded_images:
self._write_value_metadata_type()
self._xml_end_tag("metadataTypes")
def _write_cell_metadata_type(self):
# Write the <metadataType> element.
attributes = [
("name", "XLDAPR"),
("minSupportedVersion", 120000),
("copy", 1),
("pasteAll", 1),
("pasteValues", 1),
("merge", 1),
("splitFirst", 1),
("rowColShift", 1),
("clearFormats", 1),
("clearComments", 1),
("assign", 1),
("coerce", 1),
("cellMeta", 1),
]
self._xml_empty_tag("metadataType", attributes)
def _write_value_metadata_type(self):
# Write the <metadataType> element.
attributes = [
("name", "XLRICHVALUE"),
("minSupportedVersion", 120000),
("copy", 1),
("pasteAll", 1),
("pasteValues", 1),
("merge", 1),
("splitFirst", 1),
("rowColShift", 1),
("clearFormats", 1),
("clearComments", 1),
("assign", 1),
("coerce", 1),
]
self._xml_empty_tag("metadataType", attributes)
def _write_cell_future_metadata(self):
# Write the <futureMetadata> element.
attributes = [
("name", "XLDAPR"),
("count", 1),
]
self._xml_start_tag("futureMetadata", attributes)
self._xml_start_tag("bk")
self._xml_start_tag("extLst")
self._write_cell_ext()
self._xml_end_tag("extLst")
self._xml_end_tag("bk")
self._xml_end_tag("futureMetadata")
def _write_value_future_metadata(self):
# Write the <futureMetadata> element.
attributes = [
("name", "XLRICHVALUE"),
("count", self.num_embedded_images),
]
self._xml_start_tag("futureMetadata", attributes)
for index in range(self.num_embedded_images):
self._xml_start_tag("bk")
self._xml_start_tag("extLst")
self._write_value_ext(index)
self._xml_end_tag("extLst")
self._xml_end_tag("bk")
self._xml_end_tag("futureMetadata")
def _write_cell_ext(self):
# Write the <ext> element.
attributes = [("uri", "{bdbb8cdc-fa1e-496e-a857-3c3f30c029c3}")]
self._xml_start_tag("ext", attributes)
# Write the xda:dynamicArrayProperties element.
self._write_xda_dynamic_array_properties()
self._xml_end_tag("ext")
def _write_xda_dynamic_array_properties(self):
# Write the <xda:dynamicArrayProperties> element.
attributes = [
("fDynamic", 1),
("fCollapsed", 0),
]
self._xml_empty_tag("xda:dynamicArrayProperties", attributes)
def _write_value_ext(self, index):
# Write the <ext> element.
attributes = [("uri", "{3e2802c4-a4d2-4d8b-9148-e3be6c30e623}")]
self._xml_start_tag("ext", attributes)
# Write the xlrd:rvb element.
self._write_xlrd_rvb(index)
self._xml_end_tag("ext")
def _write_xlrd_rvb(self, index):
# Write the <xlrd:rvb> element.
attributes = [("i", index)]
self._xml_empty_tag("xlrd:rvb", attributes)
def _write_cell_metadata(self):
# Write the <cellMetadata> element.
attributes = [("count", 1)]
self._xml_start_tag("cellMetadata", attributes)
self._xml_start_tag("bk")
# Write the rc element.
self._write_rc(1, 0)
self._xml_end_tag("bk")
self._xml_end_tag("cellMetadata")
def _write_value_metadata(self):
# Write the <valueMetadata> element.
count = self.num_embedded_images
rc_type = 1
if self.has_dynamic_functions:
rc_type = 2
attributes = [("count", count)]
self._xml_start_tag("valueMetadata", attributes)
# Write the rc elements.
for index in range(self.num_embedded_images):
self._xml_start_tag("bk")
self._write_rc(rc_type, index)
self._xml_end_tag("bk")
self._xml_end_tag("valueMetadata")
def _write_rc(self, rc_type, index):
# Write the <rc> element.
attributes = [
("t", rc_type),
("v", index),
]
self._xml_empty_tag("rc", attributes)
|
