Django应用实战：编写你自己的PDF编辑器，实现PDF页面提取，页面合并与替换

大多数PDF软件阅读服务是免费的，但是如果你想编辑一个PDF文档，比如从一个PDF文档中提取指定页面，合并多个PDF页面或者实现PDF页面的替换，你一般需要购买收费软件才可以。这当然难不倒程序员们，尤其Python程序员们。今天小编我就带你利用Django+PyPDF2开发一个比较实用的小APP，实现PDF页面在线提取, 页面合并与页面替换。文尾我们会附上GitHub源码地址。

项目开发总体思路

对于PDF页面提取，我们的开发思路是这样子的。我们设计一个表单，让用户上传一个PDF文件并输入提取页面号码。服务器在收到PDF文件后使用PyPDF2读取用户上传的PDF文件，提取我们所需要的页面，然后通过FileResponse将这个提取的PDF页面通过浏览器返回给客户。如果用户输入的是1,3,5,7这种页码，我们将逐一提取页面，将所有提取页面压缩成一个zip包返回给用户。

对于PDF合并，我们只需用户一次上传PDF文件即可。对于PDF替换，我们需要用户上传替换页，被替换的PDF文件及被替换页面号码。

这个应用很简单，并不需要建立什么模型Models。重点要编写的是视图views.py, 用来处理用户的请求。我们预计需要4个urls和4个对应的处理方法。

PDF单页提取(如1, 3, 5): pdf_single_page_extract

PDF按页面范围连续提取(如2-8): pdf_range_extract

PDF文件合并: pdf_merge

PDF文件替换: pdf_replace

本例需要安装如下两个Python库, 其中PyPDF2库将负责PDF文件读取, 分割和合并工作。

Django==2.1.3

PyPDF2==1.26.0

项目设置

使用django-admin startproject mypdfproject创建一个名叫mypdfproject的项目，然后进入该目录再使用python manage.py startapp pdf创建一个叫pdf的app，然后把这个app加入到你的mypdfproject/settings.py里INSTALLED_APPS去。

#mypdfproject/settings.py

INSTALLED_APPS = [

'django.contrib.admin',

'django.contrib.staticfiles',

'pdf',

]

因为我们上传的PDF文件会临时存放在media文件夹，所以请在mypdfproject目录下建一个media文件夹，并在settings.py文件里设置为MEDIA_ROOT。我们还会用到css文件来美化网页，所以也请中设置好静态文件的STATIC_URL和STATIC_ROOT.

#mypdfproject/settings.py

STATIC_URL ='/static/'

STATIC_ROOT = os.path.join(BASE_DIR,'static')

#设置媒体文件夹,对于图片和文件上传很重要

MEDIA_ROOT = os.path.join(BASE_DIR,'media')

MEDIA_URL ='/media/'

同时别忘了了把我们app的urls也加到项目的urls.py里去。别忘了结尾的+static哦，否则媒体文件无法正确显示。

#mypdfproject/urls.py

fromdjango.contribimportadmin

fromdjango.urlsimportpath,include

#对于显示静态文件非常重要

fromdjango.confimportsettings

fromdjango.conf.urls.staticimportstatic

urlpatterns = [

path('admin/',admin.site.urls),

path('pdf/',include('pdf.urls')),

] + static(settings.MEDIA_URL,document_root=settings.MEDIA_ROOT)

URLConf配置与表单

在pdf文件目录下创建一个urls.py, 添加如下代码。一共有4个urls, 分别对应PDF单页提取，PDF按页面范围连续提取, PDF合并与PDF替换。

# pdf/urls.py

fromdjango.urlsimportpath,re_path

from.importviews

# namespace

app_name ='pdf'

urlpatterns = [

#上传pdf，用户输入需要提取的页面,返回需要提取的页面

path('extract/single/',views.pdf_single_page_extract,name='pdf_single_page_extract'),

path('extract/range/',views.pdf_range_extract,name='pdf_range_extract'),

path('merge/',views.pdf_merge,name='pdf_merge'),

path('replace/',views.pdf_replace,name='pdf_replace'),

]

另外我们还需要定义一些表单供用户上传PDF文件和输入页码，这些表单我们视图里会用到。

#pdf/forms.py

fromdjangoimportforms

classPdfExtractForm(forms.Form):

file = forms.FileField(label="Upload PDF Document")

page = forms.CharField(max_length=20,label="Page Number")

defclean_file(self):

file =self.cleaned_data.get('file')

if notfile.name.lower().endswith('.pdf'):

raiseforms.ValidationError("Only pdf documents are allowed. ")

returnfile

classPdfMergeForm(forms.Form):

file1 = forms.FileField(label="PDF file 1")

file2 = forms.FileField(label="PDF file 2",required=False)

file3 = forms.FileField(label="PDF file 3",required=False)

file4 = forms.FileField(label="PDF file 4",required=False)

file5 = forms.FileField(label="PDF file 5",required=False)

classPdfReplaceForm(forms.Form):

file1 = forms.FileField(label="Replacement page")

file2 = forms.FileField(label="PDF document to be replaced")

page = forms.IntegerField(label="Replace page number")

视图: PDF单页提取

我们先看下PDF单页提取对应视图方法pdf_single_page_extract的工作原理。用户上传PDF文件和一串用逗号隔开的数字后，该方法先用split方法转化为页码列表，再依次利用PyPDF2提取对应页码PDF页面，分别将每个提取的单页写入media文件夹。最后用zipfile将所有写入的PDF文件压缩成zip包，通过FileResponse方法返回给客户。

# pdf/views.py

fromdjango.shortcutsimportrender

fromdjango.httpimportFileResponse

from.formsimportPdfExtractForm,PdfMergeForm,PdfReplaceForm

importos

importPyPDF2

importzipfile

# Create your views here.

defpdf_single_page_extract(request):

ifrequest.method =='POST':

#如果用户通过POST提交

form = PdfExtractForm(request.POST,request.FILES)

ifform.is_valid():

#获取上传的文件

f = form.cleaned_data['file']

#转化为PDF文件对象

pdfFileObj = PyPDF2.PdfFileReader(f)

#获取需提取页面列表

page_num_list = form.cleaned_data['page'].split(',')

#创建zipfile对象,生成提取文件压缩包

zf = zipfile.ZipFile(os.path.join('media','extracted_pages.zip'),'w')

forpage_numinpage_num_list:

# pdf文档页码对象编码是从开始，所以减一

page_index =int(page_num) -1

#利用PyPDF2提取页码对象

pageObj = pdfFileObj.getPage(page_index)#从编码

#利用PyPDF2创建新的Pdf Writer

pdfWriter = PyPDF2.PdfFileWriter()

#添加已读取的页面对象

pdfWriter.addPage(pageObj)

# pdf文件路径

pdf_file_path = os.path.join('media','extracted_page_{}.pdf'.format(page_num))

#将提取页面写入新的PDF文件

withopen(pdf_file_path,'wb')aspdfOutputFile:

pdfWriter.write(pdfOutputFile)

#写入zip文件

zf.write(pdf_file_path)

zf.close()

#给用户返回zip压缩包

response = FileResponse(open(os.path.join('media','extracted_pages.zip'),'rb'))

response['content_type'] ="application/zip"

response['Content-Disposition'] ='attachment; filename="extracted_pages.zip"'

returnresponse

else:

#如果用户没有通过POST，提交生成空表单

form = PdfExtractForm()

returnrender(request,'pdf/pdf_extract.html',{'form': form})

视图: PDF页面按范围提取

# pdf/views.py

defpdf_range_extract(request):

ifrequest.method =='POST':

#如果用户通过POST提交

form = PdfExtractForm(request.POST,request.FILES)

ifform.is_valid():

#获取上传的文件

f = form.cleaned_data['file']

#转化为PDF文件对象

pdfFileObj = PyPDF2.PdfFileReader(f)

page_range = form.cleaned_data['page'].split('-')

page_start =int(page_range[])

page_end =int(page_range[1])

# Extracted pdf file path

pdf_file_path = os.path.join('media','extracted_page_{}-{}.pdf'.format(page_start,page_end))

pdfOutputFile =open(pdf_file_path,'ab+')

#利用PyPDF2创建新的Pdf Writer

pdfWriter = PyPDF2.PdfFileWriter()

forpage_numinrange(page_start,page_end +1):

# pdf文档页码对象编码是从开始，所以减一

page_index =int(page_num) -1

#利用PyPDF2提取页码对象

pageObj = pdfFileObj.getPage(page_index)#从编码

#添加已读取的页面对象

pdfWriter.addPage(pageObj)

pdfWriter.write(pdfOutputFile)

pdfOutputFile.close()

extractedPage =open(pdf_file_path,'rb')

response = FileResponse(extractedPage)

response['content_type'] ="application/octet-stream"

response['Content-Disposition'] ='attachment; filename="extracted_pages.pdf"'

returnresponse

else:

#如果用户没有通过POST，提交生成空表单

form = PdfExtractForm()

视图: PDF文档合并

# pdf/views.py

defpdf_merge(request):

ifrequest.method =='POST':

#如果用户通过POST提交

form = PdfMergeForm(request.POST,request.FILES)

ifform.is_valid():

#获取上传的文件1

f1 = form.cleaned_data['file1']

#获取上传的文件2

f2 = form.cleaned_data['file2']

#获取上传的文件3

f3 = form.cleaned_data['file3']

#获取上传的文件4

f4 = form.cleaned_data['file4']

#获取上传的文件5

f5 = form.cleaned_data['file5']

f_list = [f1,f2,f3,f4,f5]

#创建PDF文件合并对象，添加合并文件

pdfMerger = PyPDF2.PdfFileMerger()

#转化为PDF文件对象

forfinf_list:

iff:

pdfFileObj = PyPDF2.PdfFileReader(f)

pdfMerger.append(pdfFileObj)

#将合并文件对象写入到merged_file.pdf

withopen(os.path.join('media','merged_file.pdf'),'wb')aspdfOutputFile:

pdfMerger.write(pdfOutputFile)

#打开合并的merged_file.pdf，通过FileResponse输出

response = FileResponse(open(os.path.join('media','merged_file.pdf'),'rb'))

response['content_type'] ="application/octet-stream"

response['Content-Disposition'] ='attachment; filename="merged_file.pdf"'

returnresponse

else:

#如果通过POST提交，但表单未通过验证

form = PdfMergeForm()

else:

#如果用户没有通过POST，提交生成空表单

form = PdfMergeForm()

returnrender(request,'pdf/pdf_merge.html',{'form': form})

视图: PDF替换

# pdf/views.py

defpdf_replace(request):

ifrequest.method =='POST':

#如果用户通过POST提交

form = PdfReplaceForm(request.POST,request.FILES)

ifform.is_valid():

#获取需要插入的PDF页面文件1

f1 = form.cleaned_data['file1']

#获取需要被替换的文件2

f2 = form.cleaned_data['file2']

#获取替换页码数

page = form.cleaned_data['page']

#获取文件2总页数

pdfFileObj = PyPDF2.PdfFileReader(f2)

total_page = pdfFileObj.getNumPages()

#获取文件2第一部分-人为可读页码

page_start =1

page_end = page -1

pdfOutputFile1 =open(os.path.join('media','part_1.pdf'),'wb+')

#利用PyPDF2创建新的Pdf Writer

pdfWriter = PyPDF2.PdfFileWriter()

forpage_numinrange(page_start,page_end +1):

# pdf文档页码对象编码是从开始，所以减一

page_index =int(page_num) -1

#利用PyPDF2提取页码对象

pageObj = pdfFileObj.getPage(page_index)#从编码

#添加已读取的页面对象

pdfWriter.addPage(pageObj)

pdfWriter.write(pdfOutputFile1)

pdfOutputFile1.close()

#获取文件2第2部分-人为可读页码

page_start = page +1

page_end = total_page

pdfOutputFile2 =open(os.path.join('media','part_2.pdf'),'wb+')

#利用PyPDF2创建新的Pdf Writer

pdfWriter = PyPDF2.PdfFileWriter()

forpage_numinrange(page_start,page_end +1):

# pdf文档页码对象编码是从开始，所以减一

page_index =int(page_num) -1

#利用PyPDF2提取页码对象

pageObj = pdfFileObj.getPage(page_index)#从编码

#添加已读取的页面对象

pdfWriter.addPage(pageObj)

pdfWriter.write(pdfOutputFile2)

pdfOutputFile2.close()

f2_part_1 =open(os.path.join('media','part_1.pdf'),'rb+')

f2_part_2 =open(os.path.join('media','part_2.pdf'),'rb+')

#创建PDF文件合并对象，添加合并文件

pdfMerger = PyPDF2.PdfFileMerger()

pdfMerger.append(PyPDF2.PdfFileReader(f2_part_1))

pdfMerger.append(PyPDF2.PdfFileReader(f1))

pdfMerger.append(PyPDF2.PdfFileReader(f2_part_2))

#将合并文件对象写入到replaced_file.pdf

withopen(os.path.join('media','replaced_file.pdf'),'wb')aspdfOutputFile:

pdfMerger.write(pdfOutputFile)

#打开合并的replaced_file.pdf，通过HttpResponse输出

response = FileResponse(open(os.path.join('media','replaced_file.pdf'),'rb'))

response['content_type'] ="application/octet-stream"

response['Content-Disposition'] ='attachment; filename="replaced_file.pdf"'

returnresponse

else:

#如果通过POST提交，但表单未通过验证

form = PdfReplaceForm()

else:

#如果用户没有通过POST，提交生成空表单

form = PdfReplaceForm()

returnrender(request,'pdf/pdf_replace.html',{'form': form})

模板

#pdf/templates/pdf/pdf_extract.html

{% extends "pdf/base.html" %}

{% block content %}

PDF Singe Page Extract(单页提取)

|

PDF Page Range Extract(页面范围提取)|PDF Merge(合并)|

PDF Replace(替换)

PDF Single Page Extract (单页提取)

输入页面号码，如1或者3,5,9。Enter page numbers such as 1, or 1, 3, 5.

{{ form.non_field_errors }}

{% csrf_token %}

{{ form.as_p }}

Extract

{% endblock %}

#pdf/templates/pdf/pdf_range_extract.html

{% extends "pdf/base.html" %}

{% block content %}

PDF Singe Page Extract(单页提取)

|

PDF Page Range Extract(页面范围提取)|PDF Merge(合并)|

PDF Replace(替换)

PDF Page Range Extract (页面范围提取)

请输入页面范围,如2-8, 3-10。Please enter page range such as 2-8, 3-10.

{{ form.non_field_errors }}

{% csrf_token %}

{{ form.as_p }}

Extract

{% endblock %}

#pdf/templates/pdf/pdf_merge.html

{% extends "pdf/base.html" %}

{% block content %}

PDF Singe Page Extract(单页提取)

|

PDF Page Range Extract(页面范围提取)|PDF Merge(合并)|

PDF Replace(替换)

PDF Merge (合并)

请按顺序上传PDF文件。Please upload pdf documents by order.

{% csrf_token %}

{{ form.as_p }}

Merge

{% endblock %}

#pdf/templates/pdf/pdf_replace.html

{% extends "pdf/base.html" %}

{% block content %}

PDF Singe Page Extract(单页提取)

|

PDF Page Range Extract(页面范围提取)|PDF Merge(合并)|

PDF Replace(替换)

PDF Replace(替换)

一次仅能替换一个PDF页面。You can only replace 1 single page at a time.

{% csrf_token %}

{{ form.as_p }}

Replace

{% endblock %}

#pdf/templates/pdf/base.html

{% load static %}

{% block title %}Django PDF提取,合并与替换{% endblock %}

{% block content %}

{% if error_message %}

{{ error_message}}

{% endif %}

{% endblock %}

{% block footer %}{% endblock %}

实战效果

最后本项目展示效果如下，完美地实现了PDF页面的提取，合并和替换。唯一不足的是PyPDF2不支持中文命名的PDF文件读取, 所以还需进一步改进(注意: 中文PDF也支持的，只要文件名是英文就ok了)。

GitHub源码地址

https://github.com/shiyunbo/django-pypdf2-pdf-extract-merge-replace

编者按

本例是个不错的django练习项目哦，你不仅可以学习到表单和模板的使用，还可以了解django如何借助其它python库开发有趣有用的项目。除此以外你会对zipfile和PyPDF2有更深层次的了解。如果喜欢本文，就给点个赞吧。

大江狗

2018.11.14