--- /dev/null
+<!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.9.2" />
+<title>szyfrow.support.text_prettify API documentation</title>
+<meta name="description" content="Various functions for prettifying text, useful when cipher routines generate
+strings of letters without spaces." />
+<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>szyfrow.support.text_prettify</code></h1>
+</header>
+<section id="section-intro">
+<p>Various functions for prettifying text, useful when cipher routines generate
+strings of letters without spaces.</p>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">"""Various functions for prettifying text, useful when cipher routines generate
+strings of letters without spaces.
+"""
+
+import string
+from szyfrow.support.segment import segment
+from szyfrow.support.utilities import cat, lcat, sanitise
+
+
+def prettify(text, width=100):
+ """Segment a text into words, then pack into lines, and combine the lines
+ into a single string for printing."""
+ return lcat(tpack(segment(text), width=width))
+
+
+def tpack(text, width=100):
+ """Pack a list of words into lines, so long as each line (including
+ intervening spaces) is no longer than _width_"""
+ lines = [text[0]]
+ for word in text[1:]:
+ if len(lines[-1]) + 1 + len(word) <= width:
+ lines[-1] += (' ' + word)
+ else:
+ lines += [word]
+ return lines
+
+
+def depunctuate_character(c):
+ """Record the punctuation of a character"""
+ if c in string.ascii_uppercase:
+ return 'UPPER'
+ elif c in string.ascii_lowercase:
+ return 'LOWER'
+ else:
+ return c
+
+
+def depunctuate(text):
+ """Record the punctuation of a string, so it can be applied to a converted
+ version of the string.
+
+ For example,
+ punct = depunctuate(ciphertext)
+ plaintext = decipher(sanitise(ciphertext))
+ readable_plaintext = repunctuate(plaintext, punct)
+ """
+ return [depunctuate_character(c) for c in text]
+
+
+def repunctuate_character(letters, punctuation):
+ """Apply the recorded punctuation to a character. The letters must be
+ an iterator of base characters."""
+ if punctuation == 'UPPER':
+ return next(letters).upper()
+ elif punctuation == 'LOWER':
+ return next(letters).lower()
+ else:
+ return punctuation
+
+
+def repunctuate(text, punctuation):
+ """Apply the recored punctuation to a sanitised string.
+
+ For example,
+ punct = depunctuate(ciphertext)
+ plaintext = decipher(sanitise(ciphertext))
+ readable_plaintext = repunctuate(plaintext, punct)
+ """
+ letters = iter(sanitise(text))
+ return cat(repunctuate_character(letters, p) for p in punctuation)</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="szyfrow.support.text_prettify.cat"><code class="name flex">
+<span>def <span class="ident">cat</span></span>(<span>iterable, /)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Concatenate any number of strings.</p>
+<p>The string whose method is called is inserted in between each given string.
+The result is returned as a new string.</p>
+<p>Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'</p></div>
+</dd>
+<dt id="szyfrow.support.text_prettify.depunctuate"><code class="name flex">
+<span>def <span class="ident">depunctuate</span></span>(<span>text)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Record the punctuation of a string, so it can be applied to a converted
+version of the string.</p>
+<p>For example,
+punct = depunctuate(ciphertext)
+plaintext = decipher(sanitise(ciphertext))
+readable_plaintext = repunctuate(plaintext, punct)</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def depunctuate(text):
+ """Record the punctuation of a string, so it can be applied to a converted
+ version of the string.
+
+ For example,
+ punct = depunctuate(ciphertext)
+ plaintext = decipher(sanitise(ciphertext))
+ readable_plaintext = repunctuate(plaintext, punct)
+ """
+ return [depunctuate_character(c) for c in text]</code></pre>
+</details>
+</dd>
+<dt id="szyfrow.support.text_prettify.depunctuate_character"><code class="name flex">
+<span>def <span class="ident">depunctuate_character</span></span>(<span>c)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Record the punctuation of a character</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def depunctuate_character(c):
+ """Record the punctuation of a character"""
+ if c in string.ascii_uppercase:
+ return 'UPPER'
+ elif c in string.ascii_lowercase:
+ return 'LOWER'
+ else:
+ return c</code></pre>
+</details>
+</dd>
+<dt id="szyfrow.support.text_prettify.lcat"><code class="name flex">
+<span>def <span class="ident">lcat</span></span>(<span>iterable, /)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Concatenate any number of strings.</p>
+<p>The string whose method is called is inserted in between each given string.
+The result is returned as a new string.</p>
+<p>Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'</p></div>
+</dd>
+<dt id="szyfrow.support.text_prettify.prettify"><code class="name flex">
+<span>def <span class="ident">prettify</span></span>(<span>text, width=100)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Segment a text into words, then pack into lines, and combine the lines
+into a single string for printing.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def prettify(text, width=100):
+ """Segment a text into words, then pack into lines, and combine the lines
+ into a single string for printing."""
+ return lcat(tpack(segment(text), width=width))</code></pre>
+</details>
+</dd>
+<dt id="szyfrow.support.text_prettify.repunctuate"><code class="name flex">
+<span>def <span class="ident">repunctuate</span></span>(<span>text, punctuation)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Apply the recored punctuation to a sanitised string.</p>
+<p>For example,
+punct = depunctuate(ciphertext)
+plaintext = decipher(sanitise(ciphertext))
+readable_plaintext = repunctuate(plaintext, punct)</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def repunctuate(text, punctuation):
+ """Apply the recored punctuation to a sanitised string.
+
+ For example,
+ punct = depunctuate(ciphertext)
+ plaintext = decipher(sanitise(ciphertext))
+ readable_plaintext = repunctuate(plaintext, punct)
+ """
+ letters = iter(sanitise(text))
+ return cat(repunctuate_character(letters, p) for p in punctuation)</code></pre>
+</details>
+</dd>
+<dt id="szyfrow.support.text_prettify.repunctuate_character"><code class="name flex">
+<span>def <span class="ident">repunctuate_character</span></span>(<span>letters, punctuation)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Apply the recorded punctuation to a character. The letters must be
+an iterator of base characters.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def repunctuate_character(letters, punctuation):
+ """Apply the recorded punctuation to a character. The letters must be
+ an iterator of base characters."""
+ if punctuation == 'UPPER':
+ return next(letters).upper()
+ elif punctuation == 'LOWER':
+ return next(letters).lower()
+ else:
+ return punctuation</code></pre>
+</details>
+</dd>
+<dt id="szyfrow.support.text_prettify.tpack"><code class="name flex">
+<span>def <span class="ident">tpack</span></span>(<span>text, width=100)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Pack a list of words into lines, so long as each line (including
+intervening spaces) is no longer than <em>width</em></p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def tpack(text, width=100):
+ """Pack a list of words into lines, so long as each line (including
+ intervening spaces) is no longer than _width_"""
+ lines = [text[0]]
+ for word in text[1:]:
+ if len(lines[-1]) + 1 + len(word) <= width:
+ lines[-1] += (' ' + word)
+ else:
+ lines += [word]
+ return lines</code></pre>
+</details>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="szyfrow.support" href="index.html">szyfrow.support</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="szyfrow.support.text_prettify.cat" href="#szyfrow.support.text_prettify.cat">cat</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.depunctuate" href="#szyfrow.support.text_prettify.depunctuate">depunctuate</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.depunctuate_character" href="#szyfrow.support.text_prettify.depunctuate_character">depunctuate_character</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.lcat" href="#szyfrow.support.text_prettify.lcat">lcat</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.prettify" href="#szyfrow.support.text_prettify.prettify">prettify</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.repunctuate" href="#szyfrow.support.text_prettify.repunctuate">repunctuate</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.repunctuate_character" href="#szyfrow.support.text_prettify.repunctuate_character">repunctuate_character</a></code></li>
+<li><code><a title="szyfrow.support.text_prettify.tpack" href="#szyfrow.support.text_prettify.tpack">tpack</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
+</footer>
+</body>
+</html>
\ No newline at end of file
projects / szyfrow.git / blobdiff