awsc.base_control.Describer

class awsc.base_control.Describer(parent, alignment, dimensions, *args, entry, entry_key=None, **kwargs)

Describers are AWS-aware text browsers. When provided with a resource ID, Describer subclasses contact the AWS API on a specified API endpoint, retrieve information about the resource, and display it or a subpath (depending on response format) in a syntax-highlighted, pretty-printed JSON form.

Attributes:

border

Returns the border of the control.

corners

Read-only property for calculating the four corners of the block.

describe_kwarg_name

filter

Property.

height

Read-only property for the height of the block.

inner

Read-only property for calculating the four inner corners of the block.

w_in

Read-only property for the inner width of the block.

width

Read-only property for the width of the block.

Methods

Autohotkey(key[, tooltip, is_validated, ...])	Decorator that automatically assigns a hotkey to a function upon instantiation.
add_block(block)	Adds a new child block to this block.
add_hotkey(hotkey, action[, tooltip, ...])	Adds a new hotkey to the control.
add_text(text)	Adds raw text to the text browser.
autohotkey_condition(hotkey)	Autohotkey condition callback.
before_paint()	Hook function for acting on the block before any blocks are painted for the current frame.
bottomright()	Returns the coordinates of the bottom right corner of the block.
clear()	Empties out the text browser.
clear_blocks([tag])	Removes all blocks with the matching tag from the child blocks of this block.
command(cmd, **kwargs)	Command caller.
command_wrapper(cmd, data_arg, **kwargs)	Command wrapper.
confirm_template(*args[, hotkey, hotkey_tooltip])	Creates a confirmation sequence.
copy_contents(*args)	Hotkey callback for copying the contents of the text browser to the system clipboard.
end(*args)	Hotkey callback for scrolling to bring the final line in view within the browser.
home(*args)	Hotkey callback for jumping to the top of the text browser.
input(key)	Input handler hook function.
opener(**kwargs)	Session-aware initializer for this class.
paint()	Hook function for painting the block.
pgdown(*args)	Hotkey callback for scrolling down within the browser by a single page.
pgup(*args)	Hotkey callback for scrolling up within the browser by a single page.
populate_describe_kwargs(**kwargs)	Populates the describe kwargs dict, which is what will be sent to the AWS API when querying the resource.
populate_entry(**kwargs)	Populates the entry fields of the Describer based on the entry and entry_key received.
raw([line])	Generates the raw output of the text browser.
rawlines()	Generates a list of raw lines.
refresh_data(*args, **kwargs)	Data refresh callback.
register()	Classmethod to register this class and all of its subclasses with the commander control.
remove_block(block)	Removes a specific block from this block.
reparent()	Shorthand function for removing a Block from its parent and re-adding it.
scroll_down(*args)	Hotkey callback for scrolling down within the browser by a single line.
scroll_left(*args)	Hotkey callback for scrolling left within the browser by a single character column.
scroll_right(*args)	Hotkey callback for scrolling right within the browser by a single character column.
scroll_up(*args)	Hotkey callback for scrolling up within the browser by a single line.
title_info()	Title info functions are used to determine the title info after a lister has been instantiated.
toggle_wrap(*args, **kwargs)	Hotkey callback for toggling the wrap flag.
topleft()	Returns the coordinates of the top left corner of the block.
validate_hotkey(key)	Validates whether a hotkey can be used based on the state of the control.

on_become_frame

__init__(parent, alignment, dimensions, *args, entry, entry_key=None, **kwargs)

Initializes a HotkeyControl object.

Methods

__init__(parent, alignment, dimensions, ...)	Initializes a HotkeyControl object.
add_block(block)	Adds a new child block to this block.
add_hotkey(hotkey, action[, tooltip, ...])	Adds a new hotkey to the control.
add_text(text)	Adds raw text to the text browser.
autohotkey_condition(hotkey)	Autohotkey condition callback.
before_paint()	Hook function for acting on the block before any blocks are painted for the current frame.
bottomright()	Returns the coordinates of the bottom right corner of the block.
clear()	Empties out the text browser.
clear_blocks([tag])	Removes all blocks with the matching tag from the child blocks of this block.
command(cmd, **kwargs)	Command caller.
command_wrapper(cmd, data_arg, **kwargs)	Command wrapper.
confirm_template(*args[, hotkey, hotkey_tooltip])	Creates a confirmation sequence.
copy_contents(*args)	Hotkey callback for copying the contents of the text browser to the system clipboard.
end(*args)	Hotkey callback for scrolling to bring the final line in view within the browser.
home(*args)	Hotkey callback for jumping to the top of the text browser.
input(key)	Input handler hook function.
on_become_frame()
opener(**kwargs)	Session-aware initializer for this class.
paint()	Hook function for painting the block.
pgdown(*args)	Hotkey callback for scrolling down within the browser by a single page.
pgup(*args)	Hotkey callback for scrolling up within the browser by a single page.
populate_describe_kwargs(**kwargs)	Populates the describe kwargs dict, which is what will be sent to the AWS API when querying the resource.
populate_entry(**kwargs)	Populates the entry fields of the Describer based on the entry and entry_key received.
raw([line])	Generates the raw output of the text browser.
rawlines()	Generates a list of raw lines.
refresh_data(*args, **kwargs)	Data refresh callback.
register()	Classmethod to register this class and all of its subclasses with the commander control.
remove_block(block)	Removes a specific block from this block.
reparent()	Shorthand function for removing a Block from its parent and re-adding it.
scroll_down(*args)	Hotkey callback for scrolling down within the browser by a single line.
scroll_left(*args)	Hotkey callback for scrolling left within the browser by a single character column.
scroll_right(*args)	Hotkey callback for scrolling right within the browser by a single character column.
scroll_up(*args)	Hotkey callback for scrolling up within the browser by a single line.
title_info()	Title info functions are used to determine the title info after a lister has been instantiated.
toggle_wrap(*args, **kwargs)	Hotkey callback for toggling the wrap flag.
topleft()	Returns the coordinates of the top left corner of the block.
validate_hotkey(key)	Validates whether a hotkey can be used based on the state of the control.

Attributes

border	Returns the border of the control.
category
corners	Read-only property for calculating the four corners of the block.
default_entry_key
describe_kwarg_is_list
describe_kwarg_name
describe_kwargs_override
describe_method
filter	Property.
height	Read-only property for the height of the block.
inner	Read-only property for calculating the four inner corners of the block.
main_provider
object_path
prefix
resource_type
subcategory
title
w_in	Read-only property for the inner width of the block.
width	Read-only property for the width of the block.