Skip to content

cli

Functions and classes for handling the CLI call.

Classes:

Functions:

CustomHelpFormatter 

CustomHelpFormatter(
    prog: str,
    indent_increment: int = 2,
    max_help_position: int = 4,
    width: Optional[int] = None,
    **kwargs: Any,
)

Bases: RawTextHelpFormatter

Formatter for generating usage messages and argument help strings.

Only the name of this class is considered a public API. All the methods provided by the class are considered an implementation detail.

Source code in src/arx/cli.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def __init__(
    self,
    prog: str,
    indent_increment: int = 2,
    max_help_position: int = 4,
    width: Optional[int] = None,
    **kwargs: Any,
) -> None:
    super().__init__(
        prog,
        indent_increment=indent_increment,
        max_help_position=max_help_position,
        width=width,
        **kwargs,
    )

app 

app() -> None

Run the application.

Source code in src/arx/cli.py 
107
108
109
110
111
112
113
114
115
116
def app() -> None:
    """Run the application."""
    args_parser = get_args()
    args = args_parser.parse_args()

    if args.version:
        return show_version()

    arx = ArxMain()
    return arx.run(**dict(args._get_kwargs()))

get_args 

get_args() -> ArgumentParser

Get the CLI arguments.

Source code in src/arx/cli.py 
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def get_args() -> argparse.ArgumentParser:
    """Get the CLI arguments."""
    parser = argparse.ArgumentParser(
        prog="arx",
        description=(
            "Arx is a compiler that uses the power of llvm to bring a modern "
            "infra-structure."
        ),
        epilog=(
            "If you have any problem, open an issue at: "
            "https://github.com/arxlang/arx"
        ),
        add_help=True,
        formatter_class=CustomHelpFormatter,
    )
    parser.add_argument(
        "input_files",
        nargs="*",
        type=str,
        help="The input file",
    )
    parser.add_argument(
        "--version",
        action="store_true",
        help="Show the version of the installed MakIm tool.",
    )

    parser.add_argument(
        "--output-file",
        type=str,
        help="The output file",
    )

    parser.add_argument(
        "--lib",
        dest="is_lib",
        action="store_true",
        help="build source code as library",
    )

    parser.add_argument(
        "--show-ast",
        action="store_true",
        help="Show the AST for the input source code",
    )

    parser.add_argument(
        "--show-tokens",
        action="store_true",
        help="Show the tokens for the input source code",
    )

    parser.add_argument(
        "--show-llvm-ir",
        action="store_true",
        help="Show the LLVM IR for the input source code",
    )

    parser.add_argument(
        "--shell",
        action="store_true",
        help="Open Arx in a shell prompt",
    )

    return parser

show_version 

show_version() -> None

Show the application version.

Source code in src/arx/cli.py 
102
103
104
def show_version() -> None:
    """Show the application version."""
    print(__version__)