ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-28 00:31:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some docstrings

Browse Source
This commit is contained in:
Richard Chien
2018-07-04 19:50:42 +08:00
parent 1f4e5f3435
commit e639889944
4 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
none/__init__.py
View File

@ -67,17 +67,30 @@ class NoneBot(CQHttp):
_bot = None
def init(config_object: Any = None) -> NoneBot:
def init(config_object: Any = None) -> None:
"""
Initialize NoneBot instance.
This function must be called at the very beginning of code,
otherwise the get_bot() function will return None and nothing
is gonna work properly.
:param config_object: configuration object
"""
global _bot
_bot = NoneBot(config_object)
if _bot.config.DEBUG:
logger.setLevel(logging.DEBUG)
else:
logger.setLevel(logging.INFO)
return _bot
def get_bot() -> NoneBot:
"""
Get the NoneBot instance.
:raise ValueError: instance not initialized
"""
if _bot is None:
raise ValueError('NoneBot instance has not been initialized')
# noinspection PyTypeChecker
@ -85,6 +98,7 @@ def get_bot() -> NoneBot:
def run(host: str = None, port: int = None, *args, **kwargs) -> None:
"""Run the NoneBot instance."""
get_bot().run(host=host, port=port, *args, **kwargs)