editor

Module for finding the user’s preferred text editor.

Defines one function, editor(), which invokes the editor defined by the user’s VISUAL environment variable if set. We fall back to the editor defined by the EDITOR environment variable if VISUAL is not set or the specified editor fails (e.g. no DISPLAY for a graphical editor). If neither variable is set, we fall back to one of several common editors, raising an EnvironmentError if we are unable to find one.

This file was adapted from spack.util.editor

editor(*args_in: str, exec_fn: ~typing.Callable[[str, list[str]], int] = <built-in function execv>) → bool

Invoke the user’s editor.

This will try to execute the following, in order:

1. $VISUAL <args> # the “visual” editor (per POSIX)

2. $EDITOR <args> # the regular editor (per POSIX)

3. some default editor (see _default_editors) with <args>

If an environment variable isn’t defined, it is skipped. If it points to something that can’t be executed, we’ll print a warning. And if we can’t find anything that can be executed after searching the full list above, we’ll raise an error.

Parameters:

args_in – args to pass to editor

Optional Arguments:

exec_fn: invoke this function to run