Update configuration to support .toml files#1352
Open
a1-su wants to merge 4 commits into
Open
Conversation
Collaborator
Coverage Report for CI Build 27395431043Warning Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes. Coverage increased (+0.2%) to 90.929%Details
Uncovered Changes
Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
david-yz-liu
reviewed
Jun 5, 2026
david-yz-liu
left a comment
david-yz-liu
left a comment
Contributor
There was a problem hiding this comment.
Hi @a1-su, nice work. The changes overall look good. A few general comments:
- We should update the PythonTA documentation with this new behaviour (accepting toml files, the
[tool.python-ta]section, looking forpyproject.tomlfile by default, anything else). - There are a few other places in the code base (e.g., variable names) that refer to
pylintrcexplicitly. These should be modified to use more general terms for "config files" or something similar.
| return args_list | ||
|
|
||
| try: | ||
| with open(config_location, "r") as f: |
Contributor
There was a problem hiding this comment.
In general use a UTF8 encoding for text file reading
| # Configuration | ||
|
|
||
| PythonTA supports configuration through an "rc file" in the [INI format](https://docs.python.org/3/library/configparser.html). | ||
| PythonTA supports configuration through `pyproject.toml` files and "rc files" in the [INI format](https://docs.python.org/3/library/configparser.html). |
Contributor
There was a problem hiding this comment.
I would just say "TOML" files. The filename pyproject.toml is a default, but users can pass in arbitrary toml files as the config argument to python_ta.check_all, I believe (please make sure to test this)
| PythonTA supports configuration through `pyproject.toml` files and "rc files" in the [INI format](https://docs.python.org/3/library/configparser.html). | ||
| A custom configuration file can be passed in the command-line using the `--config <path>` option, | ||
| and to `python_ta.check_all` with the `config=<path>` argument. | ||
| When using a `pyproject.toml` file, PythonTA-specific options must be placed under the [tool.python-ta] section, while standard Pylint options should be placed under [tool.pylint] (e.g., [tool.pylint.FORMAT]). |
Contributor
There was a problem hiding this comment.
Same comment as above about the filename.
Also, please put all section headers in monospace font, e.g. [tool.python-ta].
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed Changes
This PR updates the configuration options to support
.tomlfiles, in addition to the.pylintrcthat is currently used. In addition, it updates the tests to add.tomlchecking.Type of Change
(Write an
Xor a brief description next to the type or types that best describe your changes.)Checklist
(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the
[ ]into a[x]in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)Before opening your pull request:
After opening your pull request:
Questions and Comments
(Include any questions or comments you have regarding your changes.)