xonsh.history.json

Implements JSON version of xonsh history backend.

class xonsh.history.json.JsonCommandField(field, hist, default=None)

A field in the ‘cmds’ portion of history.

Represents a field in the ‘cmds’ portion of history.

Will query the buffer for the relevant data, if possible. Otherwise it will lazily acquire data from the file.

Parameters:

fieldstr

The name of the field to query.

histHistory object

The history object to query.

defaultoptional

The default value to return if key is not present.

count(value) → integer -- return number of occurrences of value

i_am_at_the_front()

Tests if the command field is at the front of the queue.

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

class xonsh.history.json.JsonHistory(filename=None, sessionid=None, buffersize=100, gc=True, save_cwd=None, **meta)

Xonsh history backend implemented with JSON files.

JsonHistory implements an extra action: diff

Represents a xonsh session’s history as an in-memory buffer that is periodically flushed to disk.

Parameters:

filenamestr, optional

Location of history file, defaults to $XONSH_DATA_DIR/history_json/xonsh-{sessionid}.json.

sessionidint, uuid, str, optional

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

buffersizeint, optional

Maximum buffersize in memory.

metaoptional

Top-level metadata to store along with the history. The kwargs ‘cmds’ and ‘sessionid’ are not allowed and will be overwritten.

gcbool, optional

Run garbage collector flag.

all_items(newest_first=False, **kwargs)

Returns all history as found in XONSH_DATA_DIR.

yield format: {‘inp’: cmd, ‘rtn’: 0, …}

append(cmd)

Appends command to history. Will periodically flush the history to file.

Parameters:

cmddict

This dict contains information about the command that is to be added to the history list. It should contain the keys inp, rtn and ts. These key names mirror the same names defined as instance variables in the HistoryEntry class. Additionally, an optional key spc may be present which will affect commands from being stored if ignorespace is in $HISTCONTROL.

Returns:

hfJsonHistoryFlusher or None

The thread that was spawned to flush history

clear()

Clears the current session’s history from both memory and disk.

delete(pattern)

Deletes all entries in history which matches a pattern.

flush(at_exit=False)

Flushes the current command buffer to disk.

Parameters:

at_exitbool, optional

Whether the JsonHistoryFlusher should act as a thread in the background, or execute immediately and block.

Returns:

hfJsonHistoryFlusher or None

The thread that was spawned to flush history

info()

A collection of information about the shell history.

Returns:

dict or collections.OrderedDict

Contains history information as str key pairs.

is_ignored(cmd)

Determines if a history item should be added to the event history. Call this in your append method.

Parameters:

cmd: dict

The prospective item to append (structure is the same as the append method).

Returns:

bool

True if the item should be appended, False if not.

items(newest_first=False)

Display history items of current session.

pull(**kwargs)

Pull history from other parallel sessions.

run_gc(size=None, blocking=True, force=False, **_)

Run the garbage collector.

Parameters:

size: None or tuple of a int and a string

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

blocking: bool

If set blocking, then wait until gc action finished.

property ignore_regex

class xonsh.history.json.JsonHistoryFlusher(filename, buffer, queue, cond, at_exit=False, skip=None, *args, **kwargs)

Flush shell history to disk periodically.

Thread for flushing history.

dump()

Write the cached history to external storage.

getName()

Return a string used for identification purposes only.

This method is deprecated, use the name attribute instead.

i_am_at_the_front()

Tests if the flusher is at the front of the queue.

isDaemon()

Return whether this thread is a daemon.

This method is deprecated, use the daemon attribute instead.

is_alive()

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. See also the module function enumerate().

join(timeout=None)

Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

setDaemon(daemonic)

Set whether this thread is a daemon.

This method is deprecated, use the .daemon property instead.

setName(name)

Set the name string for this thread.

This method is deprecated, use the name attribute instead.

start()

Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.

property daemon

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

property ident

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

property name

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

property native_id

Native integral thread ID of this thread, or None if it has not been started.

This is a non-negative integer. See the get_native_id() function. This represents the Thread ID as reported by the kernel.

class xonsh.history.json.JsonHistoryGC(wait_for_shell=True, size=None, force=False, *args, **kwargs)

Shell history garbage collection.

Thread responsible for garbage collecting old history.

May wait for shell (and for xonshrc to have been loaded) to start work.

files(only_unlocked=False)

Find and return the history files. Optionally locked files may be excluded.

This is sorted by the last closed time. Returns a list of (file_size, timestamp, number of cmds, file name) tuples.

getName()

Return a string used for identification purposes only.

This method is deprecated, use the name attribute instead.

isDaemon()

Return whether this thread is a daemon.

This method is deprecated, use the daemon attribute instead.

is_alive()

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. See also the module function enumerate().

join(timeout=None)

Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

setDaemon(daemonic)

Set whether this thread is a daemon.

This method is deprecated, use the .daemon property instead.

setName(name)

Set the name string for this thread.

This method is deprecated, use the name attribute instead.

start()

Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.

property daemon

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

property ident

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

property name

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

property native_id

Native integral thread ID of this thread, or None if it has not been started.

This is a non-negative integer. See the get_native_id() function. This represents the Thread ID as reported by the kernel.