bundles / jupyter_client latest / jupyter_client / client / KernelClient / inspect

function

`jupyter_client.client:KernelClient.inspect`

source: /jupyter_client/client.py:697

Signature

def inspect(self, code: str, cursor_pos: int | None = None, detail_level: int = 0) → str

Summary

Get metadata information about an object in the kernel's namespace.

Extended Summary

It is up to the kernel to determine the appropriate object to inspect.

Parameters

code : str: The context in which info is requested. Can be anything between a variable name and an entire cell.
cursor_pos : int, optional: The position of the cursor in the block of code where the info was requested. Default: len(code)
detail_level : int, optional: The level of detail for the introspection (0-2)

Returns

: The msg_id of the message sent.

Aliases

jupyter_client.KernelClient.inspect