Repository navigation
Expand file tree
/
Copy pathtest_section.py
More file actions
877 lines (705 loc) · 30.4 KB
/
Copy pathtest_section.py
File metadata and controls
877 lines (705 loc) · 30.4 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
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
# pyright: reportPrivateUsage=false
"""Unit test suite for the docx.section module."""
from __future__ import annotations
from typing import cast
import pytest
from docx import Document
from docx.enum.section import WD_HEADER_FOOTER, WD_ORIENTATION, WD_SECTION
from docx.oxml.document import CT_Document
from docx.oxml.section import CT_SectPr
from docx.parts.document import DocumentPart
from docx.parts.hdrftr import FooterPart, HeaderPart
from docx.section import Section, Sections, _BaseHeaderFooter, _Footer, _Header
from docx.shared import Inches, Length
from docx.table import Table
from docx.text.paragraph import Paragraph
from .unitutil.cxml import element, xml
from .unitutil.file import test_file
from .unitutil.mock import (
FixtureRequest,
Mock,
call,
class_mock,
instance_mock,
method_mock,
property_mock,
)
class DescribeSections:
"""Unit-test suite for `docx.section.Sections`."""
def it_knows_how_many_sections_it_contains(self, document_part_: Mock):
document_elm = cast(
CT_Document, element("w:document/w:body/(w:p/w:pPr/w:sectPr, w:sectPr)")
)
sections = Sections(document_elm, document_part_)
assert len(sections) == 2
def it_can_iterate_over_its_Section_instances(
self, Section_: Mock, section_: Mock, document_part_: Mock
):
document_elm = cast(
CT_Document, element("w:document/w:body/(w:p/w:pPr/w:sectPr, w:sectPr)")
)
sectPrs = document_elm.xpath("//w:sectPr")
Section_.return_value = section_
sections = Sections(document_elm, document_part_)
section_lst = list(sections)
assert Section_.call_args_list == [
call(sectPrs[0], document_part_),
call(sectPrs[1], document_part_),
]
assert section_lst == [section_, section_]
def it_can_access_its_Section_instances_by_index(
self, Section_: Mock, section_: Mock, document_part_: Mock
):
document_elm = cast(
CT_Document,
element("w:document/w:body/(w:p/w:pPr/w:sectPr,w:p/w:pPr/w:sectPr,w:sectPr)"),
)
sectPrs = document_elm.xpath("//w:sectPr")
Section_.return_value = section_
sections = Sections(document_elm, document_part_)
section_lst = [sections[idx] for idx in range(3)]
assert Section_.call_args_list == [
call(sectPrs[0], document_part_),
call(sectPrs[1], document_part_),
call(sectPrs[2], document_part_),
]
assert section_lst == [section_, section_, section_]
def it_can_access_its_Section_instances_by_slice(
self, Section_: Mock, section_: Mock, document_part_: Mock
):
document_elm = cast(
CT_Document,
element("w:document/w:body/(w:p/w:pPr/w:sectPr,w:p/w:pPr/w:sectPr,w:sectPr)"),
)
sectPrs = document_elm.xpath("//w:sectPr")
Section_.return_value = section_
sections = Sections(document_elm, document_part_)
section_lst = sections[1:9]
assert Section_.call_args_list == [
call(sectPrs[1], document_part_),
call(sectPrs[2], document_part_),
]
assert section_lst == [section_, section_]
# -- fixtures---------------------------------------------------------------------------------
@pytest.fixture
def document_part_(self, request: FixtureRequest):
return instance_mock(request, DocumentPart)
@pytest.fixture
def Section_(self, request: FixtureRequest):
return class_mock(request, "docx.section.Section")
@pytest.fixture
def section_(self, request: FixtureRequest):
return instance_mock(request, Section)
class DescribeSection:
"""Unit-test suite for `docx.section.Section`."""
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[
("w:sectPr", False),
("w:sectPr/w:titlePg", True),
("w:sectPr/w:titlePg{w:val=0}", False),
("w:sectPr/w:titlePg{w:val=1}", True),
("w:sectPr/w:titlePg{w:val=true}", True),
],
)
def it_knows_when_it_displays_a_distinct_first_page_header(
self, sectPr_cxml: str, expected_value: bool, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
section = Section(sectPr, document_part_)
different_first_page_header_footer = section.different_first_page_header_footer
assert different_first_page_header_footer is expected_value
@pytest.mark.parametrize(
("sectPr_cxml", "value", "expected_cxml"),
[
("w:sectPr", True, "w:sectPr/w:titlePg"),
("w:sectPr/w:titlePg", False, "w:sectPr"),
("w:sectPr/w:titlePg{w:val=1}", True, "w:sectPr/w:titlePg"),
("w:sectPr/w:titlePg{w:val=off}", False, "w:sectPr"),
],
)
def it_can_change_whether_the_document_has_distinct_odd_and_even_headers(
self, sectPr_cxml: str, value: bool, expected_cxml: str, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
expected_xml = xml(expected_cxml)
section = Section(sectPr, document_part_)
section.different_first_page_header_footer = value
assert sectPr.xml == expected_xml
def it_provides_access_to_its_even_page_footer(
self, document_part_: Mock, _Footer_: Mock, footer_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
_Footer_.return_value = footer_
section = Section(sectPr, document_part_)
footer = section.even_page_footer
_Footer_.assert_called_once_with(sectPr, document_part_, WD_HEADER_FOOTER.EVEN_PAGE)
assert footer is footer_
def it_provides_access_to_its_even_page_header(
self, document_part_: Mock, _Header_: Mock, header_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
_Header_.return_value = header_
section = Section(sectPr, document_part_)
header = section.even_page_header
_Header_.assert_called_once_with(sectPr, document_part_, WD_HEADER_FOOTER.EVEN_PAGE)
assert header is header_
def it_provides_access_to_its_first_page_footer(
self, document_part_: Mock, _Footer_: Mock, footer_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
_Footer_.return_value = footer_
section = Section(sectPr, document_part_)
footer = section.first_page_footer
_Footer_.assert_called_once_with(sectPr, document_part_, WD_HEADER_FOOTER.FIRST_PAGE)
assert footer is footer_
def it_provides_access_to_its_first_page_header(
self, document_part_: Mock, _Header_: Mock, header_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
_Header_.return_value = header_
section = Section(sectPr, document_part_)
header = section.first_page_header
_Header_.assert_called_once_with(sectPr, document_part_, WD_HEADER_FOOTER.FIRST_PAGE)
assert header is header_
def it_provides_access_to_its_default_footer(
self, document_part_: Mock, _Footer_: Mock, footer_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
_Footer_.return_value = footer_
section = Section(sectPr, document_part_)
footer = section.footer
_Footer_.assert_called_once_with(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
assert footer is footer_
def it_provides_access_to_its_default_header(
self, document_part_: Mock, _Header_: Mock, header_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
_Header_.return_value = header_
section = Section(sectPr, document_part_)
header = section.header
_Header_.assert_called_once_with(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
assert header is header_
def it_can_iterate_its_inner_content(self):
document = Document(test_file("sct-inner-content.docx"))
assert len(document.sections) == 3
inner_content = list(document.sections[0].iter_inner_content())
assert len(inner_content) == 3
p = inner_content[0]
assert isinstance(p, Paragraph)
assert p.text == "P1"
t = inner_content[1]
assert isinstance(t, Table)
assert t.rows[0].cells[0].text == "T2"
p = inner_content[2]
assert isinstance(p, Paragraph)
assert p.text == "P3"
inner_content = list(document.sections[1].iter_inner_content())
assert len(inner_content) == 3
t = inner_content[0]
assert isinstance(t, Table)
assert t.rows[0].cells[0].text == "T4"
p = inner_content[1]
assert isinstance(p, Paragraph)
assert p.text == "P5"
p = inner_content[2]
assert isinstance(p, Paragraph)
assert p.text == "P6"
inner_content = list(document.sections[2].iter_inner_content())
assert len(inner_content) == 3
p = inner_content[0]
assert isinstance(p, Paragraph)
assert p.text == "P7"
p = inner_content[1]
assert isinstance(p, Paragraph)
assert p.text == "P8"
p = inner_content[2]
assert isinstance(p, Paragraph)
assert p.text == "P9"
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[
("w:sectPr", WD_SECTION.NEW_PAGE),
("w:sectPr/w:type", WD_SECTION.NEW_PAGE),
("w:sectPr/w:type{w:val=continuous}", WD_SECTION.CONTINUOUS),
("w:sectPr/w:type{w:val=nextPage}", WD_SECTION.NEW_PAGE),
("w:sectPr/w:type{w:val=oddPage}", WD_SECTION.ODD_PAGE),
("w:sectPr/w:type{w:val=evenPage}", WD_SECTION.EVEN_PAGE),
("w:sectPr/w:type{w:val=nextColumn}", WD_SECTION.NEW_COLUMN),
],
)
def it_knows_its_start_type(
self, sectPr_cxml: str, expected_value: WD_SECTION, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
section = Section(sectPr, document_part_)
start_type = section.start_type
assert start_type is expected_value
@pytest.mark.parametrize(
("sectPr_cxml", "value", "expected_cxml"),
[
(
"w:sectPr/w:type{w:val=oddPage}",
WD_SECTION.EVEN_PAGE,
"w:sectPr/w:type{w:val=evenPage}",
),
("w:sectPr/w:type{w:val=nextPage}", None, "w:sectPr"),
("w:sectPr", None, "w:sectPr"),
("w:sectPr/w:type{w:val=continuous}", WD_SECTION.NEW_PAGE, "w:sectPr"),
("w:sectPr/w:type", WD_SECTION.NEW_PAGE, "w:sectPr"),
(
"w:sectPr/w:type",
WD_SECTION.NEW_COLUMN,
"w:sectPr/w:type{w:val=nextColumn}",
),
],
)
def it_can_change_its_start_type(
self,
sectPr_cxml: str,
value: WD_SECTION | None,
expected_cxml: str,
document_part_: Mock,
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
expected_xml = xml(expected_cxml)
section = Section(sectPr, document_part_)
section.start_type = value
assert section._sectPr.xml == expected_xml
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[
("w:sectPr/w:pgSz{w:w=1440}", Inches(1)),
("w:sectPr/w:pgSz", None),
("w:sectPr", None),
],
)
def it_knows_its_page_width(
self, sectPr_cxml: str, expected_value: Length | None, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
section = Section(sectPr, document_part_)
page_width = section.page_width
assert page_width == expected_value
@pytest.mark.parametrize(
("value", "expected_cxml"),
[
(None, "w:sectPr/w:pgSz"),
(Inches(4), "w:sectPr/w:pgSz{w:w=5760}"),
],
)
def it_can_change_its_page_width(
self,
value: Length | None,
expected_cxml: str,
document_part_: Mock,
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
expected_xml = xml(expected_cxml)
section = Section(sectPr, document_part_)
section.page_width = value
assert section._sectPr.xml == expected_xml
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[
("w:sectPr/w:pgSz{w:h=2880}", Inches(2)),
("w:sectPr/w:pgSz", None),
("w:sectPr", None),
],
)
def it_knows_its_page_height(
self, sectPr_cxml: str, expected_value: Length | None, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
section = Section(sectPr, document_part_)
page_height = section.page_height
assert page_height == expected_value
@pytest.mark.parametrize(
("value", "expected_cxml"),
[
(None, "w:sectPr/w:pgSz"),
(Inches(2), "w:sectPr/w:pgSz{w:h=2880}"),
],
)
def it_can_change_its_page_height(
self, value: Length | None, expected_cxml: str, document_part_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
expected_xml = xml(expected_cxml)
section = Section(sectPr, document_part_)
section.page_height = value
assert section._sectPr.xml == expected_xml
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[
("w:sectPr/w:pgSz{w:orient=landscape}", WD_ORIENTATION.LANDSCAPE),
("w:sectPr/w:pgSz{w:orient=portrait}", WD_ORIENTATION.PORTRAIT),
("w:sectPr/w:pgSz", WD_ORIENTATION.PORTRAIT),
("w:sectPr", WD_ORIENTATION.PORTRAIT),
],
)
def it_knows_its_page_orientation(
self, sectPr_cxml: str, expected_value: WD_ORIENTATION, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
section = Section(sectPr, document_part_)
orientation = section.orientation
assert orientation is expected_value
@pytest.mark.parametrize(
("value", "expected_cxml"),
[
(WD_ORIENTATION.LANDSCAPE, "w:sectPr/w:pgSz{w:orient=landscape}"),
(WD_ORIENTATION.PORTRAIT, "w:sectPr/w:pgSz"),
(None, "w:sectPr/w:pgSz"),
],
)
def it_can_change_its_orientation(
self, value: WD_ORIENTATION | None, expected_cxml: str, document_part_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr"))
expected_xml = xml(expected_cxml)
section = Section(sectPr, document_part_)
section.orientation = value
assert section._sectPr.xml == expected_xml
@pytest.mark.parametrize(
("sectPr_cxml", "margin_prop_name", "expected_value"),
[
("w:sectPr/w:pgMar{w:left=120}", "left_margin", 76200),
("w:sectPr/w:pgMar{w:right=240}", "right_margin", 152400),
("w:sectPr/w:pgMar{w:top=-360}", "top_margin", -228600),
("w:sectPr/w:pgMar{w:bottom=480}", "bottom_margin", 304800),
("w:sectPr/w:pgMar{w:gutter=600}", "gutter", 381000),
("w:sectPr/w:pgMar{w:header=720}", "header_distance", 457200),
("w:sectPr/w:pgMar{w:footer=840}", "footer_distance", 533400),
("w:sectPr/w:pgMar", "left_margin", None),
("w:sectPr", "top_margin", None),
],
)
def it_knows_its_page_margins(
self,
sectPr_cxml: str,
margin_prop_name: str,
expected_value: int | None,
document_part_: Mock,
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
section = Section(sectPr, document_part_)
value = getattr(section, margin_prop_name)
assert value == expected_value
@pytest.mark.parametrize(
("sectPr_cxml", "margin_prop_name", "value", "expected_cxml"),
[
("w:sectPr", "left_margin", Inches(1), "w:sectPr/w:pgMar{w:left=1440}"),
("w:sectPr", "right_margin", Inches(0.5), "w:sectPr/w:pgMar{w:right=720}"),
("w:sectPr", "top_margin", Inches(-0.25), "w:sectPr/w:pgMar{w:top=-360}"),
(
"w:sectPr",
"bottom_margin",
Inches(0.75),
"w:sectPr/w:pgMar{w:bottom=1080}",
),
("w:sectPr", "gutter", Inches(0.25), "w:sectPr/w:pgMar{w:gutter=360}"),
(
"w:sectPr",
"header_distance",
Inches(1.25),
"w:sectPr/w:pgMar{w:header=1800}",
),
(
"w:sectPr",
"footer_distance",
Inches(1.35),
"w:sectPr/w:pgMar{w:footer=1944}",
),
("w:sectPr", "left_margin", None, "w:sectPr/w:pgMar"),
(
"w:sectPr/w:pgMar{w:top=-360}",
"top_margin",
Inches(0.6),
"w:sectPr/w:pgMar{w:top=864}",
),
],
)
def it_can_change_its_page_margins(
self,
sectPr_cxml: str,
margin_prop_name: str,
value: Length | None,
expected_cxml: str,
document_part_: Mock,
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
expected_xml = xml(expected_cxml)
section = Section(sectPr, document_part_)
setattr(section, margin_prop_name, value)
assert section._sectPr.xml == expected_xml
# -- fixtures-----------------------------------------------------
@pytest.fixture
def document_part_(self, request: FixtureRequest):
return instance_mock(request, DocumentPart)
@pytest.fixture
def _Footer_(self, request: FixtureRequest):
return class_mock(request, "docx.section._Footer")
@pytest.fixture
def footer_(self, request: FixtureRequest):
return instance_mock(request, _Footer)
@pytest.fixture
def _Header_(self, request: FixtureRequest):
return class_mock(request, "docx.section._Header")
@pytest.fixture
def header_(self, request: FixtureRequest):
return instance_mock(request, _Header)
class Describe_BaseHeaderFooter:
"""Unit-test suite for `docx.section._BaseHeaderFooter`."""
@pytest.mark.parametrize(("has_definition", "expected_value"), [(False, True), (True, False)])
def it_knows_when_its_linked_to_the_previous_header_or_footer(
self,
has_definition: bool,
expected_value: bool,
header: _BaseHeaderFooter,
_has_definition_prop_: Mock,
):
_has_definition_prop_.return_value = has_definition
assert header.is_linked_to_previous is expected_value
@pytest.mark.parametrize(
("has_definition", "value", "drop_calls", "add_calls"),
[
(False, True, 0, 0),
(True, False, 0, 0),
(True, True, 1, 0),
(False, False, 0, 1),
],
)
def it_can_change_whether_it_is_linked_to_previous_header_or_footer(
self,
has_definition: bool,
value: bool,
drop_calls: int,
add_calls: int,
header: _BaseHeaderFooter,
_has_definition_prop_: Mock,
_drop_definition_: Mock,
_add_definition_: Mock,
):
_has_definition_prop_.return_value = has_definition
header.is_linked_to_previous = value
assert _drop_definition_.call_args_list == [call(header)] * drop_calls
assert _add_definition_.call_args_list == [call(header)] * add_calls
def it_provides_access_to_the_header_or_footer_part_for_BlockItemContainer(
self, header: _BaseHeaderFooter, _get_or_add_definition_: Mock, header_part_: Mock
):
# ---this override fulfills part of the BlockItemContainer subclass interface---
_get_or_add_definition_.return_value = header_part_
header_part = header.part
_get_or_add_definition_.assert_called_once_with(header)
assert header_part is header_part_
def it_provides_access_to_the_hdr_or_ftr_element_to_help(
self, header: _BaseHeaderFooter, _get_or_add_definition_: Mock, header_part_: Mock
):
hdr = element("w:hdr")
_get_or_add_definition_.return_value = header_part_
header_part_.element = hdr
hdr_elm = header._element
_get_or_add_definition_.assert_called_once_with(header)
assert hdr_elm is hdr
def it_gets_the_definition_when_it_has_one(
self,
header: _BaseHeaderFooter,
_has_definition_prop_: Mock,
_definition_prop_: Mock,
header_part_: Mock,
):
_has_definition_prop_.return_value = True
_definition_prop_.return_value = header_part_
header_part = header._get_or_add_definition()
assert header_part is header_part_
def but_it_gets_the_prior_definition_when_it_is_linked(
self,
header: _BaseHeaderFooter,
_has_definition_prop_: Mock,
_prior_headerfooter_prop_: Mock,
prior_headerfooter_: Mock,
header_part_: Mock,
):
_has_definition_prop_.return_value = False
_prior_headerfooter_prop_.return_value = prior_headerfooter_
prior_headerfooter_._get_or_add_definition.return_value = header_part_
header_part = header._get_or_add_definition()
prior_headerfooter_._get_or_add_definition.assert_called_once_with()
assert header_part is header_part_
def and_it_adds_a_definition_when_it_is_linked_and_the_first_section(
self,
header: _BaseHeaderFooter,
_has_definition_prop_: Mock,
_prior_headerfooter_prop_: Mock,
_add_definition_: Mock,
header_part_: Mock,
):
_has_definition_prop_.return_value = False
_prior_headerfooter_prop_.return_value = None
_add_definition_.return_value = header_part_
header_part = header._get_or_add_definition()
_add_definition_.assert_called_once_with(header)
assert header_part is header_part_
# -- fixture -----------------------------------------------------
@pytest.fixture
def _add_definition_(self, request: FixtureRequest):
return method_mock(request, _BaseHeaderFooter, "_add_definition")
@pytest.fixture
def _definition_prop_(self, request: FixtureRequest):
return property_mock(request, _BaseHeaderFooter, "_definition")
@pytest.fixture
def document_part_(self, request: FixtureRequest):
return instance_mock(request, DocumentPart)
@pytest.fixture
def _drop_definition_(self, request: FixtureRequest):
return method_mock(request, _BaseHeaderFooter, "_drop_definition")
@pytest.fixture
def _get_or_add_definition_(self, request: FixtureRequest):
return method_mock(request, _BaseHeaderFooter, "_get_or_add_definition")
@pytest.fixture
def _has_definition_prop_(self, request: FixtureRequest):
return property_mock(request, _BaseHeaderFooter, "_has_definition")
@pytest.fixture
def header(self, document_part_: Mock) -> _BaseHeaderFooter:
sectPr = cast(CT_SectPr, element("w:sectPr"))
return _BaseHeaderFooter(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
@pytest.fixture
def header_part_(self, request: FixtureRequest):
return instance_mock(request, HeaderPart)
@pytest.fixture
def prior_headerfooter_(self, request: FixtureRequest):
return instance_mock(request, _BaseHeaderFooter)
@pytest.fixture
def _prior_headerfooter_prop_(self, request: FixtureRequest):
return property_mock(request, _BaseHeaderFooter, "_prior_headerfooter")
class Describe_Footer:
"""Unit-test suite for `docx.section._Footer`."""
def it_can_add_a_footer_part_to_help(self, document_part_: Mock, footer_part_: Mock):
sectPr = cast(CT_SectPr, element("w:sectPr{r:a=b}"))
document_part_.add_footer_part.return_value = footer_part_, "rId3"
footer = _Footer(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
footer_part = footer._add_definition()
document_part_.add_footer_part.assert_called_once_with()
assert sectPr.xml == xml("w:sectPr{r:a=b}/w:footerReference{w:type=default,r:id=rId3}")
assert footer_part is footer_part_
def it_provides_access_to_its_footer_part_to_help(
self, document_part_: Mock, footer_part_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr/w:footerReference{w:type=even,r:id=rId3}"))
document_part_.footer_part.return_value = footer_part_
footer = _Footer(sectPr, document_part_, WD_HEADER_FOOTER.EVEN_PAGE)
footer_part = footer._definition
document_part_.footer_part.assert_called_once_with("rId3")
assert footer_part is footer_part_
def it_can_drop_the_related_footer_part_to_help(self, document_part_: Mock):
sectPr = cast(
CT_SectPr, element("w:sectPr{r:a=b}/w:footerReference{w:type=first,r:id=rId42}")
)
footer = _Footer(sectPr, document_part_, WD_HEADER_FOOTER.FIRST_PAGE)
footer._drop_definition()
assert sectPr.xml == xml("w:sectPr{r:a=b}")
document_part_.drop_rel.assert_called_once_with("rId42")
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[("w:sectPr", False), ("w:sectPr/w:footerReference{w:type=default}", True)],
)
def it_knows_when_it_has_a_definition_to_help(
self, sectPr_cxml: str, expected_value: bool, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
footer = _Footer(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
has_definition = footer._has_definition
assert has_definition is expected_value
def it_provides_access_to_the_prior_Footer_to_help(
self, request: FixtureRequest, document_part_: Mock, footer_: Mock
):
doc_elm = element("w:document/(w:sectPr,w:sectPr)")
prior_sectPr, sectPr = cast(CT_SectPr, doc_elm[0]), cast(CT_SectPr, doc_elm[1])
footer = _Footer(sectPr, document_part_, WD_HEADER_FOOTER.EVEN_PAGE)
# ---mock must occur after construction of "real" footer---
_Footer_ = class_mock(request, "docx.section._Footer", return_value=footer_)
prior_footer = footer._prior_headerfooter
_Footer_.assert_called_once_with(prior_sectPr, document_part_, WD_HEADER_FOOTER.EVEN_PAGE)
assert prior_footer is footer_
def but_it_returns_None_when_its_the_first_footer(self, document_part_: Mock):
doc_elm = cast(CT_Document, element("w:document/w:sectPr"))
sectPr = cast(CT_SectPr, doc_elm[0])
footer = _Footer(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
prior_footer = footer._prior_headerfooter
assert prior_footer is None
# -- fixtures---------------------------------------------------------------------------------
@pytest.fixture
def document_part_(self, request: FixtureRequest):
return instance_mock(request, DocumentPart)
@pytest.fixture
def footer_(self, request: FixtureRequest):
return instance_mock(request, _Footer)
@pytest.fixture
def footer_part_(self, request: FixtureRequest):
return instance_mock(request, FooterPart)
class Describe_Header:
"""Unit-test suite for `docx.section._Header`."""
def it_can_add_a_header_part_to_help(self, document_part_: Mock, header_part_: Mock):
sectPr = cast(CT_SectPr, element("w:sectPr{r:a=b}"))
document_part_.add_header_part.return_value = header_part_, "rId3"
header = _Header(sectPr, document_part_, WD_HEADER_FOOTER.FIRST_PAGE)
header_part = header._add_definition()
document_part_.add_header_part.assert_called_once_with()
assert sectPr.xml == xml("w:sectPr{r:a=b}/w:headerReference{w:type=first,r:id=rId3}")
assert header_part is header_part_
def it_provides_access_to_its_header_part_to_help(
self, document_part_: Mock, header_part_: Mock
):
sectPr = cast(CT_SectPr, element("w:sectPr/w:headerReference{w:type=default,r:id=rId8}"))
document_part_.header_part.return_value = header_part_
header = _Header(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
header_part = header._definition
document_part_.header_part.assert_called_once_with("rId8")
assert header_part is header_part_
def it_can_drop_the_related_header_part_to_help(self, document_part_: Mock):
sectPr = cast(
CT_SectPr, element("w:sectPr{r:a=b}/w:headerReference{w:type=even,r:id=rId42}")
)
header = _Header(sectPr, document_part_, WD_HEADER_FOOTER.EVEN_PAGE)
header._drop_definition()
assert sectPr.xml == xml("w:sectPr{r:a=b}")
document_part_.drop_header_part.assert_called_once_with("rId42")
@pytest.mark.parametrize(
("sectPr_cxml", "expected_value"),
[("w:sectPr", False), ("w:sectPr/w:headerReference{w:type=first}", True)],
)
def it_knows_when_it_has_a_header_part_to_help(
self, sectPr_cxml: str, expected_value: bool, document_part_: Mock
):
sectPr = cast(CT_SectPr, element(sectPr_cxml))
header = _Header(sectPr, document_part_, WD_HEADER_FOOTER.FIRST_PAGE)
has_definition = header._has_definition
assert has_definition is expected_value
def it_provides_access_to_the_prior_Header_to_help(
self, request: FixtureRequest, document_part_: Mock, header_: Mock
):
doc_elm = element("w:document/(w:sectPr,w:sectPr)")
prior_sectPr, sectPr = cast(CT_SectPr, doc_elm[0]), cast(CT_SectPr, doc_elm[1])
header = _Header(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
# ---mock must occur after construction of "real" header---
_Header_ = class_mock(request, "docx.section._Header", return_value=header_)
prior_header = header._prior_headerfooter
_Header_.assert_called_once_with(prior_sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
assert prior_header is header_
def but_it_returns_None_when_its_the_first_header(self, document_part_: Mock):
doc_elm = element("w:document/w:sectPr")
sectPr = cast(CT_SectPr, doc_elm[0])
header = _Header(sectPr, document_part_, WD_HEADER_FOOTER.PRIMARY)
prior_header = header._prior_headerfooter
assert prior_header is None
# -- fixtures---------------------------------------------------------------------------------
@pytest.fixture
def document_part_(self, request: FixtureRequest):
return instance_mock(request, DocumentPart)
@pytest.fixture
def header_(self, request: FixtureRequest):
return instance_mock(request, _Header)
@pytest.fixture
def header_part_(self, request: FixtureRequest):
return instance_mock(request, HeaderPart)