From a6402c60a8798d6b0872ff2cbf79071889e706e9 Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Wed, 9 Feb 2022 17:08:58 +0300 Subject: [PATCH] added docstrings in config.py --- config.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/config.py b/config.py index ac8538e..1fc15d7 100644 --- a/config.py +++ b/config.py @@ -4,6 +4,12 @@ from dataclasses import dataclass @dataclass class Config: + """ + Notifier config dataclass. + + * `api_token`: telegram api token. + * `param bot_owner`: telegram id of bot owner. + """ api_token: str bot_owner: int @@ -13,21 +19,23 @@ class ConfigError(Exception): _api_token = getenv('LTLNOTIFIER_API_TOKEN') +# Check api token if not _api_token: raise ConfigError('virtual environment LTLNOTIFIER_API_TOKEN not set.') if len(_api_token) != 45 or _api_token[9] or not _api_token[:9].isdigit(): - raise ConfigError('Virtual environment LTLNOTIFIER_API_TOKEN incorrect') + raise ConfigError('virtual environment LTLNOTIFIER_API_TOKEN incorrect.') _bot_owner = getenv('LTLNOTIFIER_BOT_OWNER') +# Check bot owner if not _bot_owner: - raise ConfigError('Virtual environment LTLNOTIFIER_BOT_OWNER not set') + raise ConfigError('virtual environment LTLNOTIFIER_BOT_OWNER not set.') try: if len(_bot_owner) != 9: raise ValueError _bot_owner = int(_bot_owner) except ValueError: - raise ConfigError('Virtual environment LTLNOTIFIER_BOT_OWNER incorrect') + raise ConfigError('virtual environment LTLNOTIFIER_BOT_OWNER incorrect.') config = Config(api_token=_api_token, bot_owner=_bot_owner) -__all__ = ['Config', config] \ No newline at end of file +__all__ = ['Config', 'config']