Skip to content

main

Main entry point for the somesy CLI.

version 

version(value: bool)

Show somesy version and exit.

Source code in src/somesy/main.py 
16
17
18
19
20
21
@app.callback()
def version(value: bool):
    """Show somesy version and exit."""
    if value:
        typer.echo(f"somesy version: {__version__}")
        raise typer.Exit()

common 

common(
    ctx: typer.Context,
    version: bool = typer.Option(
        None,
        "--version",
        help=version.__doc__,
        callback=version,
    ),
    show_info: bool = typer.Option(
        None, "--info", "-v", help="Enable basic logging."
    ),
    verbose: bool = typer.Option(
        None,
        "--verbose",
        "-vv",
        help="Enable verbose logging.",
    ),
    debug: bool = typer.Option(
        None,
        "--debug",
        "-vvv",
        help="Enable debug logging.",
    ),
)

General flags and arguments for somesy.

Source code in src/somesy/main.py 
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
64
@app.callback()
def common(
    ctx: typer.Context,
    version: bool = typer.Option(
        None, "--version", help=version.__doc__, callback=version
    ),
    show_info: bool = typer.Option(
        None,
        "--info",
        "-v",
        help="Enable basic logging.",
    ),
    verbose: bool = typer.Option(
        None,
        "--verbose",
        "-vv",
        help="Enable verbose logging.",
    ),
    debug: bool = typer.Option(
        None,
        "--debug",
        "-vvv",
        help="Enable debug logging.",
    ),
):
    """General flags and arguments for somesy."""
    init_log()

    if sum(map(int, map(bool, [show_info, verbose, debug]))) > 1:
        typer.echo(
            "Only one of --info, --verbose or --debug may be set!", file=sys.stderr
        )
        raise typer.Exit(1)

    if show_info or verbose or debug:
        # NOTE: only explicitly setting log level if a flag is passed,
        # in order to distinguish from using the "default log level"
        # (needed to check if the user did override the log level as a CLI flag)
        set_log_level(
            SomesyLogLevel.from_flags(info=show_info, verbose=verbose, debug=debug)
        )