Что бы вы сказали об этом коде?

Question

[Lina Qwerty]

В качестве практики решила написать программу, которая шифрует и дешифрует пароли. В итоге все получилось (вот пара скринов работы),

Фото

Это шифрование А это дешифрованиеДа, выглядят фото так себе, но главное что видно, что все работает.

но мне хотелось бы узнать мнение о моём коде у более опытных питонистов. Помимо мнений, было бы интересно послушать и рекомендации по улучшению кода.
Собственно, сам код:

Тут код

def Mode(letter):		#функция обработки числа
	global mode
	if mode is True:
		j = letter * 2 - 9
	elif mode is False:
		j = (letter + 9) / 2
	return int(abs(j))

def rebuild_code(password):		#функция шифрования
	re_pass, pass_2_list = list(), list()
	for i in password:	#проход по чилам, обработка и добавление в re_pass
		letter = ord(i)
		j = Mode(letter)
		re_pass.append(j)
	for i in re_pass:
		pass_2_list.append(chr(i)) #перевод чисел в символы
	return "".join(pass_2_list)		#получение нового пороля

password = input('Введите пороль: ')
CorD = input("Выберите режим (Code/Decode): ")
if CorD.capitalize().startswith('Code'):
	mode = True
	print(rebuild_code(password))
elif CorD.capitalize().startswith('Decode'):
mode = False
	print(rebuild_code(password))
else:
	print('Вы ввели {}. Данного режима не существует.'.format(CorD))

Если так неудобно читать, можете посмотреть код и в виде фото.

Comments

[Lina Qwerty]

А, да, забыла сказать, как работает код.
1) Человек вводит пароль,
2) дальше пароль разбивается посимвольно,
3) все символы преобразуется в свое числовое представление,
4) полученные числа проходят через небольшую формулу в функции Mode
5) числа полученные после 4 шага переводятся в свое символьное представление
6) человек получает зашифрованные пароль.

[Animkim]

Katawara, про pep8 вам уже рассказали, почему функция шифрования умеет и дешифровать? Разве не логично что это две разные функции? Зачем вешать разный функционал на одну функцию и весьма криво через глобальную переменную переключать режим её работы?
Описание функции (docstring) задается через тройные кавычки, вместо #функция шифрования, хороший код редко требует комментариев, комментарии нужны в местах непонятных и они должны объяснять зачем сделано так, а не иначе, вместо того что бы говорить что делает код. Что делает код и я так вижу, я же читаю код. Поэтому капитанские комментарии в мусорку, они только засоряют код.

Ну и кода как-то мало, напишите что-нибудь побольше тут особо и обсуждать нечего. Например задача о ходе коня.

[Lina Qwerty]

Animkim, А смысл увеличивать код? Все это шифрование идет через цифры и функции ord(), chr(). Зачем мне прописывать, даже не так, создавать копию функции, с разницей в одной строке? Ко всему прочему, это код ради практики, а не ради реального использования.
Про комменты. Ну это конечно вообще, придираться к тому, что человек делал для самого себя... Я че, эти функции собираюсь выкладывать на всеобщее использование? Нет, так и зачем мне замарачиваться со стоками документации, если __doc__ ни я, ни кто-либо ещё все равно применять не будет? Если коменты для вас - мусор, то для меня, как человека забывчивого, они помогают вспомнить что и зачем нужно.
Про коня. Это какая именно? Если та, что проверяет по начальным и конечным координатам, может ли конь попасть из А в Б, то это я уже делала. Скучная задача была...

[Animkim]

Katawara, вопрос называется "Что бы вы сказали об этом коде?" я и сказал что сказал. Если вы хотите писать код для себя и никому никогда его не показывать, можете писать как угодно.

[Lina Qwerty]

Animkim, я просто к тому, что это глупая придирка, т.к. это лишь учебный код.

[Animkim]

Katawara, умываю руки, если делать скидку на "учебный код", "я только учусь", "ты чо самый умный читоли?", то это просто идеальный код.
Задача про коня так и называется как я её написал, гуглится на раз, но так и быть pogugli.com/?332036

[Lina Qwerty]

Animkim, Я и не делала скидку на "учебный код", как и не говорила, что это идеальный код. Но правда, делать строку документации на это... как минимум глупо, вот честно.

Кстати, давайте попробуем:
def rebuild_code(password):
"""функция шифрования"""
re_pass, pass_2_list = list(), list()
for i in password:
"""проход по чилам, обработка и добавление в re_pass"""
letter = ord(i)
j = Mode(letter)
re_pass.append(j)
for i in re_pass:
pass_2_list.append(chr(i))
"""перевод чисел в символы"""
return "".join(pass_2_list)
"""получение нового пороля"""
Код стал в разы читабельнее, понятнее, и вообще, будто сам боженька наш джизис поцеловал его.

А про коня, я специально уточнила, о какой именно задаче про коня вы говорили.
Не вижу смысла и дальше продолжать этот диалог, ибо кроме задачи про коня и обход доски, я ничего полезного от вас не узнала.

Answer 1

[Andy_U]

"if mode is True" - не надо так. Так же не надо называть целое число, как letter и очередной символ строки, как i,

Ну и алгоритм можно гораздо проще имплементировать:

from typing import Callable


def encode(code: int) -> int:
    """ Encode unicode code point of the character. """
    return code * 2 - 9


def decode(code: int) -> int:
    """ Decode unicode code point of the character. """
    return (code + 9) // 2


def process(password: str, func: Callable[[int], int]) -> str:
    """ Encode/decode password. """
    return ''.join([chr(abs(func(ord(c)))) for c in password])


if __name__ == '__main__':

    password = input('Введите пароль: ')
    mode = input("Выберите режим (Code/Decode): ").capitalize()

    if mode.startswith('Code'):
        print(process(password, encode))
    elif mode.startswith('Decode'):
        print(process(password, decode))
    else:
        print('Вы ввели {}. Данного режима не существует.'.format(mode))

Ну и наконец, одно большое "но". Маленькая буква "z" кодируется в "ё", а русские буквы вообще черт знает во что. Т.е. вместо правильного utf-символа Windows может напечатать знак вопроса в квадратике - т.е. признак непечатного символа.

Comments

[Lina Qwerty]

Спасибо.

"if mode is True" - не надо так.

А почему не надо?

[Andy_U]

Katawara, Потому что PEP 8 не рекомендует так делать. См. например: тут.

[Lina Qwerty]

Andy_U, Да, только что дочитала его, но все равно спасибо.

Answer 2

[Дмитрий Шицков]

Рекомендую ознакомиться с данным документом https://pep8.ru/doc/pep8/
Рекомендую использовать какой-либо плагин linter для вашей ide - так будете уверены, что код соответствует определенным стандартам. Хотябы, тому же pep8. Мне сильно помогло улучшить культуру кода.

В частности, рекомендации по именованию переменных и функций.
По коду - rebuild_code работает двойным проходом - зачем? Можно сразу же преобразовывать и join-ить строку.

P. S. Не Питонист. Заметил то, в чем сам изначально ошибался.

Comments

[Lina Qwerty]

Для того чтобы код было легче читать, когда постите его сюда, нужно было указать что это python в теге. Тогда была бы подсветка синтаксиса.

Сделала, кажется.
Спасибо за совет по коду.
А про проход, я сделала теперь так:
return "".join([chr(i) for i in re_pass])
Сделала генератор -> сократила 2 строки кода.

[Дмитрий Шицков]

Katawara, посмотрел с компа код - вы используете Global переменную - не очень хороший подход.
Следует добавить в функцию Mode дополнительный параметр:
def Mode(letter, mode):
и, соответвенно:

if CorD.capitalize().startswith('Code'):
  print(rebuild_code(password, True))

[Дмитрий Шицков]

Katawara, вот вариант:

def mode(letter, mode_):		#функция обработки числа
  if mode_ is True:
    j = ord(letter) * 2 - 9
  else:
    j = (ord(letter) + 9) / 2
  return chr(abs(j))

def rebuild_code(password, mode_):
    re_pass = [mode(i, mode_) for i in password]
    return ''.join(re_pass)
    
print(rebuild_code('qrcx', True))

[Lina Qwerty]

Дмитрий Шицков, спасибо. Я изначально хотела как раз сделать генератор, вместо тех 4 строк, но не поняла как. Зато теперь знаю.