.env_sample

@@ -0,0 +1,5 @@
+DEBUG=false           # debug logging
+TIMEOUT=2             # http requests timeout
+NDIGITS=3             # digits after floating point or after zeroes
+COINAPI_KEYS=["key"]  # coinapi keys list
+TELEGRAM_TOKEN=       # telegram bot token

.gitignore

@@ -5,4 +5,4 @@ __pycache__
 .mypy_cache
 
 venv
-config.yaml
+.env

README.md

@@ -9,18 +9,15 @@ https://t.me/Shirino_bot
 Получите токен бота в телеграме и токен CoinAPI.  
 Вставьте в файл `.env` в формате:
 
-```yaml
+```
-coinapi_keys:
+COINAPI_KEYS=["Токен от CoinAPI"]
-  - key1
+TELEGRAM_TOKEN=Токен Telegram-бота
-  - key2
-  - etc.
-telegram_token: Токен Telegram-бота
 ```
 
 В .env файл ещё можно такие переменные добавить:
-```yaml
+```
-debug: false или true, включает отладочные логи
+DEBUG=false или true, включает отладочные логи
-timeout: таймаут для библиотеки requests, в секундах (2 по дефолту)
+TIMEOUT=таймаут для библиотеки requests, в секундах (2 по дефолту)
 ```
 
 ## Хочу сделать пулл-реквест
@@ -31,11 +28,8 @@ timeout: таймаут для библиотеки requests, в секунда
 ## Почему энв для CoinAPI -- список?
 Можно получить несколько ключей на разные почтовые ящики
 и все ключи вписать в список:
-```yaml
+```
-coinapi_keys:
+COINAPI_KEYS=["первый", "второй", "и так далее"]
-  - key1
-  - key2
-  - etc.
 ```
 
 Если вдруг один из них будет заблокирован по рейтлимиту,

config_sample.yaml

@@ -1,7 +0,0 @@
-debug: false           # debug logging
-timeout: 2             # http requests timeout
-ndigits: 3             # digits after floating point or after zeroes
-coinapi_keys:
-  - key
-  - key2               # coinapi keys list
-telegram_token:        # telegram bot token

main.py

@@ -1,24 +1,45 @@
 #!/usr/bin/env python3
+
 import asyncio
 import hashlib
 import json
-import string
-
-import aiohttp
-import requests
-import re
 import logging
-import yaml
+import re
 
+import string
+from typing import List, Any, Dict, Optional
+
+import requests
 from aiogram import Dispatcher, types, Bot
-from aiogram.filters import CommandStart
+import aiohttp.client_exceptions
+from pydantic.v1 import BaseSettings
 
 # Constants
 DDG_URL = 'https://duckduckgo.com/js/spice/currency'
 COINAPI_URL = 'https://rest.coinapi.io/v1/exchangerate'
 
-config = yaml.safe_load(open("config.yaml"))
 
+# ---
+
+
+# Config from .env
+class Settings(BaseSettings):
+    debug: bool
+    timeout: int = 2
+    ndigits: int = 3
+    coinapi_keys: List[str]
+    telegram_token: str
+
+    class Config:
+        env_file = '.env'
+        env_file_encoding = 'utf-8'
+
+
+settings = Settings()  # type: ignore
+# ---
+
+
+# Logging
 log = logging.getLogger('shirino')
 handler = logging.StreamHandler()
 fmt = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
@@ -26,24 +47,29 @@ fmt = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
 handler.setFormatter(fmt)
 log.addHandler(handler)
 
-if config['debug']:
+if settings.debug:
     handler.setLevel(logging.DEBUG)
     log.setLevel(logging.DEBUG)
+# ---
 
 
-coinapi_len = len(config['coinapi_keys'])
+coinapi_len = len(settings.coinapi_keys)
-coinapi_active = [0]
+coinapi_active = [0]  # API key index
 dp = Dispatcher()
 
 
 class CurrencyConverter:
-    def __init__(self):
-        self.amount = 1.0
-        self.conv_amount = 0.0
-        self.from_currency = 'RUB'
-        self.conv_currency = 'USD'
 
-    def convert(self):
+    def __init__(self) -> None:
+
+        self.amount: float = 1.0
+        self.conv_amount: float = 0.0
+        self.from_currency = ''
+        self.conv_currency = ''
+
+    def convert(self) -> None:
+        """Currency conversion"""
+
         if not self.ddgapi():
             self.coinapi()
 
@@ -51,7 +77,7 @@ class CurrencyConverter:
         point = str_amount.find(".")
         after_point = str_amount[point + 1:]
 
-        fnz = min(
+        fnz = min(  # index of first non-zero digit
             (
                 after_point.index(i)
                 for i in string.digits[1:]
@@ -61,26 +87,35 @@ class CurrencyConverter:
         )
 
         if fnz == -1:
+            # it is an integer like 81.0
             return
 
-        ndigits = fnz + config['ndigits']
+        # how many digits should be after the point:
+        # ndigits (3 by default) after first non-zero
+        ndigits = fnz + settings.ndigits
 
         self.conv_amount = round(self.conv_amount, ndigits)
 
-    def ddgapi(self):
+    def ddgapi(self) -> bool:
-        res = requests.get(f'{DDG_URL}/{self.amount}/{self.from_currency}/{self.conv_currency}')
+        """Получение данных фиатной валюты через DuckDuckGo
-        data = json.loads(re.findall(r'\(\s*(.*)\s*\);$', res.text)[0])
 
-        del data['terms']
+        e.g: https://duckduckgo.com/js/spice/currency/1/USD/RUB
-        del data['privacy']
+
-        del data['timestamp']
+        Returns:
+            `False` если валюты нет в API
+            `True` если конвертация прошла успешно
+        """
+
+        # Запрос к API
+        res = requests.get(f'{DDG_URL}/{self.amount}/{self.from_currency}/{self.conv_currency}')
+        data: Dict[str, Any] = json.loads(re.findall(r'(.+)\);', res.text)[0])
 
         log.debug(data)
 
         if len(data.get('to')) == 0:
             return False
 
-        conv = data.get('to')[0]
+        conv: Dict[str, str] = data.get('to')[0]
         conv_amount = conv.get("mid")
 
         if conv_amount is None:
@@ -93,7 +128,13 @@ class CurrencyConverter:
 
         return True
 
-    def coinapi(self, depth: int = config['coinapi_keys']):
+    def coinapi(self, depth: int = coinapi_len) -> None:
+        """Получение данных с CoinAPI для получения курса криптовалюты
+
+        Args:
+            depth (int, optional): Счетчик, защищающий от рекурсии
+        """
+
         if depth <= 0:
             raise RecursionError('Рейтлимит на всех токенах')
 
@@ -103,29 +144,36 @@ class CurrencyConverter:
                 f'/{self.conv_currency}'
             ),
             headers={
-                'X-CoinAPI-Key': config['coinapi_keys'][coinapi_active[0]],
+                'X-CoinAPI-Key': settings.coinapi_keys[coinapi_active[0]],
             },
-            timeout=config['timeout'],
+            timeout=settings.timeout,
         )
 
         if resp.status_code == 429:
             log.warning('CoinAPI ratelimited, rotating token')
-            rotate_token(config['coinapi_keys'], coinapi_active)
+            rotate_token(settings.coinapi_keys, coinapi_active)
             self.coinapi(depth - 1)
 
-        data = resp.json()
+        data: Dict[str, Any] = resp.json()
         rate = data.get('rate')
         if rate is None:
             raise RuntimeError('Не удалось получить курс валюты от CoinAPI')
         self.conv_amount = float(rate * self.amount)
 
 
-def rotate_token(lst, active):
+def rotate_token(lst: List[str], active: List[int]) -> None:
+    """Смена API-ключей CoinAPI при ratelimits
+
+    Args:
+        lst (List[str]): Список ключей
+        active (List[str]): Изменяемый объект с текущим ключевым индексом
+    """
+
     active[0] = (active[0] + 1) % len(lst)
 
 
-async def inline_reply(result_id: str, title: str, description: str or None, inline_query: types.InlineQuery):
+async def inline_reply(result_id: str, title: str, description: str or None, inline_query: types.InlineQuery) -> None:
-    article = [None]
+    article: List[Optional[types.InlineQueryResultArticle]] = [None]
     article[0] = types.InlineQueryResultArticle(
         id=result_id,
         title=title,
@@ -143,7 +191,7 @@ async def inline_reply(result_id: str, title: str, description: str or None, inl
 
 
 @dp.inline_query()
-async def currency(inline_query: types.InlineQuery):
+async def currency(inline_query: types.InlineQuery) -> None:
     query = inline_query.query
     args = query.split()
 
@@ -190,18 +238,8 @@ async def currency(inline_query: types.InlineQuery):
     await inline_reply(result_id, result, None, inline_query)
 
 
-@dp.message(CommandStart())
-async def start(message: types.Message):
-    await message.answer("Привет! Бот может показывать курс обмена криптовалюты и фиатной валюты. "
-                         "Бот используется с помощью инлайн-команд: "
-                         "`@shirino_bot 12 usd rub` или `@shirino_bot usd rub`"
-                         "\n\nИсходный код опубликован на [Github](https://github.com/redume/shirino)",
-                         parse_mode="markdown")
-
-
 async def main() -> None:
-    log.debug(config)
+    bot = Bot(settings.telegram_token)
-    bot = Bot(config['telegram_token'])
     await dp.start_polling(bot)
 
 

requirements.txt

@@ -1,4 +1,4 @@
-aiohttp~=3.9.5
+requests==2.31.0
-requests~=2.32.3
+aiogram==3.1.1
-PyYAML~=6.0.1
+aiohttp==3.8.5
-aiogram~=3.7.0
+pydantic[dotenv]==2.5.2