PEP 621: round 3

I think @ofek is the only one of us who has actually implemented PEP 621 at this point. I would be interested to hear his taken on the final version.

I also think it might make sense to do another Provisional acceptance (or whatever PEP 517 is), but on a shorter time period, so that we can see if there are any points of friction that need clarification or adjustment as we try and implement this (particularly in setuptools, which is always the biggest PITA).

2 Likes

I’d be happy to hear comments from @ofek (or from anyone else) but at this point the PEP has been pretty much stable for 2 weeks (since @brettcannon updated it reflecting the poll results) so I’m assuming if anyone has anything more to say, they’ve had plenty of time to say it. So I’m not going to wait indefinitely “just in case”. To be honest, I think by this point @brettcannon deserves a decision.

I’ll post my decision at the weekend. If anyone wants to add anything further, they have until then. But it would have to be something pretty significant at this point to make much difference.

The details are here. I’m not convinced it’s needed - I’d rather handle any changes using the handling fixes and minor updates process. I don’t really want to give the impression that subsequent withdrawal or rejection is possible (which provisional status allows) or that we’re expecting to make backward incompatible changes, as that will put people off adopting the format.

If we did make it a provisional acceptance, it’s until “successful rollout and initial adoption of the reference implementation”. Arguably, that’s already happened if @ofek has implemented it :slight_smile: If you’re suggesting the relevant rollout should be setuptools, do you have any view on how long it’ll take for that to happen? I don’t want to leave things provisional for an indefinite period…

I will consider the option, though.

(As a side note, I think PEP 517 is long overdue to be moved to “Final” status. It’s not obvious to me whether I can do that or if it needs the original BDFL-delegate - so I’ll prepare a PR to make the change and ask @ncoghlan to approve it).

Originally this PEP said that tools SHOULD backfill appropriate trove classifiers. This was changed to say it MAY occur to emphasize it was entirely optional for build back-ends to implement.

Now it’s verboten so that wording should be changed.

Otherwise, it looks excellent!

Development on v1 beta of Hatch is progressing, albeit slower than I anticipated because I’m trying to implement everything on my personal backlog (except dependency locking). However, you can try it out now (docs site will come):

[build-system]
requires = ['hatchling']
build-backend = 'hatch.core.build'

[project]
name = 'foobar'
dynamic = ['version']

[tool.hatch.version]
source = 'regex'
path = 'foobar/__init__.py'

# You can override what to include with `packages`, `include`, or `exclude`,
# which all use Git-style pattern matching and can be either lists of strings
# or comma-separated strings.
#
# `packages` is like `include` but is a bit special in that it forces matching
# at the root AND the distributed path will start at the last path component
# (making it easy for src layouts, etc.).
#
# By default it will include everything not excluded by VCS
# [tool.hatch.build.targets.sdist]
# packages = ['foobar', 'tests']
# include = ['LICENSE', 'README.md']
#
# By default it will be smart about what to include
# [tool.hatch.build.targets.wheel]
# packages = ['src/foobar']  # for example

I split the project in 2: hatchling is the build back-end and hatch is still the main CLI (no code pushed yet)

2 Likes

Yep, as soon as I find the time.

1 Like

Got a PR up at https://github.com/python/peps/pull/1714. Just waiting for the status checks to pass to merge it.

1 Like

It is with pleasure that I am formally accepting PEP 621. Thanks to @brettcannon and the other authors for their work in developing the PEP, and to the “cast of thousands” who contributed to the discussions.

After reflection, I have decided that the PEP is initially accepted as provisional, to allow time for any issues identified as tools implement the spec to be ironed out. But I am strictly limiting the provisional status to a maximum of (just over) three months, so the PEP will be declared final on 1st March 2021. If we have fully working implementations of the PEP sooner than that, I’m happy to move the status to final before the deadline.

13 Likes

PEP 1 doesn’t spell it out, but I agree it makes sense for the BDFL-Delegate to approve leaving the Provisional state (reverting to the SC if the original delegate is uncontactable).

And for this specific case, I agree that the Provisional qualification can now be removed - the proposal has been successfully implemented and deployed.

1 Like

Thanks! Glad the PEP worked out in the end!

Would you like me to hold off on a PR for packaging.python.org to link to the PEP from there (or fully copying it over so the official version is kept on packaging.python.org entirely)?

I don’t think there’s a need to hold off. Sure, there’s a possibility of change due to the provisional status, but I certainly don’t think we should delay having official documentation until the provisional status is removed.

I’d prefer it if the official version were kept on packaging.python.org, rather than just linking to the PEP, but that is a non-trivial amount of extra work, so I’m perfectly fine if you prefer to just link to the PEP for now.

2 Likes

I’m happy to put in the work to move it all over to packaging.python.org since it will make it easier to read due to having less comparison details to other tools and such.

1 Like

Quick update: I marked the PEP as provisionally accepted. Next step is creating the page for the spec on packaging.python.org.

1 Like

PR for the spec on packaging.python.org: https://github.com/pypa/packaging.python.org/pull/797.

1 Like

As an update to this, PEP 621 is now officially declared as Final. @brettcannon can you update the PEP to reflect this?

2 Likes

PEP 621: mark as final by brettcannon · Pull Request #1857 · python/peps · GitHub has the update to final.

3 Likes

I’ve just released Flit 3.2 with experimental support for PEP 621. It’s also using PEP 621 itself (is it the first package to do so? :slightly_smiling_face: )

This is largely undocumented for now - the idea is that early adopters can try it out before everyone switches over. I’m asking that anyone who does try it out declare that only Flit 3.2.x should build their project, in case the support needs to change for 3.3 - i.e. start pyproject.toml like this:

[build-system]
requires = ["flit_core >=3.2.0,<3.3"]
6 Likes

(There is pdm already that I know of.)

I released whey (as in curds and whey, used to make wheels of cheese; Home - whey 0.0.6 documentation), a PEP 517 backend with PEP 621 support, on the 23rd Feb. I’ve used it for several of my projects already.

I’m curious how flit handles the case where one author has only a name and one has only an email like in the example? It wasn’t obvious to me what should go in which core metadata field.

1 Like

OK, I don’t get to lay claim to the first PEP 621 package, then. Congrats to both of you!

Fairly naively. Following the recommendation in PEP 621, authors with email addresses go in Author-Email, and authors with just a name go in Author. So in that case, it wouldn’t be obvious in the resulting METADATA file that they were meant to be for two different people. You can see the relevant code in flit here.

Once PEP 621 is more widely adopted, someone who wants to automate getting author metadata might be better off fetching sdists and parsing the pyproject.toml, rather than trying to make sense of the essentially free-text fields in a METADATA file. So I’m not going to lose too much sleep over the potential ambiguity once it’s translated into METADATA.

1 Like

Either of you care to share how PEP 621 has worked for you? Other than all of us (re)discovering ambiguities in METADATA, has PEP 621 made sense, seemed to work well, etc.? I.e. did I help write a horrible PEP or does it seem okay? :wink:

1 Like

So far, I’ve been pretty happy with it. We’ll see how it goes as more people try to use it.

One question that I wondered about: what should a tool like Flit do if there are extra keys in the [project] table which it doesn’t recognise? I.e. is it meant to be extensible, and if so, will it be OK for implementations to ignore new keys, or should they bail out if there’s anything they don’t understand? For now, I’ve gone for a warning (“Unexpected names under [project]”) but no error.

Flit isn’t doing much with the license field at present - it includes a file if one is specified, but doesn’t put anything in the metadata for it. I understand we’re waiting on PEP 639 to define more precise ways of describing licenses in metadata (let’s not get into that question on this thread).

1 Like