def test_ignore_undefined_variables_1(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_undefined_variables_1.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data = {}
error = True
try:
template.render(data)
print("Error: template contains variables that must be "
"replaced")
except TemplateError:
error = False
assert error is False
template = Template(template_name, outname,
ignore_undefined_variables=True)
error = False
try:
template.render(data)
except:
traceback.print_exc()
error = True
assert error is False
def test_ignore_undefined_variables_1(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_undefined_variables_1.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data = {}
error = True
try:
template.render(data)
print("Error: template contains variables that must be "
"replaced")
except TemplateError:
error = False
assert error is False
template = Template(template_name, outname,
ignore_undefined_variables=True)
error = False
try:
template.render(data)
except:
traceback.print_exc()
error = True
assert error is False
def test_missing_opening(self):
"""test orphaned /for raises a TemplateException"""
template_name = pkg_resources.resource_filename(
'py3o.template', 'tests/templates/py3o_missing_open_template.odt')
outname = get_secure_filename()
try:
template = Template(template_name, outname)
finally:
os.remove(outname)
class Item(object):
def __init__(self, val):
self.val = val
data_dict = {"items": [Item(1), Item(2), Item(3), Item(4)]}
template.set_image_path(
'logo',
pkg_resources.resource_filename(
'py3o.template', 'tests/templates/images/new_logo.png'))
# this will raise a TemplateException... or the test will fail
error_occured = False
try:
template.render(data_dict)
except TemplateException as e:
error_occured = True
# make sure this is the correct TemplateException that pops
assert e.message == "No open instruction for /for"
# and make sure we raised
assert error_occured is True
def test_list_duplicate(self):
"""test duplicated listed get a unique id"""
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_list_template.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
class Item(object):
def __init__(self, val):
self.val = val
data_dict = {
"items": [Item(1), Item(2), Item(3), Item(4)]
}
error = False
template.set_image_path('logo', pkg_resources.resource_filename(
'py3o.template',
'tests/templates/images/new_logo.png'
))
template.render(data_dict)
outodt = zipfile.ZipFile(outname, 'r')
try:
content_list = [
lxml.etree.parse(BytesIO(outodt.read(filename)))
for filename in template.templated_files
]
except lxml.etree.XMLSyntaxError as e:
error = True
print(
"List was not deduplicated->{}".format(e)
)
# remove end file
os.unlink(outname)
assert error is False
# first content is the content.xml
content = content_list[0]
list_expr = '//text:list'
list_items = content.xpath(
list_expr,
namespaces=template.namespaces
)
ids = []
for list_item in list_items:
ids.append(
list_item.get(
'{}id'.format(XML_NS)
)
)
assert ids, "this list of ids should not be empty"
assert len(ids) == len(set(ids)), "all ids should have been unique"
def test_example_1(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_example_template.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
template.set_image_path(
'staticimage.logo',
pkg_resources.resource_filename(
'py3o.template',
'tests/templates/images/new_logo.png'
)
)
class Item(object):
pass
items = list()
item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = '12345.35'
item1.InvoiceRef = '#1234'
items.append(item1)
# if you are using python 2.x you should use xrange
for i in range(1000):
item = Item()
item.val1 = 'Item%s Value1' % i
item.val2 = 'Item%s Value2' % i
item.val3 = 'Item%s Value3' % i
item.Currency = 'EUR'
item.Amount = '6666.77'
item.InvoiceRef = 'Reference #%04d' % i
items.append(item)
document = Item()
document.total = '9999999999999.999'
data = dict(items=items, document=document)
error = False
try:
template.render(data)
except ValueError as e:
print('The template did not render properly...')
traceback.print_exc()
error = True
assert error is False
def test_invalid_template_1(self):
"""a template should not try to define a /for and a for on the same
paragraph
"""
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_example_invalid_template.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
class Item(object):
pass
items = list()
item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = '12345.35'
item1.InvoiceRef = '#1234'
items.append(item1)
# if you are using python 2.x you should use xrange
for i in range(1000):
item = Item()
item.val1 = 'Item%s Value1' % i
item.val2 = 'Item%s Value2' % i
item.val3 = 'Item%s Value3' % i
item.Currency = 'EUR'
item.Amount = '6666.77'
item.InvoiceRef = 'Reference #%04d' % i
items.append(item)
document = Item()
document.total = '9999999999999.999'
data = dict(
items=items,
items2=copy.copy(items),
document=document
)
error = False
try:
template.render(data)
except TemplateException:
error = True
assert error is True, "This template should have been refused"
def test_invalid_template_1(self):
"""a template should not try to define a /for and a for on the same
paragraph
"""
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_example_invalid_template.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
class Item(object):
pass
items = list()
item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = '12345.35'
item1.InvoiceRef = '#1234'
items.append(item1)
# if you are using python 2.x you should use xrange
for i in range(1000):
item = Item()
item.val1 = 'Item%s Value1' % i
item.val2 = 'Item%s Value2' % i
item.val3 = 'Item%s Value3' % i
item.Currency = 'EUR'
item.Amount = '6666.77'
item.InvoiceRef = 'Reference #%04d' % i
items.append(item)
document = Item()
document.total = '9999999999999.999'
data = dict(
items=items,
items2=copy.copy(items),
document=document
)
error = False
try:
template.render(data)
except TemplateException:
error = True
assert error is True, "This template should have been refused"
def test_example_1(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_example_template.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
template.set_image_path('logo', pkg_resources.resource_filename(
'py3o.template',
'tests/templates/images/new_logo.png'
))
class Item(object):
pass
items = list()
item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = '12345.35'
item1.InvoiceRef = '#1234'
items.append(item1)
# if you are using python 2.x you should use xrange
for i in range(1000):
item = Item()
item.val1 = 'Item%s Value1' % i
item.val2 = 'Item%s Value2' % i
item.val3 = 'Item%s Value3' % i
item.Currency = 'EUR'
item.Amount = '6666.77'
item.InvoiceRef = 'Reference #%04d' % i
items.append(item)
document = Item()
document.total = '9999999999999.999'
data = dict(items=items, document=document)
error = False
try:
template.render(data)
except ValueError as e:
print('The template did not render properly...')
traceback.print_exc()
error = True
assert error is False
def test_render_apply_style(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_style1_template.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
template.set_image_path('logo', pkg_resources.resource_filename(
'py3o.template',
'tests/templates/images/new_logo.png'
))
class Item(object):
pass
items = list()
item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = 12345.35
item1.InvoiceRef = '#1234'
items.append(item1)
document = Item()
document.total = '9999999999999.999'
data = dict(items=items, document=document)
template.render(data)
# reuse the template engine just to open our odt file content...
tempout = get_secure_filename()
t2 = Template(outname, tempout)
os.unlink(tempout)
result_content = t2.content_trees[0]
expr = "//text:p[contains(text(), 'Invoice')]"
paragraphs = result_content.xpath(
expr,
namespaces=t2.namespaces
)
assert len(paragraphs) == 1, "Only one paragraph should have been found"
p = paragraphs[0]
result_text = p.text
print(result_text)
assert result_text == "Invoice #1234 for a total of 12345,35 EUR"
def test_render_apply_style(self):
template_name = pkg_resources.resource_filename(
'py3o.template', 'tests/templates/py3o_style1_template.odt')
outname = get_secure_filename()
template = Template(template_name, outname)
template.set_image_path(
'logo',
pkg_resources.resource_filename(
'py3o.template', 'tests/templates/images/new_logo.png'))
class Item(object):
pass
items = list()
item1 = Item()
item1.val1 = 'Item1 Value1'
item1.val2 = 'Item1 Value2'
item1.val3 = 'Item1 Value3'
item1.Currency = 'EUR'
item1.Amount = 12345.35
item1.InvoiceRef = '#1234'
items.append(item1)
document = Item()
document.total = '9999999999999.999'
data = dict(items=items, document=document)
template.render(data)
# reuse the template engine just to open our odt file content...
tempout = get_secure_filename()
t2 = Template(outname, tempout)
os.unlink(tempout)
result_content = t2.content_trees[0]
expr = "//text:p[contains(text(), 'Invoice')]"
paragraphs = result_content.xpath(expr, namespaces=t2.namespaces)
assert len(
paragraphs) == 1, "Only one paragraph should have been found"
p = paragraphs[0]
result_text = p.text
print(result_text)
assert result_text == "Invoice #1234 for a total of 12345,35 EUR"
def test_list_duplicate(self):
"""test duplicated listed get a unique id"""
template_name = pkg_resources.resource_filename(
'py3o.template', 'tests/templates/py3o_list_template.odt')
outname = get_secure_filename()
template = Template(template_name, outname)
class Item(object):
def __init__(self, val):
self.val = val
data_dict = {"items": [Item(1), Item(2), Item(3), Item(4)]}
error = False
template.set_image_path(
'logo',
pkg_resources.resource_filename(
'py3o.template', 'tests/templates/images/new_logo.png'))
template.render(data_dict)
outodt = zipfile.ZipFile(outname, 'r')
try:
content_list = [
lxml.etree.parse(BytesIO(outodt.read(filename)))
for filename in template.templated_files
]
except lxml.etree.XMLSyntaxError as e:
error = True
print("List was not deduplicated->{}".format(e))
# remove end file
os.unlink(outname)
assert error is False
# first content is the content.xml
content = content_list[0]
list_expr = '//text:list'
list_items = content.xpath(list_expr, namespaces=template.namespaces)
ids = []
for list_item in list_items:
ids.append(list_item.get('{}id'.format(XML_NS)))
assert ids, "this list of ids should not be empty"
assert len(ids) == len(set(ids)), "all ids should have been unique"
def test_format_date(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_template_format_date.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data_dict = {
'datestring': '2015-08-02',
'datetimestring': '2015-08-02 17:05:06',
'datestring2': '2015-10-15',
'datetime': datetime.datetime.strptime(
'2015-11-13 17:00:20',
'%Y-%m-%d %H:%M:%S'
),
}
template.render(data_dict)
outodt = zipfile.ZipFile(outname, 'r')
content_list = lxml.etree.parse(
BytesIO(outodt.read(template.templated_files[0]))
)
result_a = lxml.etree.tostring(
content_list,
pretty_print=True,
).decode('utf-8')
result_e = open(
pkg_resources.resource_filename(
'py3o.template',
'tests/templates/template_format_date_result.xml'
)
).read()
result_a = result_a.replace("\n", "").replace(" ", "")
result_e = result_e.replace("\n", "").replace(" ", "")
assert result_a == result_e
def test_remove_soft_page_breaks(self):
template_xml = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_soft_page_break.odt'
)
t = Template(template_xml, get_secure_filename())
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) > 0
t.remove_soft_breaks()
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) == 0
t = Template(template_xml, get_secure_filename())
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) > 0
t.render(data={"list1": [1, 2, 3]})
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) == 0
def test_remove_soft_page_breaks(self):
template_xml = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_soft_page_break.odt'
)
t = Template(template_xml, get_secure_filename())
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) > 0
t.remove_soft_breaks()
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) == 0
t = Template(template_xml, get_secure_filename())
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) > 0
t.render(data={"list1": [1, 2, 3]})
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) == 0
def test_ignore_undefined_variables_2(self):
"""
Test ignore undefined variables for template with dotted variables like
py3o.document.value
"""
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_undefined_variables_2.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data = {}
error = True
try:
template.render(data)
print("Error: template contains variables that must be "
"replaced")
except TemplateError:
error = False
assert error is False
template = Template(template_name, outname,
ignore_undefined_variables=True)
error = True
try:
template.render(data)
print("Error: template contains dotted variables that must be "
"replaced")
except TemplateError:
error = False
assert error is False
def test_ignore_undefined_variables_2(self):
"""
Test ignore undefined variables for template with dotted variables like
py3o.document.value
"""
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_undefined_variables_2.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data = {}
error = True
try:
template.render(data)
print("Error: template contains variables that must be "
"replaced")
except TemplateError:
error = False
assert error is False
template = Template(template_name, outname,
ignore_undefined_variables=True)
error = True
try:
template.render(data)
print("Error: template contains dotted variables that must be "
"replaced")
except TemplateError:
error = False
assert error is False
def test_style_application_with_function_call(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/style_application_with_function_call.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data_dict = {
'date': '2015-08-02',
}
template.render(data_dict)
outodt = zipfile.ZipFile(outname, 'r')
content_list = lxml.etree.parse(
BytesIO(outodt.read(template.templated_files[0]))
)
result_a = lxml.etree.tostring(
content_list,
pretty_print=True,
).decode('utf-8')
result_e = open(
pkg_resources.resource_filename(
'py3o.template', (
'tests/templates/'
'style_application_with_function_call_result.xml'
)
)
).read()
result_a = result_a.replace("\n", "").replace(" ", "")
result_e = result_e.replace("\n", "").replace(" ", "")
assert result_a == result_e
def test_format_date_exception(self):
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_template_format_date_exception.odt'
)
outname = get_secure_filename()
template = Template(template_name, outname)
data_dict = {
'date': '2015/08/02',
}
# this will raise a TemplateException... or the test will fail
error_occured = False
try:
template.render(data_dict)
except TemplateException as e:
error_occured = True
# and make sure we raised
assert error_occured is True
def test_missing_opening(self):
"""test orphaned /for raises a TemplateException"""
template_name = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_missing_open_template.odt'
)
outname = get_secure_filename()
try:
template = Template(template_name, outname)
finally:
os.remove(outname)
class Item(object):
def __init__(self, val):
self.val = val
data_dict = {
"items": [Item(1), Item(2), Item(3), Item(4)]
}
template.set_image_path('logo', pkg_resources.resource_filename(
'py3o.template',
'tests/templates/images/new_logo.png'
))
# this will raise a TemplateException... or the test will fail
error_occured = False
try:
template.render(data_dict)
except TemplateException as e:
error_occured = True
# make sure this is the correct TemplateException that pops
assert e.message == "No open instruction for /for"
# and make sure we raised
assert error_occured is True
def test_remove_soft_breaks_without_tail(self):
template_xml = pkg_resources.resource_filename(
'py3o.template',
'tests/templates/py3o_page_break_without_tail.odt'
)
t = Template(template_xml, get_secure_filename())
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) > 0
t.remove_soft_breaks()
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) == 0
t = Template(template_xml, get_secure_filename())
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) > 0
t.render(data={"items": [
{'Amount': 3, 'Currency': 'D'},
{'Amount': 2, 'Currency': 'E'},
{'Amount': 1, 'Currency': 'C'},
]})
soft_breaks = get_soft_breaks(t.content_trees[0], t.namespaces)
assert len(soft_breaks) == 0