Skip to main content

Jupyter Python Comm implementation, for usage in ipykernel, xeus-python etc.

Project description

Comm

It provides a way to register a Kernel Comm implementation, as per the Jupyter kernel protocol. It also provides a base Comm implementation and a default CommManager that can be used.

Register a comm implementation in the kernel:

Case 1: Using the default CommManager and the BaseComm implementations

We provide default implementations for usage in IPython:

import comm


class MyCustomComm(comm.base_comm.BaseComm):

    def publish_msg(self, msg_type, data=None, metadata=None, buffers=None, **keys):
        # TODO implement the logic for sending comm messages through the iopub channel
        pass


comm.create_comm = MyCustomComm

This is typically what ipykernel and JupyterLite's pyolite kernel will do.

Case 2: Providing your own comm manager creation implementation

import comm

comm.create_comm = custom_create_comm
comm.get_comm_manager = custom_comm_manager_getter

This is typically what xeus-python does (it has its own manager implementation using xeus's C++ messaging logic).

Comm users

Libraries like ipywidgets can then use the comms implementation that has been registered by the kernel:

from comm import create_comm, get_comm_manager

# Create a comm
comm_manager = get_comm_manager()
comm = create_comm()

comm_manager.register_comm(comm)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

comm-0.1.2.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

comm-0.1.2-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file comm-0.1.2.tar.gz.

File metadata

  • Download URL: comm-0.1.2.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for comm-0.1.2.tar.gz
Algorithm Hash digest
SHA256 3e2f5826578e683999b93716285b3b1f344f157bf75fa9ce0a797564e742f062
MD5 d609639ae2c67bdae8c102c44361d566
BLAKE2b-256 605b0e55c73beb88043811601050c87e871bd1f6cab78c869dc077fa5d0a5b5b

See more details on using hashes here.

Provenance

File details

Details for the file comm-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: comm-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for comm-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9f3abf3515112fa7c55a42a6a5ab358735c9dccc8b5910a9d8e3ef5998130666
MD5 b1c5fc7d5880d29970f1ab844f6851ff
BLAKE2b-256 fc04e740a61ec9df8975bcb32e6698663bc9efa945ac6b2a585728deed6dcced

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page