-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
gummy.models.html
344 lines (314 loc) · 35.5 KB
/
gummy.models.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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<!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.models module" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://iwasakishuto.github.io/Translation-Gummy/gummy.models.html" />
<meta property="og:description" content="This file defines a model that integrates all of journals, translators, gateways, and it is possible to do all of the following at once. Determine the journal_type of paper from the url or file ext..." />
<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.models 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.translators module" href="gummy.translators.html" />
<link rel="prev" title="gummy.journals module" href="gummy.journals.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.translators.html" title="gummy.translators module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gummy.journals.html" title="gummy.journals 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" accesskey="U">gummy package</a> »</li>
<li class="nav-item nav-item-this"><a href="">gummy.models 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.models">
<span id="gummy-models-module"></span><h1>gummy.models module<a class="headerlink" href="#module-gummy.models" title="Permalink to this headline">¶</a></h1>
<p>This file defines a model that integrates all of <a class="reference internal" href="gummy.journals.html#module-gummy.journals" title="gummy.journals"><code class="xref py py-mod docutils literal notranslate"><span class="pre">journals</span></code></a>,
<a class="reference internal" href="gummy.translators.html#module-gummy.translators" title="gummy.translators"><code class="xref py py-mod docutils literal notranslate"><span class="pre">translators</span></code></a>, <a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a>, and
it is possible to do all of the following at once.</p>
<ol class="arabic simple">
<li><p>Determine the <code class="docutils literal notranslate"><span class="pre">journal_type</span></code> of paper from the <code class="docutils literal notranslate"><span class="pre">url</span></code> or file extension.</p></li>
<li><p>If necessary, use a <code class="docutils literal notranslate"><span class="pre">GummyGateway</span></code> to access non-open content of the journal.</p></li>
<li><p>Parse the paper using <code class="docutils literal notranslate"><span class="pre">GummyJournals</span></code> and obtain the contents.</p></li>
<li><p>Translate the English obtained using <code class="docutils literal notranslate"><span class="pre">GummyTranslators</span></code> to Japanese.</p></li>
<li><p>Arrange Japanese and English according to the <a class="reference external" href="https://github.com/iwasakishuto/Translation-Gummy/tree/master/gummy/templates">templates</a> .</p></li>
<li><p>Convert the obtained HTML to PDF.</p></li>
</ol>
<p>You can get (import) <code class="docutils literal notranslate"><span class="pre">TranslationGummy</span></code> by the following 2 ways.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gummy.models</span> <span class="kn">import</span> <span class="n">TranslationGummy</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gummy</span> <span class="kn">import</span> <span class="n">TranslationGummy</span>
</pre></div>
</div>
<dl class="py class">
<dt id="gummy.models.TranslationGummy">
<em class="property">class </em><code class="sig-prename descclassname">gummy.models.</code><code class="sig-name descname">TranslationGummy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">chrome_options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">browser</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">driver</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">gateway</span><span class="o">=</span><span class="default_value">'useless'</span></em>, <em class="sig-param"><span class="n">translator</span><span class="o">=</span><span class="default_value">'deepl'</span></em>, <em class="sig-param"><span class="n">maxsize</span><span class="o">=</span><span class="default_value">5000</span></em>, <em class="sig-param"><span class="n">specialize</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">from_lang</span><span class="o">=</span><span class="default_value">'en'</span></em>, <em class="sig-param"><span class="n">to_lang</span><span class="o">=</span><span class="default_value">'ja'</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">translator_verbose</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/models.html#TranslationGummy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.models.TranslationGummy" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class integrates all of the followings</p>
<ul class="simple">
<li><p><a class="reference internal" href="gummy.journals.html#module-gummy.journals" title="gummy.journals"><code class="xref py py-mod docutils literal notranslate"><span class="pre">journals</span></code></a></p></li>
<li><p><a class="reference internal" href="gummy.translators.html#module-gummy.translators" title="gummy.translators"><code class="xref py py-mod docutils literal notranslate"><span class="pre">translators</span></code></a></p></li>
<li><p><a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a></p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>chrome_options</strong> (<em>ChromeOptions</em>) – Instance of ChromeOptions. (default= <a class="reference internal" href="gummy.utils.driver_utils.html#gummy.utils.driver_utils.get_chrome_options" title="gummy.utils.driver_utils.get_chrome_options"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_chrome_options()</span></code></a> )</p></li>
<li><p><strong>browser</strong> (<em>bool</em>) – Whether you want to run Chrome with GUI browser. (default= <code class="docutils literal notranslate"><span class="pre">False</span></code> )</p></li>
<li><p><strong>driver</strong> (<em>WebDriver</em>) – Selenium WebDriver.</p></li>
<li><p><strong>gateway</strong> (<em>str</em><em>, </em><em>GummyGateWay</em>) – identifier of the Gummy Gateway Class. See <a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a>. (default= <cite>“useless”</cite>)</p></li>
<li><p><strong>translator</strong> (<em>str</em><em>, </em><em>GummyTranslator</em>) – identifier of the Gummy Translator Class. See <a class="reference internal" href="gummy.translators.html#module-gummy.translators" title="gummy.translators"><code class="xref py py-mod docutils literal notranslate"><span class="pre">translators</span></code></a>. (default= <cite>“deepl”</cite>)</p></li>
<li><p><strong>maxsize</strong> (<em>int</em>) – Number of English characters that we can send a request at one time. (default= <code class="docutils literal notranslate"><span class="pre">5000</span></code>)</p></li>
<li><p><strong>specialize</strong> (<em>bool</em>) – Whether to support multiple languages or specialize. (default= <code class="docutils literal notranslate"><span class="pre">True</span></code>) If you want to specialize in translating between specific languages, set <code class="docutils literal notranslate"><span class="pre">from_lang</span></code> and <code class="docutils literal notranslate"><span class="pre">to_lang</span></code> arguments.</p></li>
<li><p><strong>from_lang</strong> (<em>str</em>) – Language before translation.</p></li>
<li><p><strong>to_lang</strong> (<em>str</em>) – Language after translation.</p></li>
<li><p><strong>verbose</strong> (<em>bool</em>) – Whether you want to print output or not. (default= <code class="docutils literal notranslate"><span class="pre">True</span></code> )</p></li>
<li><p><strong>translator_verbose</strong> (<em>bool</em>) – Whether you want to print translator’s output or not. (default= <code class="docutils literal notranslate"><span class="pre">False</span></code> )</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt id="gummy.models.TranslationGummy.translate">
<code class="sig-name descname">translate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">query</span></em>, <em class="sig-param"><span class="n">barname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">from_lang</span><span class="o">=</span><span class="default_value">'en'</span></em>, <em class="sig-param"><span class="n">to_lang</span><span class="o">=</span><span class="default_value">'ja'</span></em>, <em class="sig-param"><span class="n">correspond</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/models.html#TranslationGummy.translate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.models.TranslationGummy.translate" title="Permalink to this definition">¶</a></dt>
<dd><p>Translate English into Japanese. See <code class="xref py py-meth docutils literal notranslate"><span class="pre">translate</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>query</strong> (<em>str</em>) – English to be translated.</p></li>
<li><p><strong>barname</strong> (<em>str</em>) – Bar name for <a class="reference internal" href="gummy.utils.monitor_utils.html#gummy.utils.monitor_utils.ProgressMonitor" title="gummy.utils.monitor_utils.ProgressMonitor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ProgressMonitor</span></code></a>.</p></li>
<li><p><strong>from_lang</strong> (<em>str</em>) – Language before translation.</p></li>
<li><p><strong>to_lang</strong> (<em>str</em>) – Language after translation.</p></li>
<li><p><strong>correspond</strong> (<em>bool</em>) – Whether to correspond the location of <code class="docutils literal notranslate"><span class="pre">from_lang</span></code> correspond to that of <code class="docutils literal notranslate"><span class="pre">to_lang</span></code>.</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</span> <span class="kn">import</span> <span class="n">TranslationGummy</span>
<span class="gp">>>> </span><span class="n">model</span> <span class="o">=</span> <span class="n">TranslationGummy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">ja</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="s2">"This is a pen."</span><span class="p">)</span>
<span class="go">DeepLTranslator (query1) 03/30 [##------------------] 10.00% - 3.243[s]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">ja</span><span class="p">)</span>
<span class="go">'これはペンです。'</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt id="gummy.models.TranslationGummy.get_contents">
<code class="sig-name descname">get_contents</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">journal_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">crawl_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">gateway</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">gatewaykwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/models.html#TranslationGummy.get_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.models.TranslationGummy.get_contents" title="Permalink to this definition">¶</a></dt>
<dd><p>Get contents of the journal.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<em>str</em>) – URL of a paper or <code class="docutils literal notranslate"><span class="pre">path/to/local.pdf</span></code>.</p></li>
<li><p><strong>journal_type</strong> (<em>str</em>) – Journal type, if you not specify, judge by analyzing from <code class="docutils literal notranslate"><span class="pre">url</span></code>.</p></li>
<li><p><strong>crawl_type</strong> (<em>str</em>) – Crawling type, if you not specify, use recommended crawling type.</p></li>
<li><p><strong>gateway</strong> (<em>str</em><em>, </em><em>GummyGateWay</em>) – identifier of the Gummy Gateway Class. See <a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a>. (default= <code class="docutils literal notranslate"><span class="pre">None</span></code>)</p></li>
<li><p><strong>gatewaykwargs</strong> (<em>dict</em>) – Gateway keywargs. See <a class="reference internal" href="gummy.gateways.html#gummy.gateways.GummyAbstGateWay.passthrough" title="gummy.gateways.GummyAbstGateWay.passthrough"><code class="xref py py-meth docutils literal notranslate"><span class="pre">passthrough</span></code></a>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>(title, content)</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>tuple (str, dict)</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</span> <span class="kn">import</span> <span class="n">TranslationGummy</span>
<span class="gp">>>> </span><span class="n">model</span> <span class="o">=</span> <span class="n">TranslationGummy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">title</span><span class="p">,</span> <span class="n">texts</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">get_contents</span><span class="p">(</span><span class="s2">"https://www.nature.com/articles/ncb0800_500"</span><span class="p">)</span>
<span class="go">Estimated Journal Type : Nature</span>
<span class="go">Crawling Type: soup</span>
<span class="go"> :</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
<span class="go">Formation of the male-specific muscle in female by ectopic expression</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">texts</span><span class="p">[:</span><span class="mi">1</span><span class="p">])</span>
<span class="go">[{'head': 'Abstract', 'en': 'The () gene product Fru has been ... for the sexually dimorphic actions of the gene.'}]</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt id="gummy.models.TranslationGummy.toHTML">
<code class="sig-name descname">toHTML</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">out_dir</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/.gummy'</span></em>, <em class="sig-param"><span class="n">from_lang</span><span class="o">=</span><span class="default_value">'en'</span></em>, <em class="sig-param"><span class="n">to_lang</span><span class="o">=</span><span class="default_value">'ja'</span></em>, <em class="sig-param"><span class="n">correspond</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">journal_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">crawl_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">gateway</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">searchpath</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/Github/portfolio/Translation-Gummy/gummy/templates'</span></em>, <em class="sig-param"><span class="n">template</span><span class="o">=</span><span class="default_value">'paper.html'</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">gatewaykwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/models.html#TranslationGummy.toHTML"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.models.TranslationGummy.toHTML" title="Permalink to this definition">¶</a></dt>
<dd><p>Get contents from URL and create a HTML.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<em>str</em>) – URL of a paper or <code class="docutils literal notranslate"><span class="pre">path/to/local.pdf</span></code>.</p></li>
<li><p><strong>path/out_dir</strong> (<em>str</em>) – Where you save a created HTML. If path is None, save at <code class="docutils literal notranslate"><span class="pre"><out_dir>/<title>.html</span></code> (default= <code class="docutils literal notranslate"><span class="pre">GUMMY_DIR</span></code>)</p></li>
<li><p><strong>from_lang</strong> (<em>str</em>) – Language before translation.</p></li>
<li><p><strong>to_lang</strong> (<em>str</em>) – Language after translation.</p></li>
<li><p><strong>correspond</strong> (<em>bool</em>) – Whether to correspond the location of <code class="docutils literal notranslate"><span class="pre">from_lang</span></code> correspond to that of <code class="docutils literal notranslate"><span class="pre">to_lang</span></code>.</p></li>
<li><p><strong>journal_type</strong> (<em>str</em>) – Journal type, if you specify, use <code class="docutils literal notranslate"><span class="pre">journal_type</span></code> journal crawler. (default= <cite>None</cite>)</p></li>
<li><p><strong>crawl_type</strong> (<em>str</em>) – Crawling type, if you not specify, use recommended crawling type. (default= <cite>None</cite>)</p></li>
<li><p><strong>gateway</strong> (<em>str</em><em>, </em><em>GummyGateWay</em>) – identifier of the Gummy Gateway Class. See <a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a>. (default= <cite>None</cite>)</p></li>
<li><p><strong>searchpath/template</strong> (<em>str</em>) – Use a <code class="docutils literal notranslate"><span class="pre"><searchpath>/<template></span></code> tpl for creating HTML. (default= <cite>TEMPLATES_DIR/paper.html</cite>)</p></li>
<li><p><strong>gatewaykwargs</strong> (<em>dict</em>) – Gateway keywargs. See <a class="reference internal" href="gummy.gateways.html#gummy.gateways.GummyAbstGateWay.passthrough" title="gummy.gateways.GummyAbstGateWay.passthrough"><code class="xref py py-meth docutils literal notranslate"><span class="pre">passthrough</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="gummy.models.TranslationGummy.toPDF">
<code class="sig-name descname">toPDF</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">out_dir</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/.gummy'</span></em>, <em class="sig-param"><span class="n">from_lang</span><span class="o">=</span><span class="default_value">'en'</span></em>, <em class="sig-param"><span class="n">to_lang</span><span class="o">=</span><span class="default_value">'ja'</span></em>, <em class="sig-param"><span class="n">correspond</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">journal_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">crawl_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">gateway</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">searchpath</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/Github/portfolio/Translation-Gummy/gummy/templates'</span></em>, <em class="sig-param"><span class="n">template</span><span class="o">=</span><span class="default_value">'paper.html'</span></em>, <em class="sig-param"><span class="n">delete_html</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">{}</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">gatewaykwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/models.html#TranslationGummy.toPDF"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.models.TranslationGummy.toPDF" title="Permalink to this definition">¶</a></dt>
<dd><p>Get contents from URL and create a PDF.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<em>str</em>) – URL of a paper or <code class="docutils literal notranslate"><span class="pre">path/to/local.pdf</span></code>.</p></li>
<li><p><strong>path/out_dir</strong> (<em>str</em>) – Where you save a created HTML. If path is None, save at <code class="docutils literal notranslate"><span class="pre"><out_dir>/<title>.html</span></code> (default= <code class="docutils literal notranslate"><span class="pre">GUMMY_DIR</span></code>)</p></li>
<li><p><strong>from_lang</strong> (<em>str</em>) – Language before translation.</p></li>
<li><p><strong>to_lang</strong> (<em>str</em>) – Language after translation.</p></li>
<li><p><strong>correspond</strong> (<em>bool</em>) – Whether to correspond the location of <code class="docutils literal notranslate"><span class="pre">from_lang</span></code> correspond to that of <code class="docutils literal notranslate"><span class="pre">to_lang</span></code>.</p></li>
<li><p><strong>journal_type</strong> (<em>str</em>) – Journal type, if you specify, use <code class="docutils literal notranslate"><span class="pre">journal_type</span></code> journal crawler. (default= <cite>None</cite>)</p></li>
<li><p><strong>crawl_type</strong> (<em>str</em>) – Crawling type, if you not specify, use recommended crawling type. (default= <cite>None</cite>)</p></li>
<li><p><strong>gateway</strong> (<em>str</em><em>, </em><em>GummyGateWay</em>) – identifier of the Gummy Gateway Class. See <a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a>. (default= <cite>None</cite>)</p></li>
<li><p><strong>searchpath/template</strong> (<em>str</em>) – Use a <code class="docutils literal notranslate"><span class="pre"><searchpath>/<template></span></code> tpl for creating HTML. (default= <cite>TEMPLATES_DIR/paper.html</cite>)</p></li>
<li><p><strong>delete_html</strong> (<em>bool</em>) – Whether you want to delete an intermediate html file. (default= <cite>True</cite>)</p></li>
<li><p><strong>options</strong> (<em>dict</em>) – Options for wkhtmltopdf. See <a class="reference external" href="https://wkhtmltopdf.org/usage/wkhtmltopdf.txt">https://wkhtmltopdf.org/usage/wkhtmltopdf.txt</a> (default= <cite>{}</cite>)</p></li>
<li><p><strong>gatewaykwargs</strong> (<em>dict</em>) – Gateway keywargs. See <a class="reference internal" href="gummy.gateways.html#gummy.gateways.GummyAbstGateWay.passthrough" title="gummy.gateways.GummyAbstGateWay.passthrough"><code class="xref py py-meth docutils literal notranslate"><span class="pre">passthrough</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="gummy.models.TranslationGummy.highlight">
<code class="sig-name descname">highlight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">out_dir</span><span class="o">=</span><span class="default_value">'/Users/iwasakishuto/.gummy'</span></em>, <em class="sig-param"><span class="n">from_lang</span><span class="o">=</span><span class="default_value">'en'</span></em>, <em class="sig-param"><span class="n">to_lang</span><span class="o">=</span><span class="default_value">'ja'</span></em>, <em class="sig-param"><span class="n">journal_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">gateway</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ignore_length</span><span class="o">=</span><span class="default_value">10</span></em>, <em class="sig-param"><span class="n">highlight_color</span><span class="o">=</span><span class="default_value">[1, 1, 0]</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">gatewaykwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/gummy/models.html#TranslationGummy.highlight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gummy.models.TranslationGummy.highlight" title="Permalink to this definition">¶</a></dt>
<dd><p>Get contents from URL and create a PDF.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<em>str</em>) – URL of a paper or <code class="docutils literal notranslate"><span class="pre">path/to/local.pdf</span></code>.</p></li>
<li><p><strong>path/out_dir</strong> (<em>str</em>) – Where you save a created HTML. If path is None, save at <code class="docutils literal notranslate"><span class="pre"><out_dir>/<title>.html</span></code> (default= <code class="docutils literal notranslate"><span class="pre">GUMMY_DIR</span></code>)</p></li>
<li><p><strong>from_lang</strong> (<em>str</em>) – Language before translation.</p></li>
<li><p><strong>to_lang</strong> (<em>str</em>) – Language after translation.</p></li>
<li><p><strong>journal_type</strong> (<em>str</em>) – Journal type, if you specify, use <code class="docutils literal notranslate"><span class="pre">journal_type</span></code> journal crawler. (default= <cite>None</cite>)</p></li>
<li><p><strong>gateway</strong> (<em>str</em><em>, </em><em>GummyGateWay</em>) – identifier of the Gummy Gateway Class. See <a class="reference internal" href="gummy.gateways.html#module-gummy.gateways" title="gummy.gateways"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gateways</span></code></a>. (default= <cite>None</cite>)</p></li>
<li><p><strong>ignore_length</strong> (<em>int</em>) – If the number of English characters is smaller than <code class="docutils literal notranslate"><span class="pre">ignore_length</span></code> , do not highlight</p></li>
<li><p><strong>highlight_color</strong> (<em>list</em>) – The highlight color.</p></li>
<li><p><strong>gatewaykwargs</strong> (<em>dict</em>) – Gateway keywargs. See <a class="reference internal" href="gummy.gateways.html#gummy.gateways.GummyAbstGateWay.passthrough" title="gummy.gateways.GummyAbstGateWay.passthrough"><code class="xref py py-meth docutils literal notranslate"><span class="pre">passthrough</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</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.journals.html"
title="previous chapter">gummy.journals module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="gummy.translators.html"
title="next chapter">gummy.translators module</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/gummy.models.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.translators.html" title="gummy.translators module"
>next</a> |</li>
<li class="right" >
<a href="gummy.journals.html" title="gummy.journals 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-this"><a href="">gummy.models 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>