Skip to content

Pdfs

hypha.apply.utils.pdfs

html_to_pdf 

html_to_pdf(html_body)

Convert HTML to PDF.

Parameters:

  • html_body (str) –

    The body of the html as string

Returns:

  • BytesIO ( BytesIO ) –

    PDF file

Source code in hypha/apply/utils/pdfs.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
def html_to_pdf(html_body: str) -> BytesIO:
    """Convert HTML to PDF.

    Args:
        html_body: The body of the html as string

    Returns:
        BytesIO: PDF file
    """
    packet = BytesIO()
    pisa.CreatePDF(html_body, dest=packet, raise_exception=True, encoding="utf-8")
    packet.seek(0)
    return packet

render_as_pdf 

render_as_pdf(template_name, filename, context, request=None)

Convert HTML template to PDF file and return as a downloadable file.

Parameters:

  • template_name (str) –

    Django template name to render

  • filename (str) –

    Name of the output PDF file

  • context (dict) –

    Context dictionary for rendering template

  • request –

    Request object, defaults to None

Returns:

  • HttpResponse ( HttpResponse ) –

    PDF file as downloadable response

Example

response = render_as_pdf( template_name='my_template.html', filename='my_pdf.pdf', context={'title': 'My PDF'}, request=request )

Source code in hypha/apply/utils/pdfs.py 
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
def render_as_pdf(
    template_name: str, filename: str, context: dict, request=None
) -> HttpResponse:
    """Convert HTML template to PDF file and return as a downloadable file.

    Args:
        template_name: Django template name to render
        filename: Name of the output PDF file
        context: Context dictionary for rendering template
        request: Request object, defaults to None

    Returns:
        HttpResponse: PDF file as downloadable response

    Example:
        response = render_as_pdf(
            template_name='my_template.html',
            filename='my_pdf.pdf',
            context={'title': 'My PDF'},
            request=request
        )
    """
    if "pagesize" not in context:
        pdf_page_settings = PDFPageSettings.load(request_or_site=request)
        context["pagesize"] = pdf_page_settings.download_page_size

    context.setdefault("export_date", timezone.now())
    context.setdefault("export_user", request.user if request else None)

    html = render_to_string(
        template_name=template_name, context=context, request=request
    )
    pdf = html_to_pdf(html)

    response = HttpResponse(content_type="application/pdf")
    response["Content-Disposition"] = f"attachment; filename={filename}"
    response.write(pdf.read())
    return response

merge_pdf 

merge_pdf(origin_pdf, input_pdf)

Given two PDFs, merge them together.

Parameters:

  • origin_pdf (BytesIO) –

    a file-like object containing a PDF

  • input_pdf (BytesIO) –

    a file-like object containing a PDF

Returns:

  • File –

    Return a File object containing the merged PDF and with the same name as the

  • File –

    original PDF.

Source code in hypha/apply/utils/pdfs.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def merge_pdf(origin_pdf: BytesIO, input_pdf: BytesIO) -> File:
    """Given two PDFs, merge them together.

    Args:
        origin_pdf: a file-like object containing a PDF
        input_pdf: a file-like object containing a PDF

    Returns:
        Return a File object containing the merged PDF and with the same name as the
        original PDF.
    """
    merger = PdfWriter(clone_from=BytesIO(origin_pdf.read()))
    merger.append(PdfReader(input_pdf))

    output_pdf = BytesIO()
    merger.write(output_pdf)
    output_pdf.seek(0)
    return File(output_pdf, name=origin_pdf.name)