Python学习笔记之wkhtmltopdf使用

在使用wkhtmltopdf时出现如下问题：

    from main import WKhtmlToPdf, wkhtmltopdf
ModuleNotFoundError: No module named 'main'

而直接看网上，存在好多类似的问题，我看了源码，发现其不仅存在一些问题，还仅支持到Python2.x；

如果要支持Python 3.x还需要修改一些东西；

1. init文件修改

api临时永不到，先注释掉了。

from .main import WKhtmlToPdf, wkhtmltopdf
#from .api import *

2. 修改main文件

#!/usr/bin/env python

import os
import optparse

class WKhtmlToPdf(object):
    """
    Convert an html page via its URL into a pdf.
    """
    def __init__(self, *args, **kwargs):
        self.url = None
        self.output_file = None
        
        # get the url and output_file options
        try:
            self.url, self.output_file = args[0], args[1]
        except IndexError:
            pass
        
        if not self.url or not self.output_file:
            raise Exception("Missing url and output file arguments")
            
        # save the file to /tmp if a full path is not specified
        output_path = os.path.split(self.output_file)[0]
        if not output_path:
            self.output_file = os.path.join('/tmp', self.output_file)
        
        self.defaults = {
            'screen_resolution': [kwargs.get('screen_resolution', [1024, 768]), list],
            'color_depth': [kwargs.get('color_depth', 24), int],
            'flash_plugin': [kwargs.get('flash_plugin', True), bool],
            'disable_javascript': [kwargs.get('disable_javascript', False), bool],
            'delay': [kwargs.get('delay', 0), int],
            'orientation': [kwargs.get('orientation', 'Portrait'), str],
            'dpi': [kwargs.get('dpi', 100), int],
            'no_background': [kwargs.get('no_background', False), bool],
            'grayscale': [kwargs.get('grayscale', False), bool],
            'http_username': [kwargs.get('http_username', ""), str],
            'http_password': [kwargs.get('http_password', ""), str],
            'header_html': [kwargs.get('header_html', ""), str],
            'footer_html': [kwargs.get('footer_html', ""), str],
        }
        
        for k, v in self.defaults.items():
            if not isinstance(v[0], v[1]):
                try:
                    v[0] = v[1](v[0])
                    print (v[0], v[1])
                except TypeError:
                    raise TypeError("%s argument required for %s" % (v[1].__name__.capitalize(), k))
            if k is "orientation" and v[0] not in ['Portrait', 'Landscape']:
                raise TypeError("Orientation argument must be either Portrait or Landscape")
            setattr(self, k, v[0])
    
    def _create_option_list(self):
        """
        Add command option according to the default settings.
        """
        option_list = []
        if self.flash_plugin:
            option_list.append("--enable-plugins")
        if self.disable_javascript:
            option_list.append("--disable-javascript")
        if self.no_background:
            option_list.append("--no-background")
        if self.grayscale:
            option_list.append("--grayscale")
        if self.delay:
            option_list.append("--redirect-delay %s" % self.delay)
        if self.http_username:
            option_list.append("--username %s" % self.http_username)
        if self.http_password:
            option_list.append("--password %s" % self.http_password)
        option_list.append("--orientation %s" % self.orientation)
        option_list.append("--dpi %s" % self.dpi)
        if os.path.exists(self.header_html):
            option_list.append("--header-html %s" % self.header_html)
        if os.path.exists(self.footer_html):
            option_list.append("--footer-html %s" % self.footer_html)

        option_list.append("--enable-local-file-access")
        
        return option_list
        
    def render(self):
        """
        Render the URL into a pdf and setup the evironment if required.
        """
        
        # setup the environment if it isn't set up yet
        '''
        if not os.getenv('DISPLAY'):
            os.system("Xvfb :0 -screen 0 %sx%sx%s & " % (
                self.screen_resolution[0],
                self.screen_resolution[1],
                self.color_depth
            ))
            os.putenv("DISPLAY", '127.0.0.1:0')
        '''
        
        # execute the command
        command = 'wkhtmltopdf %s "%s" "%s" >> ./wkhtp.log' % (
            " ".join(self._create_option_list()),
            self.url,
            self.output_file
        )
        print (command)
        sys_output = int(os.system(command))
        
        # return file if successful else return error code
        if not sys_output:
            return True, self.output_file
        return False, sys_output
        
def wkhtmltopdf(*args, **kwargs):
    wkhp = WKhtmlToPdf(*args, **kwargs)
    wkhp.render()
    
if __name__ == '__main__':
    
    # parse through the system argumants
    usage = "Usage: %prog [options] url output_file"
    parser = optparse.OptionParser()
    
    parser.add_option("-F", "--flash-plugin", action="store_true", dest="flash_plugin", default=True, help="use flash plugin")
    parser.add_option("-J", "--disable-javascript", action="store_true", dest="disable_javascript", default=False, help="disable javascript")
    parser.add_option("-b", "--no-background", action="store_true", dest="no_background", default=False, help="do not print background")
    parser.add_option("-g", "--grayscale", action="store_true", dest="grayscale", default=False, help="make grayscale")
    parser.add_option("-d", "--redirect-delay", dest="delay", default=0, help="page delay before convertion")
    parser.add_option("-O", "--orientation", dest="orientation", default='Portrait', help="page orientation")
    parser.add_option("-D", "--dpi", dest="dpi", default=100, help="print dpi")
    parser.add_option("-U", "--username", dest="http_username", default="", help="http username")
    parser.add_option("-P", "--password", dest="http_password", default="", help="http password")
    parser.add_option("-h", "--header-html", dest="header_html", default="", help="url to the header html")
    parser.add_option("-f", "--footer-html", dest="footer_html", default="", help="url to the footer html")
    
    options, args = parser.parse_args()
    
    # call the main method with parsed argumants
    wkhtmltopdf(*args, **options.__dict__)
    

到这里就能生成command line了：

wkhtmltopdf --enable-plugins --orientation Portrait --dpi 100 --header-html  --footer-html  "readme.html" "readme.pdf" >> /tmp/wkhtp.log

3. 安装wkhtmltopdf程序

切换到https://wkhtmltopdf.org/downloads.html 这个地址下载对应版本，安装对应系统的程序；安装完成后，注意添加环境变量；

为了生效，可重启PC；要不再调用wkhtmltopdf地方，直接引用绝对路径；

至此完成；

4. 直接调用wkhtmltopdf进行HTML转pdf

from subprocess import call
call(["wkhtmltopdf", '--enable-local-file-access', src_html_name, dest_pdf_name])

这样也OK。

详细官方介绍：https://wkhtmltopdf.org/usage/wkhtmltopdf.txt