-
Notifications
You must be signed in to change notification settings - Fork 0
/
Word-machine.doc.dictionary.html
730 lines (682 loc) · 35.9 KB
/
Word-machine.doc.dictionary.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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
---
layout: null
title: "Word Machine Doc"
permalink: Word-machine/doc/dictionary
---
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>dictionary API documentation</title>
<meta name="description" content="This module allows you to **manage** input and output files and to **process** the dictionary." />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>dictionary</code></h1>
</header>
<section id="section-intro">
<h2 id="this-module-allows-you-to-manage-input-and-output-files-and-to-process-the-dictionary">This module allows you to <strong>manage</strong> input and output files and to <strong>process</strong> the dictionary.</h2>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">"""
## This module allows you to **manage** input and output files and to **process** the dictionary.
"""
from statistics import quantiles
from fractions import Fraction
####################################
# Input and output file management #
####################################
def open_alphabet (filename):
"""
`open_alphabet()` gets the input alphabet from a file.
* **filename** (*str*): the name of the file to open (`read` mode)
* **return** (*list*): the input alphabet
"""
f = open(filename, "r")
alphabet = f.read().split(' ')
f.close()
while '\n' in alphabet:
alphabet.remove('\n')
alphabet.insert(0, '')
return alphabet
def open_dictionaries(filenames):
"""
`open_dictionary()` gets the input dictionary from a file.
* **filenames** (*list*): the list of names of files to open (`read` mode)
* **return** (*list*): the input dictionary
"""
for filename in filenames:
f = open(filename, "r")
dictionary = f.read().split('\n')
f.close()
to_del = []
for word in dictionary:
if word.startswith('#') or word == '' or word == ' ':
to_del.append(word)
for word in to_del:
dictionary.remove(word)
return dictionary
def get_alphabet_from_dict(dictionary):
"""
`get_alphabet_from_dict()` gets the alphabet from the dictionary by adding each used letter.
* **dictionary** (*list*): the input dictionary (before processing)
* **return** (*list*): the alphabet based on the letters used in the dictionary
"""
alphabet = []
for word in dictionary:
for letter in word:
if not letter in alphabet:
alphabet.append(letter)
alphabet = list(sorted(set(alphabet)))
alphabet.insert(0, '')
return alphabet
def write_clean_dictionary(dictionary, filename):
"""
`write_clean_dictionary()` writes the processed dictionary in a file.
* **dictionary** (*list*): the input dictionary (after processing)
* **filename** (*str*): the name of the file to open (`write` mode)
* **return** (*None*)
"""
f = open(filename, 'w')
for word in dictionary:
f.write(word+'\n')
f.close()
def write_generated_words(word_list, filename):
"""
`write_generated_words()` writes the list of generated words in a file.
* **word_list** (*str*): the string that contain all generated words
* **filename** (*str*): the name of the file to open (`write` mode)
* **return** (*None*)
"""
f = open(filename, 'w')
f.write(word_list)
f.close()
#########################
# Dictionary processing #
#########################
def process_dictionary (dictionary):
"""
`process_dictionary()` sorts the dictionary and removes duplicated words.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*list*): the sorted dictionary without duplicated words
"""
return sorted(set(dictionary))
def get_average_size(dictionary, percent):
"""
`get_average_size()` gets the minimum and maximum size values for which a percentage of words in dictionary lie between them.
* **dictionary** (*list*): the input dictionary (while processing)
* **percent** (*int*): the percentage of words within the interval
* **return** (*list*): the minimum and maximum size values
"""
# p: percentage (0<p<1)
# n: number of quantiles
# o: offset on each side
dict_len = [len(word) for word in dictionary]
p=percent/100
(a,b)=Fraction(p).limit_denominator(1000).as_integer_ratio()
(o,n)=(b-a,2*b) if (b-a)%2 == 1 else ((b-a)//2,b)
return (quantiles(dict_len, n=n)[o-1], quantiles(dict_len, n=n)[-o])
def remove_missing_letters(dictionary, missing_letters):
"""
`get_missing_letters()` removes from the dictionary every word that uses at least one letter that is not in the alphabet.
* **dictionary** (*list*): the input dictionary (while processing)
* **missing_letters** (*list*): letters used in the dictionary that are not in the alphabet
* **return** (*list*): the dictionary without any word that contain one word from **missing_letters**
"""
words_to_del = []
for letter in missing_letters:
for word in dictionary:
if letter in word:
words_to_del.append(word)
words_to_del = set(words_to_del)
for word in words_to_del:
dictionary.remove(word)
return dictionary
def get_missing_letters (dictionary, alphabet):
"""
`get_missing_letters()` gets every word from the dictionary that uses at least one letter that is not in the alphabet.
* **dictionary** (*list*): the input dictionary (while processing)
* **alphabet** (*list*): the used alphabet (from input file or from dictionary)
* **return** (*list*): the list of letters used at least once in the dictionary that are not in the alphabet
"""
missing_letter = []
for word in dictionary:
for letter in word:
if not letter in alphabet and not letter in missing_letter:
missing_letter.append(letter)
return (missing_letter)
def print_plural_words (dictionary, lang):
"""
`print_plural_words()` prints every word from the dictionary that is already in the dictionary in singular form.
* **dictionary** (*list*): the input dictionary (while processing)
* **lang** (*str*): the language used to follow plural rules (only `FR` is available yet)
* **return** (*None*)
"""
if lang == 'fr':
for word in dictionary:
l = len(word)
if word[l-1] == 's'and word[:l-1] in dictionary \
or word[l-1] == 'x'and word[:l-1] in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'al' in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'ail' in dictionary:
print(word)
# insert here plural rules from other languages
def remove_plural_words (dictionary, lang):
"""
`remove_plural_words()` removes from the dictionary every word that is already in the dictionary in singular form.
* **dictionary** (*list*): the input dictionary (while processing)
* **lang** (*str*): the language used to follow plural rules (only `FR` is available yet)
* **return** (*list*): the dictionary without duplicated words in singular / plural forms
"""
words_to_del = []
if lang == 'fr':
for word in dictionary:
l = len(word)
if word[l-1] == 's'and word[:l-1] in dictionary \
or word[l-1] == 'x'and word[:l-1] in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'al' in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'ail' in dictionary:
words_to_del.append(word)
words_to_del = set(words_to_del)
for word in words_to_del:
dictionary.remove(word)
# HERE insert plural rules from other languages
return (dictionary)
def lower_case_words(dictionary):
"""
`lower_case_words()` lower-cases every word from the dictionary.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*list*): the dictionary with each word lower-cased
"""
return ([word.lower() for word in dictionary])
def print_acronyms (dictionary):
"""
`print_acronyms()` prints every acronyms from the dictionary.
An acronyms is a word such as `word == word.upper()`.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*None*)
"""
for word in dictionary:
if word == word.upper():
print(word)
def remove_acronyms (dictionary):
"""
`remove_acronyms()` removes every acronyms from the dictionary.
An acronyms is a word such as `word == word.upper()`.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*list*): the dictionary without acronyms
"""
words_to_del = []
for word in dictionary:
if word == word.upper():
words_to_del.append(word)
words_to_del = set(words_to_del)
for word in words_to_del:
dictionary.remove(word)
return (dictionary)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="dictionary.get_alphabet_from_dict"><code class="name flex">
<span>def <span class="ident">get_alphabet_from_dict</span></span>(<span>dictionary)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.get_alphabet_from_dict" href="#dictionary.get_alphabet_from_dict">get_alphabet_from_dict()</a></code> gets the alphabet from the dictionary by adding each used letter.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (before processing)</li>
<li><strong>return</strong> (<em>list</em>): the alphabet based on the letters used in the dictionary</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_alphabet_from_dict(dictionary):
"""
`get_alphabet_from_dict()` gets the alphabet from the dictionary by adding each used letter.
* **dictionary** (*list*): the input dictionary (before processing)
* **return** (*list*): the alphabet based on the letters used in the dictionary
"""
alphabet = []
for word in dictionary:
for letter in word:
if not letter in alphabet:
alphabet.append(letter)
alphabet = list(sorted(set(alphabet)))
alphabet.insert(0, '')
return alphabet</code></pre>
</details>
</dd>
<dt id="dictionary.get_average_size"><code class="name flex">
<span>def <span class="ident">get_average_size</span></span>(<span>dictionary, percent)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.get_average_size" href="#dictionary.get_average_size">get_average_size()</a></code> gets the minimum and maximum size values for which a percentage of words in dictionary lie between them.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>percent</strong> (<em>int</em>): the percentage of words within the interval </li>
<li><strong>return</strong> (<em>list</em>): the minimum and maximum size values</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_average_size(dictionary, percent):
"""
`get_average_size()` gets the minimum and maximum size values for which a percentage of words in dictionary lie between them.
* **dictionary** (*list*): the input dictionary (while processing)
* **percent** (*int*): the percentage of words within the interval
* **return** (*list*): the minimum and maximum size values
"""
# p: percentage (0<p<1)
# n: number of quantiles
# o: offset on each side
dict_len = [len(word) for word in dictionary]
p=percent/100
(a,b)=Fraction(p).limit_denominator(1000).as_integer_ratio()
(o,n)=(b-a,2*b) if (b-a)%2 == 1 else ((b-a)//2,b)
return (quantiles(dict_len, n=n)[o-1], quantiles(dict_len, n=n)[-o])</code></pre>
</details>
</dd>
<dt id="dictionary.get_missing_letters"><code class="name flex">
<span>def <span class="ident">get_missing_letters</span></span>(<span>dictionary, alphabet)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.get_missing_letters" href="#dictionary.get_missing_letters">get_missing_letters()</a></code> gets every word from the dictionary that uses at least one letter that is not in the alphabet.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>alphabet</strong> (<em>list</em>): the used alphabet (from input file or from dictionary)</li>
<li><strong>return</strong> (<em>list</em>): the list of letters used at least once in the dictionary that are not in the alphabet</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_missing_letters (dictionary, alphabet):
"""
`get_missing_letters()` gets every word from the dictionary that uses at least one letter that is not in the alphabet.
* **dictionary** (*list*): the input dictionary (while processing)
* **alphabet** (*list*): the used alphabet (from input file or from dictionary)
* **return** (*list*): the list of letters used at least once in the dictionary that are not in the alphabet
"""
missing_letter = []
for word in dictionary:
for letter in word:
if not letter in alphabet and not letter in missing_letter:
missing_letter.append(letter)
return (missing_letter)</code></pre>
</details>
</dd>
<dt id="dictionary.lower_case_words"><code class="name flex">
<span>def <span class="ident">lower_case_words</span></span>(<span>dictionary)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.lower_case_words" href="#dictionary.lower_case_words">lower_case_words()</a></code> lower-cases every word from the dictionary.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>return</strong> (<em>list</em>): the dictionary with each word lower-cased</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def lower_case_words(dictionary):
"""
`lower_case_words()` lower-cases every word from the dictionary.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*list*): the dictionary with each word lower-cased
"""
return ([word.lower() for word in dictionary])</code></pre>
</details>
</dd>
<dt id="dictionary.open_alphabet"><code class="name flex">
<span>def <span class="ident">open_alphabet</span></span>(<span>filename)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.open_alphabet" href="#dictionary.open_alphabet">open_alphabet()</a></code> gets the input alphabet from a file.</p>
<ul>
<li><strong>filename</strong> (<em>str</em>): the name of the file to open (<code>read</code> mode)</li>
<li><strong>return</strong> (<em>list</em>): the input alphabet</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def open_alphabet (filename):
"""
`open_alphabet()` gets the input alphabet from a file.
* **filename** (*str*): the name of the file to open (`read` mode)
* **return** (*list*): the input alphabet
"""
f = open(filename, "r")
alphabet = f.read().split(' ')
f.close()
while '\n' in alphabet:
alphabet.remove('\n')
alphabet.insert(0, '')
return alphabet</code></pre>
</details>
</dd>
<dt id="dictionary.open_dictionaries"><code class="name flex">
<span>def <span class="ident">open_dictionaries</span></span>(<span>filenames)</span>
</code></dt>
<dd>
<div class="desc"><p><code>open_dictionary()</code> gets the input dictionary from a file.</p>
<ul>
<li><strong>filenames</strong> (<em>list</em>): the list of names of files to open (<code>read</code> mode)</li>
<li><strong>return</strong> (<em>list</em>): the input dictionary</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def open_dictionaries(filenames):
"""
`open_dictionary()` gets the input dictionary from a file.
* **filenames** (*list*): the list of names of files to open (`read` mode)
* **return** (*list*): the input dictionary
"""
for filename in filenames:
f = open(filename, "r")
dictionary = f.read().split('\n')
f.close()
to_del = []
for word in dictionary:
if word.startswith('#') or word == '' or word == ' ':
to_del.append(word)
for word in to_del:
dictionary.remove(word)
return dictionary</code></pre>
</details>
</dd>
<dt id="dictionary.print_acronyms"><code class="name flex">
<span>def <span class="ident">print_acronyms</span></span>(<span>dictionary)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.print_acronyms" href="#dictionary.print_acronyms">print_acronyms()</a></code> prints every acronyms from the dictionary.
An acronyms is a word such as <code>word == word.upper()</code>.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>return</strong> (<em>None</em>)</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def print_acronyms (dictionary):
"""
`print_acronyms()` prints every acronyms from the dictionary.
An acronyms is a word such as `word == word.upper()`.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*None*)
"""
for word in dictionary:
if word == word.upper():
print(word)</code></pre>
</details>
</dd>
<dt id="dictionary.print_plural_words"><code class="name flex">
<span>def <span class="ident">print_plural_words</span></span>(<span>dictionary, lang)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.print_plural_words" href="#dictionary.print_plural_words">print_plural_words()</a></code> prints every word from the dictionary that is already in the dictionary in singular form.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>lang</strong> (<em>str</em>): the language used to follow plural rules (only <code>FR</code> is available yet)</li>
<li><strong>return</strong> (<em>None</em>)</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def print_plural_words (dictionary, lang):
"""
`print_plural_words()` prints every word from the dictionary that is already in the dictionary in singular form.
* **dictionary** (*list*): the input dictionary (while processing)
* **lang** (*str*): the language used to follow plural rules (only `FR` is available yet)
* **return** (*None*)
"""
if lang == 'fr':
for word in dictionary:
l = len(word)
if word[l-1] == 's'and word[:l-1] in dictionary \
or word[l-1] == 'x'and word[:l-1] in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'al' in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'ail' in dictionary:
print(word)
# insert here plural rules from other languages</code></pre>
</details>
</dd>
<dt id="dictionary.process_dictionary"><code class="name flex">
<span>def <span class="ident">process_dictionary</span></span>(<span>dictionary)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.process_dictionary" href="#dictionary.process_dictionary">process_dictionary()</a></code> sorts the dictionary and removes duplicated words.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>return</strong> (<em>list</em>): the sorted dictionary without duplicated words</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def process_dictionary (dictionary):
"""
`process_dictionary()` sorts the dictionary and removes duplicated words.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*list*): the sorted dictionary without duplicated words
"""
return sorted(set(dictionary))</code></pre>
</details>
</dd>
<dt id="dictionary.remove_acronyms"><code class="name flex">
<span>def <span class="ident">remove_acronyms</span></span>(<span>dictionary)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.remove_acronyms" href="#dictionary.remove_acronyms">remove_acronyms()</a></code> removes every acronyms from the dictionary.
An acronyms is a word such as <code>word == word.upper()</code>.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>return</strong> (<em>list</em>): the dictionary without acronyms</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def remove_acronyms (dictionary):
"""
`remove_acronyms()` removes every acronyms from the dictionary.
An acronyms is a word such as `word == word.upper()`.
* **dictionary** (*list*): the input dictionary (while processing)
* **return** (*list*): the dictionary without acronyms
"""
words_to_del = []
for word in dictionary:
if word == word.upper():
words_to_del.append(word)
words_to_del = set(words_to_del)
for word in words_to_del:
dictionary.remove(word)
return (dictionary)</code></pre>
</details>
</dd>
<dt id="dictionary.remove_missing_letters"><code class="name flex">
<span>def <span class="ident">remove_missing_letters</span></span>(<span>dictionary, missing_letters)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.get_missing_letters" href="#dictionary.get_missing_letters">get_missing_letters()</a></code> removes from the dictionary every word that uses at least one letter that is not in the alphabet.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>missing_letters</strong> (<em>list</em>): letters used in the dictionary that are not in the alphabet</li>
<li><strong>return</strong> (<em>list</em>): the dictionary without any word that contain one word from <strong>missing_letters</strong></li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def remove_missing_letters(dictionary, missing_letters):
"""
`get_missing_letters()` removes from the dictionary every word that uses at least one letter that is not in the alphabet.
* **dictionary** (*list*): the input dictionary (while processing)
* **missing_letters** (*list*): letters used in the dictionary that are not in the alphabet
* **return** (*list*): the dictionary without any word that contain one word from **missing_letters**
"""
words_to_del = []
for letter in missing_letters:
for word in dictionary:
if letter in word:
words_to_del.append(word)
words_to_del = set(words_to_del)
for word in words_to_del:
dictionary.remove(word)
return dictionary</code></pre>
</details>
</dd>
<dt id="dictionary.remove_plural_words"><code class="name flex">
<span>def <span class="ident">remove_plural_words</span></span>(<span>dictionary, lang)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.remove_plural_words" href="#dictionary.remove_plural_words">remove_plural_words()</a></code> removes from the dictionary every word that is already in the dictionary in singular form.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (while processing)</li>
<li><strong>lang</strong> (<em>str</em>): the language used to follow plural rules (only <code>FR</code> is available yet)</li>
<li><strong>return</strong> (<em>list</em>): the dictionary without duplicated words in singular / plural forms</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def remove_plural_words (dictionary, lang):
"""
`remove_plural_words()` removes from the dictionary every word that is already in the dictionary in singular form.
* **dictionary** (*list*): the input dictionary (while processing)
* **lang** (*str*): the language used to follow plural rules (only `FR` is available yet)
* **return** (*list*): the dictionary without duplicated words in singular / plural forms
"""
words_to_del = []
if lang == 'fr':
for word in dictionary:
l = len(word)
if word[l-1] == 's'and word[:l-1] in dictionary \
or word[l-1] == 'x'and word[:l-1] in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'al' in dictionary \
or l > 3 and word[l-3:l] == 'aux'and word[:l-3]+'ail' in dictionary:
words_to_del.append(word)
words_to_del = set(words_to_del)
for word in words_to_del:
dictionary.remove(word)
# HERE insert plural rules from other languages
return (dictionary)</code></pre>
</details>
</dd>
<dt id="dictionary.write_clean_dictionary"><code class="name flex">
<span>def <span class="ident">write_clean_dictionary</span></span>(<span>dictionary, filename)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.write_clean_dictionary" href="#dictionary.write_clean_dictionary">write_clean_dictionary()</a></code> writes the processed dictionary in a file.</p>
<ul>
<li><strong>dictionary</strong> (<em>list</em>): the input dictionary (after processing)</li>
<li><strong>filename</strong> (<em>str</em>): the name of the file to open (<code>write</code> mode)</li>
<li><strong>return</strong> (<em>None</em>)</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def write_clean_dictionary(dictionary, filename):
"""
`write_clean_dictionary()` writes the processed dictionary in a file.
* **dictionary** (*list*): the input dictionary (after processing)
* **filename** (*str*): the name of the file to open (`write` mode)
* **return** (*None*)
"""
f = open(filename, 'w')
for word in dictionary:
f.write(word+'\n')
f.close()</code></pre>
</details>
</dd>
<dt id="dictionary.write_generated_words"><code class="name flex">
<span>def <span class="ident">write_generated_words</span></span>(<span>word_list, filename)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="dictionary.write_generated_words" href="#dictionary.write_generated_words">write_generated_words()</a></code> writes the list of generated words in a file.</p>
<ul>
<li><strong>word_list</strong> (<em>str</em>): the string that contain all generated words</li>
<li><strong>filename</strong> (<em>str</em>): the name of the file to open (<code>write</code> mode)</li>
<li><strong>return</strong> (<em>None</em>)</li>
</ul></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def write_generated_words(word_list, filename):
"""
`write_generated_words()` writes the list of generated words in a file.
* **word_list** (*str*): the string that contain all generated words
* **filename** (*str*): the name of the file to open (`write` mode)
* **return** (*None*)
"""
f = open(filename, 'w')
f.write(word_list)
f.close()</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul>
<li><a href="#this-module-allows-you-to-manage-input-and-output-files-and-to-process-the-dictionary">This module allows you to manage input and output files and to process the dictionary.</a></li>
</ul>
</div>
<ul id="index">
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="dictionary.get_alphabet_from_dict" href="#dictionary.get_alphabet_from_dict">get_alphabet_from_dict</a></code></li>
<li><code><a title="dictionary.get_average_size" href="#dictionary.get_average_size">get_average_size</a></code></li>
<li><code><a title="dictionary.get_missing_letters" href="#dictionary.get_missing_letters">get_missing_letters</a></code></li>
<li><code><a title="dictionary.lower_case_words" href="#dictionary.lower_case_words">lower_case_words</a></code></li>
<li><code><a title="dictionary.open_alphabet" href="#dictionary.open_alphabet">open_alphabet</a></code></li>
<li><code><a title="dictionary.open_dictionaries" href="#dictionary.open_dictionaries">open_dictionaries</a></code></li>
<li><code><a title="dictionary.print_acronyms" href="#dictionary.print_acronyms">print_acronyms</a></code></li>
<li><code><a title="dictionary.print_plural_words" href="#dictionary.print_plural_words">print_plural_words</a></code></li>
<li><code><a title="dictionary.process_dictionary" href="#dictionary.process_dictionary">process_dictionary</a></code></li>
<li><code><a title="dictionary.remove_acronyms" href="#dictionary.remove_acronyms">remove_acronyms</a></code></li>
<li><code><a title="dictionary.remove_missing_letters" href="#dictionary.remove_missing_letters">remove_missing_letters</a></code></li>
<li><code><a title="dictionary.remove_plural_words" href="#dictionary.remove_plural_words">remove_plural_words</a></code></li>
<li><code><a title="dictionary.write_clean_dictionary" href="#dictionary.write_clean_dictionary">write_clean_dictionary</a></code></li>
<li><code><a title="dictionary.write_generated_words" href="#dictionary.write_generated_words">write_generated_words</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>