Skip to content

CLI

elva.apps.editor.cli

CLI definition.

Functions:

  • cli –

    Edit text documents collaboratively in real-time.

Attributes:

APP_NAME = 'editor' module-attribute

The name of the app.

cli(config, *args, **kwargs)

Edit text documents collaboratively in real-time.

Parameters:

  • config (dict) –

    the merged configuration from CLI parameters and files.

  • args (tuple, default: () ) –

    unused positional arguments.

  • kwargs (dict, default: {} ) –

    parameters passed from the CLI.

Source code in src/elva/apps/editor/cli.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@click.command(name=APP_NAME)
@common_options
@click.option(
    "--ansi-color/--no-ansi-color",
    "ansi_color",
    is_flag=True,
    help="Use the terminal ANSI colors for the Textual colortheme.",
)
@file_paths_option_and_argument
@pass_config_for(APP_NAME)
def cli(
    config: dict,
    *args: tuple,
    **kwargs: dict,
):
    """
    Edit text documents collaboratively in real-time.
    \f

    Arguments:
        config: the merged configuration from CLI parameters and files.
        args: unused positional arguments.
        kwargs: parameters passed from the CLI.
    """
    logging = import_("logging")
    _log = import_("elva.log")
    app = import_("elva.apps.editor.app")

    # logging
    _log.LOGGER_NAME.set(__package__)
    log = logging.getLogger(__package__)

    log_path = config.get("log")
    level_name = config.get("verbose")
    if level_name is not None and log_path is not None:
        handler = logging.FileHandler(log_path)
        handler.setFormatter(_log.DefaultFormatter())
        log.addHandler(handler)

        level = logging.getLevelNamesMapping()[level_name]
        log.setLevel(level)

    # run app
    ui = app.UI(config)
    ui.run()

    # reflect the app's return code
    ctx = click.get_current_context()
    ctx.exit(ui.return_code or 0)