Skip to content

Rewrite comm handling to make it clearer and fix a logic inversion bug #138

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
minrk merged 1 commit into from
May 31, 2016
Merged

Rewrite comm handling to make it clearer and fix a logic inversion bug #138

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
36 changes: 15 additions & 21 deletions ipykernel/comm/manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ def get_comm(self, comm_id):
except KeyError:
self.log.warn("No such comm: %s", comm_id)
if self.log.isEnabledFor(self.log.DEBUG):
# don't create the list of keys if debug messages aren't enabled
self.log.debug("Current comms: %s", list(self.comms.keys()))

# Message handlers
Expand Down Expand Up @@ -99,37 +100,30 @@ def comm_open(self, stream, ident, msg):

def comm_msg(self, stream, ident, msg):
"""Handler for comm_msg messages"""
comm_id, comm = self._get_id_and_comm(msg)
if self._comm_is_not_valid(comm, comm_id):
content = msg['content']
comm_id = content['comm_id']
comm = self.get_comm(comm_id)
if comm is None:
return

self._safe_handle(msg, comm.handle_msg, name='comm_msg')
try:
comm.handle_msg(msg)
except Exception:
self.log.error('Exception in comm_msg for %s', comm_id, exc_info=True)

def comm_close(self, stream, ident, msg):
"""Handler for comm_close messages"""
comm_id, comm = self._get_id_and_comm(msg)
if self._comm_is_not_valid(comm, comm_id):
content = msg['content']
comm_id = content['comm_id']
comm = self.get_comm(comm_id)
if comm is None:
return

del self.comms[comm_id]
self._safe_handle(msg, comm.handle_close, name='comm_close')

def _comm_is_not_valid(self, comm, comm_id):
invalid = comm is None
if invalid:
self.log.debug('No such comm: ', str(comm_id))
return not invalid

def _get_id_and_comm(self, msg):
content = msg['content']
comm_id = content['comm_id']
return (comm_id, self.get_comm(comm_id))

def _safe_handle(self, msg, callback, name = ''):
try:
callback(msg)
comm.handle_close(msg)
except Exception:
self.log.error('Exception handling ' + name + ' for %s', msg['content']['comm_id'], exc_info=True)

self.log.error('Exception in comm_close for %s', comm_id, exc_info=True)

__all__ = ['CommManager']