bumblebee_status.core package

Submodules

bumblebee_status.core.config module

class bumblebee_status.core.config.Config(args)

Bases: Store

Represents the configuration of bumblebee-status (either via config file or via CLI)

Parameters:

args – The arguments passed via the commandline

autohide(name)

debug()

errorhide(name)

iconset()

interval(default=1)

load_config(filename, content=None)

logfile()

modules()

popup_font_size(default=12)

reverse()

theme()

bumblebee_status.core.config.all_modules()

Returns a list of all available modules (either core or contrib)

Returns:

list of modules

Return type:

list of strings

class bumblebee_status.core.config.print_usage(option_strings, dest, nargs=None, **kwargs)

Bases: Action

print_modules()

print_themes()

bumblebee_status.core.decorators module

bumblebee_status.core.decorators.every(hours=0, minutes=0, seconds=0)

bumblebee_status.core.decorators.log = <Logger bumblebee_status.core.decorators (WARNING)>

Specifies that a module should never update (i.e. has static content). This means that its update() method will never be invoked

Parameters:

init – The __init__() method of the module

Returns:

Wrapped method that sets the module’s interval to “never”

bumblebee_status.core.decorators.never(init)

bumblebee_status.core.decorators.scrollable(func)

bumblebee_status.core.event module

bumblebee_status.core.event.clear()

bumblebee_status.core.event.register(event, callback, *args, **kwargs)

bumblebee_status.core.event.register_exclusive(event, callback, *args, **kwargs)

bumblebee_status.core.event.trigger(event, *args, **kwargs)

bumblebee_status.core.event.unregister(event)

bumblebee_status.core.input module

class bumblebee_status.core.input.Object

Bases: object

bumblebee_status.core.input.button_name(button)

bumblebee_status.core.input.register(obj, button=None, cmd=None, wait=False)

bumblebee_status.core.input.trigger(event)

bumblebee_status.core.module module

class bumblebee_status.core.module.Error(module, error, config=<core.config.Config object>, theme=None)

Bases: Module

Represents an “error” module

Parameters:

• module – The module name that produced the error

• error – The error message to display

• config – Configuration to apply to the module (defaults to an empty configuration)

• theme – Theme for this module, defaults to None, which means whatever is configured in “config”

full_text(widget)

state(widget)

class bumblebee_status.core.module.Module(config=<core.config.Config object>, theme=None, widgets=[])

Bases: Object

Represents a module (single piece of functionality) of the bar

Parameters:

• config – Configuration to apply to the module (defaults to an empty configuration)

• theme – Theme for this module, defaults to None, which means whatever is configured in “config”

• widgets – A list of bumblebee_status.widget.Widget objects that the module is comprised of

add_widget(full_text='', name=None, hidden=False)

clear_widgets()

hidden()

internal_update(trigger_redraw=False)

parameter(key, default=None)

register_callbacks()

scroll()

set(key, value)

state(widget)

threshold_state(value, warn, crit)

update()

update_wrapper()

widget(name=None, widget_id=None)

widgets()

bumblebee_status.core.module.import_user(module_short, config, theme)

bumblebee_status.core.module.load(module_name, config=<core.config.Config object>, theme=None)

bumblebee_status.core.output module

bumblebee_status.core.output.assign(src, dst, key, src_key=None, default=None)

class bumblebee_status.core.output.block(theme, module, widget)

Bases: object

dict()

get(key, default=None)

is_pango(attr)

pangoize(text)

set(key, value)

bumblebee_status.core.output.dump_json(obj)

class bumblebee_status.core.output.i3(theme=<core.theme.Theme object>, config=<core.config.Config object>)

Bases: object

blocks(module)

content()

draw(what, args=None)

modules(modules=None)

scroll_left()

scroll_right()

separator_block(module, widget)

start()

statusline()

stop()

theme(new_theme=None)

toggle_minimize(event)

update(affected_modules=None, redraw_only=False, force=False)

update2(affected_modules=None, redraw_only=False, force=False)

wait(interval)

bumblebee_status.core.theme module

class bumblebee_status.core.theme.Theme(name='default', iconset='auto', raw_data=None)

Bases: object

color(name, default=None)

get(key, widget=None, default=None)

keywords()

load(name, subdir='')

load_keywords(name)

bumblebee_status.core.theme.merge_replace(value, new_value, key)

bumblebee_status.core.theme.themes()

bumblebee_status.core.widget module

class bumblebee_status.core.widget.Widget(full_text='', name=None, widget_id=None, hidden=False)

Bases: Store, Object

full_text(value=None)

index()

property module

state()

theme(attribute)

Module contents