feat: auto-find config that is not pylintrc based #156
Conversation
This file contains 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
added 7 commits
May 10, 2021 13:31
Changes the way that the config file is retrieved from pylint.config. Previously this was done using the static `variable pylint.config.PYLINTRC` which is defined at load by iterating over all the files found via `pylint.config.find_default_config_files()` until one ending in "pylintrc" is found. In pylint itself config seems instead to be found by calling `next(find_default_config_files(), None)` which is also able to find setup.cfg or pyproject.toml based config files automatically. I have thus changed PyLintPlugin to use the same version and can now call `py.test --pylint` and have config from my pyproject.toml picked up correctly. I have added one additional test, essentially copying the existing `test_pylint_file_toml`, but now called `test_pyline_file_pyproject_toml`, which is modified to name the config file `pyproject.toml` and does not pass the `--pyline-fcfile` option but expects it to be auto-detected. This test passes when the file is called pyproject.toml but fails when it is called something different.
…is being used and there is no support for pyproject.toml etc.
… file but still ran the test that would fail when it couldn't detect the file. this should fix that. I also had to modify the test invalidate_cache_when_config_changes as autofinding the config caused that test to fail (which I assume was not intended)
…lint - fixed that.
…figured, not at load time of the module which may have been affecting things. Also made a change to the import of pylint.config to comply with isort and pylint 2.3
…pport find_default_config_files
|
Sorry for the string of commits, it took me a while to figure out how to get all the different version of pylint to be happy with the code. I also found that some tests passed on my dev machine but not on travis for an earlier version of the code - to fix that I had to move the search for the config file into the plugin pytest_configure() method, to make sure it picks up on the change in path. Hopefully you agree that this is a useful feature of the plugin, I certainly like being able to drop the extra command line argument. |
carsongee
approved these changes
Aug 11, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes the way that the config file is retrieved from pylint.config. Previously
this was done using the static
variable pylint.config.PYLINTRCwhich is definedat load by iterating over all the files found via
pylint.config.find_default_config_files()until one ending in "pylintrc" isfound. In pylint itself config seems instead to be found by calling
next(find_default_config_files(), None)which is also able to find setup.cfg orpyproject.toml based config files automatically. I have thus changed PyLintPlugin
to use the same version and can now call
py.test --pylintand have config frommy pyproject.toml picked up correctly.
I have added one additional test, essentially copying the existing
test_pylint_file_toml, but now calledtest_pyline_file_pyproject_toml, whichis modified to name the config file
pyproject.tomland does not pass the--pyline-fcfileoption but expects it to be auto-detected. This test passeswhen the file is called pyproject.toml but fails when it is called something
different.