Only accept documented choices after -i and -q

[DimitriPapadopoulos]

Fixes #3341.

@larsoner Could you have a look?

[peternewman]

LGTM but its broken the tests fairly spectacularly 😢

I'm going to guess that argparse uses -1 internally as no value passed (IIRC we allow just -q and it will take the default), and the choice validation logic has a bug where it happens before, rather than after, that's been mapped to the default value.

I've even a vague idea I've looked at this issue before so I don't know if there's another PR for the same fix or it was a different project.

[DimitriPapadopoulos]

Could it be an issue with the test?

codespell/codespell_lib/tests/test_basic.py

Line 240 in c7a594c

assert cs.main("-i", "-1", fname) == 1, "bad"

What exactly is the above supposed to test?

[peternewman]

You'll have to ask @larsoner ! Looks like it was added here:
0d91bf2#diff-02a558d6c6bc59b5b9e5c7fc4d54893d875b4d7cceecfc151b9d729688bef061R72

From what I can see to test if passing an invalid option upset things.

So it's either the test, or our general exception handling that's broken. What happens when you run the CLI tool with the same args?

[DimitriPapadopoulos]

If I run codespell from the command line with an incorrect -i argument:

$ codespell -i 4
usage: codespell [-h] [--version] [-d] [-c] [-w] [-D DICTIONARY] [--builtin BUILTIN-LIST]
                 [--ignore-regex IGNORE_REGEX] [-I FILE] [-L WORDS] [--uri-ignore-words-list WORDS] [-r REGEX]
                 [--uri-regex URI_REGEX] [-s] [--count] [-S SKIP] [-x FILE] [-i MODE] [-q LEVEL] [-e] [-f] [-H]
                 [-A LINES] [-B LINES] [-C LINES] [--stdin-single-line] [--config CONFIG] [--toml TOML]
                 [files ...]
codespell: error: argument -i/--interactive: invalid choice: 4 (choose from 0, 1, 2, 3)
$ echo $?
2
$ 

By the way, perhaps we should handle that manually, I'm not very happy with the -q error message:

$ codespell -q 64
usage: codespell [-h] [--version] [-d] [-c] [-w] [-D DICTIONARY] [--builtin BUILTIN-LIST]
                 [--ignore-regex IGNORE_REGEX] [-I FILE] [-L WORDS] [--uri-ignore-words-list WORDS] [-r REGEX]
                 [--uri-regex URI_REGEX] [-s] [--count] [-S SKIP] [-x FILE] [-i MODE] [-q LEVEL] [-e] [-f] [-H]
                 [-A LINES] [-B LINES] [-C LINES] [--stdin-single-line] [--config CONFIG] [--toml TOML]
                 [files ...]
codespell: error: argument -q/--quiet-level: invalid choice: 64 (choose from 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 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)
$ 

[larsoner]

From what I can see to test if passing an invalid option upset things.

Yeah I think that's all it was meant to test

@DimitriPapadopoulos let me know when CIs are green

[DimitriPapadopoulos]

@larsoner CI jobs are green. Could you have a look and possibly merge?

Requested changes applied.

[larsoner]

Yikes missed the ping on this one, thanks for reviewing @skangas and for the fixes @DimitriPapadopoulos !