Function define_options

mypy/main.py:492–1405

Define the options in the parser (by calling a bunch of methods that express/build our desired command-line flags). Returns a tuple of: a parser object, that can parse command line arguments to mypy (expected consumer: main's process_options), a list of what flags are strict (expecte

(
    program: str = "mypy",
    header: str = HEADER,
    stdout: TextIO = sys.stdout,
    stderr: TextIO = sys.stderr,
    server_options: bool = False,
)

def define_options(
    program: str = "mypy",
    header: str = HEADER,
    stdout: TextIO = sys.stdout,
    stderr: TextIO = sys.stderr,
    server_options: bool = False,
) -> tuple[CapturableArgumentParser, list[str], list[tuple[str, bool]]]:
    """Define the options in the parser (by calling a bunch of methods that express/build our desired command-line flags).
    Returns a tuple of:
      a parser object, that can parse command line arguments to mypy (expected consumer: main's process_options),
      a list of what flags are strict (expected consumer: docs' html_builder's _add_strict_list),
      strict_flag_assignments (expected consumer: main's process_options)."""
    parser = CapturableArgumentParser(
        prog=program,
        usage=header,
        description=DESCRIPTION,
        epilog=FOOTER,
        fromfile_prefix_chars="@",
        formatter_class=AugmentedHelpFormatter,
        add_help=False,
        stdout=stdout,
        stderr=stderr,
    )

    strict_flag_names: list[str] = []
    strict_flag_assignments: list[tuple[str, bool]] = []

    def add_invertible_flag(
        flag: str,
        *,
        inverse: str | None = None,
        default: bool,
        dest: str | None = None,
        help: str,
        strict_flag: bool = False,
        group: argparse._ActionsContainer | None = None,
    ) -> None:
        if inverse is None:
            inverse = invert_flag_name(flag)
        if group is None:
            group = parser

        if help is not argparse.SUPPRESS:
            help += f" (inverse: {inverse})"

        arg = group.add_argument(
            flag, action="store_false" if default else "store_true", dest=dest, help=help
        )
        dest = arg.dest
        group.add_argument(
            inverse,
            action="store_true" if default else "store_false",
            dest=dest,
            help=argparse.SUPPRESS,
        )
        if strict_flag:
            assert dest is not None
            strict_flag_names.append(flag)