kosmeticke zalezitosti, TODO

[krypto.git] / jakobsen.py

diff --git a/jakobsen.py b/jakobsen.py
index 40a1d1c..7e858f0 100644 (file)
--- a/jakobsen.py
+++ b/jakobsen.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+"""Modul pro praci s Jakobsenovym algoritmem."""
 
 from itertools import combinations
 import pickle
@@ -7,6 +7,7 @@ from ocesavac import ocesat
 MABECEDA = ' ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
 def nova_tabulka(zprava, abc=MABECEDA):
+    """Vraci tabulku cetnosti bigramu ve zprave nad danou abecedou."""
     tabulka = dict()
     for i in abc:
         tabulka[i] = dict()
@@ -21,6 +22,8 @@ def nova_tabulka(zprava, abc=MABECEDA):
     return tabulka
 
 def vzdalenost(tab1, tab2, abc=MABECEDA):
+    """Vraci soucet strednich kvadratickych odchylek pro dve tabulky cetnosti
+    bigramu nad danou abecedou."""
     rozdil = 0
     for i in abc:
         for j in abc:
@@ -28,15 +31,18 @@ def vzdalenost(tab1, tab2, abc=MABECEDA):
     return rozdil
 
 def substituce(zprava, slovnik, abc=MABECEDA):
+    """Vrati zpravu, ve ktere jsou znaky dane abecedy nahrazenypodle daneho
+    slovniku."""
     pole = []
-    for c in zprava:
-        if c in abc:
-            pole.append(slovnik[c])
+    for char in zprava:
+        if char in abc:
+            pole.append(slovnik[char])
         else:
-            pole.append(c)
+            pole.append(char)
     return pole
 
 def poradi_dle_frekvence(zprava, abc=MABECEDA):
+    """Vrati znaky dane abecedy v poradi podle frekvence v dane zprave."""
     freq = dict()
     for char in abc:
         freq[char] = 0
@@ -49,8 +55,13 @@ class reference:
     pass
 
 def jakobsen(zprava, ref):
+    """Pro danou sifrovanou zpravu vrati substitucni slovnik odvozeny s pomoci
+    Jakobsenova algoritmu s danou referencni tabulkou."""
     slovnik = dict(zip(poradi_dle_frekvence(zprava, ref.abeceda), ref.poradi))
-    tabulka = nova_tabulka(substituce(zprava, slovnik, ref.abeceda), ref.abeceda)
+    tabulka = nova_tabulka(
+                  substituce(zprava, slovnik, ref.abeceda),
+                  ref.abeceda
+                  )
     vzdal = vzdalenost(tabulka, ref.tabulka, ref.abeceda)
 
     vzdal_old = vzdal + 1
@@ -58,22 +69,27 @@ def jakobsen(zprava, ref):
         vzdal_old = vzdal
         for (x, y) in combinations(ref.abeceda, 2):
             slovnik[x], slovnik[y] = slovnik[y], slovnik[x]
-            v1 = vzdalenost(nova_tabulka(substituce(zprava, slovnik, ref.abeceda), ref.abeceda),
-                            ref.tabulka, ref.abeceda)
-            if  v1 < vzdal:
-                vzdal = v1
+            nova_vzdalenost = vzdalenost(
+                     nova_tabulka(
+                         substituce(zprava, slovnik, ref.abeceda),
+                         ref.abeceda),
+                     ref.tabulka,
+                     ref.abeceda)
+            if  nova_vzdalenost < vzdal:
+                vzdal = nova_vzdalenost
             else:
                 slovnik[x], slovnik[y] = slovnik[y], slovnik[x]
     return slovnik
     
 
 def desifruj(zprava, mezery=True):
+    """Vrati vysledek pokusu dekodovat zpravu Jakobsenovym algoritmem."""
     if mezery:
-        f = open('ref')
+        soubor = open('ref')
     else:
-        f = open('bref')
-    ref = pickle.load(f)
-    f.close()
+        soubor = open('bref')
+    ref = pickle.load(soubor)
+    soubor.close()
     slovnik = jakobsen(ocesat(zprava, mezery), ref)
     return '\n'.join([''.join(substituce(zprava, slovnik, ref.abeceda)),
                       ' '.join(ref.abeceda),