pygettext: Improve test coverage

[StanFromIreland]

Options that should be tested:

• --extract-all (NO-OP, deprecated since 3.14)
• --add-comments
• --default-domain
• --escape
  • gh-130197: pygettext: Test the --escape option #131902
  • gh-130197: Test various encodings with pygettext #132244
• --docstrings
• --help
• --keyword
• --no-default-keywords
• --no-location
• --add-location
• --output
  • gh-130197: Test pygettext output option #133041
• --output-dir
• --style stylename
• --verbose
• --version
  • gh-130197: Test option in pygettext #133022
• --width
  • gh-130703: Implement wrapping to width for msgids #130705
• --exclude-file
  • gh-130197: pygettext: Fix and test the --exclude-file option #131381
• --no-docstrings
  • gh-130197: Fix (and test) option in pygettext #133021 (Renames to exclude-docstrings)

Linked PRs

• gh-130197: Remove obsolete pygettext tests #130198
• gh-130197: pygettext: Fix and test the --exclude-file option #131381
• gh-130197: pygettext: Test the --escape option #131902
• [3.13] gh-130197: pygettext: Test the --escape option (GH-131902) #132032
• [3.12] gh-130197: pygettext: Test the --escape option (GH-131902) #132033
• gh-130197: Test various encodings with pygettext #132244
• gh-130197: Fix (and test) option in pygettext #133021
• gh-130197: Test option in pygettext #133022
• gh-130197: Test pygettext output option #133041
• gh-130197: Improve test coverage of msgfmt.py #133048

[picnixz]

As I said on the PR, even if the tests may be redundant, they are still checking that running the tool with --docstrings option works well. So they are more than just one-shot tests, they can also be thought as E2E tests.

[tomasr8]

As I said on the PR, even if the tests may be redundant, they are still checking that running the tool with --docstrings option works well. So they are more than just one-shot tests, they can also be thought as E2E tests.

A lot of them are redundant, for instance test_funcdocstring_bytes just tests that ast.get_docstring works correctly, or test_funcdocstring_annotated_return which was needed for the old tokenize code (and there are more such tests). A lot of the options are also already covered in the snapshot tests as well.

In addition to removing some of the tests, we might also want to add one test that checks that the docstrings are not extracted when the --docstring option is not passed.

[picnixz]

Ok for removing the tests, but it would be good that we have an E2E test for --docstring

[tomasr8]

Ok for removing the tests, but it would be good that we have an E2E test for --docstring

Yes of course, that is not going away, I actually think the we need more tests for the CLI in general, but the other tests just get in the way for little gain

[serhiy-storchaka]

The use of ast.get_docstring is an implementation detail. The tests should stay to ensure that no regression will be introduced when we change the implementation next time.

[tomasr8]

I see, I didn't consider the (hopefully unlikely!) possibility of changing the implementation. In that case, let's keep the tests and let's focus on actually fully testing the CLI - there are still many options/flags which are not tested at all currently.