From 6d14790e1c68e9b49cee0252ea74c6c6e9245407 Mon Sep 17 00:00:00 2001 From: Suren Khorenyan Date: Sat, 17 Mar 2018 11:22:03 +0300 Subject: [PATCH] Typos fixes --- aiogram/dispatcher/storage.py | 93 ++++++++++++++++++----------------- 1 file changed, 47 insertions(+), 46 deletions(-) diff --git a/aiogram/dispatcher/storage.py b/aiogram/dispatcher/storage.py index e50b8de7..b7e733d7 100644 --- a/aiogram/dispatcher/storage.py +++ b/aiogram/dispatcher/storage.py @@ -12,13 +12,14 @@ THROTTLE_MANAGER = '$throttle_manager' class BaseStorage: """ - In states-storage you can save current user state and data for all steps + You are able to save current user's state + and data for all steps in states-storage """ async def close(self): """ - Need override this method and use when application is shutdowns. - You can save data or etc. + You have to override this method and use when application shutdowns. + Perhaps you would like to save data and etc. :return: """ @@ -26,7 +27,7 @@ class BaseStorage: async def wait_closed(self): """ - You need override this method for all asynchronously storage's like Redis. + You have to override this method for all asynchronous storages (e.g., Redis). :return: """ @@ -37,34 +38,33 @@ class BaseStorage: chat: typing.Union[str, int, None] = None, user: typing.Union[str, int, None] = None) -> (typing.Union[str, int], typing.Union[str, int]): """ - In all methods of storage chat or user is always required. - If one of this is not presented, need set the missing value based on the presented. + In all storage's methods chat or user is always required. + If one of them is not provided, you have to set missing value based on the provided one. - This method performs the above action. + This method performs the check described above. :param chat: :param user: :return: """ - if chat is not None and user is not None: - return chat, user - elif user is None and chat is not None: + if chat is None and user is None: + raise ValueError('`user` or `chat` parameter is required but no one is provided!') + + if user is None and chat is not None: user = chat - return chat, user elif user is not None and chat is None: chat = user - return chat, user - raise ValueError('User or chat parameters is required but anyone is not presented!') + return chat, user async def get_state(self, *, chat: typing.Union[str, int, None] = None, user: typing.Union[str, int, None] = None, default: typing.Optional[str] = None) -> typing.Optional[str]: """ - Get current state of user in chat. Return value stored in `default` parameter if record is not found. + Get current state of user in chat. Return `default` if no record is found. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -78,10 +78,10 @@ class BaseStorage: user: typing.Union[str, int, None] = None, default: typing.Optional[typing.Dict] = None) -> typing.Dict: """ - Get state-data for user in chat. Return `default` if data is not presented in storage. + Get state-data for user in chat. Return `default` if no data is provided in storage. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -95,10 +95,10 @@ class BaseStorage: user: typing.Union[str, int, None] = None, state: typing.Optional[typing.AnyStr] = None): """ - Setup new state for user in chat + Set new state for user in chat - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -113,8 +113,8 @@ class BaseStorage: """ Set data for user in chat - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -132,8 +132,8 @@ class BaseStorage: You can use data parameter or|and kwargs. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param data: :param chat: @@ -147,10 +147,10 @@ class BaseStorage: chat: typing.Union[str, int, None] = None, user: typing.Union[str, int, None] = None): """ - Reset data dor user in chat. + Reset data for user in chat. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -163,10 +163,11 @@ class BaseStorage: user: typing.Union[str, int, None] = None, with_data: typing.Optional[bool] = True): """ - Reset state for user in chat. You can use this method for finish conversations. + Reset state for user in chat. + You may desire to use this method when finishing conversations. Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + you have to set missing value based on the provided one. :param chat: :param user: @@ -184,8 +185,8 @@ class BaseStorage: """ Finish conversation for user in chat. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -201,10 +202,10 @@ class BaseStorage: user: typing.Union[str, int, None] = None, default: typing.Optional[dict] = None) -> typing.Dict: """ - Get state-data for user in chat. Return `default` if data is not presented in storage. + Get bucket for user in chat. Return `default` if no data is provided in storage. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -218,10 +219,10 @@ class BaseStorage: user: typing.Union[str, int, None] = None, bucket: typing.Dict = None): """ - Set data for user in chat + Set bucket for user in chat - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: @@ -235,12 +236,12 @@ class BaseStorage: bucket: typing.Dict = None, **kwargs): """ - Update data for user in chat + Update bucket for user in chat - You can use data parameter or|and kwargs. + You can use bucket parameter or|and kwargs. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param bucket: :param chat: @@ -254,10 +255,10 @@ class BaseStorage: chat: typing.Union[str, int, None] = None, user: typing.Union[str, int, None] = None): """ - Reset data dor user in chat. + Reset bucket dor user in chat. - Chat or user is always required. If one of this is not presented, - need set the missing value based on the presented + Chat or user is always required. If one of them is not provided, + you have to set missing value based on the provided one. :param chat: :param user: