[CodingFeng101]

Summary

Reject non-string include and force-exclude values in pyproject.toml.

Details

Black already validates that exclude and extend-exclude config values are strings before passing them through regex validation. The same regex-backed options include and force-exclude did not have that type check, so list values could be silently stringified and accepted with surprising regex semantics.

This adds matching BadOptionUsage checks for include and force_exclude, plus a regression test for both config keys.

Test

• python -m pytest tests/test_black.py::BlackTestCase::test_read_pyproject_toml_rejects_non_string_regex_configs tests/test_black.py::BlackTestCase::test_read_pyproject_toml -q

[cobaltt7]

Thanks! Please add a changelog entry.

[github-actions]

diff-shades results comparing this PR (2db81d2) to main (b74b230):

--preview style: no changes

--stable style: no changes

---

What is this? | Workflow run | diff-shades documentation

[CodingFeng101]

Added the requested changelog entry in 4baa9c8.

[DTiming24]

Nice catch on list values being stringified. I like that this matches the existing exclude/extend-exclude validation. It may be worth making the error text explicitly mention include and force-exclude so users don't assume regex lists are accepted here.

[DTiming24]

Good validation. Matching exclude's failure mode makes the config errors much clearer; it may be worth checking whether the same message path is used when config is merged from CLI + pyproject, so users see the error at the source of the bad value.

[CodingFeng101]

Thanks for the suggestion. I added a CLI-level regression test in 2db81d2 that writes a pyproject.toml with non-string include and force-exclude values, invokes Black through --config, and asserts the CLI exits with code 2 while surfacing the corresponding Config key ... must be a string message.

Validation run locally:

python -m pytest tests/test_black.py::BlackTestCase::test_read_pyproject_toml_rejects_non_string_regex_configs tests/test_black.py::BlackTestCase::test_cli_rejects_non_string_pyproject_regex_configs tests/test_black.py::BlackTestCase::test_read_pyproject_toml -q
# 3 passed, 4 subtests passed

python -m black --check tests/test_black.py
python -m isort --check-only tests/test_black.py
python -m flake8 tests/test_black.py
git diff --check

I also tried python -m pre_commit run --files tests/test_black.py, but on this Windows environment it timed out while installing hook environments, so I ran the relevant checks directly.

[cobaltt7]

Thanks!