Add a nox session for regenerating pinned requirements files used in CI by namurphy · Pull Request #2664 · PlasmaPy/PlasmaPy

namurphy · 2024-05-03T21:05:54Z

This PR adds a nox environment that can be used to regenerate requirements files. It can be run with nox -s requirements. The intention of this nox environment is to eventually replace the current tox environment, but the removal of the tox environment will come after sessions for running tests get added to noxfile.py...hopefully soon.

This PR also standardizes the naming scheme for the requirements files, ideally making the names of the files better reflect what they are used for.

All of the files in ci_requirements/ are auto-generated, so they probably be mostly skipped during the review.

Only a couple pull requests into this, and I'm already hoping I never have to edit a tox.ini file ever again! 😹

Related issues

#1734, #1735, #2647, #2654, #2656

codecov · 2024-05-03T21:09:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.88%. Comparing base (79b1c19) to head (f454ee0).

❗ Current head f454ee0 differs from pull request most recent head b3d6ce4. Consider uploading reports for the commit b3d6ce4 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2664      +/-   ##
==========================================
- Coverage   95.21%   94.88%   -0.33%     
==========================================
  Files         103      103              
  Lines        9412     9412              
  Branches     2155     2155              
==========================================
- Hits         8962     8931      -31     
- Misses        273      299      +26     
- Partials      177      182       +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…ents

namurphy · 2024-05-04T00:33:27Z

I ran into a problem when I was running nox -e requirements locally with Python 3.12, without Python 3.10 installed, and when trying to resolve requirements for Python 3.10. I ended up getting:

nox > python -m uv pip compile pyproject.toml --upgrade -p 3.10 --extra tests -o ci_requirements/tests-3.10-highest.txt
error: Querying Python at `/usr/bin/python3` failed with status exit status: 1 with exit status: 1
--- stdout:

--- stderr:
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/run/media/namurphy/d423d80e-c227-4a33-b50f-545b44160ce3/namurphy/.cache/uv/.tmppRkEoP/python/get_interpreter_info.py", line 536, in main
    "platform": get_operating_system_and_architecture(),
  File "/run/media/namurphy/d423d80e-c227-4a33-b50f-545b44160ce3/namurphy/.cache/uv/.tmppRkEoP/python/get_interpreter_info.py", line 439, in get_operating_system_and_architecture
    from .packaging._manylinux import _get_glibc_version
  File "/run/media/namurphy/d423d80e-c227-4a33-b50f-545b44160ce3/namurphy/.cache/uv/.tmppRkEoP/python/packaging/_manylinux.py", line 1
    from __future__ import annotations
    ^
SyntaxError: future feature annotations is not defined
---
nox > Command python -m uv pip compile pyproject.toml --upgrade -p 3.10 --extra tests -o ci_requirements/tests-3.10-highest.txt failed with exit code 2
nox > Session requirements failed.

Will have to look into this later...

namurphy · 2024-05-04T00:47:09Z

📝 Some differences between nox and tox

A tox environment corresponds to a nox session.
Similarly, the flag used to invoke a nox session should preferably be nox -s requirements (instead of -e, though -e also works, presumably for cross-compatibility with tox).

namurphy · 2024-05-04T00:48:06Z

+requirements_directory = "ci_requirements"
+
+
+def get_requirements_file(


One of the benefits of switching to nox is that we can define functions to help create testing environments!

…ents

namurphy · 2024-05-06T20:10:06Z

I ran into a problem when I was running nox -e requirements locally with Python 3.12, without Python 3.10 installed, and when trying to resolve requirements for Python 3.10.

It turns out that this problem occurred on my workstation at work (running RHEL) but did not occur on my home computer (running Ubuntu 22.04).

This PR is going to wait until after the 2024.5.0 release.

…ents

namurphy · 2024-05-09T02:35:09Z

+    # Temporarily use requirements files generated both by tox and nox
+    # during the switchover from tox to nox.


Because the requirements filenames are changing, we'll need the files generated by tox for the remaining tox environments, as well as the files generated by nox for the current and forthcoming nox sessions. It'll be messier having duplicate requirements files under different names, but I want to switch things over completely soon.

Running `nox` will now make it print out a help message along with the list of sessions.

ejohnson-96

👍

Add nox to tests and docs requirements

18cd692

github-actions Bot added the packaging Related to packaging or distribution label May 3, 2024

Add requirements environment to nox

8956977

github-actions Bot added testing CI Related to continuous integration labels May 4, 2024

namurphy added 2 commits May 3, 2024 20:26

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox-requirem…

33d9926

…ents

Have uv pip compile be quiet

6453f7a

namurphy changed the title ~~🚧 Add a nox environment for regenerating pinned requirements files used in CI~~ 🚧 Add a nox session for regenerating pinned requirements files used in CI May 4, 2024

namurphy commented May 4, 2024

View reviewed changes

Comment thread noxfile.py Resolved

namurphy added 6 commits May 4, 2024 10:37

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox-requirem…

0cdb268

…ents

Run nox -s requirements

863753c

Update noxfile.py

7869b9d

Update & rename nox-generated requirements files

ee1d39a

Apply resolution strategy

3715c62

Update lowest direct requirements

8e3f0a5

namurphy mentioned this pull request May 8, 2024

[proposal] Switch from tox to Nox for running continuous integration environments astropy/astropy#16412

Closed

namurphy added 3 commits May 8, 2024 21:42

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox-requirem…

90785a5

…ents

Edit changelog: 2664.internal.rst

32201f2

Remove the requirements files added by the nox session

4977e39

namurphy commented May 9, 2024

View reviewed changes

Comment thread noxfile.py Resolved

namurphy added 3 commits May 8, 2024 22:28

Clean up noxfile.py

5079fd9

Add requirements files autogenerated by nox

83a02a8

Add nox session to workflow updating pinned reqs

e756d2d

github-actions Bot added the GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) label May 9, 2024

namurphy commented May 9, 2024

View reviewed changes

Comment thread ci_requirements/all-3.12.txt Resolved

namurphy commented May 9, 2024

View reviewed changes

namurphy added 2 commits May 8, 2024 22:37

Make it so that a session needs to be defined when running nox

f454ee0

Running `nox` will now make it print out a help message along with the list of sessions.

Remove comments used as section headers

b3d6ce4

namurphy marked this pull request as ready for review May 9, 2024 02:41

namurphy requested a review from a team as a code owner May 9, 2024 02:41

namurphy requested review from ejohnson-96 and removed request for a team May 9, 2024 02:41

namurphy changed the title ~~🚧 Add a nox session for regenerating pinned requirements files used in CI~~ Add a nox session for regenerating pinned requirements files used in CI May 9, 2024

namurphy requested a review from pheuer May 9, 2024 18:03

ejohnson-96 approved these changes May 9, 2024

View reviewed changes

namurphy removed the request for review from pheuer May 9, 2024 19:10

namurphy merged commit f35d5b3 into PlasmaPy:main May 9, 2024

namurphy deleted the nox-requirements branch May 9, 2024 19:23

namurphy mentioned this pull request May 13, 2024

Switch GitHub workflows used in CI from tox environments to nox sessions #2685

Merged

namurphy added the nox Related to the nox automation software label May 14, 2024

Navigation Menu

Repository navigation

Add a nox session for regenerating pinned requirements files used in CI - #2664

Add a nox session for regenerating pinned requirements files used in CI#2664
namurphy merged 18 commits into
PlasmaPy:mainfrom
namurphy:nox-requirements

namurphy commented May 3, 2024 •

edited

Loading

Uh oh!

codecov Bot commented May 3, 2024 •

edited

Loading

Uh oh!

namurphy commented May 4, 2024 •

edited

Loading

Uh oh!

namurphy commented May 4, 2024

Uh oh!

namurphy May 4, 2024

Uh oh!

Uh oh!

namurphy commented May 6, 2024

Uh oh!

Uh oh!

Uh oh!

namurphy May 9, 2024

Uh oh!

ejohnson-96 left a comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		requirements_directory = "ci_requirements"


		def get_requirements_file(

		# Temporarily use requirements files generated both by tox and nox
		# during the switchover from tox to nox.

Conversation

namurphy commented May 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Uh oh!

codecov Bot commented May 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

namurphy commented May 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

namurphy commented May 4, 2024

Uh oh!

namurphy May 4, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

namurphy commented May 6, 2024

Uh oh!

Uh oh!

Uh oh!

namurphy May 9, 2024

Choose a reason for hiding this comment

Uh oh!

ejohnson-96 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

namurphy commented May 3, 2024 •

edited

Loading

codecov Bot commented May 3, 2024 •

edited

Loading

namurphy commented May 4, 2024 •

edited

Loading