pkgs/sagemath-standard: Move metadata from setup.cfg to pyproject.toml #37902

saraedum · 2024-04-29T11:53:50Z

This PR recreates #36951 by @mkoeppe after it was reverted, see #37796.

Modernize the metadata.

This is a trivial "chore" PR. It updates Python metadata to the latest format. No controversies about the current format are known about in the Python community. In a typical open source project, someone in a Maintainer role would open a PR and then immediately merge it, or when receiving such a PR from the outside, quickly review and merge it (examples: my PRs pytest-dev/pytest-mock#410 (merged in within 1 day), pyodide/pyodide#4472, pytest-dev/pytest-xdist#1020,
sagemath/cypari2#158, fplll/fpylll#258, polymake/JuPyMake#2, cvxpy/cvxpy#2276, sagemath/cysignals#177).

~~Also fixes the pyproject.toml build requirements of sagemath-standard, broken since 10.2, hence "critical".~~

Part of Migrate from setup.cfg to pyproject.toml #33577
- See also pkgs/sage-conf: Move metadata from setup.cfg to pyproject.toml #36561

📝 Checklist

The title is concise, informative, and self-explanatory.
The description explains in detail what this PR is about.
I have linked a relevant issue or discussion.
I have created tests covering the changes.
I have updated the documentation accordingly.

⌛ Dependencies

Depends on Switch more Python toolchain packages to use (platform-independent) wheels #36885 (merged here)
Depends on Use conda-lock for reproducible conda env #35986 (merged here to resolve merge conflict)
Depends on Sphinx ext links for Sage source files #37546 (merged here to resolve merge conflict)
Depends on Refactor bootstrap, bootstrap-conda, m4/sage_spkg_collect.m4, sage-spkg-info through sage --package properties, sage-get-system-packages #37430
Depends on Makefile, .ci/write-dockerfile.sh: Update for src/pyproject.toml after #36982 #37926

saraedum · 2024-04-29T12:06:50Z

I'm counting the votes from #36951:

👍 @jhpalmieri @mkoeppe @kwankyu @kiwifb

👎 @tornaria @tobiasdiez

(I am not the author of this PR, I didn't vote yet.)

github-actions · 2024-04-29T12:25:25Z

Documentation preview for this PR (built with commit 443b5bb; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

tornaria · 2024-04-29T13:50:13Z

I'll repeat my commment #36951 (comment) since I'm not opposed to the idea of this PR, but only to its current execution.

I'm -1 on this for several reasons:

I think moving to pyproject.toml is a good idea, as it's the modern way python packages work; however, it should be pyproject.toml and not pyproject.toml.m4.
You need to fix build dependencies. Right now you require a lot of dependencies just to create a sdist.
This conflicts with other disputed PRs and I believe the way to move forward is to come together and figure out a reasonable compromise between all the different positions

orlitzky · 2024-04-30T00:57:02Z

I am -1 for now because I think #36982 is the better approach. But if that fails I would reconsider.

NathanDunfield · 2024-04-30T01:09:08Z

+1: Moving from setup.cfg.m4 to pyproject.toml.m4 seems like a clear improvement. Vote summary is now:

👍 @jhpalmieri @mkoeppe @kwankyu @kiwifb @NathanDunfield
👎 @tornaria @tobiasdiez @orlitzky

culler · 2024-04-30T02:26:49Z

I agree that generating pyproject.toml with m4 is better than generating setup.cfg with m4. It doesn't make sense to force the use of setup.cfg, and allow generating it with m4, in order to avoid generating pyproject.toml with m4.

The issue of how to generate pyproject.toml seems to me to be separate from the issue of whether tu use pyproject.toml. Perhaps the scheme in #36982 is better than using m4. If so then it should be possible to adopt that scheme later.

+1

mkoeppe · 2024-05-17T04:22:22Z

I've reworked this on top of

the change that made src/pyproject.toml a source file (Make pyproject.toml the source for build dependencies #36982)
Makefile, .ci/write-dockerfile.sh: Update for src/pyproject.toml after #36982 #37926 (which fixes most of the breakage from the above)
Refactor bootstrap, bootstrap-conda, m4/sage_spkg_collect.m4, sage-spkg-info through sage --package properties, sage-get-system-packages #37430

This is no longer a trivial PR.

Also fixes the breakage noted in #37894 (comment)

kwankyu

LGTM.

tobiasdiez · 2024-09-06T05:05:25Z

No. Unresolved remarks just need more discussion.

Then please don't set it to positive review. I've said above that the reintroduction of committed version_requirements files is not okay with me; there is also no need to change this as part of a PR that aims to move metadata from setup.cfg to pyproject.toml. There is already a framework in place on how to specify infos about package dependencies in that file; just reuse exactly the same mechanism and create the version requirements files during bootstrap (and maybee improve it in the a follow up PR).

kwankyu · 2024-09-06T06:55:11Z

I don't think this PR reverts the main of point of your PR #36982. The file src/pyproject.toml, with the dependencies info for the sage library (sagemath-standard), is still there.

This PR restores version_requirements.txt files, to establish the mapping between spkg names and pip package names, as Matthias explains. That info is not available from src/pyproject.toml. In this sense, this PR fixes a "bug" introduced by your PR #36982.

There was a need for additional version constraints (on cython, for example) for sage-the-distribution. I expected the version_requirements.txt file could be used for that purpose. But Matthias says that src/pyproject.toml serves the purpose, and provisioning a mechanism for additional set of version constraints is out of scope of this PR. I agree with that.

Thus I am positive with this PR and added "positive review".

In the discussions of you and Matthias, I see no items that you raised but Matthias didn't respond. It seemed that there is no item that Matthias will work on. It seems still so.

Now that you added "needs work" again with no new items to discuss with Matthias, this PR is qualified for "disputed PR". After seeing Matthias' response to your "needs work" label, I will add "disputed" label to this PR.

tobiasdiez · 2024-09-06T07:37:07Z

This PR restores version_requirements.txt files, to establish the mapping between spkg names and pip package names, as Matthias explains. That info is not available from src/pyproject.toml. In this sense, this PR fixes a "bug" introduced by your PR #36982.

Per #36982 this map is defined in sage bootstrap, and is working well (e.g. the constraint for the python package cypari2 is correctly mapped to the sage package cypari - which by the way is the only package with a different slightly different name that I'm aware of [apart from some - vs _)). Which bugs did you experience?

In either way, changing the way the build dependencies are handled is out-of-scope of this PR, since this information is already in pyproject.toml and no longer in setup.cfg.

kwankyu · 2024-09-06T07:51:20Z

This PR restores version_requirements.txt files, to establish the mapping between spkg names and pip package names, as Matthias explains. That info is not available from src/pyproject.toml. In this sense, this PR fixes a "bug" introduced by your PR #36982.

Per #36982 this map is defined in sage bootstrap, and is working well (e.g. the constraint for the python package cypari2 is correctly mapped to the sage package cypari - which by the way is the only package with a different slightly different name that I'm aware of [apart from some - vs _)).

Matthias makes the mapping explicit using version_requirements.txt files. Hardcoding the mapping in python code is the "bug" I am saying.

In either way, changing the way the build dependencies are handled is out-of-scope of this PR, since this information is already in pyproject.toml and no longer in setup.cfg.

The scope of a PR is set by the PR author. Neither you nor me. You may request the author to make the scope explicit in the PR description.

On the other hand, you may object to this PR on whatever ground.

mkoeppe · 2024-09-06T15:34:01Z

the sage package cypari - which by the way is the only package with a different slightly different name that I'm aware of [apart from some - vs _)).

Wrong.

mkoeppe · 2024-09-06T15:34:55Z

@kwankyu explains it all correctly.

The changed file, `m4/pyproject_toml_metadata.m4`, controls the metadata of the modularized distributions. The same changes should be done to **sagemath-standard** and **sage- conf** after sagemath#37902, sagemath#36561 are merged. ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies    URL: sagemath#38577 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee, Matthias Köppe

kwankyu · 2024-09-09T12:20:50Z

+1 from me.

The changed file, `m4/pyproject_toml_metadata.m4`, controls the metadata of the modularized distributions. The same changes should be done to **sagemath-standard** and **sage- conf** after sagemath#37902, sagemath#36561 are merged. ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies    URL: sagemath#38577 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee, Matthias Köppe

dimpase · 2024-09-19T08:32:52Z

A very fat -1 from me. All sorts of wrong reasons are given here to get this PR through, such as

mkoeppe's "I am not going to maintain 2 sets of version constraints" - as if mkoeppe is the sole project owner
flat refusal to consider normal ways to deal with package name clashes

etc.

mkoeppe · 2024-09-25T19:39:41Z

"to consider normal ways to deal with package name clashes" -- obviously outside of the scope of this PR.

mkoeppe · 2024-09-26T00:24:10Z

Closing in favor of:

Move metadata from src/setup.cfg.m4 to src/pyproject.toml #38714

tobiasdiez · 2024-09-28T06:04:44Z

I've now cherry-picked the uncontroversial parts of this PR (or more specifically of #38714) to #38727. I think nobody objected that the metadata moved from the old setup.cfg to the modern pyproject.toml.

saraedum added s: needs review disputed PR is waiting for community vote, see https://groups.google.com/g/sage-devel/c/IgBYUJl33SQ labels Apr 29, 2024

This was referenced Apr 29, 2024

pkgs/sagemath-standard: Move metadata from setup.cfg to pyproject.toml #36951

Merged

Revert PR with disputed dependencies #37796

Merged

tornaria requested a review from orlitzky April 29, 2024 13:49

This comment was marked as abuse.

Sign in to view

mkoeppe self-assigned this Apr 29, 2024

mkoeppe requested review from kiwifb, culler, NathanDunfield, antonio-rojas and williamstein April 29, 2024 18:12

mkoeppe added the c: distribution label Apr 29, 2024

mkoeppe added the s: needs work label May 3, 2024

mkoeppe force-pushed the 36951 branch from 26a234d to a228617 Compare May 17, 2024 04:07

github-actions bot added the v: large label May 17, 2024

mkoeppe removed the s: needs work label May 17, 2024

vbraun force-pushed the develop branch from eba5e19 to e5f42fa Compare June 3, 2024 22:15

mkoeppe force-pushed the 36951 branch 5 times, most recently from 51593bf to 52856cb Compare June 12, 2024 21:07

mkoeppe added s: needs review and removed s: needs work labels Sep 5, 2024

kwankyu approved these changes Sep 6, 2024

View reviewed changes

kwankyu added s: positive review and removed s: needs review labels Sep 6, 2024

kwankyu mentioned this pull request Sep 6, 2024

build/pkgs/numpy 2.0.1, scipy 1.13.1, cmake 3.30.2, gsl 2.8, meson 1.5.1, meson_python 0.16.0, ninja_build 1.12.1, openblas 0.3.28, pybind11 2.13.1, pythran 0.16.1 #38227

Closed

5 tasks

tobiasdiez added s: needs work and removed s: positive review labels Sep 6, 2024

mkoeppe added s: needs review disputed PR is waiting for community vote, see https://groups.google.com/g/sage-devel/c/IgBYUJl33SQ and removed s: needs work labels Sep 6, 2024

mkoeppe closed this Sep 26, 2024

github-actions bot removed the s: needs review label Sep 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pkgs/sagemath-standard: Move metadata from setup.cfg to pyproject.toml #37902

pkgs/sagemath-standard: Move metadata from setup.cfg to pyproject.toml #37902

saraedum commented Apr 29, 2024 •

edited by mkoeppe

Loading

saraedum commented Apr 29, 2024

github-actions bot commented Apr 29, 2024 •

edited

Loading

tornaria commented Apr 29, 2024

This comment was marked as abuse.

orlitzky commented Apr 30, 2024

NathanDunfield commented Apr 30, 2024

culler commented Apr 30, 2024

mkoeppe commented May 17, 2024 •

edited

Loading

kwankyu left a comment

tobiasdiez commented Sep 6, 2024

kwankyu commented Sep 6, 2024 •

edited

Loading

tobiasdiez commented Sep 6, 2024

kwankyu commented Sep 6, 2024

mkoeppe commented Sep 6, 2024

mkoeppe commented Sep 6, 2024

kwankyu commented Sep 9, 2024

dimpase commented Sep 19, 2024

mkoeppe commented Sep 25, 2024

mkoeppe commented Sep 26, 2024

tobiasdiez commented Sep 28, 2024

pkgs/sagemath-standard: Move metadata from setup.cfg to pyproject.toml #37902

pkgs/sagemath-standard: Move metadata from setup.cfg to pyproject.toml #37902

Conversation

saraedum commented Apr 29, 2024 • edited by mkoeppe Loading

📝 Checklist

⌛ Dependencies

saraedum commented Apr 29, 2024

github-actions bot commented Apr 29, 2024 • edited Loading

tornaria commented Apr 29, 2024

This comment was marked as abuse.

orlitzky commented Apr 30, 2024

NathanDunfield commented Apr 30, 2024

culler commented Apr 30, 2024

mkoeppe commented May 17, 2024 • edited Loading

kwankyu left a comment

Choose a reason for hiding this comment

tobiasdiez commented Sep 6, 2024

kwankyu commented Sep 6, 2024 • edited Loading

tobiasdiez commented Sep 6, 2024

kwankyu commented Sep 6, 2024

mkoeppe commented Sep 6, 2024

mkoeppe commented Sep 6, 2024

kwankyu commented Sep 9, 2024

dimpase commented Sep 19, 2024

mkoeppe commented Sep 25, 2024

mkoeppe commented Sep 26, 2024

tobiasdiez commented Sep 28, 2024

saraedum commented Apr 29, 2024 •

edited by mkoeppe

Loading

github-actions bot commented Apr 29, 2024 •

edited

Loading

mkoeppe commented May 17, 2024 •

edited

Loading

kwankyu commented Sep 6, 2024 •

edited

Loading