# encoding: utf-8
"""
Test suite for pptx.oxml.__init__.py module, primarily XML parser-related.
"""
from __future__ import print_function, unicode_literals
import pytest
from lxml import etree
from docx.oxml import (
OxmlElement, oxml_parser, parse_xml, register_element_cls
)
from docx.oxml.ns import qn
from docx.oxml.shared import BaseOxmlElement
class DescribeOxmlElement(object):
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) == (
''
).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(object):
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 = (
'\n'
' text\n'
'\n'
)
stripped_xml_text = 'text'
return pretty_xml_text, stripped_xml_text
class DescribeParseXml(object):
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 = ''
enc_decl = ''
xml_body = 'føøbår'
# 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):
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 (
'\n'
' foøbår\n'
'\n'
).encode('utf-8')
class DescribeRegisterElementCls(object):
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 (
'\n'
' foøbår\n'
'\n'
)
# ===========================================================================
# static fixture
# ===========================================================================
class CustElmCls(BaseOxmlElement):
pass