8000 Port requirements to PEP735 by QuLogic · Pull Request #29281 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Port requirements to PEP735 #29281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Port requirements to PEP735 #29281

wants to merge 1 commit into from

Conversation

QuLogic
Copy link
Member
@QuLogic QuLogic commented Dec 11, 2024

PR summary

PEP735 introduces the concept of "Dependency Groups"; these essentially replace our use of various requirements.txt files.

NOTE: This is waiting for pip to actually implement Dependency Groups: pypa/pip#12963 We may or may not wish to wait for that to bake a bit even after it's been implemented as well.

PR checklist

@QuLogic
Copy link
Member Author
QuLogic commented Dec 11, 2024

Note, tox does support this already, so the stubtest job is the only one (using dependencies) that does work right now.

Copy link
Member
@WeatherGod WeatherGod left a comment

Choose a reason for hiding this comment

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

I was curious about this new PEP, so I took a look through the changes. I think this would be a really neat feature when pip implements it. I know this is just a draft, but I figured I can point out a couple things I noticed, and I had a couple of questions, too.

@@ -71,8 +71,7 @@ stages:

- bash: |
python -m pip install --upgrade pip
python -m pip install --upgrade -r requirements/dev/build-requirements.txt
python -m pip install -r requirements/testing/all.txt -r requirements/testing/extra.txt
python -m pip install --group build --group test --group test-extra
Copy link
Member

Choose a reason for hiding this comment

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

We'll have to see if it matters whether or not we were upgrading certain dependencies or not. I suspect not.

pyproject.toml Outdated

# Extra pip requirements for the Python 3.10+ builds
test-extra = [
"--prefer-binary",
Copy link
Member

Choose a reason for hiding this comment

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

Will command-line arguments and sys.platform references work in this PEP? It isn't entirely clear to me.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, the command-line argument probably won't, but we'll have to see how the pip implementation ends up. The sys.platform should work as these are standard dependency specifiers.

Copy link
Member

Choose a reason for hiding this comment

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

I learned something new! Neat!

Copy link
Member Author

Choose a reason for hiding this comment

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

So unfortunately, we can't keep --prefer-binary here, so I've moved it to the CI invocation.

@@ -51,7 +51,7 @@ jobs:
python-version: '3.10'

- name: Install mypy
run: pip3 install -r requirements/testing/mypy.txt -r requirements/testing/all.txt
run: pip3 install --group typing
Copy link
Member

Choose a reason for hiding this comment

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

does this also need group "test"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm hoping not, so we can reduce the install set.

pyproject.toml Outdated
#
# You will first need a matching Matplotlib installation
# e.g (from the Matplotlib root directory)
# pip install --no-build-isolation --editable .[dev]
Copy link
Member

Choose a reason for hiding this comment

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

Is the .[dev] correct? Or should it be just .?

Copy link
Member Author

Choose a reason for hiding this comment

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

The [dev] is an extra, not a dependency group. It was intended to cover both build and runtime dependencies. It didn't really work though, as pip installed . before its dependencies, so you couldn't get the build ones early enough. Based on the other implementations, dependency groups should be strictly better, since they should install before ., but we'll have to see how it's finally implemented. I should probably rewrite this section a bit once that's finalized.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I see. I'm not used to seeing an extra be specified against a directory, so I thought it was a typo. And, yeah, extras wouldn't work for installing dependencies.

Copy link
Member Author

Choose a reason for hiding this comment

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

No more .[dev] now.

@QuLogic
Copy link
Member Author
QuLogic commented Apr 22, 2025

I rebased and fixed the comments. pip doesn't yet support this, but pypa/pip#13065 is scheduled for 25.1 next weekend.

@QuLogic QuLogic force-pushed the pep735 branch 3 times, most recently from 5803913 to 6770028 Compare May 1, 2025 09:39
@QuLogic QuLogic marked this pull request as ready for review May 1, 2025 09:39
Copy link
Member
@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

This is also going to require pip >= 25.1 for anyone developing Matplotlib - that should at least go in some sort of release note/changelog entry, and be noted in the development setup docs.

@@ -50,12 +50,12 @@ jobs:
- name-suffix: "(Minimum Versions)"
os: ubuntu-22.04
python-version: '3.11'
extra-requirements: '-c requirements/testing/minver.txt'
extra-requirements: 'python -m pip install --upgrade $PRE --group test-minver'
Copy link
Member

Choose a reason for hiding this comment

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

Why the addition of $PRE here?

Copy link
Member Author

Choose a reason for hiding this comment

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

This was always used: https://github.com/matplotlib/matplotlib/pull/29281/files#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fL218

But I've changed this line a bit to not require the full invocation.

python -m pip install -r requirements/testing/all.txt -r requirements/testing/extra.txt
python -m pip install --upgrade --group build
python -m pip install --group test
python -m pip install --prefer-binary --group test-extra
Copy link
Member

Choose a reason for hiding this comment

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

Worth a comment explaining the reason for using --prefer-binary just for test-extra?

Copy link
Member Author

Choose a reason for hiding this comment

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

This came from the original file: https://github.com/matplotlib/matplotlib/pull/29281/files#diff-1823d2c36efddd45c3c2fa83d0fa74b23c3559ee9ceb371d4dfcb14372d9efaeL3

But I'm actually unsure if it's applied to only the requirements file that contained it, or the entire command-line.

Copy link
Member Author

Choose a reason for hiding this comment

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

Looking at https://pip.pypa.io/en/stable/reference/requirements-file-format/#global-options it is global, so I'm going to add it on all calls.

pyproject.toml Outdated
{include-group = "doc"},
{include-group = "test"},
{include-group = "test-extra"},
"ruff",
Copy link
Member

Choose a reason for hiding this comment

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

pre-commit should be added here, and perhaps ruff dropped since running pre-commit runs ruff.

pyproject.toml Outdated
"types-python-dateutil",
"types-psutil" F438 ,
"sphinx",
{include-group = "build"},
Copy link
Member

Choose a reason for hiding this comment

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

Given the doc and test groups dont' depend on build, I don't think typing should either, and the build group can be additionally specified during the CI install stage.

@QuLogic
Copy link
Member Author
QuLogic commented May 28, 2025

Added a few notes for the pip 25.1 requirement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI: Run cygwin Run cygwin tests on a PR Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0