{ } Raw JSON

bundles / jupyter_client 8.10.0 / jupyter_client / client / KernelClient / history

function

jupyter_client.client:KernelClient.history

source: /jupyter_client/client.py:728

Signature

def history(self, raw: bool = True, output: bool = False, hist_access_type: str = range, **kwargs: t.Any) → str

Summary

Get entries from the kernel's history list.

Parameters

raw : bool

If True, return the raw input.

output : bool

If True, then return the output as well.

hist_access_type : str

'range' (fill in session, start and stop params), 'tail' (fill in n)

or 'search' (fill in pattern param).

session : int

For a range request, the session from which to get lines. Session numbers are positive integers; negative ones count back from the current session.

start : int

The first line number of a history range.

stop : int

The final (excluded) line number of a history range.

n : int

The number of lines of history to get for a tail request.

pattern : str

The glob-syntax pattern for a search request.

Returns

: The ID of the message sent.

Aliases

  • jupyter_client.KernelClient.history