from __future__ import unicode_literals
import io
import os
import tempfile
from nose import tools
from unittest import skipIf as skip_if
from PyPDF2 import PdfFileReader
from xhtml2pdf.document import pisaDocument
HTML_CONTENT = """
{head:s}
Hello, world!
The quick red fox jumps over the lazy brown dog.
{extra_html}
"""
CSS_TESTS = {
"""""",
"""""",
"""""",
}
METADATA = {
"author": "MyCorp Ltd.",
"title": "My Document Title",
"subject": "My Document Subject",
"keywords": "pdf, documents",
}
try:
import __pypy__
except ImportError:
IN_PYPY = False
else:
IN_PYPY = True
def _compare_pdf_metadata(pdf_file, assertion):
# Ensure something has been written
tools.assert_not_equal(pdf_file.tell(), 0)
# Rewind to the start of the file to read the pdf and get the
# document's metadata
pdf_file.seek(0)
pdf_reader = PdfFileReader(pdf_file)
pdf_info = pdf_reader.documentInfo
# Check the received metadata matches the expected metadata
for original_key in METADATA:
actual_key = "/{}".format(original_key.capitalize())
actual_value = pdf_info[actual_key]
expected_value = METADATA[original_key]
assertion(actual_value, expected_value)
def test_document_with_transparent_image():
"""
Test that a transparent PNG image is rendered properly.
"""
tests_folder = os.path.dirname(os.path.realpath(__file__))
image_path = os.path.join(tests_folder, 'samples', 'img', 'denker-transparent.png')
extra_html = "![](\"{image_path}\")
".format(image_path=image_path)
with tempfile.TemporaryFile() as pdf_file:
pisaDocument(
src=io.StringIO(HTML_CONTENT.format(head="", extra_html=extra_html)),
dest=pdf_file
)
pdf_file.seek(0)
pdf_reader = PdfFileReader(pdf_file)
xobjects = pdf_reader.getPage(0)['/Resources']['/XObject'].getObject()
objects = [xobjects[key] for key in xobjects.keys()]
# Identity the 'denker_transparent.png' image by its height and width, and make sure it's there.
denker_transparant = [obj for obj in objects if obj['/Height'] == 137 and obj['/Width'] == 70]
tools.assert_equal(len(denker_transparant), 1)
def test_document_background_image():
"""
Test that a transparent PNG image is rendered properly.
"""
tests_folder = os.path.dirname(os.path.realpath(__file__))
image_path = os.path.join(tests_folder, 'samples', 'img', 'denker-transparent.png')
css_background = "".format(background_location=image_path)
with tempfile.TemporaryFile() as pdf_file:
pisaDocument(
src=io.StringIO(HTML_CONTENT.format(head=css_background, extra_html="")),
dest=pdf_file
)
pdf_file.seek(0)
pdf_reader = PdfFileReader(pdf_file)
xobjects = pdf_reader.getPage(0)['/Resources']['/XObject'].getObject()
objects = [xobjects[key] for key in xobjects.keys()]
# Identity the 'denker_transparent.png' image by its height and width, and make sure it's there.
denker_transparant = [obj for obj in objects if obj['/Height'] == 137 and obj['/Width'] == 70]
tools.assert_equal(len(denker_transparant), 1)
@skip_if(IN_PYPY, "This doesn't work in pypy")
def test_document_creation_without_metadata():
with tempfile.TemporaryFile() as pdf_file:
pisaDocument(
src=io.StringIO(HTML_CONTENT.format(head="", extra_html="")),
dest=pdf_file
)
_compare_pdf_metadata(pdf_file, tools.assert_not_equal)
@skip_if(IN_PYPY, "This doesn't work in pypy")
def test_document_creation_with_metadata():
with tempfile.TemporaryFile() as pdf_file:
pisaDocument(
src=io.StringIO(HTML_CONTENT.format(head="", extra_html="")),
dest=pdf_file,
context_meta=METADATA
)
_compare_pdf_metadata(pdf_file, tools.assert_equal)
@skip_if(IN_PYPY, "This doesn't work in pypy")
def test_document_creation_with_css_metadata():
for css_code in CSS_TESTS:
with tempfile.TemporaryFile() as pdf_file:
pisaDocument(
src=io.StringIO(HTML_CONTENT.format(head=css_code, extra_html="")),
dest=pdf_file,
context_meta=METADATA
)
_compare_pdf_metadata(pdf_file, tools.assert_equal)
def test_destination_is_none():
context = pisaDocument(HTML_CONTENT.format(head="", extra_html=""))
tools.assert_greater(len(context.dest.getvalue()), 0)
def test_in_memory_document():
with io.BytesIO() as in_memory_file:
pisaDocument(HTML_CONTENT.format(head="", extra_html=""), dest=in_memory_file)
tools.assert_greater(len(in_memory_file.getvalue()), 0)
with io.BytesIO() as in_memory_file:
pisaDocument(io.StringIO(HTML_CONTENT.format(head="", extra_html="")), dest=in_memory_file)
tools.assert_greater(len(in_memory_file.getvalue()), 0)