SOURCE CODE DOC

Entry Point

Package import

launcher_menus

Python API for Launcher menus

class launcher_menus.LauncherMenu(opts=None, command=None, flag_names=None, fail='warn', **kwargs)

Launcher Menu wrapper object with pre-defined menu options.

Parameters

• opts (Optional[List[str]]) – list: options to be offerred by menu.

• command (Optional[str]) – command to use {dmenu,bemenu,<custom>}

• flag_names (Union[PathLike, dict, None]) – dict providing action: flags or path to cognate yaml.

• fail (str) – ‘warn’: warn, ‘fail’: error, ‘guess’: try creating, else warn

• **kwargs – default values for kwargs of menu

opts

default options to be offerred

command

default menu command to run

flag_names

dictionary of {actions: flag_names}

fail

default failure behaviour

Raises

• TypeError –

• FlagNameNotFoundError –

menu(opts=None, command=None, flag_names=None, fail='warn', **kwargs)

Call menu

Return type

Optional[str]

exception launcher_menus.MenuError

<MENU> errors Base.

menu() call

launcher_menus.LauncherMenu.__call__(self, opts=None, command=None, flag_names=None, fail='warn', **kwargs)

Call <command> menu to collect interactive information.

Parameters

• opts (Optional[List[str]]) – list: options to be offerred by menu.

• command (Optional[str]) – command to use {dmenu,bemenu,<custom>}

• flag_names (Union[PathLike, dict, None]) – dict providing action: flags or path to cognate yaml.

• fail (str) – ‘warn’: warn, ‘fail’: error, ‘guess’: try creating, else warn

• kwargs –

  flag to be called at command line:

  • bottom = bool: show bar at bottom

  • grab = bool: show menu before reading stdin (faster)

  • ignorecase = bool: match items ignoring case

  • wrap = bool: wrap cursor selection

  • ifne = bool: display only if opts

  • nooverlap = bool: do not overlap panels

  • lines = int: list opts on vertical ‘lines’

  • monitor = int: show menu on (bemenu w/ wayland: -1: all)

  • height = int: height of each menu line

  • index = int: select index automatically

  • prompt = str: prompt string of menu

  • prefix = str: prefix added highlighted item

  • scrollbar = str: display scrollbar {none,always,autohide}

  • font = str: font to be used format: “FONT-NAME [SIZE ]”

  • title_background = str: title background color

  • title_foreground = str: title foreground color

  • normal_background = str: normal background color

  • normal_foreground = str: normal foreground color

  • filter_background = str: filter background color

  • filter_foreground = str: filter foreground color

  • high_background = str: highlight background color

  • high_foreground = str: highlight foreground color

  • scroll_background = str: scrollbar background color

  • scroll_foreground = str: scrollbar foreground color

  • selected_background = str: selected background color

  • selected_foreground = str: selected foreground color

  • windowid = str: embed into windowid

Raises

• CommandError –

• UsageError –

• FlagNameNotFoundError –

• ValueError – bad scrollbar options

Return type

Optional[str]

Returns

User’s selected opt from opts or overridden-entered choice else None [Esc]

---

Errors

Error/Warnings

Menu errors

exception launcher_menus.errors.CommandError(args, err)

<MENU> command failed.

Parameters

• args (list) – args called with <menu> command.

• err (str) – error raised by <menu> command.

exception launcher_menus.errors.FlagNameNotFoundError(command, flag)

Flag not found for <menu> in menu-cfgs/<menu>.yml, nor provided via **flags or config_yml.

Parameters

• command (str) – command that was unsed as <menu>.

• flag (str) – flag that was not identified from yml file.

exception launcher_menus.errors.MenuError

<MENU> errors Base.

exception launcher_menus.errors.UsageError(args, err)

Usage error described by <menu> command.

Parameters

• args (list) – args called with <menu> command.

• err (str) – error raised by <menu> command.

---

Structure

Themes

Launcher Menu Themes

launcher_menus.themes.custom_themes(custom_config=None)

Read configuration file themes.yml from standard configuration locations and generate custom themes

Return type

Dict[str, LauncherMenu]

launcher_menus.themes.emergency_prompt = <launcher_menus.functions.LauncherMenu object>

Emergency prompt menu

launcher_menus.themes.menu = <launcher_menus.functions.LauncherMenu object>

Plain menu object.

command defaults to the first one found to be installed.

launcher_menus.themes.password_prompt = <launcher_menus.functions.LauncherMenu object>

Password prompt menu.