History Base Class – xonsh.history.base

Base class of Xonsh History backends.

class xonsh.history.base.History(sessionid=None, **kwargs)[source]

Xonsh history backend base class.

History objects should be created via a subclass of History.

Attributes

rtns (sequence of ints) The return of the command (ie, 0 on success)
inps (sequence of strings) The command as typed by the user, including newlines
tss (sequence of two-tuples of floats) The timestamps of when the command started and finished, including fractions
outs (sequence of strings) The output of the command, if xonsh is configured to save it
gc (A garbage collector or None) The garbage collector
In all of these sequences, index 0 is the oldest and -1 (the last item)  
is the newest.  

Represents a xonsh session’s history.

Parameters:

sessionid : int, uuid, str, optional

Current session identifier, will generate a new sessionid if not set.

all_items()[source]

Get all history items.

append(cmd)[source]

Append a command item into history.

Parameters:

cmd: dict

A dict contains informations of a command. It should contains the following keys like inp, rtn, ts etc.

flush(**kwargs)[source]

Flush the history items to disk from a buffer.

info()[source]

A collection of information about the shell history.

Returns:

dict or collections.OrderedDict

Contains history information as str key pairs.

items()[source]

Get history items of current session.

run_gc(size=None, blocking=True)[source]

Run the garbage collector.

Parameters:

size: None or tuple of a int and a string

Detemines the size and units of what would be allowed to remain.

blocking: bool

If set blocking, then wait until gc action finished.

class xonsh.history.base.HistoryEntry[source]

Represent a command in history.

Attributes

cmd: str The command as typed by the user, including newlines
out: str The output of the command, if xonsh is configured to save it
rtn: int The return of the command (ie, 0 on success)
ts: two-tuple of floats The timestamps of when the command started and finished, including fractions.