X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=docs%2Fszyfrow%2Fcaesar.html;fp=docs%2Fszyfrow%2Fcaesar.html;h=2f40c00113d8556cee8adb5d5fbb57704b55134c;hb=b535d9d75e69cc395e8de28c99e38564655e5ac9;hp=0000000000000000000000000000000000000000;hpb=f19a021eabb3222709b9d513839a14c01cfdfd38;p=szyfrow.git diff --git a/docs/szyfrow/caesar.html b/docs/szyfrow/caesar.html new file mode 100644 index 0000000..2f40c00 --- /dev/null +++ b/docs/szyfrow/caesar.html @@ -0,0 +1,461 @@ +<!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.caesar API documentation</title> +<meta name="description" content="Enciphering and deciphering using the [Caesar cipher](https://en.wikipedia.org/wiki/Caesar_cipher). +Also attempts to break messages that use a Caesar â¦" /> +<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.caesar</code></h1> +</header> +<section id="section-intro"> +<p>Enciphering and deciphering using the <a href="https://en.wikipedia.org/wiki/Caesar_cipher">Caesar cipher</a>. +Also attempts to break messages that use a Caesar cipher.</p> +<p>The Caesar cipher operates one letter at a time. It converts each letter to a +number, then enciphers that number by adding the key. The result is taken mod +26 and converted back into a letter.</p> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">"""Enciphering and deciphering using the [Caesar cipher](https://en.wikipedia.org/wiki/Caesar_cipher). +Also attempts to break messages that use a Caesar cipher. + +The Caesar cipher operates one letter at a time. It converts each letter to a +number, then enciphers that number by adding the key. The result is taken mod +26 and converted back into a letter. + +""" + +from szyfrow.support.utilities import * +from szyfrow.support.language_models import * + +def caesar_encipher_letter(accented_letter, shift): + """Encipher a letter, given a shift amount. + + Accented version of latin letters (such as é and ö) are converted to their + non-accented versions before encryption. + + >>> caesar_encipher_letter('a', 1) + 'b' + >>> caesar_encipher_letter('a', 2) + 'c' + >>> caesar_encipher_letter('b', 2) + 'd' + >>> caesar_encipher_letter('x', 2) + 'z' + >>> caesar_encipher_letter('y', 2) + 'a' + >>> caesar_encipher_letter('z', 2) + 'b' + >>> caesar_encipher_letter('z', -1) + 'y' + >>> caesar_encipher_letter('a', -1) + 'z' + >>> caesar_encipher_letter('A', 1) + 'B' + >>> caesar_encipher_letter('é', 1) + 'f' + """ + # letter = unaccent(accented_letter) + # if letter in string.ascii_letters: + # if letter in string.ascii_uppercase: + # alphabet_start = ord('A') + # else: + # alphabet_start = ord('a') + # return chr(((ord(letter) - alphabet_start + shift) % 26) + + # alphabet_start) + # else: + # return letter + + letter = unaccent(accented_letter) + if letter in string.ascii_letters: + cipherletter = unpos(pos(letter) + shift) + if letter in string.ascii_uppercase: + return cipherletter.upper() + else: + return cipherletter + else: + return letter + +def caesar_decipher_letter(letter, shift): + """Decipher a letter, given a shift amount + + >>> caesar_decipher_letter('b', 1) + 'a' + >>> caesar_decipher_letter('b', 2) + 'z' + """ + return caesar_encipher_letter(letter, -shift) + +def caesar_encipher(message, shift): + """Encipher a message with the Caesar cipher of given shift + + >>> caesar_encipher('abc', 1) + 'bcd' + >>> caesar_encipher('abc', 2) + 'cde' + >>> caesar_encipher('abcxyz', 2) + 'cdezab' + >>> caesar_encipher('ab cx yz', 2) + 'cd ez ab' + >>> caesar_encipher('Héllo World!', 2) + 'Jgnnq Yqtnf!' + """ + enciphered = [caesar_encipher_letter(l, shift) for l in message] + return cat(enciphered) + +def caesar_decipher(message, shift): + """Decipher a message with the Caesar cipher of given shift + + >>> caesar_decipher('bcd', 1) + 'abc' + >>> caesar_decipher('cde', 2) + 'abc' + >>> caesar_decipher('cd ez ab', 2) + 'ab cx yz' + >>> caesar_decipher('Jgnnq Yqtnf!', 2) + 'Hello World!' + """ + return caesar_encipher(message, -shift) + + +def caesar_break(message, fitness=Pletters): + """Breaks a Caesar cipher using frequency analysis + + It tries all possible keys, scores the fitness of the text decipherd with + each key, and returns the key that produces the most fit deciphered text. + + >>> caesar_break('ibxcsyorsaqcheyklxivoexlevmrimwxsfiqevvmihrsasrxliwyrh' \ + 'ecjsppsamrkwleppfmergefifvmhixscsymjcsyqeoixlm') # doctest: +ELLIPSIS + (4, -130.849989015...) + >>> caesar_break('wxwmaxdgheetgwuxztgptedbgznitgwwhpguxyhkxbmhvvtlbhgtee' \ + 'raxlmhiixweblmxgxwmhmaxybkbgztgwztsxwbgmxgmert') # doctest: +ELLIPSIS + (19, -128.82410410...) + >>> caesar_break('yltbbqnqnzvguvaxurorgenafsbezqvagbnornfgsbevpnaabjurer' \ + 'svaquvzyvxrnznazlybequrvfohgriraabjtbaruraprur') # doctest: +ELLIPSIS + (13, -126.25403935...) + """ + sanitised_message = sanitise(message) + best_shift = 0 + best_fit = float('-inf') + for shift in range(26): + plaintext = caesar_decipher(sanitised_message, shift) + fit = fitness(plaintext) + + if fit > best_fit: + best_fit = fit + best_shift = shift + + return best_shift, best_fit</code></pre> +</details> +</section> +<section> +</section> +<section> +</section> +<section> +<h2 class="section-title" id="header-functions">Functions</h2> +<dl> +<dt id="szyfrow.caesar.caesar_break"><code class="name flex"> +<span>def <span class="ident">caesar_break</span></span>(<span>message, fitness=<function Pletters>)</span> +</code></dt> +<dd> +<div class="desc"><p>Breaks a Caesar cipher using frequency analysis</p> +<p>It tries all possible keys, scores the fitness of the text decipherd with +each key, and returns the key that produces the most fit deciphered text.</p> +<pre><code class="language-python-repl">>>> caesar_break('ibxcsyorsaqcheyklxivoexlevmrimwxsfiqevvmihrsasrxliwyrh' 'ecjsppsamrkwleppfmergefifvmhixscsymjcsyqeoixlm') # doctest: +ELLIPSIS +(4, -130.849989015...) +>>> caesar_break('wxwmaxdgheetgwuxztgptedbgznitgwwhpguxyhkxbmhvvtlbhgtee' 'raxlmhiixweblmxgxwmhmaxybkbgztgwztsxwbgmxgmert') # doctest: +ELLIPSIS +(19, -128.82410410...) +>>> caesar_break('yltbbqnqnzvguvaxurorgenafsbezqvagbnornfgsbevpnaabjurer' 'svaquvzyvxrnznazlybequrvfohgriraabjtbaruraprur') # doctest: +ELLIPSIS +(13, -126.25403935...) +</code></pre></div> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">def caesar_break(message, fitness=Pletters): + """Breaks a Caesar cipher using frequency analysis + + It tries all possible keys, scores the fitness of the text decipherd with + each key, and returns the key that produces the most fit deciphered text. + + >>> caesar_break('ibxcsyorsaqcheyklxivoexlevmrimwxsfiqevvmihrsasrxliwyrh' \ + 'ecjsppsamrkwleppfmergefifvmhixscsymjcsyqeoixlm') # doctest: +ELLIPSIS + (4, -130.849989015...) + >>> caesar_break('wxwmaxdgheetgwuxztgptedbgznitgwwhpguxyhkxbmhvvtlbhgtee' \ + 'raxlmhiixweblmxgxwmhmaxybkbgztgwztsxwbgmxgmert') # doctest: +ELLIPSIS + (19, -128.82410410...) + >>> caesar_break('yltbbqnqnzvguvaxurorgenafsbezqvagbnornfgsbevpnaabjurer' \ + 'svaquvzyvxrnznazlybequrvfohgriraabjtbaruraprur') # doctest: +ELLIPSIS + (13, -126.25403935...) + """ + sanitised_message = sanitise(message) + best_shift = 0 + best_fit = float('-inf') + for shift in range(26): + plaintext = caesar_decipher(sanitised_message, shift) + fit = fitness(plaintext) + + if fit > best_fit: + best_fit = fit + best_shift = shift + + return best_shift, best_fit</code></pre> +</details> +</dd> +<dt id="szyfrow.caesar.caesar_decipher"><code class="name flex"> +<span>def <span class="ident">caesar_decipher</span></span>(<span>message, shift)</span> +</code></dt> +<dd> +<div class="desc"><p>Decipher a message with the Caesar cipher of given shift</p> +<pre><code class="language-python-repl">>>> caesar_decipher('bcd', 1) +'abc' +>>> caesar_decipher('cde', 2) +'abc' +>>> caesar_decipher('cd ez ab', 2) +'ab cx yz' +>>> caesar_decipher('Jgnnq Yqtnf!', 2) +'Hello World!' +</code></pre></div> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">def caesar_decipher(message, shift): + """Decipher a message with the Caesar cipher of given shift + + >>> caesar_decipher('bcd', 1) + 'abc' + >>> caesar_decipher('cde', 2) + 'abc' + >>> caesar_decipher('cd ez ab', 2) + 'ab cx yz' + >>> caesar_decipher('Jgnnq Yqtnf!', 2) + 'Hello World!' + """ + return caesar_encipher(message, -shift)</code></pre> +</details> +</dd> +<dt id="szyfrow.caesar.caesar_decipher_letter"><code class="name flex"> +<span>def <span class="ident">caesar_decipher_letter</span></span>(<span>letter, shift)</span> +</code></dt> +<dd> +<div class="desc"><p>Decipher a letter, given a shift amount</p> +<pre><code class="language-python-repl">>>> caesar_decipher_letter('b', 1) +'a' +>>> caesar_decipher_letter('b', 2) +'z' +</code></pre></div> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">def caesar_decipher_letter(letter, shift): + """Decipher a letter, given a shift amount + + >>> caesar_decipher_letter('b', 1) + 'a' + >>> caesar_decipher_letter('b', 2) + 'z' + """ + return caesar_encipher_letter(letter, -shift)</code></pre> +</details> +</dd> +<dt id="szyfrow.caesar.caesar_encipher"><code class="name flex"> +<span>def <span class="ident">caesar_encipher</span></span>(<span>message, shift)</span> +</code></dt> +<dd> +<div class="desc"><p>Encipher a message with the Caesar cipher of given shift</p> +<pre><code class="language-python-repl">>>> caesar_encipher('abc', 1) +'bcd' +>>> caesar_encipher('abc', 2) +'cde' +>>> caesar_encipher('abcxyz', 2) +'cdezab' +>>> caesar_encipher('ab cx yz', 2) +'cd ez ab' +>>> caesar_encipher('Héllo World!', 2) +'Jgnnq Yqtnf!' +</code></pre></div> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">def caesar_encipher(message, shift): + """Encipher a message with the Caesar cipher of given shift + + >>> caesar_encipher('abc', 1) + 'bcd' + >>> caesar_encipher('abc', 2) + 'cde' + >>> caesar_encipher('abcxyz', 2) + 'cdezab' + >>> caesar_encipher('ab cx yz', 2) + 'cd ez ab' + >>> caesar_encipher('Héllo World!', 2) + 'Jgnnq Yqtnf!' + """ + enciphered = [caesar_encipher_letter(l, shift) for l in message] + return cat(enciphered)</code></pre> +</details> +</dd> +<dt id="szyfrow.caesar.caesar_encipher_letter"><code class="name flex"> +<span>def <span class="ident">caesar_encipher_letter</span></span>(<span>accented_letter, shift)</span> +</code></dt> +<dd> +<div class="desc"><p>Encipher a letter, given a shift amount.</p> +<p>Accented version of latin letters (such as é and ö) are converted to their +non-accented versions before encryption.</p> +<pre><code class="language-python-repl">>>> caesar_encipher_letter('a', 1) +'b' +>>> caesar_encipher_letter('a', 2) +'c' +>>> caesar_encipher_letter('b', 2) +'d' +>>> caesar_encipher_letter('x', 2) +'z' +>>> caesar_encipher_letter('y', 2) +'a' +>>> caesar_encipher_letter('z', 2) +'b' +>>> caesar_encipher_letter('z', -1) +'y' +>>> caesar_encipher_letter('a', -1) +'z' +>>> caesar_encipher_letter('A', 1) +'B' +>>> caesar_encipher_letter('é', 1) +'f' +</code></pre></div> +<details class="source"> +<summary> +<span>Expand source code</span> +</summary> +<pre><code class="python">def caesar_encipher_letter(accented_letter, shift): + """Encipher a letter, given a shift amount. + + Accented version of latin letters (such as é and ö) are converted to their + non-accented versions before encryption. + + >>> caesar_encipher_letter('a', 1) + 'b' + >>> caesar_encipher_letter('a', 2) + 'c' + >>> caesar_encipher_letter('b', 2) + 'd' + >>> caesar_encipher_letter('x', 2) + 'z' + >>> caesar_encipher_letter('y', 2) + 'a' + >>> caesar_encipher_letter('z', 2) + 'b' + >>> caesar_encipher_letter('z', -1) + 'y' + >>> caesar_encipher_letter('a', -1) + 'z' + >>> caesar_encipher_letter('A', 1) + 'B' + >>> caesar_encipher_letter('é', 1) + 'f' + """ + # letter = unaccent(accented_letter) + # if letter in string.ascii_letters: + # if letter in string.ascii_uppercase: + # alphabet_start = ord('A') + # else: + # alphabet_start = ord('a') + # return chr(((ord(letter) - alphabet_start + shift) % 26) + + # alphabet_start) + # else: + # return letter + + letter = unaccent(accented_letter) + if letter in string.ascii_letters: + cipherletter = unpos(pos(letter) + shift) + if letter in string.ascii_uppercase: + return cipherletter.upper() + else: + return cipherletter + else: + return letter</code></pre> +</details> +</dd> +<dt id="szyfrow.caesar.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.caesar.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.caesar.wcat"><code class="name flex"> +<span>def <span class="ident">wcat</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> +</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" href="index.html">szyfrow</a></code></li> +</ul> +</li> +<li><h3><a href="#header-functions">Functions</a></h3> +<ul class=""> +<li><code><a title="szyfrow.caesar.caesar_break" href="#szyfrow.caesar.caesar_break">caesar_break</a></code></li> +<li><code><a title="szyfrow.caesar.caesar_decipher" href="#szyfrow.caesar.caesar_decipher">caesar_decipher</a></code></li> +<li><code><a title="szyfrow.caesar.caesar_decipher_letter" href="#szyfrow.caesar.caesar_decipher_letter">caesar_decipher_letter</a></code></li> +<li><code><a title="szyfrow.caesar.caesar_encipher" href="#szyfrow.caesar.caesar_encipher">caesar_encipher</a></code></li> +<li><code><a title="szyfrow.caesar.caesar_encipher_letter" href="#szyfrow.caesar.caesar_encipher_letter">caesar_encipher_letter</a></code></li> +<li><code><a title="szyfrow.caesar.cat" href="#szyfrow.caesar.cat">cat</a></code></li> +<li><code><a title="szyfrow.caesar.lcat" href="#szyfrow.caesar.lcat">lcat</a></code></li> +<li><code><a title="szyfrow.caesar.wcat" href="#szyfrow.caesar.wcat">wcat</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