-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
gummy.utils.pdf_utils.html
291 lines (262 loc) · 21.8 KB
/
gummy.utils.pdf_utils.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta property="og:title" content="gummy.utils.pdf_utils module" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://iwasakishuto.github.io/Translation-Gummy/gummy.utils.pdf_utils.html" />
<meta property="og:description" content="Utility programs for handling and analyzing PDF file." />
<meta property="og:image" content="https://iwasakishuto.github.io/images/FacebookImage/Translation-Gummy.png" />
<meta property="og:site_name" content="Translation-Gummy" />
<meta name="twitter:site" content="@cabernet_rock" />
<meta name="twitter:card" content="summary">
<meta name="twitter:image:src" content="https://iwasakishuto.github.io/images/FacebookImage/Translation-Gummy.png">
<title>gummy.utils.pdf_utils module — Translation-Gummy documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
<link rel="stylesheet" type="text/css" href="_static/font-awesome/css/solid.css" />
<link rel="stylesheet" type="text/css" href="_static/font-awesome/css/brands.css" />
<link rel="stylesheet" type="text/css" href="_static/font-awesome/css/fontawesome.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/custom.js"></script>
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="gummy.utils.soup_utils module" href="gummy.utils.soup_utils.html" />
<link rel="prev" title="gummy.utils.outfmt_utils module" href="gummy.utils.outfmt_utils.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="gummy.utils.soup_utils.html" title="gummy.utils.soup_utils module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gummy.utils.outfmt_utils.html" title="gummy.utils.outfmt_utils module"
accesskey="P">previous</a> |</li>
<li><i class="fas fa-home"></i><a href="https://iwasakishuto.github.io/">Portfolio Top</a> »</li>
<li class="nav-item nav-item-0"><a href="index.html">Translation-Gummy documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="gummy.html" >gummy package</a> »</li>
<li class="nav-item nav-item-2"><a href="gummy.utils.html" accesskey="U">gummy.utils package</a> »</li>
<li class="nav-item nav-item-this"><a href="">gummy.utils.pdf_utils module</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-gummy.utils.pdf_utils">
<span id="gummy-utils-pdf-utils-module"></span><h1>gummy.utils.pdf_utils module<a class="headerlink" href="#module-gummy.utils.pdf_utils" title="Permalink to this headline">¶</a></h1>
<p>Utility programs for handling and analyzing PDF file.</p>
<dl class="py function">
<dt id="gummy.utils.pdf_utils.get_pdf_pages">
<code class="sig-prename descclassname">gummy.utils.pdf_utils.</code><code class="sig-name descname">get_pdf_pages</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span></em>, <em class="sig-param"><span class="n">dirname</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/.gummy'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/utils/pdf_utils.html#get_pdf_pages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.utils.pdf_utils.get_pdf_pages" title="Permalink to this definition">¶</a></dt>
<dd><p>Get PDF pages.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>data</em><em>, </em><em>str</em>) – url or path or data of PDF.</p></li>
<li><p><strong>dirname</strong> (<em>str</em>) – if <code class="docutils literal notranslate"><span class="pre">file</span></code> is url, download and save it to <code class="docutils literal notranslate"><span class="pre">dirname</span></code>. (defalt= <code class="docutils literal notranslate"><span class="pre">GUMMY_DIR</span></code>)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="gummy.utils.pdf_utils.parser_pdf_pages">
<code class="sig-prename descclassname">gummy.utils.pdf_utils.</code><code class="sig-name descname">parser_pdf_pages</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">layout_objs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/utils/pdf_utils.html#parser_pdf_pages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.utils.pdf_utils.parser_pdf_pages" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse PDF pages and get contents in order.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>layout_objs</strong> (<em>list</em>) – Each element is pdfminer.layout object.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Each element is a list which contains [text, bbox(x0,y0,x1,y1)]</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="gummy.utils.pdf_utils.get_pdf_contents">
<code class="sig-prename descclassname">gummy.utils.pdf_utils.</code><code class="sig-name descname">get_pdf_contents</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span></em>, <em class="sig-param"><span class="n">dirname</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/.gummy'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/utils/pdf_utils.html#get_pdf_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.utils.pdf_utils.get_pdf_contents" title="Permalink to this definition">¶</a></dt>
<dd><p>Get PDF contents.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>data</em><em>, </em><em>str</em>) – url or path or data of PDF.</p></li>
<li><p><strong>dirname</strong> (<em>str</em>) – if <code class="docutils literal notranslate"><span class="pre">file</span></code> is url, download and save it to <code class="docutils literal notranslate"><span class="pre">dirname</span></code>. (defalt= <code class="docutils literal notranslate"><span class="pre">GUMMY_DIR</span></code>)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Each element is a list which contains [text, bbox(x0,y0,x1,y1)]</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="gummy.utils.pdf_utils.createHighlight">
<code class="sig-prename descclassname">gummy.utils.pdf_utils.</code><code class="sig-name descname">createHighlight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bbox</span><span class="o">=</span><span class="default_value">0, 0, 1, 1</span></em>, <em class="sig-param"><span class="n">contents</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">color</span><span class="o">=</span><span class="default_value">[1, 1, 0]</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">'iwasakishuto(@cabernet_rock)'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/utils/pdf_utils.html#createHighlight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.utils.pdf_utils.createHighlight" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a Highlight</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bbox</strong> (<em>tuple</em>) – a bounding box showing the location of highlight.</p></li>
<li><p><strong>contents</strong> (<em>str</em>) – Text comments for a highlight label.</p></li>
<li><p><strong>color</strong> (<em>list</em>) – Highlight color. Defaults to <code class="docutils literal notranslate"><span class="pre">[1,1,0]</span></code>. (yellow)</p></li>
<li><p><strong>author</strong> (<em>str</em>) – Who wrote the annotation (comment). Defaults to <code class="docutils literal notranslate"><span class="pre">"iwasakishuto(@cabernet_rock)"</span></code> .</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Highlight information.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>DictionaryObject</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gummy.utils</span> <span class="kn">import</span> <span class="n">createHighlight</span><span class="p">,</span> <span class="n">addHighlightToPage</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">PyPDF2</span> <span class="kn">import</span> <span class="n">PdfFileWriter</span><span class="p">,</span> <span class="n">PdfFileReader</span>
<span class="gp">>>> </span><span class="n">page_no</span> <span class="o">=</span> <span class="mi">0</span>
<span class="gp">>>> </span><span class="n">pdfOutput</span> <span class="o">=</span> <span class="n">PdfFileWriter</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"input.pdf"</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">inPdf</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">pdfInput</span> <span class="o">=</span> <span class="n">PdfFileReader</span><span class="p">(</span><span class="n">inPdf</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">page</span> <span class="o">=</span> <span class="n">pdfInput</span><span class="o">.</span><span class="n">getPage</span><span class="p">(</span><span class="n">page_no</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">highlight</span> <span class="o">=</span> <span class="n">createHighlight</span><span class="p">(</span><span class="n">bbox</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">10</span><span class="p">,</span><span class="mi">90</span><span class="p">,</span><span class="mi">90</span><span class="p">),</span> <span class="n">contents</span><span class="o">=</span><span class="s2">"COMMENT"</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">))</span>
<span class="gp">... </span> <span class="n">addHighlightToPage</span><span class="p">(</span><span class="n">highlight</span><span class="p">,</span> <span class="n">page</span><span class="p">,</span> <span class="n">pdfOutput</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">pdfOutput</span><span class="o">.</span><span class="n">addPage</span><span class="p">(</span><span class="n">page</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"output.pdf"</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">"wb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">outPdf</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">pdfOutput</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">outPdf</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt id="gummy.utils.pdf_utils.addHighlightToPage">
<code class="sig-prename descclassname">gummy.utils.pdf_utils.</code><code class="sig-name descname">addHighlightToPage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">highlight</span></em>, <em class="sig-param"><span class="n">page</span></em>, <em class="sig-param"><span class="n">output</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/utils/pdf_utils.html#addHighlightToPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.utils.pdf_utils.addHighlightToPage" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a highlight to a page.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>highlight</strong> (<em>DictionaryObject</em>) – Highlight information.</p></li>
<li><p><strong>page</strong> (<em>PageObject</em>) – A single page within a PDF file.</p></li>
<li><p><strong>output</strong> (<em>PdfFileWriter</em>) – A pdf writer.</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gummy.utils</span> <span class="kn">import</span> <span class="n">createHighlight</span><span class="p">,</span> <span class="n">addHighlightToPage</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">PyPDF2</span> <span class="kn">import</span> <span class="n">PdfFileWriter</span><span class="p">,</span> <span class="n">PdfFileReader</span>
<span class="gp">>>> </span><span class="n">page_no</span> <span class="o">=</span> <span class="mi">0</span>
<span class="gp">>>> </span><span class="n">pdfOutput</span> <span class="o">=</span> <span class="n">PdfFileWriter</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"input.pdf"</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">inPdf</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">pdfInput</span> <span class="o">=</span> <span class="n">PdfFileReader</span><span class="p">(</span><span class="n">inPdf</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">page</span> <span class="o">=</span> <span class="n">pdfInput</span><span class="o">.</span><span class="n">getPage</span><span class="p">(</span><span class="n">page_no</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">highlight</span> <span class="o">=</span> <span class="n">createHighlight</span><span class="p">(</span><span class="n">bbox</span><span class="o">=</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">10</span><span class="p">,</span><span class="mi">90</span><span class="p">,</span><span class="mi">90</span><span class="p">),</span> <span class="n">contents</span><span class="o">=</span><span class="s2">"COMMENT"</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">))</span>
<span class="gp">... </span> <span class="n">addHighlightToPage</span><span class="p">(</span><span class="n">highlight</span><span class="p">,</span> <span class="n">page</span><span class="p">,</span> <span class="n">pdfOutput</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">pdfOutput</span><span class="o">.</span><span class="n">addPage</span><span class="p">(</span><span class="n">page</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"output.pdf"</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">"wb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">outPdf</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">pdfOutput</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">outPdf</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Other contents</h4>
<ul class="social">
<li><a href="https://iwasakishuto.github.io/Blog/index.html"><img src="https://iwasakishuto.github.io/images/apple-touch-icon/Blog.png"></a></li>
<li><a href="https://iwasakishuto.github.io/University/index.html"><img src="https://iwasakishuto.github.io/images/apple-touch-icon/University.png"></a></li>
<li><a href="https://iwasakishuto.github.io/Front-End/index.html"><img src="https://iwasakishuto.github.io/images/apple-touch-icon/Front-End.png"></a></li>
<li><a href="https://iwasakishuto.github.io/Kerasy/index.html"><img src="https://iwasakishuto.github.io/images/apple-touch-icon/Kerasy.png"></a></li>
<li><a href="https://iwasakishuto.github.io/Python-Charmers/index.html"><img src="https://iwasakishuto.github.io/images/apple-touch-icon/Python-Charmers.png"></a></li>
</ul>
<h4>Social link</h4>
<ul class="social">
<li><a class="sc-twitter" href="https://twitter.com/cabernet_rock">
<i class="fab fa-twitter" aria-hidden="true"></i>
</a></li>
<li><a class="sc-github" href="https://github.com/iwasakishuto">
<i class="fab fa-github" aria-hidden="true"></i>
</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="gummy.utils.outfmt_utils.html"
title="previous chapter">gummy.utils.outfmt_utils module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="gummy.utils.soup_utils.html"
title="next chapter">gummy.utils.soup_utils module</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/gummy.utils.pdf_utils.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="gummy.utils.soup_utils.html" title="gummy.utils.soup_utils module"
>next</a> |</li>
<li class="right" >
<a href="gummy.utils.outfmt_utils.html" title="gummy.utils.outfmt_utils module"
>previous</a> |</li>
<li><i class="fas fa-home"></i><a href="https://iwasakishuto.github.io/">Portfolio Top</a> »</li>
<li class="nav-item nav-item-0"><a href="index.html">Translation-Gummy documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="gummy.html" >gummy package</a> »</li>
<li class="nav-item nav-item-2"><a href="gummy.utils.html" >gummy.utils package</a> »</li>
<li class="nav-item nav-item-this"><a href="">gummy.utils.pdf_utils module</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2021, iwasakishuto.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-164333757-6"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-164333757-6');
</script>
</body>
</html>