Add typehints ciphers and bool alg (TheAlgorithms#3264)

jenia90 · github-actions · poyea · stokhos · commit 08786a2745a1 · 2021-01-02T19:05:44.000-05:00
* updating DIRECTORY.md

* updating DIRECTORY.md

* Fixed accidental commit of file I have't touched

* fixup! Format Python code with psf/black push

* updating DIRECTORY.md

* updating DIRECTORY.md

* Fixed some suggested coding style issues

* Update rsa_key_generator.py

* Update rsa_key_generator.py

Co-authored-by: github-actions &lt;${GITHUB_ACTOR}@users.noreply.github.com&gt;
Co-authored-by: John Law &lt;johnlaw.po@gmail.com&gt;
diff --git a/boolean_algebra/quine_mc_cluskey.py b/boolean_algebra/quine_mc_cluskey.py
@@ -1,4 +1,4 @@
-def compare_string(string1, string2):
+def compare_string(string1: str, string2: str) -> str:
     """
     >>> compare_string('0010','0110')
     '0_10'
@@ -19,7 +19,7 @@ def compare_string(string1, string2):
         return "".join(l1)
 
 
-def check(binary):
+def check(binary: [str]) -> [str]:
     """
     >>> check(['0.00.01.5'])
     ['0.00.01.5']
@@ -43,7 +43,7 @@ def check(binary):
         binary = list(set(temp))
 
 
-def decimal_to_binary(no_of_variable, minterms):
+def decimal_to_binary(no_of_variable: int, minterms: [float]) -> [str]:
     """
     >>> decimal_to_binary(3,[1.5])
     ['0.00.01.5']
@@ -59,7 +59,7 @@ def decimal_to_binary(no_of_variable, minterms):
     return temp
 
 
-def is_for_table(string1, string2, count):
+def is_for_table(string1: str, string2: str, count: int) -> bool:
     """
     >>> is_for_table('__1','011',2)
     True
@@ -79,7 +79,7 @@ def is_for_table(string1, string2, count):
         return False
 
 
-def selection(chart, prime_implicants):
+def selection(chart: [[int]], prime_implicants: [str]) -> [str]:
     """
     >>> selection([[1]],['0.00.01.5'])
     ['0.00.01.5']
@@ -126,7 +126,7 @@ def selection(chart, prime_implicants):
                     chart[j][i] = 0
 
 
-def prime_implicant_chart(prime_implicants, binary):
+def prime_implicant_chart(prime_implicants: [str], binary: [str]) -> [[int]]:
     """
     >>> prime_implicant_chart(['0.00.01.5'],['0.00.01.5'])
     [[1]]
diff --git a/ciphers/affine_cipher.py b/ciphers/affine_cipher.py
@@ -29,7 +29,7 @@ def main():
     print(f"\n{mode.title()}ed text: \n{translated}")
 
 
-def check_keys(keyA, keyB, mode):
+def check_keys(keyA: int, keyB: int, mode: str) -> None:
     if mode == "encrypt":
         if keyA == 1:
             sys.exit(
@@ -90,7 +90,7 @@ def decrypt_message(key: int, message: str) -> str:
     return plainText
 
 
-def get_random_key():
+def get_random_key() -> int:
     while True:
         keyA = random.randint(2, len(SYMBOLS))
         keyB = random.randint(2, len(SYMBOLS))
diff --git a/ciphers/base64_cipher.py b/ciphers/base64_cipher.py
@@ -1,4 +1,4 @@
-def encode_base64(text):
+def encode_base64(text: str) -> str:
     r"""
     >>> encode_base64('WELCOME to base64 encoding 😁')
     'V0VMQ09NRSB0byBiYXNlNjQgZW5jb2Rpbmcg8J+YgQ=='
@@ -33,7 +33,7 @@ def encode_base64(text):
     return r[0 : len(r) - len(p)] + p
 
 
-def decode_base64(text):
+def decode_base64(text: str) -> str:
     r"""
     >>> decode_base64('V0VMQ09NRSB0byBiYXNlNjQgZW5jb2Rpbmcg8J+YgQ==')
     'WELCOME to base64 encoding 😁'
diff --git a/ciphers/brute_force_caesar_cipher.py b/ciphers/brute_force_caesar_cipher.py
@@ -1,4 +1,4 @@
-def decrypt(message):
+def decrypt(message: str) -> None:
     """
     >>> decrypt('TMDETUX PMDVU')
     Decryption using Key #0: TMDETUX PMDVU
diff --git a/ciphers/cryptomath_module.py b/ciphers/cryptomath_module.py
@@ -1,10 +1,10 @@
-def gcd(a, b):
+def gcd(a: int, b: int) -> int:
     while a != 0:
         a, b = b % a, a
     return b
 
 
-def findModInverse(a, m):
+def findModInverse(a: int, m: int) -> int:
     if gcd(a, m) != 1:
         return None
     u1, u2, u3 = 1, 0, a
diff --git a/ciphers/decrypt_caesar_with_chi_squared.py b/ciphers/decrypt_caesar_with_chi_squared.py
@@ -1,12 +1,14 @@
 #!/usr/bin/env python3
 
+from typing import Tuple
+
 
 def decrypt_caesar_with_chi_squared(
     ciphertext: str,
-    cipher_alphabet=None,
-    frequencies_dict=None,
+    cipher_alphabet: str = None,
+    frequencies_dict: str = None,
     case_sensetive: bool = False,
-) -> tuple:
+) -> Tuple[int, float, str]:
     """
     Basic Usage
     ===========
diff --git a/ciphers/deterministic_miller_rabin.py b/ciphers/deterministic_miller_rabin.py
@@ -3,7 +3,7 @@
 """
 
 
-def miller_rabin(n, allow_probable=False):
+def miller_rabin(n: int, allow_probable: bool = False) -> bool:
     """Deterministic Miller-Rabin algorithm for primes ~< 3.32e24.
 
     Uses numerical analysis results to return whether or not the passed number
@@ -87,7 +87,7 @@ def miller_rabin(n, allow_probable=False):
     return True
 
 
-def test_miller_rabin():
+def test_miller_rabin() -> None:
     """Testing a nontrivial (ends in 1, 3, 7, 9) composite
     and a prime in each range.
     """
diff --git a/ciphers/diffie.py b/ciphers/diffie.py
@@ -1,4 +1,4 @@
-def find_primitive(n):
+def find_primitive(n: int) -> int:
     for r in range(1, n):
         li = []
         for x in range(n - 1):
diff --git a/ciphers/elgamal_key_generator.py b/ciphers/elgamal_key_generator.py
@@ -19,7 +19,7 @@ def main():
 # so I used 4.80 Algorithm in
 # Handbook of Applied Cryptography(CRC Press, ISBN : 0-8493-8523-7, October 1996)
 # and it seems to run nicely!
-def primitiveRoot(p_val):
+def primitiveRoot(p_val: int) -> int:
     print("Generating primitive root of p")
     while True:
         g = random.randrange(3, p_val)
@@ -30,7 +30,7 @@ def primitiveRoot(p_val):
         return g
 
 
-def generateKey(keySize):
+def generateKey(keySize: int) -> ((int, int, int, int), (int, int)):
     print("Generating prime p...")
     p = rabinMiller.generateLargePrime(keySize)  # select large prime number.
     e_1 = primitiveRoot(p)  # one primitive root on modulo p.
@@ -43,7 +43,7 @@ def generateKey(keySize):
     return publicKey, privateKey
 
 
-def makeKeyFiles(name, keySize):
+def makeKeyFiles(name: str, keySize: int):
     if os.path.exists("%s_pubkey.txt" % name) or os.path.exists(
         "%s_privkey.txt" % name
     ):
diff --git a/ciphers/hill_cipher.py b/ciphers/hill_cipher.py
@@ -64,7 +64,7 @@ class HillCipher:
 
     to_int = numpy.vectorize(lambda x: round(x))
 
-    def __init__(self, encrypt_key):
+    def __init__(self, encrypt_key: int):
         """
         encrypt_key is an NxN numpy array
         """
diff --git a/ciphers/mixed_keyword_cypher.py b/ciphers/mixed_keyword_cypher.py
@@ -1,4 +1,4 @@
-def mixed_keyword(key="college", pt="UNIVERSITY"):
+def mixed_keyword(key: str = "college", pt: str = "UNIVERSITY") -> str:
     """
 
     For key:hello
diff --git a/ciphers/morse_code_implementation.py b/ciphers/morse_code_implementation.py
@@ -57,7 +57,7 @@
 }
 
 
-def encrypt(message):
+def encrypt(message: str) -> str:
     cipher = ""
     for letter in message:
         if letter != " ":
@@ -69,7 +69,7 @@ def encrypt(message):
     return cipher[:-1]
 
 
-def decrypt(message):
+def decrypt(message: str) -> str:
     decipher = ""
     letters = message.split(" ")
     for letter in letters:
diff --git a/ciphers/onepad_cipher.py b/ciphers/onepad_cipher.py
@@ -2,7 +2,7 @@
 
 
 class Onepad:
-    def encrypt(self, text):
+    def encrypt(self, text: str) -> ([str], [int]):
         """Function to encrypt text using pseudo-random numbers"""
         plain = [ord(i) for i in text]
         key = []
@@ -14,7 +14,7 @@ def encrypt(self, text):
             key.append(k)
         return cipher, key
 
-    def decrypt(self, cipher, key):
+    def decrypt(self, cipher: [str], key: [int]) -> str:
         """Function to decrypt text using pseudo-random numbers."""
         plain = []
         for i in range(len(key)):
diff --git a/ciphers/playfair_cipher.py b/ciphers/playfair_cipher.py
@@ -11,7 +11,7 @@ def chunker(seq, size):
         yield chunk
 
 
-def prepare_input(dirty):
+def prepare_input(dirty: str) -> str:
     """
     Prepare the plaintext by up-casing it
     and separating repeated letters with X's
@@ -37,7 +37,7 @@ def prepare_input(dirty):
     return clean
 
 
-def generate_table(key):
+def generate_table(key: str) -> [str]:
 
     # I and J are used interchangeably to allow
     # us to use a 5x5 table (25 letters)
@@ -59,7 +59,7 @@ def generate_table(key):
     return table
 
 
-def encode(plaintext, key):
+def encode(plaintext: str, key: str) -> str:
     table = generate_table(key)
     plaintext = prepare_input(plaintext)
     ciphertext = ""
@@ -82,7 +82,7 @@ def encode(plaintext, key):
     return ciphertext
 
 
-def decode(ciphertext, key):
+def decode(ciphertext: str, key: str) -> str:
     table = generate_table(key)
     plaintext = ""
 
diff --git a/ciphers/porta_cipher.py b/ciphers/porta_cipher.py
@@ -28,7 +28,7 @@
 }
 
 
-def generate_table(key):
+def generate_table(key: str) -> [(str, str)]:
     """
     >>> generate_table('marvin')  # doctest: +NORMALIZE_WHITESPACE
     [('ABCDEFGHIJKLM', 'UVWXYZNOPQRST'), ('ABCDEFGHIJKLM', 'NOPQRSTUVWXYZ'),
@@ -38,7 +38,7 @@ def generate_table(key):
     return [alphabet[char] for char in key.upper()]
 
 
-def encrypt(key, words):
+def encrypt(key: str, words: str) -> str:
     """
     >>> encrypt('marvin', 'jessica')
     'QRACRWU'
@@ -52,15 +52,15 @@ def encrypt(key, words):
     return cipher
 
 
-def decrypt(key, words):
+def decrypt(key: str, words: str) -> str:
     """
     >>> decrypt('marvin', 'QRACRWU')
     'JESSICA'
     """
     return encrypt(key, words)
 
 
-def get_position(table, char):
+def get_position(table: [(str, str)], char: str) -> (int, int) or (None, None):
     """
     >>> table = [
     ...     ('ABCDEFGHIJKLM', 'UVWXYZNOPQRST'), ('ABCDEFGHIJKLM', 'NOPQRSTUVWXYZ'),
@@ -76,7 +76,7 @@ def get_position(table, char):
     return (None, None) if row == -1 else (row, table[row].index(char))
 
 
-def get_opponent(table, char):
+def get_opponent(table: [(str, str)], char: str) -> str:
     """
     >>> table = [
     ...     ('ABCDEFGHIJKLM', 'UVWXYZNOPQRST'), ('ABCDEFGHIJKLM', 'NOPQRSTUVWXYZ'),
diff --git a/ciphers/rabin_miller.py b/ciphers/rabin_miller.py
@@ -3,7 +3,7 @@
 import random
 
 
-def rabinMiller(num):
+def rabinMiller(num: int) -> bool:
     s = num - 1
     t = 0
 
@@ -25,7 +25,7 @@ def rabinMiller(num):
     return True
 
 
-def isPrime(num):
+def isPrime(num: int) -> bool:
     if num < 2:
         return False
 
@@ -210,7 +210,7 @@ def isPrime(num):
     return rabinMiller(num)
 
 
-def generateLargePrime(keysize=1024):
+def generateLargePrime(keysize: int = 1024) -> int:
     while True:
         num = random.randrange(2 ** (keysize - 1), 2 ** (keysize))
         if isPrime(num):
diff --git a/ciphers/rot13.py b/ciphers/rot13.py
@@ -1,4 +1,4 @@
-def dencrypt(s: str, n: int = 13):
+def dencrypt(s: str, n: int = 13) -> str:
     """
     https://en.wikipedia.org/wiki/ROT13
 
diff --git a/ciphers/rsa_cipher.py b/ciphers/rsa_cipher.py
diff --git a/ciphers/rsa_factorization.py b/ciphers/rsa_factorization.py
diff --git a/ciphers/rsa_key_generator.py b/ciphers/rsa_key_generator.py
diff --git a/ciphers/simple_substitution_cipher.py b/ciphers/simple_substitution_cipher.py
diff --git a/ciphers/trafid_cipher.py b/ciphers/trafid_cipher.py
diff --git a/ciphers/transposition_cipher.py b/ciphers/transposition_cipher.py
diff --git a/ciphers/vigenere_cipher.py b/ciphers/vigenere_cipher.py
diff --git a/ciphers/xor_cipher.py b/ciphers/xor_cipher.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-def decrypt(message):`
	`1`	`+def decrypt(message: str) -> None:`
`2`	`2`	`"""`
`3`	`3`	`>>> decrypt('TMDETUX PMDVU')`
`4`	`4`	`Decryption using Key #0: TMDETUX PMDVU`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-def find_primitive(n):`
	`1`	`+def find_primitive(n: int) -> int:`
`2`	`2`	`for r in range(1, n):`
`3`	`3`	`li = []`
`4`	`4`	`for x in range(n - 1):`