Skip to content

CLI Calculator Module

src.cli.calculator

This module provides CLI commands for performing basic arithmetic operations.

It uses the typer library to define commands for addition, subtraction, multiplication, and division. Each command takes two numbers as input and prints the result to the console.

The module relies on the core.calculator module for the actual arithmetic operations.

add(a, b)

Add two numbers.

PARAMETER DESCRIPTION
a

The first number to add.

TYPE: float

b

The second number to add.

TYPE: float

Source code in src/cli/calculator.py 
22
23
24
25
26
27
28
29
30
31
32
@calculator_app.command()
def add(a: float, b: float) -> None:
    """
    Add two numbers.

    Args:
        a (float): The first number to add.
        b (float): The second number to add.
    """
    result = calculator.add(a, b)
    typer.echo(f"The result of addition is: {result}")

subtract(a, b)

Subtract two numbers.

PARAMETER DESCRIPTION
a

The number to subtract from.

TYPE: float

b

The number to subtract.

TYPE: float

Source code in src/cli/calculator.py 
35
36
37
38
39
40
41
42
43
44
45
@calculator_app.command()
def subtract(a: float, b: float) -> None:
    """
    Subtract two numbers.

    Args:
        a (float): The number to subtract from.
        b (float): The number to subtract.
    """
    result = calculator.subtract(a, b)
    typer.echo(f"The result of subtraction is: {result}")

multiply(a, b)

Multiply two numbers.

PARAMETER DESCRIPTION
a

The first number to multiply.

TYPE: float

b

The second number to multiply.

TYPE: float

Source code in src/cli/calculator.py 
48
49
50
51
52
53
54
55
56
57
58
@calculator_app.command()
def multiply(a: float, b: float) -> None:
    """
    Multiply two numbers.

    Args:
        a (float): The first number to multiply.
        b (float): The second number to multiply.
    """
    result = calculator.multiply(a, b)
    typer.echo(f"The result of multiplication is: {result}")

divide(a, b)

Divide two numbers. Args: a (float): The numerator. b (float): The denominator.

Source code in src/cli/calculator.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
@calculator_app.command()
def divide(a: float, b: float) -> None:
    """
    Divide two numbers.
    Args:
        a (float): The numerator.
        b (float): The denominator.
    """
    try:
        result = calculator.divide(a, b)
        typer.echo(f"The result of division is: {result}")
    except ValueError as e:
        typer.echo(f"Error: {e}")

main(version=typer.Option(None, '--version', '-v', help="Show the application's version and exit.", callback=_version_callback, is_eager=True))

Handles the --version flag

Source code in src/cli/calculator.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
@calculator_app.callback()
def main(
    version: Optional[bool] = typer.Option(
        None,
        "--version",
        "-v",
        help="Show the application's version and exit.",
        callback=_version_callback,
        is_eager=True,
    ),
) -> None:
    """Handles the --version flag"""
    return

CLI Greeter Module

src.cli.greeter

This module provides CLI commands for greeting people.

The module relies on the core.greeter module for the actual greeting logic.

greet(name='')

Greet someone.

PARAMETER DESCRIPTION
name

The name of the person to greet. If name is omitted, the world will be greeted.

TYPE: Annotated[str, Argument(help='The name of the person to greet.')] DEFAULT: ''

Source code in src/cli/greeter.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@greeter_app.command()
def greet(
    name: Annotated[
        str,
        typer.Argument(help="The name of the person to greet."),
    ] = "",
) -> None:
    """
    Greet someone.

    Args:
        name: The name of the person to greet. If name is omitted, the world
            will be greeted.
    """
    greeting = greeter.greeting(name)
    typer.echo(greeting)

main(version=typer.Option(None, '--version', '-v', help="Show the application's version and exit.", callback=_version_callback, is_eager=True))

Handles the --version flag

Source code in src/cli/greeter.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
@greeter_app.callback()
def main(
    version: Optional[bool] = typer.Option(
        None,
        "--version",
        "-v",
        help="Show the application's version and exit.",
        callback=_version_callback,
        is_eager=True,
    ),
) -> None:
    """Handles the --version flag"""
    return