Replace `setuptools` build backend with `hatchling` #551

ofek · 2022-08-26T05:50:29Z

cc @graingert as requested!

Background

Hello there! The Python packaging ecosystem has standardized on the interface for build backends (PEP 517/PEP 660) and the format for metadata declaration (PEP 621/PEP 631). As a result, the execution of setup.py files is now deprecated.

So, I'm spending my free time updating important projects so that they are modernized and set an example for others 😄

Summary of changes

This implements PEP 621, obviating the need for setup.py and MANIFEST.in. The build backend hatchling (of which I am a maintainer in the PyPA) is now used as that is the default in the official Python packaging tutorial. Hatchling is available on all the major distribution channels such as Debian, Fedora, Arch Linux, conda-forge, Nixpkgs, Alpine Linux, FreeBSD/OpenBSD, Gentoo Linux, MacPorts, OpenEmbedded, Spack, MSYS2, etc.

Python support

The earliest supported Python 3 version of Hatchling is 3.7, therefore I've also set that as the minimum here. Python 3.6 is EOL and other build backends like flit-core and setuptools also dropped support. Python 3.6 accounted for 6-8% of downloads in the last month: https://pypistats.org/packages/pytest-cov

Notes

The source distributions on PyPI are erroneously shipping a build artifact *.egg-info from python setup.py develop; this is now fixed
The CHANGELOG.rst regex substitution was doing nothing so the PyPI landing page continues to be simply README.rst + CHANGELOG.rst
The generated pytest-cov.pth was being checked into the repo but is not necessary now so I've removed it

Future

Move config for tools like pytest out of setup.cfg and into pyproject.toml

ionelmc · 2022-08-26T09:21:19Z

What exactly is hatch-autorun? How does it work? I don't get how this replaces the pth file we use.

ofek · 2022-08-26T16:46:48Z

It essentially does the current logic of executing the src/pytest-cov.embed in a PTH file.

ionelmc · 2022-08-28T11:21:15Z

pyproject.toml

+]
+
+[project.optional-dependencies]
+testing = [


This works as the "testing" extra right?

I wonder if nowadays this could be turned into a dependency group finally..

ionelmc · 2022-08-28T11:22:59Z

pyproject.toml

+Homepage = "https://github.com/pytest-dev/pytest-cov"
+"Issue Tracker" = "https://github.com/pytest-dev/pytest-cov/issues"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]


Does the fancy pypi readme do the ref tag stripping automatically? The ol setup.py had a re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', ...

No, but as I mentioned in the OP it was doing nothing:

Python 3.11.0b3 (main, Jun 1 2022, 13:29:14) [MSC v.1932 64 bit (AMD64)] on win32 Type "help", "copyright", "credits" or "license" for more information. >>> import pathlib, re >>> >>> before = pathlib.Path('CHANGELOG.rst').read_text(encoding='utf-8') >>> after = re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', before) >>> >>> before == after True

ofek · 2022-09-04T13:57:59Z

CI passing btw

ofek · 2022-09-10T14:23:51Z

Just let me know if I can help!

ionelmc · 2022-09-28T19:09:53Z

I'll be honest here I'm not a fan of redoing something that works. But I am also curious how well this could work so how about this: release it as pytest-cov 5.0.0a (or beta) and we keep this in a special "alpha" branch till people try it out enough? This can only work if you pledge yourself to maintain pytest-cov's packaging from here on out :-)

RonnyPfannschmidt · 2022-09-28T19:12:33Z

I'm also in on this, starting with pluggy, then going for other pytest projects

I like hatch enough that i decided to let my own tool die in favour of it.

ofek · 2022-10-05T04:32:20Z

I rebased to fix conflicts. Would you mind triggering the CI with that button below?

ofek · 2022-10-20T04:39:55Z

I rebased again, accounting for #553 (comment)

ofek · 2022-10-20T17:48:30Z

flake?

ofek · 2022-10-22T20:25:01Z

I rebased again, accounting for #556

ofek · 2022-10-25T15:40:24Z

Would you mind triggering the CI with that button below?

ofek · 2022-10-29T19:02:55Z

Passing 🙂

cclauss · 2023-02-28T16:10:37Z

Please rebase.

webknjaz · 2025-06-05T15:23:56Z

tox.ini

-    flake8 src tests setup.py
-    isort --check-only --diff src tests setup.py
+    python -m build
+    twine check dist/*


this should probably include --strict too

Suggested change

twine check dist/*

twine check --strict dist/*

ofek · 2025-06-05T15:29:55Z

I don't know whether to invest time rebasing because of the previous lack of correspondence.

RonnyPfannschmidt · 2025-06-05T16:51:32Z

@ionelmc anything preventing committing to this

Im
Happy to take ownership in that case as @ofek already did enough

webknjaz · 2025-06-06T12:18:21Z

src/pytest-cov.pth

NOTE: Looks like this is replaced by [tool.hatch.build.targets.wheel.hooks.autorun].

webknjaz · 2025-06-06T12:20:25Z

docs/releasing.rst

@@ -21,12 +21,12 @@ The process for releasing should follow these steps:
 #. Make sure you have a clean checkout, run ``git status`` to verify.
 #. Manually clean temporary files (that are ignored and won't show up in ``git status``)::

-        rm -rf dist build src/*.egg-info
+        rm -rf dist


Perhaps, this could be replaced by a git clean which is cross-platform.

webknjaz · 2025-06-06T12:21:38Z

pyproject.toml

+authors = [
+  { name = "Marc Schlaich", email = "[email protected]" },
+]


Not directly related to the conversion but perhaps, a maintainers entry should be added at some point too.

webknjaz · 2025-06-06T12:24:01Z

@ofek thanks for the initial effort, though! I was just going through the old PRs to see if anything could be closed and making notes. Hopefully, @RonnyPfannschmidt will get it through the finish line.

ionelmc · 2025-06-06T19:54:15Z

@ionelmc anything preventing committing to this

I am not against it outright, but I not a fan of fixing what ain't broken either. If you wanna bring this up to date and help with whatever issues will come up (basically own this aspect of the project) then I am ok with it.

ofek force-pushed the modernize-metadata branch from f7d916e to da3db18 Compare August 26, 2022 16:45

ofek force-pushed the modernize-metadata branch from da3db18 to 804b337 Compare August 26, 2022 16:58

ionelmc reviewed Aug 28, 2022

View reviewed changes

ofek force-pushed the modernize-metadata branch from fd71fa5 to 9c11353 Compare October 5, 2022 04:30

ofek force-pushed the modernize-metadata branch from 9c11353 to c860920 Compare October 20, 2022 04:38

ofek mentioned this pull request Oct 20, 2022

Revert "Enable pytest-cov[toml] akin to upstream coverage[toml]" #556

Merged

Update package metadata

7f0fe2e

ofek force-pushed the modernize-metadata branch from c860920 to 7f0fe2e Compare October 22, 2022 20:24

ssbarnea added the enhancement label Oct 26, 2022

RonnyPfannschmidt mentioned this pull request Mar 10, 2023

PEP 621: Migrate settings from setup.cfg into pyproject.toml #586

Closed

cclauss mentioned this pull request Mar 10, 2023

pre-commit: Replace flake8, isort, and pyupgrade with ruff #584

Closed

webknjaz reviewed Jun 5, 2025

View reviewed changes

webknjaz reviewed Jun 6, 2025

View reviewed changes

src/pytest-cov.pth

Copy link

Member

webknjaz Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: Looks like this is replaced by [tool.hatch.build.targets.wheel.hooks.autorun].

webknjaz reviewed Jun 6, 2025

View reviewed changes

webknjaz changed the title ~~Update package metadata~~ Replace setuptools build backend with hatchling Jun 6, 2025

webknjaz assigned RonnyPfannschmidt Jun 6, 2025

Replace setuptools build backend with hatchling #551

Are you sure you want to change the base?

Replace setuptools build backend with hatchling #551

Uh oh!

Conversation

ofek commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

Summary of changes

Python support

Notes

Future

Uh oh!

ionelmc commented Aug 26, 2022

Uh oh!

ofek commented Aug 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ofek commented Sep 4, 2022

Uh oh!

ofek commented Sep 10, 2022

Uh oh!

ionelmc commented Sep 28, 2022

Uh oh!

RonnyPfannschmidt commented Sep 28, 2022

Uh oh!

ofek commented Oct 5, 2022

Uh oh!

ofek commented Oct 20, 2022

Uh oh!

ofek commented Oct 20, 2022

Uh oh!

ofek commented Oct 22, 2022

Uh oh!

ofek commented Oct 25, 2022

Uh oh!

ofek commented Oct 29, 2022

Uh oh!

cclauss commented Feb 28, 2023

Uh oh!

webknjaz Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ofek commented Jun 5, 2025

Uh oh!

RonnyPfannschmidt commented Jun 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

webknjaz commented Jun 6, 2025

Uh oh!

ionelmc commented Jun 6, 2025

Uh oh!

Uh oh!

Replace `setuptools` build backend with `hatchling` #551

Replace `setuptools` build backend with `hatchling` #551

ofek commented Aug 26, 2022 •

edited

Loading

webknjaz Jun 5, 2025 •

edited

Loading