Coverage for cc_modules/cc_pdf.py : 55%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1#!/usr/bin/env python
3"""
4camcops_server/cc_modules/cc_pdf.py
6===============================================================================
8 Copyright (C) 2012-2020 Rudolf Cardinal (rudolf@pobox.com).
10 This file is part of CamCOPS.
12 CamCOPS is free software: you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation, either version 3 of the License, or
15 (at your option) any later version.
17 CamCOPS is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with CamCOPS. If not, see <https://www.gnu.org/licenses/>.
25===============================================================================
27**PDF functions.**
29"""
31from typing import Any, Dict, TYPE_CHECKING
33from cardinal_pythonlib.pdf import get_pdf_from_html
35from camcops_server.cc_modules.cc_constants import (
36 PDF_ENGINE,
37 WKHTMLTOPDF_OPTIONS,
38)
40if TYPE_CHECKING:
41 from camcops_server.cc_modules.cc_request import CamcopsRequest
44def pdf_from_html(req: "CamcopsRequest",
45 html: str,
46 header_html: str = None,
47 footer_html: str = None,
48 extra_wkhtmltopdf_options: Dict[str, Any] = None) -> bytes:
49 """
50 Create and return a PDF from the HTML provided.
51 """
52 extra_wkhtmltopdf_options = extra_wkhtmltopdf_options or {} # type: Dict[str, Any] # noqa
53 wkhtmltopdf_options = dict(WKHTMLTOPDF_OPTIONS,
54 **extra_wkhtmltopdf_options)
55 cfg = req.config
56 return get_pdf_from_html(html,
57 header_html=header_html,
58 footer_html=footer_html,
59 processor=PDF_ENGINE,
60 wkhtmltopdf_filename=cfg.wkhtmltopdf_filename,
61 wkhtmltopdf_options=wkhtmltopdf_options)