Adopt '[tool.pytest-enabler]' for configuration (PEP 518) #5
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
|
@jaraco i strongly recommend this |
jaraco
reviewed
Jun 22, 2022
jaraco
reviewed
Jun 22, 2022
pytest_enabler/__init__.py
Outdated
Comment on lines
28
to
33
| if "pytest" in defn and "enabler" in defn["pytest"]: | ||
| msg = "pytest-enabler configuration should use the `[tool.pytest-enabler]` " | ||
| msg += "table in pyproject.toml (`[pytest.enabler]` is now deprecated)." | ||
| warnings.warn(msg, DeprecationWarning) | ||
| return defn["pytest"]["enabler"] | ||
| return defn["tool"]["pytest-enabler"] |
There was a problem hiding this comment.
I'd like to see this logic broken out as a compatibility shim that will be removed. I'll do that.
jaraco
reviewed
Jun 22, 2022
|
Thank you very much Jason. |
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.
As described in #4, PEP 518 restricts the name of tables in
pyproject.toml(currently, with PEP 517/518/621, only[build-system],[project]and[tool.*]are allowed) and specifies that tools should use[tool.<name on PyPI>]for storing their configuration.This PR fix #4, by deprecating
[pytest.enabler]and migrating to[tool.pytest-enabler].The usage of hyphen (
-) is preferred to underscore for the sake of consistency with PEP 517/518/621 (also the official name of the distribution, before normalisation, seems to bepytest-enableraccording tosetup.cfg).