Skip to content

Argument Parsing

parse_arguments()

Parse command line arguments and return the command to be explained.

Returns:

Name Type Description
str

The command to be explained.

Raises:

Type Description
SystemExit

If the help option is specified.
SystemExit

If the required argument is missing.
Source code in peter_explains/args.py 
10
11
12
13
14
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def parse_arguments():
    """
    Parse command line arguments and return the command to be explained.

    Returns:
        str: The command to be explained.

    Raises:
        SystemExit: If the help option is specified.
        SystemExit: If the required argument is missing.
    """
    parser = argparse.ArgumentParser(
        description="Linux commands explained the Peter Griffin way. Seriously.",
        add_help=False,
    )
    parser.add_argument(
        "--version", action="version", version=f"Peter Explains (peter) v{__version__}"
    )
    parser.add_argument(
        "-h",
        "--help",
        action="store_true",
        help="Display the help message",
    )

    parser.add_argument(
        "--api",
        metavar="<API_KEY>",
        help="Set the Google AI platform API key",
    )

    parser.add_argument(
        "--delete-api",
        action="store_true",
        help="Deletes the Google AI platform API key",
    )

    # add --clear-cache argument to clear cache
    parser.add_argument(
        "--delete-cache",
        action="store_true",
        help="Delete the cache",
    )

    parser.add_argument("command", nargs="?", help="The command to be explained")

    args = parser.parse_args()

    # Handle API key operations
    google_api_key = GoogleApiKey()

    if args.api:
        google_api_key.set(args.api)
        sys.exit(0)

    if args.delete_api:
        google_api_key.clear()
        sys.exit(0)

    # Handle cache operations
    cache = PeterCache()

    if args.delete_cache:
        cache.clear()
        sys.exit(0)

    if args.help:
        show_peter_help()
        sys.exit(0)

    # Handle missing required argument
    if not args.command:
        show_peter_help()
        sys.exit(1)

    else:
        command = args.command.strip().lower()
        return command