Python 3 Vigenere Cipher
Я все еще новичок в Python и пытаюсь понять, эффективно ли я использовал модули, функции и т. Д., Или есть другой / более простой способ что-то сделать.
Этот Python 3 Vigenere Cipher представляет собой перестроение шифра на основе JavaScript и основано на Windows. Он принимает любой алфавитный символ и имеет встроенные демонстрационные опции. В демонстрации шифра используется первый этап шифра CIA Kryptos .
#! python
import os
import re
## Initialize global variables
continue_cipher = ""
demo_alphabet = "KRYPTOSABCDEFGHIJLMNQUVWXZ"
demo_key = "PALIMPSEST"
demo_cipher_string = "EMUFPHZLRFAXYUSDJKZLDKRNSHGNFIVJYQTQUXQBQVYUVLLTREVJYQTMKYRDMFD"
demo_cipher_decoded = "BETWEENSUBTLESHADINGANDTHEABSENCEOFLIGHTLIESTHENUANCEOFIQLUSION"
## Visuals
def display_header():
print("################################################")
print("# #")
print("# --- VIGENERE CIPHER --- #")
print("# #")
print("# A simple Vigenere cipher decoder/encoder #")
print("# #")
print("################################################", end="\n\n")
return
def display_results(mode, cipher_vars):
# Clear screen for final results
os.system('cls')
# Display header
display_header()
# Decompose cipher_vars
(alphabet, key, cipher_string, results) = cipher_vars
print("Mode:", "Decrypt" if mode == "D" else "Encrypt", end="\n\n")
print("Alphabet:", alphabet)
print("Key:", key)
print("Cipher String:", cipher_string, end="\n\n")
print("Decoded string:" if mode == "D" else "Encoded string:", results, end="\n\n")
return
## Validations
def string_is_alpha(input_string):
return True if re.match("^[a-zA-Z_]*$", input_string) else False
## Cipher variables
def get_alphabet():
global demo_alphabet
while True:
alphabet = input("Enter cipher alphabet: ").upper()
if alphabet == "":
alphabet = demo_alphabet
break
elif string_is_alpha(alphabet) is False:
print("The alphabet is not valid. Alphabet should not contain spaces, digits or special characters.")
else:
break
return alphabet
def get_key():
global demo_key
while True:
key = input("Enter cipher key: ").upper()
if key == "":
key = demo_key
break
elif string_is_alpha(key) is False:
print("The key is not valid. Key should not contain spaces, digits or special characters.")
else:
break
return key
def get_cipher_string(mode):
global demo_cipher_string
global demo_cipher_decoded
while True:
cipher_string = input("Enter cipher string: ").upper()
if cipher_string == "":
cipher_string = demo_cipher_string if mode == "D" else demo_cipher_decoded
break
elif string_is_alpha(cipher_string) is False:
print("The cipher string is not valid. Cipher strings should not contain spaces, digits or special characters.")
else:
break
return cipher_string
## Cipher actions
def get_cipher_alphabets(alphabet, key):
cipher_alphabets = []
for char in key:
char_index = alphabet.find(char)
cipher_alphabet = alphabet[char_index:] + alphabet[:char_index]
cipher_alphabets.append(cipher_alphabet)
return cipher_alphabets
def start_cipher(mode, alphabet, key, cipher_string):
mode_string = ""
cipher_alphabets = get_cipher_alphabets(alphabet, key)
cipher_alphabet_index = 0
for char in cipher_string:
# Reset cipher_alphabet_index to 0 when at end of cipher alphabets
if cipher_alphabet_index == len(cipher_alphabets):
cipher_alphabet_index = 0
# Use appropriate alphabet based on mode
# Syntax: base_alphabet[mode_alphabet.find(char)]
if mode == "D":
mode_string += alphabet[cipher_alphabets[cipher_alphabet_index].find(char)]
else:
mode_string += cipher_alphabets[cipher_alphabet_index][alphabet.find(char)]
cipher_alphabet_index += 1
return mode_string
## Cipher Mode
def get_cipher_mode():
while True:
cipher_mode = input("Choose cipher mode - [D]ecrypt or [E]ncrypt: ").upper()
if cipher_mode != "D" and cipher_mode != "E":
print("That is not a valid option. Please enter 'D' for decrypt and 'E' for encrypt.")
else:
break
print("")
return cipher_mode
def start_cipher_mode(mode):
print("Press 'enter' to use demo options")
alphabet = get_alphabet()
key = get_key()
cipher_string = get_cipher_string(mode)
mode_string = start_cipher(mode, alphabet, key, cipher_string)
return alphabet, key, cipher_string, mode_string
## Loop cipher
def get_continue_cipher():
while True:
continue_cipher = input("Do you want to decode/encode more? [Y/N]: ").upper()
if continue_cipher != "Y" and continue_cipher != "N":
print("That is not a valid option. Please enter 'Y' to continue and 'N' to quit.")
else:
break
return continue_cipher
## Start vigenere cipher program
while continue_cipher != "N":
# Clear the screen after each operation
os.system('cls')
# Display header
display_header()
# Determine cipher mode
cipher_mode = get_cipher_mode()
cipher_vars = start_cipher_mode(cipher_mode)
# Display results
display_results(cipher_mode, cipher_vars)
continue_cipher = get_continue_cipher()
Ответы
Shebang
Шебанг должен быть общим. В настоящее время вы звоните python, что может указывать на python 2 в некоторых системах.
Общий, дружественный к виртуальной среде python shebang:
#!/usr/bin/env python3
PEP-8
Несколько моментов из руководства PEP-8 :
- Окружите определения функций и классов верхнего уровня двумя пустыми строками.
- Осторожно используйте пустые строки в функциях для обозначения логических разделов.
- Константы обычно определяются на уровне модуля и пишутся заглавными буквами с подчеркиванием, разделяющим слова.
PEP-484
Функции подсказки типа упрощают выполнение ваших функций. Обратите внимание на PEP-484 .
if __name__ блокировать
Поместите логику выполнения вашего скрипта внутрь if __name__ == "__main__"блока. Более подробное объяснение можно найти на сайте Stack Overflow .
Избыточная логика
В вашем коде у вас есть 5 различных функций, только для чтения пользовательского ввода. Все они выполняют одну и ту же работу:
- бесконечная петля
- запросить ввод пользователя
- преобразовать в верхний регистр
- проверить, пуст ли ввод (или в наборе допустимых значений)
- в случае пустого значения вернуть значение по умолчанию
- вернуться со значением
Все это можно сделать одной функцией:
def ask_user_input(message: str, options: List[str] = None, default: str = None, check_alpha: bool = False) -> str:
if not any([options, default]):
raise ValueError("Either a set of `options` for validation or a fallback `default` needed.")
while True:
value = input(message).upper()
if options:
if value in options:
break
else:
print(f"Invalid value. Select one of {', '.join(options)}")
continue
if default is not None:
if not value:
value = default
break
elif not check_alpha:
break
elif not (value.isalpha() and value.isascii()):
print("The input text should only consist of ascii alphabets.")
continue
else:
break
return value
Регулярное выражение / проверка
Регулярное выражение для проверки ввода допускает _, тогда как в сообщении об ошибке явно не указано никаких специальных символов. Проверка в приведенной выше перезаписи выполняется с использованием (обновлено на основе комментария ниже):
value.isalpha() and value.isascii()
который будет работать быстрее, чем регулярное выражение (если пользователь не будет вводить неправильные значения \$ 10^ n \$раз, когда предварительно скомпилированный шаблон может работать немного лучше).
Спектакль
Несколько вещей, которые можно изменить, чтобы сделать код более производительным:
Вместо конкатенации (добавления) к строке
mode_stringнажмите на список и в конце используйте"".join(). Подробнее о переполнении стека .Вы также можете сделать так, чтобы ваша программа поддерживала системы linux (* nix). Единственная зависимость от Windows - это ваш системный вызов
cls. Возможно ( взято из Stack Overflow ):def clear(): os.system("cls" if os.name == "nt" else "clear")Есть 2 функции с очень похожими именами:
start_cipher(mode...)иstart_cipher_mode(mode). Это делает действительно трудным узнать, какой из них действительно запускает шифр . Может быть, есть 2 отдельные функцииencryptиdecrypt?Используя операцию по модулю, вы можете удалить следующее условие:
if cipher_alphabet_index == len(cipher_alphabets): cipher_alphabet_index = 0и будет выглядеть так:
result.append(alphabet[cipher_alphabets[cipher_alphabet_index % alphabets_length].find(char)]Поскольку вы используете
alphabetстроку только для фактической работы со значениями индекса символов в ней, создайте словарь. Поиск в словаре \$ O(1) \$по сравнению с \$ O(n) \$для.find(). Это было бы:from itertools import count alphabet_map = dict(zip(alphabet, count()))Из приведенных выше 2 пунктов ясно, что вам действительно не нужны символы / алфавиты после ввода пользователя. Имеет значение только значение индекса по модулю. Это может быть трудно понять / реализовать без значительного математического понимания, поэтому вы можете пропустить это сейчас.
@hjpotter покрыл большинство моих комментариев.
Булевы
Python имеет концепцию истинных и ложных значений, поэтому предпочтительнее просто обрабатывать значения как логические напрямую, а не сравнивать их с True или False.
return True if re.match("^[a-zA-Z_]*$", input_string) else False
можно упростить до:
return re.match("^[a-zA-Z_]*$", input_string)
elif string_is_alpha(alphabet) is False:
Это можно упростить до:
elif not string_is_alpha(alphabet):
В общем, вы редко хотите использовать «есть» для сравнения. (Основное исключение - сравнение с None.)
Компиляция регулярных выражений
Это почти наверняка ненужное улучшение производительности, но может быть полезно знать на будущее:
Вызов re.matchдолжен компилировать регулярное выражение каждый раз, когда он вызывается. Вы можете предварительно скомпилировать регулярное выражение, а затем вызвать matchскомпилированный объект, чтобы ускорить его.
Глобалы
Почти каждый раз, когда я набираю globalключевое слово, это оказывается ошибкой.
Я не думаю, что вам нужно объявлять идентификаторы демонстрации как глобальные; они уже должны быть доступны для использования (только для чтения - если вы попытаетесь писать в них, вы определите новую переменную в новой области, скрывая оригиналы).