Ремарки по реализации лабораторных

[ladyitsecurity]

Общие ремарки

• Перед открытием pr убедитесь, что ваш код работоспособен и в нем реализованы все требуемые пункты задания.
• Перед открытием pr убедитесь, что ваш код соответствует стандартам кодирования (поскольку на этом предмете в основном будет использовать python, то не забывайте о РЕР).
• От вашего кода ожидается, что он будет грамотно физически и логически декомпозирован.
• Используйте в своей реализации лабораторных принципы и парадигмы построения качественного кода, изученные вами ранее, - OOP, SOLID, DDD и т.д.
• Не забывайте про observability своего кода - в нем должны присутствовать обработка исключений и логирование.
• Эффективно используйте средства языка - например, не плодите бесконечный цепочки elif-ов там, где можно обойтись match-case, заменяйте флаги на enum-ы, заменяйте циклы компрехеншенами и т.д.

[ladyitsecurity]

Несколько примеров для пункта об эффективном использовании языка:

1. Используйте f-strings для форматирования строк:

name, group, job = "Имя Фамилия", 6213
message = "Студенту"+" "+ name+ " " + "из группы" + " " + str(group) + " " + "ампутируют руки за такое форматирование строк"

name, group, job = "Имя Фамилия", 6213
message = f"Студент {name} из группы {group} сохраняет все свои конечности при себе"

2. Используйте os.path.join для конкатенации путей:

base_path, sub_path, file = "Это", "путь", "в ад.png"
path = base_path+"//"+sub_path+"//"+file 

import os
base_path, sub_path, file = "Это", "путь", " не в ад.png"
path = os.path.join(base_path, sub_path, file)

3. Используйте компрехеншены, где это возможно:

my_fate = []
for char in "Меня отчислят":
    my_fate.append(char)
my_fate = [char for char in "Меня отчислят не сегодня"]

4. Используйте распаковку, где это возможно:

def sample_function(arg1, arg2, arg3):
   pass

args = ["я","совершил","ошибку"]
sample_function(args[0],args[1],args[2])

def sample_function(arg1, arg2, arg3):
   pass

args = ["я","поступил","как вменяемый человек"]
sample_function(*args)

5. Используйте декораторы для геттеров/сеттеров:
   Вместо

class SampleClass:

  def __init__(self, something):
	self.__something= something

  def get_something(self):
       return self.__something

  def set_something(self, value):
      self.__something=value

лучше

class SampleClass:

  def __init__(self, something):
	self.__something= something

  @property
  def something(self):
       return self.__something

  @something.setter
  def something(self, value):
      self.__something=value

6. Используйте enum-ы для повышения readability своего кода:
   Вместо

def sample_function(param: int) -> None:
   if param == 1:
      print("делаем что-то")
   elif param == 2:
      print("делаем что-то другое")
   elif param == 3:
      print("делаем что-то третье")
   else
      print("ничего не делаем или кидаем эксепшен")

лучше

class Action(Enum):
    SOMETHING = 1
    OTHER = 2
    ANOTHER = 3

def sample_function(param: Action) -> None:
   match param:
      case Action.SOMETHING:
          print("делаем что-то")
      case Action.OTHER:
          print("делаем что-то другое")
      case Action.ANOTHER:
          print("делаем что-то третье")
      case _:
          print("ничего не делаем или кидаем эксепшен")