ipykernel の API リファレンス

ipykernel (ipython/ipykernel) の公開 API 197 件 —— クラス 36、関数 26、メソッド 135。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	36
関数	26
メソッド	135

API 一覧

classhatch_build.CustomHook

The IPykernel build hook.

methodhatch_build.CustomHook.initialize(version, build_data)

Initialize the hook.

funcipykernel._eventloop_macos.C(classname)

get an ObjC Class by name

funcipykernel._eventloop_macos.n(name)

create a selector name (for ObjC methods)

funcipykernel._eventloop_macos.stop(timer=None, loop=None)

Callback to fire when there's input to be read

classipykernel.comm.comm.BaseComm

The base class for comms.

classipykernel.comm.comm.Comm

Class for communicating between a Frontend and a Kernel

classipykernel.comm.manager.CommManager

A comm manager.

methodipykernel.comm.manager.CommManager.comm_open(stream, ident, msg)

Handler for comm_open messages

classipykernel.compiler.XCachingCompiler

A custom caching compiler.

methodipykernel.compiler.XCachingCompiler.get_code_name(raw_code, code, number)

Get the code name.

funcipykernel.compiler.get_file_name(code)

Get a file name.

funcipykernel.compiler.get_tmp_directory()

Get a temp directory.

funcipykernel.compiler.get_tmp_hash_seed()

Get a temp hash seed.

funcipykernel.compiler.murmur2_x86(data, seed)

Get the murmur2 hash.

funcipykernel.connect.connect_qtconsole(connection_file:str | None=None, argv:list[str] | None=None) -> Popen[Any]

Connect a qtconsole to the current kernel.

funcipykernel.connect.get_connection_info(connection_file:str | None=None, unpack:bool=False) -> str | dict[str, Any]

Return the connection information for the current Kernel.

classipykernel.control.ControlThread

A thread for a control channel.

classipykernel.debugger.Debugger

The debugger class.

methodipykernel.debugger.Debugger.accept_variable(variable_name)

Accept a variable by name.

methodipykernel.debugger.Debugger.attach(message)

Handle an attach message.

methodipykernel.debugger.Debugger.debugInfo(message)

Handle a debug info message.

methodipykernel.debugger.Debugger.dumpCell(message)

Handle a dump cell message.

methodipykernel.debugger.Debugger.handle_stopped_event()

Handle a stopped event.

methodipykernel.debugger.Debugger.modules(message)

Handle a modules message.

methodipykernel.debugger.Debugger.process_request(message)

Process a request.

methodipykernel.debugger.Debugger.setBreakpoints(message)

Handle a set breakpoints message.

methodipykernel.debugger.Debugger.source(message)

Handle a source message.

methodipykernel.debugger.Debugger.stackTrace(message)

Handle a stack trace message.

methodipykernel.debugger.Debugger.start()

Start the debugger.

methodipykernel.debugger.Debugger.stop()

Stop the debugger.

methodipykernel.debugger.Debugger.variables(message)

Handle a variables message.

classipykernel.debugger.DebugpyClient

A client for debugpy.

methodipykernel.debugger.DebugpyClient.connect_tcp_socket()

Connect to the tcp socket.

methodipykernel.debugger.DebugpyClient.disconnect_tcp_socket()

Disconnect from the tcp socket.

methodipykernel.debugger.DebugpyClient.get_host_port()

Get the host debugpy port.

methodipykernel.debugger.DebugpyClient.receive_dap_frame(frame)

Receive a dap frame.

methodipykernel.debugger.DebugpyClient.send_dap_request(msg)

Send a dap request.

classipykernel.debugger.DebugpyMessageQueue

A debugpy message queue.

methodipykernel.debugger.DebugpyMessageQueue.get_message()

Get a message from the queue.

methodipykernel.debugger.DebugpyMessageQueue.put_tcp_frame(frame)

Put a tcp frame in the queue.

classipykernel.debugger.VariableExplorer

A variable explorer.

methodipykernel.debugger.VariableExplorer.track()

Start tracking.

methodipykernel.debugger.VariableExplorer.untrack_all()

Stop tracking.

classipykernel.displayhook.ZMQShellDisplayHook

A displayhook subclass that publishes data using ZeroMQ.

methodipykernel.displayhook.ZMQShellDisplayHook.set_parent(parent)

Set the parent header.

methodipykernel.displayhook.ZMQShellDisplayHook.start_displayhook()

Start the display hook.

methodipykernel.displayhook.ZMQShellDisplayHook.write_output_prompt()

Write the output prompt.

funcipykernel.eventloops.decorator(func)

Integration registration decorator.

funcipykernel.eventloops.enable_gui(gui, kernel=None)

Enable integration with a given GUI

funcipykernel.eventloops.exit_loop()

fall back to main loop

funcipykernel.eventloops.loop_asyncio_exit(kernel)

Exit hook for asyncio

funcipykernel.eventloops.loop_cocoa_exit(kernel)

Exit the cocoa loop.

funcipykernel.eventloops.loop_gtk3_exit(kernel)

Exit the gtk3 loop.

funcipykernel.eventloops.loop_gtk_exit(kernel)

Exit the gtk loop.

funcipykernel.eventloops.loop_tk(kernel)

Start a kernel with the Tk event loop.

funcipykernel.eventloops.loop_tk_exit(kernel)

Exit the tk loop.

funcipykernel.eventloops.loop_wx_exit(kernel)

Exit the wx loop.

classipykernel.gui.gtk3embed.GTKEmbed

A class to embed a kernel into the GTK main event loop.

funcipykernel.gui.gtk3embed.GTKEmbed.dummy(*args, **kw)

No-op.

methodipykernel.gui.gtk3embed.GTKEmbed.stop()

Stop the embed.

classipykernel.gui.gtkembed.GTKEmbed

A class to embed a kernel into the GTK main event loop.

funcipykernel.gui.gtkembed.GTKEmbed.dummy(*args, **kw)

No-op.

methodipykernel.gui.gtkembed.GTKEmbed.stop()

Stop the embed.

classipykernel.heartbeat.Heartbeat

A simple ping-pong style heartbeat that runs in a thread.

methodipykernel.heartbeat.Heartbeat.pick_port()

Pick a port for the heartbeat.

methodipykernel.heartbeat.Heartbeat.run()

Run the heartbeat thread.

classipykernel.inprocess.blocking.BlockingInProcessChannel

A blocking in-process channel.

methodipykernel.inprocess.blocking.BlockingInProcessChannel.call_handlers(msg)

Call the handlers for a message.

classipykernel.inprocess.blocking.BlockingInProcessKernelClient

A blocking in-process kernel client.

classipykernel.inprocess.blocking.BlockingInProcessStdInChannel

A blocking in-process stdin channel.

classipykernel.inprocess.channels.InProcessChannel

Base class for in-process channels.

methodipykernel.inprocess.channels.InProcessChannel.flush(timeout=1.0)

Flush the channel.

methodipykernel.inprocess.channels.InProcessChannel.is_alive()

Test if the channel is alive.

methodipykernel.inprocess.channels.InProcessChannel.process_events()

Process any pending GUI events.

methodipykernel.inprocess.channels.InProcessChannel.start()

Start the channel.

methodipykernel.inprocess.channels.InProcessChannel.stop()

Stop the channel.

classipykernel.inprocess.client.InProcessKernelClient

A client for an in-process kernel.

methodipykernel.inprocess.client.InProcessKernelClient.complete(code, cursor_pos=None)

Get code completion.

method

ipykernel.inprocess.client.InProcessKernelClient.execute(code:str, silent:bool=False, store_history:bool=True, user_expressions:dict[str, Any] | None=None, allow_stdin:bool | None=None, stop_on_error:bool=True) -> str

Execute code on the client.

methodipykernel.inprocess.client.InProcessKernelClient.get_connection_info(session:bool=False) -> KernelConnectionInfo

Get the connection info for the client.

methodipykernel.inprocess.client.InProcessKernelClient.get_control_msg(block=True, timeout=None)

Get a control message.

methodipykernel.inprocess.client.InProcessKernelClient.get_iopub_msg(block=True, timeout=None)

Get an iopub message.

methodipykernel.inprocess.client.InProcessKernelClient.get_shell_msg(block=True, timeout=None)

Get a shell message.

methodipykernel.inprocess.client.InProcessKernelClient.get_stdin_msg(block=True, timeout=None)

Get a stdin message.

methodipykernel.inprocess.client.InProcessKernelClient.history(raw=True, output=False, hist_access_type='range', **kwds)

Get code history.

methodipykernel.inprocess.client.InProcessKernelClient.input(string)

Handle kernel input.

methodipykernel.inprocess.client.InProcessKernelClient.inspect(code, cursor_pos=None, detail_level=0)

Get code inspection.

methodipykernel.inprocess.client.InProcessKernelClient.kernel_info()

Request kernel info.

methodipykernel.inprocess.client.InProcessKernelClient.shutdown(restart=False)

Handle shutdown.

classipykernel.inprocess.ipkernel.InProcessInteractiveShell

An in-process interactive shell.

classipykernel.inprocess.ipkernel.InProcessKernel

An in-process kernel.

classipykernel.inprocess.manager.InProcessKernelManager

A manager for an in-process kernel.

methodipykernel.inprocess.manager.InProcessKernelManager.client(**kwargs)

Get a client for the kernel.

methodipykernel.inprocess.manager.InProcessKernelManager.interrupt_kernel()

Interrupt the kernel.

methodipykernel.inprocess.manager.InProcessKernelManager.is_alive()

Test if the kernel is alive.

methodipykernel.inprocess.manager.InProcessKernelManager.restart_kernel(now=False, **kwds)

Restart the kernel.

methodipykernel.inprocess.manager.InProcessKernelManager.shutdown_kernel()

Shutdown the kernel.

methodipykernel.inprocess.manager.InProcessKernelManager.signal_kernel(signum)

Send a signal to the kernel.

methodipykernel.inprocess.manager.InProcessKernelManager.start_kernel(**kwds)

Start the kernel.

methodipykernel.iostream.BackgroundSocket.send(msg, *args, **kwargs)

Send a message to the socket.

methodipykernel.iostream.BackgroundSocket.send_multipart(*args, **kwargs)

Schedule send in IO thread

methodipykernel.iostream.OutStream.close()

Close the stream.

methodipykernel.iostream.OutStream.set_parent(parent)

Set the parent header.

methodipykernel.iostream.OutStream.writable()

Test whether the stream is writable.

methodipykernel.iostream.OutStream.writelines(sequence)

Write lines to the stream.

classipykernel.ipkernel.IPythonKernel

The IPython Kernel class.

methodipykernel.ipkernel.IPythonKernel.do_apply(content, bufs, msg_id, reply_metadata)

Handle an apply request.

methodipykernel.ipkernel.IPythonKernel.do_clear()

Clear the kernel.

methodipykernel.ipkernel.IPythonKernel.do_complete(code, cursor_pos)

Handle code completion.

methodipykernel.ipkernel.IPythonKernel.do_debug_request(msg)

Handle a debug request.

methodipykernel.ipkernel.IPythonKernel.do_inspect(code, cursor_pos, detail_level=0, omit_sections=())

Handle code inspection.

methodipykernel.ipkernel.IPythonKernel.do_is_complete(code)

Handle an is_complete request.

methodipykernel.ipkernel.IPythonKernel.do_shutdown(restart)

Handle kernel shutdown.

methodipykernel.ipkernel.IPythonKernel.finish_metadata(parent, metadata, reply_content)

Finish populating metadata.

methodipykernel.ipkernel.IPythonKernel.init_metadata(parent)

Initialize metadata.

methodipykernel.ipkernel.IPythonKernel.poll_stopped_queue()

Poll the stopped queue.

methodipykernel.ipkernel.IPythonKernel.start()

Start the kernel.

classipykernel.ipkernel.Kernel

DEPRECATED.

funcipykernel.jsonutil.json_clean(obj)

Deprecated, this is a no-op for jupyter-client>=7.

classipykernel.kernelapp.IPKernelApp

The IPYKernel application class.

methodipykernel.kernelapp.IPKernelApp.cleanup_connection_file()

Clean up our connection file.

methodipykernel.kernelapp.IPKernelApp.close()

Close zmq sockets in an orderly fashion

methodipykernel.kernelapp.IPKernelApp.excepthook(etype, evalue, tb)

Handle an exception.

methodipykernel.kernelapp.IPKernelApp.init_connection_file()

Initialize our connection file.

methodipykernel.kernelapp.IPKernelApp.init_control(context)

Initialize the control channel.

methodipykernel.kernelapp.IPKernelApp.init_crash_handler()

Initialize the crash handler.

methodipykernel.kernelapp.IPKernelApp.init_heartbeat()

start the heart beating

methodipykernel.kernelapp.IPKernelApp.init_iopub(context)

Initialize the iopub channel.

methodipykernel.kernelapp.IPKernelApp.init_kernel()

Create the Kernel object itself

methodipykernel.kernelapp.IPKernelApp.init_poller()

Initialize the poller.

methodipykernel.kernelapp.IPKernelApp.init_shell()

Initialize the shell channel.

methodipykernel.kernelapp.IPKernelApp.init_signal()

Initialize the signal handler.

methodipykernel.kernelapp.IPKernelApp.initialize(argv=None)

Initialize the application.

methodipykernel.kernelapp.IPKernelApp.start()

Start the application.

methodipykernel.kernelapp.IPKernelApp.write_connection_file(**kwargs:Any) -> None

write connection info to JSON file

funcipykernel.kernelapp.main()

Run an IPKernel as an application

classipykernel.kernelbase.Kernel

The base kernel class.

methodipykernel.kernelbase.Kernel.comm_info_request(stream, ident, parent)

Handle a comm info request.

methodipykernel.kernelbase.Kernel.complete_request(stream, ident, parent)

Handle a completion request.

methodipykernel.kernelbase.Kernel.connect_request(stream, ident, parent)

Handle a connect request.

methodipykernel.kernelbase.Kernel.create_subshell_request(socket, ident, parent) -> None

Handle a create subshell request.

methodipykernel.kernelbase.Kernel.debug_request(stream, ident, parent)

Handle a debug request.

methodipykernel.kernelbase.Kernel.delete_subshell_request(socket, ident, parent) -> None

Handle a delete subshell request.

methodipykernel.kernelbase.Kernel.dispatch_shell(msg, subshell_id:str | None=None)

dispatch shell requests

methodipykernel.kernelbase.Kernel.enter_eventloop()

enter eventloop

methodipykernel.kernelbase.Kernel.execute_request(stream, ident, parent)

handle an execute_request

methodipykernel.kernelbase.Kernel.finish_metadata(parent, metadata, reply_content)

Finish populating metadata.

methodipykernel.kernelbase.Kernel.get_process_metric_value(process, name, attribute=None)

Get the process metric value.

methodipykernel.kernelbase.Kernel.history_request(stream, ident, parent)

Handle a history request.

methodipykernel.kernelbase.Kernel.init_metadata(parent)

Initialize metadata.

methodipykernel.kernelbase.Kernel.inspect_request(stream, ident, parent)

Handle an inspect request.

methodipykernel.kernelbase.Kernel.interrupt_request(stream, ident, parent)

Handle an interrupt request.

methodipykernel.kernelbase.Kernel.is_complete_request(stream, ident, parent)

Handle an is_complete request.

methodipykernel.kernelbase.Kernel.kernel_info_request(stream, ident, parent)

Handle a kernel info request.

methodipykernel.kernelbase.Kernel.list_subshell_request(socket, ident, parent) -> None

Handle a list subshell request.

methodipykernel.kernelbase.Kernel.process_control(msg)

dispatch control requests

methodipykernel.kernelbase.Kernel.shutdown_request(stream, ident, parent)

Handle a shutdown request.

methodipykernel.kernelbase.Kernel.start()

methodipykernel.kernelbase.Kernel.usage_request(stream, ident, parent)

Handle a usage request.

classipykernel.kernelspec.InstallIPythonKernelSpecApp

Dummy app wrapping argparse

methodipykernel.kernelspec.InstallIPythonKernelSpecApp.initialize(argv:list[str] | None=None) -> None

Initialize the app.

methodipykernel.kernelspec.InstallIPythonKernelSpecApp.start() -> None

Start the app.

func

ipykernel.kernelspec.get_kernel_dict(extra_arguments:list[str] | None=None, python_arguments:list[str] | None=None) -> dict[str, Any]

Construct dict for kernel.json

classipykernel.log.EnginePUBHandler

A simple PUBHandler subclass that sets root_topic

classipykernel.shellchannel.ShellChannelThread

A thread for a shell channel.

methodipykernel.shellchannel.ShellChannelThread.run() -> None

Run the thread.

classipykernel.subshell.SubshellThread

A thread for a subshell.

methodipykernel.subshell.SubshellThread.run() -> None

Run the thread.

classipykernel.subshell_manager.SubshellManager

A manager of subshells.

methodipykernel.subshell_manager.SubshellManager.close() -> None

Stop all subshells and close all resources.

methodipykernel.subshell_manager.SubshellManager.get_subshell_aborting(subshell_id:str) -> bool

Get the boolean aborting flag of the specified subshell.

methodipykernel.subshell_manager.SubshellManager.list_subshell() -> list[str]

Return list of current subshell ids.

methodipykernel.subshell_manager.SubshellManager.set_subshell_aborting(subshell_id:str, aborting:bool) -> None

Set the aborting flag of the specified subshell.

methodipykernel.subshell_manager.SubshellManager.subshell_id_from_thread_id(thread_id:int) -> str | None

Return subshell_id of the specified thread_id.

classipykernel.thread.BaseThread

Base class for threads.

methodipykernel.thread.BaseThread.run() -> None

Run the thread.

methodipykernel.thread.BaseThread.stop() -> None

Stop the thread.

classipykernel.trio_runner.TrioRunner

A trio loop runner.

methodipykernel.trio_runner.TrioRunner.initialize(kernel, io_loop)

Initialize the runner.

methodipykernel.trio_runner.TrioRunner.interrupt(signum, frame)

Interrupt the runner.

funcipykernel.trio_runner.TrioRunner.loc(coro)

A thread runner context.

methodipykernel.trio_runner.TrioRunner.run()

Run the loop.

funcipykernel.trio_runner.TrioRunner.trio_main()

Run the main loop.

classipykernel.utils.LazyDict

Lazy evaluated read-only dictionary.

classipykernel.zmqshell.KernelMagics

Kernel magics.

methodipykernel.zmqshell.KernelMagics.clear(arg_s)

Clear the terminal.

methodipykernel.zmqshell.KernelMagics.less(arg_s)

Show a file through the pager.

methodipykernel.zmqshell.KernelMagics.subshell(arg_s)

List all current subshells

classipykernel.zmqshell.ZMQInteractiveShell

A subclass of InteractiveShell for ZMQ.

methodipykernel.zmqshell.ZMQInteractiveShell.ask_exit()

Engage the exit actions.

methodipykernel.zmqshell.ZMQInteractiveShell.enable_gui(gui:typing.Any=None) -> None

Enable a given gui.

methodipykernel.zmqshell.ZMQInteractiveShell.get_parent()

Get the parent header.

methodipykernel.zmqshell.ZMQInteractiveShell.init_hooks()

Initialize hooks.

methodipykernel.zmqshell.ZMQInteractiveShell.init_magics()

Initialize magics.

methodipykernel.zmqshell.ZMQInteractiveShell.init_virtualenv()

Initialize virtual environment.

methodipykernel.zmqshell.ZMQInteractiveShell.run_cell(*args, **kwargs)

Run a cell.

この情報について

掲載しているシグネチャは ipython/ipykernel の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る