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
|
"""Test suite for pptx.oxml.__init__.py module, primarily XML parser-related."""
import pytest
from lxml import etree
from docx.oxml.ns import qn
from docx.oxml.parser import OxmlElement, oxml_parser, parse_xml, register_element_cls
from docx.oxml.shared import BaseOxmlElement
class DescribeOxmlElement:
def it_returns_an_lxml_element_with_matching_tag_name(self):
element = OxmlElement("a:foo")
assert isinstance(element, etree._Element)
assert element.tag == (
"{http://schemas.openxmlformats.org/drawingml/2006/main}foo"
)
def it_adds_supplied_attributes(self):
element = OxmlElement("a:foo", {"a": "b", "c": "d"})
assert etree.tostring(element) == (
'<a:foo xmlns:a="http://schemas.openxmlformats.org/drawingml/200'
'6/main" a="b" c="d"/>'
).encode("utf-8")
def it_adds_additional_namespace_declarations_when_supplied(self):
ns1 = "http://schemas.openxmlformats.org/drawingml/2006/main"
ns2 = "other"
element = OxmlElement("a:foo", nsdecls={"a": ns1, "x": ns2})
assert len(element.nsmap.items()) == 2
assert element.nsmap["a"] == ns1
assert element.nsmap["x"] == ns2
class DescribeOxmlParser:
def it_strips_whitespace_between_elements(self, whitespace_fixture):
pretty_xml_text, stripped_xml_text = whitespace_fixture
element = etree.fromstring(pretty_xml_text, oxml_parser)
xml_text = etree.tostring(element, encoding="unicode")
assert xml_text == stripped_xml_text
# fixtures -------------------------------------------------------
@pytest.fixture
def whitespace_fixture(self):
pretty_xml_text = "<foø>\n" " <bår>text</bår>\n" "</foø>\n"
stripped_xml_text = "<foø><bår>text</bår></foø>"
return pretty_xml_text, stripped_xml_text
class DescribeParseXml:
def it_accepts_bytes_and_assumes_utf8_encoding(self, xml_bytes):
parse_xml(xml_bytes)
def it_accepts_unicode_providing_there_is_no_encoding_declaration(self):
non_enc_decl = '<?xml version="1.0" standalone="yes"?>'
enc_decl = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
xml_body = "<foo><bar>føøbår</bar></foo>"
# unicode body by itself doesn't raise
parse_xml(xml_body)
# adding XML decl without encoding attr doesn't raise either
xml_text = "%s\n%s" % (non_enc_decl, xml_body)
parse_xml(xml_text)
# but adding encoding in the declaration raises ValueError
xml_text = "%s\n%s" % (enc_decl, xml_body)
with pytest.raises(ValueError, match="Unicode strings with encoding declara"):
parse_xml(xml_text)
def it_uses_registered_element_classes(self, xml_bytes):
register_element_cls("a:foo", CustElmCls)
element = parse_xml(xml_bytes)
assert isinstance(element, CustElmCls)
# fixture components ---------------------------------------------
@pytest.fixture
def xml_bytes(self):
return (
'<a:foo xmlns:a="http://schemas.openxmlformats.org/drawingml/200'
'6/main">\n'
" <a:bar>foøbår</a:bar>\n"
"</a:foo>\n"
).encode("utf-8")
class DescribeRegisterElementCls:
def it_determines_class_used_for_elements_with_matching_tagname(self, xml_text):
register_element_cls("a:foo", CustElmCls)
foo = parse_xml(xml_text)
assert type(foo) is CustElmCls
assert type(foo.find(qn("a:bar"))) is etree._Element
# fixture components ---------------------------------------------
@pytest.fixture
def xml_text(self):
return (
'<a:foo xmlns:a="http://schemas.openxmlformats.org/drawingml/200'
'6/main">\n'
" <a:bar>foøbår</a:bar>\n"
"</a:foo>\n"
)
# ===========================================================================
# static fixture
# ===========================================================================
class CustElmCls(BaseOxmlElement):
pass
|