【发布时间】：2015-12-14 19:01:31
【问题描述】：
我一直在网上搜索使用 pdfkit（python 包装器）实现页眉和页脚的人的示例，但找不到任何示例。
谁能展示一些如何使用 pdfkit python 包装器在 wkhtmltopdf 中实现选项的示例？
【问题讨论】：
-
如果您认为答案对您有用，那么您可以将其标记为已接受的答案。
标签： python wkhtmltopdf pdfkit
【发布时间】：2015-12-14 19:01:31
【问题描述】：
我只将它与页眉一起使用，但我认为它与页脚相同。
您需要有单独的 html 文件作为标题。
header.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
</head>
<body>
Code of your header goes here.
</body>
</html>
然后你就可以像在 Python 中那样使用它了
import pdfkit
pdfkit.from_file('path/to/your/file.html', 'out.pdf', {
'--header-html': 'path/to/header.html'
})
如果您使用 Django 之类的后端并且想要使用模板，那么棘手的部分是您不能将标头 html 作为渲染字符串传递。你需要有一个文件。
这就是我用 Django 渲染 PDF 所做的。
import os
import tempfile
import pdfkit
from django.template.loader import render_to_string
def render_pdf(template, context, output, header_template=None):
"""
Simple function for easy printing of pdfs from django templates
Header template can also be set
"""
html = render_to_string(template, context)
options = {
'--load-error-handling': 'skip',
}
try:
if header_template:
with tempfile.NamedTemporaryFile(suffix='.html', delete=False) as header_html:
options['header-html'] = header_html.name
header_html.write(render_to_string(header_template, context).encode('utf-8'))
return pdfkit.from_string(html, output, options=options)
finally:
# Ensure temporary file is deleted after finishing work
if header_template:
os.remove(options['header-html'])
在我的示例中，我创建了放置渲染内容的临时文件。重要的部分是临时文件需要以.html 结尾并手动删除。
【讨论】：
-
不知何故我的头文件被忽略了:(
-
是的，头文件被忽略了，有什么解决办法吗？
-
它不起作用页眉和页脚被忽略
-
你需要在
header_html.write(...)之后做header_html.flush()，否则你只是使用一个空白临时文件作为页眉和页脚，所以它们看起来被忽略了。 -
在哪里？ @AlbaHoo ？
改进@V Stoykov 的回答，因为它帮助我使用 Flask，Flask 中带有自定义标头的渲染函数如下：
import os
import tempfile
import pdfkit
from flask import render_template, make_response
@app.route('/generate_pdf')
def render_pdf_custom_header(foo, bar):
main_content = render_template('main_pdf.html', foo=foo)
options = {
'--encoding': "utf-8"
}
add_pdf_header(options, bar)
add_pdf_footer(options)
try:
pdf = pdfkit.from_string(main_content, False, options=options)
finally:
os.remove(options['--header-html'])
os.remove(options['--footer-html'])
response = build_response(pdf)
return response
def add_pdf_header(options, bar):
with tempfile.NamedTemporaryFile(suffix='.html', delete=False) as header:
options['--header-html'] = header.name
header.write(
render_template('header.html', bar=bar).encode('utf-8')
)
return
def add_pdf_footer(options):
# same behaviour as add_pdf_header but without passing any variable
return
def build_response(pdf):
response = make_response(pdf)
response.headers['Content-Type'] = 'application/pdf'
filename = 'pdf-from-html.pdf'
response.headers['Content-Disposition'] = ('attachment; filename=' + filename)
return response
请注意，我使用了 '--header-html' 和 '--footer-html' 表示法，因为它与 wkhtmltopdf 选项格式匹配。
【讨论】：
options = {
'page-size': 'Letter',
'margin-top': '0.9in',
'margin-right': '0.9in',
'margin-bottom': '0.9in',
'margin-left': '0.9in',
'encoding': "UTF-8",
'header-center': 'YOUR HEADER',
'custom-header' : [
('Accept-Encoding', 'gzip')
],
'no-outline':None
}
您可以在header-center的值中添加您需要的标题
【讨论】：
这个问题及其答案已经很老了，对我不起作用。
wkhtmltopdf 版本：$ wkhtmltopdf --version
wkhtmltopdf 0.12.6（带有补丁的 qt）
python 3.8
对于 wkhtmltopdf，
header-html 和 footer-html 只能是 URI，例如html url 或文件路径，不能是字符串。所以想法是将每个 html 文件保存在云端或在本地创建一个临时文件作为页脚和页眉以供参考。
请求：
- 内容为
url或html - 标题为
html url或html string - 页脚为
html url或html string
例子：
import logging
import os
import tempfile
import pdfkit
from flask import Flask, Response, make_response
from flask_restx import Resource, Api, fields
Request = api.model('Request', {
'url': fields.String(
required=False,
description='url',
example='https://www.w3schools.com/html/html5_svg.asp',
),
'html': fields.String(
required=False,
description='content html string',
example=example_content_html
),
'header_html': fields.String(
required=False,
description='pdf header html string',
example=example_header_html
),
'footer_html': fields.String(
required=False,
description='pdf footer html string',
example=example_footer_html
),
})
@api.route("/convert_html_to_pdf", endpoint = 'html2pdf')
@api.representation('application/octet-stream')
class PdfConverter(Resource):
@api.doc(body=Request)
def post(self):
logging.info(request.json)
url = request.json.get('url')
html = request.json.get('html')
header_html = request.json.get('header_html')
footer_html = request.json.get('footer_html')
header_uri = 'https://xxxxx/header.html' # default header
footer_uri = 'https://xxxxx/footer.html' # default footer
if header_html:
fph = tempfile.NamedTemporaryFile(suffix='.html')
fph.write(header_html.encode('utf-8'))
fph.flush()
header_uri = fph.name
if footer_html:
fpf = tempfile.NamedTemporaryFile(suffix='.html')
fpf.write(footer_html.encode('utf-8'))
fpf.flush()
footer_uri = fpf.name
options = {
'page-size': 'A4',
'margin-top': '32mm',
'header-spacing': 6,
'footer-spacing': 6,
'header-html': header_uri,
'footer-html': footer_uri,
'margin-right': '0',
'margin-bottom': '16mm',
'margin-left': '0',
'encoding': "UTF-8",
'cookie': [
('cookie-empty-value', '""'),
('cookie-name1', 'cookie-value1'),
('cookie-name2', 'cookie-value2'),
],
'no-outline': None
}
logging.info(options)
if url:
# api.payload['requestedBlobUrl'] = url
# return api.payload
pdf = pdfkit.from_url(url, options=options)
else:
pdf = pdfkit.from_string(html, options=options)
if header_html:
fph.close()
if footer_html:
fpf.close() # close will delete the temp file
response = make_response(pdf)
response.headers['Content-Type'] = 'application/pdf'
response.headers['Content-Disposition'] = 'attachment;filename=report.pdf'
return response
【讨论】：