added signatures

egorcoders · egorcoders · commit 57c651d93e2f · 2022-08-04T09:46:35.000+05:00
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ class Record
 r1 = Record(amount=122, comment='Хороший шопинг', date='09.04.2019')
 ```
 
-## Родительский класс калькулятора
+## Базовый класс калькулятора
 
 ```python
 class Calculator
diff --git a/homework.py b/homework.py
@@ -4,7 +4,13 @@
 
 
 class Record:
-    def __init__(self, amount, comment, date=None):
+    '''Класс записей пользователя.'''
+    def __init__(
+        self,
+        amount: float,
+        comment: str,
+        date: dt.date = None
+    ) -> None:
         self.amount = amount
         self.comment = comment
         if date is None:
@@ -14,45 +20,54 @@ def __init__(self, amount, comment, date=None):
 
 
 class Calculator:
-    def __init__(self, limit):
+    '''Базовый класс калькулятора.'''
+    def __init__(self, limit) -> None:
         self.limit = limit
         self.records = []
 
-    def get_today_date(self):
+    def get_today_date(self) -> dt.date:
+        """Получить текущую дату."""
         return dt.date.today()
 
-    def get_week_date(self):
+    def get_week_date(self) -> dt.date:
+        """Получить дату неделю назад."""
         return self.get_today_date() - dt.timedelta(days=7)
 
-    def add_record(self, record):
+    def add_record(self, record) -> None:
+        """Добавить новую запись."""
         return self.records.append(record)
 
-    def get_today_stats(self):
+    def get_today_stats(self) -> float:
+        """Получить сумму расходов за сегодня."""
         today = self.get_today_date()
         t_amount = [record.amount for record in self.records
                     if record.date == today]
         return sum(t_amount)
 
-    def get_week_stats(self):
+    def get_week_stats(self) -> float:
+        """Получить сумму расходов за неделю."""
         today = self.get_today_date()
         week_ago = self.get_week_date()
         week_amount = [record.amount for record in self.records
                        if today >= record.date > week_ago]
         return sum(week_amount)
 
-    def get_today_limit(self):
+    def get_today_limit(self) -> float:
+        """Получить допустимую сумму расходов за сегодня."""
         return self.limit - self.get_today_stats()
 
 
 class CashCalculator(Calculator):
+    '''Класс калькулятора денег.'''
     USD_RATE = 73.20
     EURO_RATE = 86.64
 
-    def __init__(self, limit):
+    def __init__(self, limit: float) -> None:
         self.limit = limit
         self.records = []
 
-    def get_today_cash_remained(self, currency):
+    def get_today_cash_remained(self, currency: str) -> str:
+        """Вернуть информационное сообщение о  финансовых расходах."""
         self.currency = currency
         t_amount = self.get_today_limit()
         currencies = {'rub': ('руб', 1),
@@ -72,11 +87,13 @@ def get_today_cash_remained(self, currency):
 
 
 class CaloriesCalculator(Calculator):
-    def __init__(self, limit):
+    '''Класс калькулятора калорий.'''
+    def __init__(self, limit: float) -> None:
         self.limit = limit
         self.records = []
 
-    def get_calories_remained(self):
+    def get_calories_remained(self) -> str:
+        """Вернуть информационное сообщение о расходах калорий."""
         positive_message = ('Сегодня можно съесть что-нибудь ещё, '
                             'но с общей калорийностью не более')
         t_amount = self.get_today_limit()
