decentral1se/xbotlib
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use error logging when facing errors

Browse Source 
See https://github.com/decentral1se/xbotlib/issues/2.
This commit is contained in:
Luke Murphy 2021-01-31 21:19:31 +01:00
parent 8a72b486ac
commit 772a3e46a5
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 39 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
xbotlib.py
View File

@ -41,7 +41,7 @@ class SimpleDatabase(dict):
self.update(loads(handle.read())) self.update(loads(handle.read()))
except Exception as exception: except Exception as exception:
message = f"Loading file storage failed: {exception}" message = f"Loading file storage failed: {exception}"
self.log.debug(message) self.log.error(message)
exit(1) exit(1)
def _dumps(self): def _dumps(self):
@ -51,7 +51,7 @@ class SimpleDatabase(dict):
handle.write(dumps(self)) handle.write(dumps(self))
except Exception as exception: except Exception as exception:
message = f"Saving file storage failed: {exception}" message = f"Saving file storage failed: {exception}"
self.log.debug(message) self.log.error(message)
exit(1) exit(1)
def __setitem__(self, key, val): def __setitem__(self, key, val):
@ -501,8 +501,10 @@ class Bot(ClientXMPP):
try: try:
from jinja2 import Environment, FileSystemLoader from jinja2 import Environment, FileSystemLoader
except ModuleNotFoundError: except ModuleNotFoundError:
print("Missing required dependency: jinja2") self.log.error(
print("Have you tried `pip install xbotlib[web]`") "Missing required dependency jinja2, ",
"have you tried `pip install xbotlib[web]`",
)
exit(1) exit(1)
try: try:
@ -510,7 +512,8 @@ class Bot(ClientXMPP):
env = Environment(loader=loader) env = Environment(loader=loader)
return env.get_template(template) return env.get_template(template)
except Exception: except Exception:
self.log.info(f"Unable to load {template}") self.log.error(f"Unable to load {template}")
exit(1)
def register_xmpp_event_handlers(self): def register_xmpp_event_handlers(self):
"""Register functions against specific XMPP event handlers.""" """Register functions against specific XMPP event handlers."""
@ -542,7 +545,7 @@ class Bot(ClientXMPP):
try: try:
self.direct(message) self.direct(message)
except Exception as exception: except Exception as exception:
self.log.info(f"Bot.direct threw exception {exception}") self.log.error(f"Bot.direct threw exception {exception}")
if self.storage == "file": if self.storage == "file":
self.db._dumps() self.db._dumps()
@ -556,12 +559,17 @@ class Bot(ClientXMPP):
def publish_avatar(self): def publish_avatar(self):
"""Publish bot avatar.""" """Publish bot avatar."""
try:
abspath = Path(self.avatar).absolute() abspath = Path(self.avatar).absolute()
if not exists(abspath):
self.log.info(f"No avatar discovered (tried '{abspath})'")
return
try:
with open(abspath, "rb") as handle: with open(abspath, "rb") as handle:
contents = handle.read() contents = handle.read()
except IOError: except Exception as exception:
self.log.info(f"No avatar discovered (tried '{abspath}')") self.log.error(f"Failed to load avatar: {exception}")
return return
id = self.plugin["xep_0084"].generate_id(contents) id = self.plugin["xep_0084"].generate_id(contents)
@ -619,7 +627,7 @@ class Bot(ClientXMPP):
try: try:
self.group(message) self.group(message)
except Exception as exception: except Exception as exception:
self.log.info(f"Bot.group threw exception: {exception}") self.log.error(f"Bot.group threw exception: {exception}")
if self.storage == "file": if self.storage == "file":
self.db._dumps() self.db._dumps()
@ -641,8 +649,8 @@ class Bot(ClientXMPP):
self.register_plugin(plugin) self.register_plugin(plugin)
self.log.info(f"Loaded {plugin}") self.log.info(f"Loaded {plugin}")
except Exception as exception: except Exception as exception:
message = f"Loading additional plugins failed {exception}" message = f"Loading additional plugins failed: {exception}"
self.log.info(message) self.log.error(message)
def init_storage(self): def init_storage(self):
"""Initialise the storage back-end.""" """Initialise the storage back-end."""
@ -652,7 +660,7 @@ class Bot(ClientXMPP):
self.log.info("Successfully loaded file storage") self.log.info("Successfully loaded file storage")
except Exception as exception: except Exception as exception:
message = f"Failed to load {self.storage_file}: {exception}" message = f"Failed to load {self.storage_file}: {exception}"
self.log.info(message) self.log.error(message)
exit(1) exit(1)
else: else:
try: try:
@ -662,11 +670,13 @@ class Bot(ClientXMPP):
return self.log.info("Successfully connected to Redis storage") return self.log.info("Successfully connected to Redis storage")
except ValueError as exception: except ValueError as exception:
message = f"Failed to connect to Redis storage: {exception}" message = f"Failed to connect to Redis storage: {exception}"
self.log.info(message) self.log.error(message)
exit(1) exit(1)
except ModuleNotFoundError: except ModuleNotFoundError:
print("missing required dependency using Redis") self.log.error(
print("Have you tried `pip install xbotlib[redis]`") "Missing required dependency using Redis, ",
"have you tried `pip install xbotlib[redis]`",
)
exit(1) exit(1)
def run(self): def run(self):
@ -684,7 +694,7 @@ class Bot(ClientXMPP):
self.log.info("Finished running setup") self.log.info("Finished running setup")
except Exception as exception: except Exception as exception:
message = f"Bot.setup failed: {exception}" message = f"Bot.setup failed: {exception}"
self.log.info(message) self.log.error(message)
self.process(forever=False) self.process(forever=False)
except (KeyboardInterrupt, RuntimeError): except (KeyboardInterrupt, RuntimeError):
@ -695,8 +705,10 @@ class Bot(ClientXMPP):
try: try:
from aiohttp.web import Application, get, run_app from aiohttp.web import Application, get, run_app
except ModuleNotFoundError: except ModuleNotFoundError:
print("Missing required dependency: aiohttp") self.log.error(
print("Have you tried `pip install xbotlib[web]`") "Missing required dependency aiohttp, ",
"have you tried `pip install xbotlib[web]`",
)
exit(1) exit(1)
self.web = Application() self.web = Application()
@ -720,8 +732,10 @@ class Bot(ClientXMPP):
try: try:
from aiohttp.web import Response from aiohttp.web import Response
except ModuleNotFoundError: except ModuleNotFoundError:
print("Missing required dependency: aiohttp") self.log.error(
print("Have you tried `pip install xbotlib[web]`") "Missing required dependency aiohttp, ",
"have you tried `pip install xbotlib[web]`",
)
exit(1) exit(1)
return Response(text=f"{self.nick} is alive and well") return Response(text=f"{self.nick} is alive and well")
@ -772,8 +786,10 @@ class Bot(ClientXMPP):
try: try:
from aiohttp.web import Response from aiohttp.web import Response
except ModuleNotFoundError: except ModuleNotFoundError:
print("Missing required dependency: aiohttp") self.log.error(
print("Have you tried `pip install xbotlib[web]`") "Missing required dependency aiohttp, ",
"have you tried `pip install xbotlib[web]`",
)
exit(1) exit(1)
return Response(text=response, content_type=content_type) return Response(text=response, content_type=content_type)