search

wntrblm / nox

Flexible test automation for Python
https://nox.thea.codes
Apache License 2.0
1.3k stars 148 forks source link

feat: support PEP 723 with a toml load function #811

Closed henryiii closed 4 months ago

henryiii commented 5 months ago

This is the suggestion from #808. As detailed there, I think this is a flexible first step that will help noxfile authors support PEP 723 in scripts, and could have a followup later that provides a more integrated solution.

This also allows noxfile authors to finally integrate with pyproject.toml on all versions of Python, rather than requiring nox be installed on Python 3.11+, by ensuring that a toml library is always present. You might need to read the version, etc. from pyproject.toml in your noxfile, and now you can.

I made all the errors ValueError because that's what the PEP did in the example implementation. Happy to make them something else if there's something better.

cjolowicz commented 5 months ago

Should we fail the session instead of raising ValueError? Nox can be more opinionated about the error handling than say a library, and it would avoid the traceback.

henryiii commented 5 months ago

Hmm, we could, but most of the improperly configured calls seem to also raise ValueError, such as

https://github.com/wntrblm/nox/blob/956f10c5691b4f4d1a7e2d648fa2ca2eb4b27ab5/nox/sessions.py#L219

and

https://github.com/wntrblm/nox/blob/956f10c5691b4f4d1a7e2d648fa2ca2eb4b27ab5/nox/sessions.py#L388-L393

henryiii commented 5 months ago

Current name (from the issue) is nox.project.load_toml. nox.project is imported by default.

henryiii commented 4 months ago

Do we want to mark this as a provisional API in some way? ...

I think what we've added here is pretty conservative. nox.project is a place for project related tools. load_toml does exactly that, it loads toml and nothing more. (It does support PEP 723, but that's accepted so it isn't allowed to change significantly without a new PEP). We've left it up to the user to handle converting pyproject.toml's and script blocks into useable information.

If we add more things here, then possibly. If we have a session_from_script helper or something, that could be provisional. Or helpers for parametrizing over the Python versions allowed. Etc.

(But happy to call this provisional too if you prefer)