Skip to content
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

Jump to bottom

Don't pass None kernels to logging configurable in Comm #1061

Merged
merged 6 commits into from Dec 20, 2022
Merged

Don't pass None kernels to logging configurable in Comm #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
282536e
don't hand None kernels to traitlets
bollwyvl Dec 20, 2022
e2218ed
allow for _explict_ None kernel
bollwyvl Dec 20, 2022
e1f0d19
add test from @maartenbreddels
bollwyvl Dec 20, 2022
b29db82
try typing kernel fixture
bollwyvl Dec 20, 2022
1f7a1a4
lint
blink1073 Dec 20, 2022
8eacbf7
lint
blink1073 Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion ipykernel/comm/comm.py
View file
Open in desktop
Expand Up @@ -70,13 +70,16 @@ def _default_comm_id(self):

def __init__(self, target_name='', data=None, metadata=None, buffers=None, **kwargs):
# Handle differing arguments between base classes.
had_kernel = 'kernel' in kwargs
kernel = kwargs.pop('kernel', None)
if target_name:
kwargs['target_name'] = target_name
BaseComm.__init__(
self, data=data, metadata=metadata, buffers=buffers, **kwargs
) # type:ignore[call-arg]
kwargs['kernel'] = kernel
# only re-add kernel if explicitly provided
if had_kernel:
kwargs['kernel'] = kernel
traitlets.config.LoggingConfigurable.__init__(self, **kwargs)


Expand Down
16 changes: 12 additions & 4 deletions ipykernel/tests/test_comm.py
View file
Open in desktop
Expand Up @@ -2,15 +2,18 @@

from ipykernel.comm import Comm, CommManager
from ipykernel.ipkernel import IPythonKernel
from ipykernel.kernelbase import Kernel


def test_comm(kernel):
def test_comm(kernel: Kernel) -> None:
manager = CommManager(kernel=kernel)
kernel.comm_manager = manager
kernel.comm_manager = manager # type:ignore

c = Comm(kernel=kernel, target_name="bar")
msgs = []

assert kernel is c.kernel # type:ignore

def on_close(msg):
msgs.append(msg)

Expand All @@ -28,7 +31,7 @@ def on_message(msg):
assert c.target_name == "bar"


def test_comm_manager(kernel):
def test_comm_manager(kernel: Kernel) -> None:
manager = CommManager(kernel=kernel)
msgs = []

Expand All @@ -48,14 +51,19 @@ def on_msg(msg):
manager.register_target("foo", foo)
manager.register_target("fizz", fizz)

kernel.comm_manager = manager
kernel.comm_manager = manager # type:ignore
with unittest.mock.patch.object(Comm, "publish_msg") as publish_msg:
comm = Comm()
comm.on_msg(on_msg)
comm.on_close(on_close)
manager.register_comm(comm)
assert publish_msg.call_count == 1

# make sure that when we don't pass a kernel, the 'default' kernel is taken
Kernel._instance = kernel # type:ignore
assert comm.kernel is kernel # type:ignore
Kernel.clear_instance()

assert manager.get_comm(comm.comm_id) == comm
assert manager.get_comm('foo') is None

Expand Down