awsc.session.Session

class awsc.session.Session(config, highlight_color, generic_color, common)

Session manager object. Manages what’s visible on the screen. Also stores some information related to the current user session.

Attributes:

jqcdict

JQ cache. Stores compiled JQ objects keyed by JQ statement.

uiawsc.termui.ui.UI

The main UI object of AWSC.

configawsc.config.config.Config

The configuration object also stored in Common. We cannot import Common.

context_update_hookslist(callable)

A list of hooks to run when the active context is updated.

info_displayawsc.info.InfoDisplay

The top left information display, which contains information about the active session.

global_hotkey_tooltipsdict

A dict of global hotkeys and associated tooltips.

message_displayawsc.info.NeutralDialog

The message display is a dialog on the backend which shows a flashed message to the user.

_message_labelslist(awsc.termui.dialog.DialogFieldLabel)

Label fields for each line of the message display.

_contextstr

Current AWS context.

_regionstr

Current AWS region.

_ssh_keystr

Current SSH key.

stacklist

A stack of stack frames.

stack_framelist

The topmost stack frame. This frame is the one that is being displayed to the user.

resource_mainawsc.termui.control.Control

The main control of the stack frame. Usually the first element passed in a new frame.

service_providerawsc.aws.AWS

The AWS connection provider.

message_timefloat

The remaining amount of time for which a flashed message continues to be displayed.

last_ticktime.time

The timestamp when the last tick was executed, for deltatime purposes.

filterer: awsc.commander.Filterer

The filterer object that is open in the session, if there is one.

commander: awsc.commander.Commander

The commander object that is open in the session, if there is one.

commander_optionsdict(str, callable)

A map of available commander options mapped to the callback for that command.

control_registrydict(str, callable)

A map of available awsc control opener functions keyed by classname.

commonawsc.common.Common

Reference back to the common object.

Methods

extend_frame(control)	Adds an additional control to the current frame.
get_context_dashboard_layout()	Returns the configured dashboard layout for the currently selected context.
get_default_dashboard_layout()	Returns the default configured dashboard layout.
get_keypair_association(keypair_id)	Fetches the keypair association of a keypair from the configuration.
jq(stmt)	Creates a compiled JQ object, or fetches from cache if it exists.
pop_frame(*args)	Pops the topmost frame of the stack.
push_frame(new_frame)	Pushes a new frame to the stack, replacing the currently active frame for display.
remove_from_frame(control)	Removes a control from the current frame.
replace_frame(new_frame[, drop_stack])	Removes the topmost stack frame, replacing it with a new frame.
set_keypair_association(keypair_id, key_name)	Sets the association between a keypair and an SSH key.
set_message(text, color)	Flashes a message to the user.
set_version_information()	Updates the version information on the info display.
textedit(value)	Open the text editor command specified in the editor_command configuration option to edit a text.
tick()	Ticker function.

__init__(config, highlight_color, generic_color, common)

Methods

__init__(config, highlight_color, ...)
extend_frame(control)	Adds an additional control to the current frame.
get_context_dashboard_layout()	Returns the configured dashboard layout for the currently selected context.
get_default_dashboard_layout()	Returns the default configured dashboard layout.
get_keypair_association(keypair_id)	Fetches the keypair association of a keypair from the configuration.
jq(stmt)	Creates a compiled JQ object, or fetches from cache if it exists.
pop_frame(*args)	Pops the topmost frame of the stack.
push_frame(new_frame)	Pushes a new frame to the stack, replacing the currently active frame for display.
remove_from_frame(control)	Removes a control from the current frame.
replace_frame(new_frame[, drop_stack])	Removes the topmost stack frame, replacing it with a new frame.
set_keypair_association(keypair_id, key_name)	Sets the association between a keypair and an SSH key.
set_message(text, color)	Flashes a message to the user.
set_version_information()	Updates the version information on the info display.
textedit(value)	Open the text editor command specified in the editor_command configuration option to edit a text.
tick()	Ticker function.

Attributes

context	Property.
context_auth	Property.
context_data	Property.
context_perm_auth	Property.
region	Property.
ssh_key	Property.