Argparse

Table of contents

1. Argparse
   1. New Parser(String, String, String) -> Parser
   2. Parse.addString(String, String, Bool, string -> Optional)
   3. Parser.addNumber(String, String, Bool, String -> Optional)
   4. Parser.addBool(String, String, Bool, String -> Optional)
   5. Parser.addList(String, String, Bool, String -> Optional)
   6. Parser.parse() -> Result

Argparse

To make use of the Argparse module an import is required.

from Argparse import Parse;

New Parser(String, String, String) -> Parser

To create a new parser instance, call the Parser class with the 3 required string arguments; name, description, and user provided usage.

var parser = Parser("prog_name", "Program to do all the things", "");

Parse.addString(String, String, Bool, string -> Optional)

To add a new string argument, call the method below with at least the 3 required arguments; name, description, and boolean indicating the flag is required. A fourth argument can be passed to give the parser a custom name for the given flag.

parser.addString("-b", "birth month", false, "month");

Parser.addNumber(String, String, Bool, String -> Optional)

To add a new number argument, call the method below with at least the 3 required arguments; name, description, and boolean indicating the flag is required. A fourth argument can be passed to give the parser a custom name for the given flag.

parser.addNumber("--port", "server port", false);

Parser.addBool(String, String, Bool, String -> Optional)

To add a new bool argument, call the method below with at least the 3 required arguments; name, description, and boolean indicating the flag is required. A fourth argument can be passed to give the parser a custom name for the given flag.

parser.addBool("-s", "run securely", true, "secure");

Parser.addList(String, String, Bool, String -> Optional)

To add a new list argument, call the method below with at least the 3 required arguments; name, description, and boolean indicating the flag is required. A fourth argument can be passed to give the parser a custom name for the given flag.

parser.addList("-u", "active users", true, "users");

Parser.parse() -> Result

The parse method needs to be called to process the given flags against the configured flags. parse returns a Result value that, on success, will need to be unwrapped to access an instance of the Args class.

const args = parser.parse().match(
    def (result) => result,
    def (error) => {
        print(error);
        System.exit(1);
    }
);

The value of type Args will be instantiated with fields matching the configured flags or the given metavar names. Below is an example using the list argument example from above.

print("Users: {}".format(args.users));