Skip to content

Update docstrings and log messages #7709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabaff merged 1 commit into from
May 30, 2017
Merged

Update docstrings and log messages #7709

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions homeassistant/components/telegram_bot/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ def _render_template_attr(data, attribute):
for attribute in [ATTR_MESSAGE, ATTR_TITLE, ATTR_URL, ATTR_FILE,
ATTR_CAPTION, ATTR_LONGITUDE, ATTR_LATITUDE]:
_render_template_attr(kwargs, attribute)
_LOGGER.debug("NEW telegram_message %s: %s", msgtype, kwargs)
_LOGGER.debug("New telegram message %s: %s", msgtype, kwargs)

if msgtype == SERVICE_SEND_MESSAGE:
yield from hass.async_add_job(
Expand Down Expand Up @@ -418,22 +418,22 @@ def _send_msg(self, func_send, msg_error, *args_rep, **kwargs_rep):
if not isinstance(out, bool) and hasattr(out, ATTR_MESSAGEID):
chat_id = out.chat_id
self._last_message_id[chat_id] = out[ATTR_MESSAGEID]
_LOGGER.debug("LAST MSG ID: %s (from chat_id %s)",
_LOGGER.debug("Last message ID: %s (from chat_id %s)",
self._last_message_id, chat_id)
elif not isinstance(out, bool):
_LOGGER.warning("UPDATE LAST MSG??: out_type:%s, out=%s",
_LOGGER.warning("Update last message: out_type:%s, out=%s",
type(out), out)
return out
except TelegramError:
_LOGGER.exception(msg_error)

def send_message(self, message="", target=None, **kwargs):
"""Send a message to one or multiple pre-allowed chat_ids."""
"""Send a message to one or multiple pre-allowed chat IDs."""
title = kwargs.get(ATTR_TITLE)
text = '{}\n{}'.format(title, message) if title else message
params = self._get_msg_kwargs(kwargs)
for chat_id in self._get_target_chat_ids(target):
_LOGGER.debug("send_message in chat_id %s with params: %s",
_LOGGER.debug("Send message in chat ID %s with params: %s",
chat_id, params)
self._send_msg(self.bot.sendMessage,
"Error sending message",
Expand All @@ -444,13 +444,13 @@ def edit_message(self, type_edit, chat_id=None, **kwargs):
chat_id = self._get_target_chat_ids(chat_id)[0]
message_id, inline_message_id = self._get_msg_ids(kwargs, chat_id)
params = self._get_msg_kwargs(kwargs)
_LOGGER.debug("edit_message %s in chat_id %s with params: %s",
_LOGGER.debug("Edit message %s in chat ID %s with params: %s",
message_id or inline_message_id, chat_id, params)
if type_edit == SERVICE_EDIT_MESSAGE:
message = kwargs.get(ATTR_MESSAGE)
title = kwargs.get(ATTR_TITLE)
text = '{}\n{}'.format(title, message) if title else message
_LOGGER.debug("editing message w/id %s.",
_LOGGER.debug("Editing message with ID %s.",
message_id or inline_message_id)
return self._send_msg(self.bot.editMessageText,
"Error editing text message",
Expand All @@ -472,8 +472,8 @@ def answer_callback_query(self, message, callback_query_id,
show_alert=False, **kwargs):
"""Answer a callback originated with a press in an inline keyboard."""
params = self._get_msg_kwargs(kwargs)
_LOGGER.debug("answer_callback_query w/callback_id %s: %s, alert: %s.",
callback_query_id, message, show_alert)
_LOGGER.debug("Answer callback query with callback ID %s: %s, "
"alert: %s.", callback_query_id, message, show_alert)
self._send_msg(self.bot.answerCallbackQuery,
"Error sending answer callback query",
callback_query_id,
Expand All @@ -493,7 +493,7 @@ def send_file(self, is_photo=True, target=None, **kwargs):
)
if file_content:
for chat_id in self._get_target_chat_ids(target):
_LOGGER.debug("send file to chat_id %s. Caption: %s.",
_LOGGER.debug("Send file to chat ID %s. Caption: %s.",
chat_id, caption)
self._send_msg(func_send, "Error sending file",
chat_id, file_content,
Expand All @@ -508,7 +508,7 @@ def send_location(self, latitude, longitude, target=None, **kwargs):
longitude = float(longitude)
params = self._get_msg_kwargs(kwargs)
for chat_id in self._get_target_chat_ids(target):
_LOGGER.debug("send location %s/%s to chat_id %s.",
_LOGGER.debug("Send location %s/%s to chat ID %s.",
latitude, longitude, chat_id)
self._send_msg(self.bot.sendLocation,
"Error sending location",
Expand Down Expand Up @@ -575,7 +575,6 @@ def process_message(self, data):
event_data[ATTR_TEXT] = data['text']
event = EVENT_TELEGRAM_TEXT
else:
# Some other thing...
_LOGGER.warning("Message without text data received: %s", data)
event_data[ATTR_TEXT] = str(data)
event = EVENT_TELEGRAM_TEXT
Expand All @@ -597,6 +596,5 @@ def process_message(self, data):
self.hass.bus.async_fire(event, event_data)
return True
else:
# Some other thing...
_LOGGER.warning("SOME OTHER THING RECEIVED --> %s", data)
_LOGGER.warning("Message with unknown data received: %s", data)
return True