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
|
# encoding: utf-8
"""Unit test suite for the docx.parts.document module"""
from __future__ import absolute_import, division, print_function, unicode_literals
import pytest
from docx.enum.style import WD_STYLE_TYPE
from docx.opc.constants import RELATIONSHIP_TYPE as RT
from docx.opc.coreprops import CoreProperties
from docx.package import Package
from docx.parts.document import DocumentPart
from docx.parts.hdrftr import FooterPart, HeaderPart
from docx.parts.numbering import NumberingPart
from docx.parts.settings import SettingsPart
from docx.parts.styles import StylesPart
from docx.settings import Settings
from docx.styles.style import BaseStyle
from docx.styles.styles import Styles
from ..oxml.parts.unitdata.document import a_body, a_document
from ..unitutil.mock import class_mock, instance_mock, method_mock, property_mock
class DescribeDocumentPart(object):
def it_can_add_a_footer_part(self, package_, FooterPart_, footer_part_, relate_to_):
FooterPart_.new.return_value = footer_part_
relate_to_.return_value = "rId12"
document_part = DocumentPart(None, None, None, package_)
footer_part, rId = document_part.add_footer_part()
FooterPart_.new.assert_called_once_with(package_)
relate_to_.assert_called_once_with(document_part, footer_part_, RT.FOOTER)
assert footer_part is footer_part_
assert rId == "rId12"
def it_can_add_a_header_part(self, package_, HeaderPart_, header_part_, relate_to_):
HeaderPart_.new.return_value = header_part_
relate_to_.return_value = "rId7"
document_part = DocumentPart(None, None, None, package_)
header_part, rId = document_part.add_header_part()
HeaderPart_.new.assert_called_once_with(package_)
relate_to_.assert_called_once_with(document_part, header_part_, RT.HEADER)
assert header_part is header_part_
assert rId == "rId7"
def it_can_drop_a_specified_header_part(self, drop_rel_):
document_part = DocumentPart(None, None, None, None)
document_part.drop_header_part("rId42")
drop_rel_.assert_called_once_with(document_part, "rId42")
def it_provides_access_to_a_footer_part_by_rId(
self, related_parts_prop_, related_parts_, footer_part_
):
related_parts_prop_.return_value = related_parts_
related_parts_.__getitem__.return_value = footer_part_
document_part = DocumentPart(None, None, None, None)
footer_part = document_part.footer_part("rId9")
related_parts_.__getitem__.assert_called_once_with("rId9")
assert footer_part is footer_part_
def it_provides_access_to_a_header_part_by_rId(
self, related_parts_prop_, related_parts_, header_part_
):
related_parts_prop_.return_value = related_parts_
related_parts_.__getitem__.return_value = header_part_
document_part = DocumentPart(None, None, None, None)
header_part = document_part.header_part("rId11")
related_parts_.__getitem__.assert_called_once_with("rId11")
assert header_part is header_part_
def it_can_save_the_package_to_a_file(self, save_fixture):
document, file_ = save_fixture
document.save(file_)
document._package.save.assert_called_once_with(file_)
def it_provides_access_to_the_document_settings(self, settings_fixture):
document_part, settings_ = settings_fixture
settings = document_part.settings
assert settings is settings_
def it_provides_access_to_the_document_styles(self, styles_fixture):
document_part, styles_ = styles_fixture
styles = document_part.styles
assert styles is styles_
def it_provides_access_to_its_core_properties(self, core_props_fixture):
document_part, core_properties_ = core_props_fixture
core_properties = document_part.core_properties
assert core_properties is core_properties_
def it_provides_access_to_the_inline_shapes_in_the_document(
self, inline_shapes_fixture):
document, InlineShapes_, body_elm = inline_shapes_fixture
inline_shapes = document.inline_shapes
InlineShapes_.assert_called_once_with(body_elm, document)
assert inline_shapes is InlineShapes_.return_value
def it_provides_access_to_the_numbering_part(
self, part_related_by_, numbering_part_
):
part_related_by_.return_value = numbering_part_
document_part = DocumentPart(None, None, None, None)
numbering_part = document_part.numbering_part
part_related_by_.assert_called_once_with(document_part, RT.NUMBERING)
assert numbering_part is numbering_part_
def and_it_creates_a_numbering_part_if_not_present(
self, part_related_by_, relate_to_, NumberingPart_, numbering_part_
):
part_related_by_.side_effect = KeyError
NumberingPart_.new.return_value = numbering_part_
document_part = DocumentPart(None, None, None, None)
numbering_part = document_part.numbering_part
NumberingPart_.new.assert_called_once_with()
relate_to_.assert_called_once_with(document_part, numbering_part_, RT.NUMBERING)
assert numbering_part is numbering_part_
def it_can_get_a_style_by_id(self, styles_prop_, styles_, style_):
styles_prop_.return_value = styles_
styles_.get_by_id.return_value = style_
document_part = DocumentPart(None, None, None, None)
style = document_part.get_style("BodyText", WD_STYLE_TYPE.PARAGRAPH)
styles_.get_by_id.assert_called_once_with("BodyText", WD_STYLE_TYPE.PARAGRAPH)
assert style is style_
def it_can_get_the_id_of_a_style(self, style_, styles_prop_, styles_):
styles_prop_.return_value = styles_
styles_.get_style_id.return_value = "BodyCharacter"
document_part = DocumentPart(None, None, None, None)
style_id = document_part.get_style_id(style_, WD_STYLE_TYPE.CHARACTER)
styles_.get_style_id.assert_called_once_with(style_, WD_STYLE_TYPE.CHARACTER)
assert style_id == "BodyCharacter"
def it_provides_access_to_its_settings_part_to_help(
self, part_related_by_, settings_part_
):
part_related_by_.return_value = settings_part_
document_part = DocumentPart(None, None, None, None)
settings_part = document_part._settings_part
part_related_by_.assert_called_once_with(document_part, RT.SETTINGS)
assert settings_part is settings_part_
def and_it_creates_a_default_settings_part_if_not_present(
self, package_, part_related_by_, SettingsPart_, settings_part_, relate_to_
):
part_related_by_.side_effect = KeyError
SettingsPart_.default.return_value = settings_part_
document_part = DocumentPart(None, None, None, package_)
settings_part = document_part._settings_part
SettingsPart_.default.assert_called_once_with(package_)
relate_to_.assert_called_once_with(document_part, settings_part_, RT.SETTINGS)
assert settings_part is settings_part_
def it_provides_access_to_its_styles_part_to_help(
self, part_related_by_, styles_part_
):
part_related_by_.return_value = styles_part_
document_part = DocumentPart(None, None, None, None)
styles_part = document_part._styles_part
part_related_by_.assert_called_once_with(document_part, RT.STYLES)
assert styles_part is styles_part_
def and_it_creates_a_default_styles_part_if_not_present(
self, package_, part_related_by_, StylesPart_, styles_part_, relate_to_
):
part_related_by_.side_effect = KeyError
StylesPart_.default.return_value = styles_part_
document_part = DocumentPart(None, None, None, package_)
styles_part = document_part._styles_part
StylesPart_.default.assert_called_once_with(package_)
relate_to_.assert_called_once_with(document_part, styles_part_, RT.STYLES)
assert styles_part is styles_part_
# fixtures -------------------------------------------------------
@pytest.fixture
def core_props_fixture(self, package_, core_properties_):
document_part = DocumentPart(None, None, None, package_)
package_.core_properties = core_properties_
return document_part, core_properties_
@pytest.fixture
def inline_shapes_fixture(self, request, InlineShapes_):
document_elm = (
a_document().with_nsdecls().with_child(
a_body())
).element
body_elm = document_elm[0]
document = DocumentPart(None, None, document_elm, None)
return document, InlineShapes_, body_elm
@pytest.fixture
def save_fixture(self, package_):
document_part = DocumentPart(None, None, None, package_)
file_ = 'foobar.docx'
return document_part, file_
@pytest.fixture
def settings_fixture(self, _settings_part_prop_, settings_part_,
settings_):
document_part = DocumentPart(None, None, None, None)
_settings_part_prop_.return_value = settings_part_
settings_part_.settings = settings_
return document_part, settings_
@pytest.fixture
def styles_fixture(self, _styles_part_prop_, styles_part_, styles_):
document_part = DocumentPart(None, None, None, None)
_styles_part_prop_.return_value = styles_part_
styles_part_.styles = styles_
return document_part, styles_
# fixture components ---------------------------------------------
@pytest.fixture
def core_properties_(self, request):
return instance_mock(request, CoreProperties)
@pytest.fixture
def drop_rel_(self, request):
return method_mock(request, DocumentPart, "drop_rel", autospec=True)
@pytest.fixture
def FooterPart_(self, request):
return class_mock(request, 'docx.parts.document.FooterPart')
@pytest.fixture
def footer_part_(self, request):
return instance_mock(request, FooterPart)
@pytest.fixture
def HeaderPart_(self, request):
return class_mock(request, 'docx.parts.document.HeaderPart')
@pytest.fixture
def header_part_(self, request):
return instance_mock(request, HeaderPart)
@pytest.fixture
def InlineShapes_(self, request):
return class_mock(request, 'docx.parts.document.InlineShapes')
@pytest.fixture
def NumberingPart_(self, request):
return class_mock(request, 'docx.parts.document.NumberingPart')
@pytest.fixture
def numbering_part_(self, request):
return instance_mock(request, NumberingPart)
@pytest.fixture
def package_(self, request):
return instance_mock(request, Package)
@pytest.fixture
def part_related_by_(self, request):
return method_mock(request, DocumentPart, 'part_related_by')
@pytest.fixture
def relate_to_(self, request):
return method_mock(request, DocumentPart, 'relate_to')
@pytest.fixture
def related_parts_(self, request):
return instance_mock(request, dict)
@pytest.fixture
def related_parts_prop_(self, request):
return property_mock(request, DocumentPart, 'related_parts')
@pytest.fixture
def SettingsPart_(self, request):
return class_mock(request, 'docx.parts.document.SettingsPart')
@pytest.fixture
def settings_(self, request):
return instance_mock(request, Settings)
@pytest.fixture
def settings_part_(self, request):
return instance_mock(request, SettingsPart)
@pytest.fixture
def _settings_part_prop_(self, request):
return property_mock(request, DocumentPart, '_settings_part')
@pytest.fixture
def style_(self, request):
return instance_mock(request, BaseStyle)
@pytest.fixture
def styles_(self, request):
return instance_mock(request, Styles)
@pytest.fixture
def StylesPart_(self, request):
return class_mock(request, 'docx.parts.document.StylesPart')
@pytest.fixture
def styles_part_(self, request):
return instance_mock(request, StylesPart)
@pytest.fixture
def styles_prop_(self, request):
return property_mock(request, DocumentPart, 'styles')
@pytest.fixture
def _styles_part_prop_(self, request):
return property_mock(request, DocumentPart, '_styles_part')
|
