Coveragepy: Allow configuration via pyproject.toml
Originally reported by pradyunsg (Bitbucket: pradyunsg, GitHub: pradyunsg)
As per PEP 518, tools can use tool.<pypi-name> namespace within the pyproject.toml file if they own <pypi-name> on PyPI.
Allowing configuration via the above mechanism would allow for users to have a single file in their root directory, for configuring this coverage (and other tools) for their project. Essentially, this would allow eliminating a .coveragerc file in the root of the project in favor of using pyproject.toml.
nedbat
All 9 comments
This is a good idea. One twist: coverage.py has no required dependencies. It will need a toml parser to parse the pyproject.toml file. My inclination is to implement this so that if the toml module is available, then coverage will try to read the pyproject.toml file. Installing coverage won't install toml automatically, you'll have to do that yourself if you want to use pyproject.toml for configuration.
nedbat
on 11 Jun 2018
@nedbat What about vendoring the toml library along with coverage? Would you be ok with that approach? Some projects do that (I think Pipenv does that with Pip, although there are probably examples in less chaotic projects as well [that's not to say that Pipenv is bad] ), to stay independent of other dependencies, and act as a self-contained dependency.
butla
on 14 Feb 2019
Or on the other hand... your solution seems more sensible :) Just have to document that.
butla
on 14 Feb 2019
You can also list it as optional dependency.
mhozza
on 3 Jul 2019
+1 for optional dependency, isort does that for example: pip install isort[pyproject].
zsiciarz
on 5 Jul 2019
This is finished as of df744f8cbcad7ea7dca893be5017920afa4ce32f
nedbat
on 4 Nov 2019
Awesome, @nedbat thanks for helping move this along. Assume this will land in the next release?
adithyabsk
on 4 Nov 2019
Yes, if by next release you mean 5.0.
nedbat
on 4 Nov 2019
This is available in 5.0b1: https://pypi.org/project/coverage/5.0b1/
nedbat
on 11 Nov 2019
Related issues
lxiaopei
路
5Comments
cdce8p
路
4Comments
decorator-factory
路
5Comments
nitzmahone
路
3Comments
ogrisel
路
10Comments
Most helpful comment
This is a good idea. One twist: coverage.py has no required dependencies. It will need a toml parser to parse the pyproject.toml file. My inclination is to implement this so that if the toml module is available, then coverage will try to read the pyproject.toml file. Installing coverage won't install toml automatically, you'll have to do that yourself if you want to use pyproject.toml for configuration.