Skip to content

Use xrechnung.xml for XRECHNUNG attachments #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philippwolak wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −2
Open

Use xrechnung.xml for XRECHNUNG attachments #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions drafthorse/pdf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,10 @@ def _prepare_pdf_metadata_txt(pdf_metadata):
}


def _get_xml_attachment_filename(profile):
return "xrechnung.xml" if profile == "XRECHNUNG" else "factur-x.xml"


def _prepare_xmp_metadata(profile, pdf_metadata):
"""
Prepare pdf metadata using the FACTUR-X XMP extension schema
Expand All @@ -161,6 +165,7 @@ def _prepare_xmp_metadata(profile, pdf_metadata):
escaped_metadata = {
key: xml_escape(str(value)) for key, value in pdf_metadata.items()
}
xml_filename = _get_xml_attachment_filename(profile)

xml_str = XMP_SCHEMA.format(
title=escaped_metadata.get("title", ""),
Expand All @@ -171,7 +176,7 @@ def _prepare_xmp_metadata(profile, pdf_metadata):
timestamp=datetime.now(tz=timezone.utc).strftime("%Y-%m-%dT%H:%M:%S+00:00"),
urn="urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0#",
documenttype="INVOICE",
xml_filename="factur-x.xml",
xml_filename=xml_filename,
version="1.0",
xmp_level=profile,
)
Expand Down Expand Up @@ -222,7 +227,8 @@ def _update_metadata_add_attachment(
{NameObject("/F"): file_entry_obj, NameObject("/UF"): file_entry_obj}
)

fname_obj = create_string_object("factur-x.xml")
xml_filename = _get_xml_attachment_filename(facturx_level)
fname_obj = create_string_object(xml_filename)
filespec_dict = DictionaryObject(
{
NameObject("/AFRelationship"): NameObject(
Expand Down
10 changes: 10 additions & 0 deletions tests/test_roundtrip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@ def test_sample_roundtrip(filename):
# Read back the PDF. We don't support extensive parsing, but this way we can assert that metadata is at least present
# and syntactically valid.
pdf_reader = PdfReader(BytesIO(created_pdf_bytes))
expected_xml_filename = (
"xrechnung.xml" if filename.split("_")[2] == "XRECHNUNG" else "factur-x.xml"
)
embedded_names = (
pdf_reader.trailer["/Root"]["/Names"]["/EmbeddedFiles"]["/Names"]
).get_object()
metadata_xml = pdf_reader.trailer["/Root"]["/Metadata"].get_object().get_data()

assert str(embedded_names[0]) == expected_xml_filename
assert expected_xml_filename.encode() in metadata_xml
assert pdf_reader.xmp_metadata

# Parse the sample file into our internal python structure
Expand Down