Default value for filename in nox.project.load_toml

[paduszyk]

How would this feature be useful?

I think most people will use the nox.project.load_toml function (added in #811) with their pyproject.toml. In fact, the name of the function itself suggests loading from a TOML.

Describe the solution you'd like

I would update the function's signature:

nox/nox/project.py

Line 33 in e0868b6

def load_toml(filename: os.PathLike[str] | str) -> dict[str, Any]:

with:

def load_toml(filename: os.PathLike[str] | str = "pyproject.toml") -> dict[str, Any]: 

or set the default to None and evaluate the file location from pwd:

def load_toml(filename: os.PathLike[str] | str | None = None) -> dict[str, Any]: 
    if filename is None:
        filename = Path.cwd() / "pyproject.toml"

    # ...

Describe alternatives you've considered

Alternatively, the path to the pyproject.toml can be set via nox.options.

Anything else?

No response

[CAM-Gerlach]

Not a Nox maintainer or anything, but FYI, you can just do Path("pyproject.toml") rather than the unnecessary Path.cwd() / "pyproject.toml", since filename doesn't require absolute paths (as the example indeed shows).

[henryiii]

The function was actually added to make loading PEP 723 files easier, since it's a pretty trivial wrapper over tomllib/tomli otherwise. But defaulting to pyprojec.toml doesn't seem unreasonable.

[paduszyk]

Not a Nox maintainer or anything, but FYI, you can just do Path("pyproject.toml") rather than the unnecessary Path.cwd() / "pyproject.toml", since filename doesn't require absolute paths (as the example indeed shows).

@CAM-Gerlach Yeah. Maybe I've been too much into PEP 20, line 2: Explicit is better than implicit. 😄

[CAM-Gerlach]

Well, as I am a PEP editor, I can say that despite the widespread misconception to the contrary, PEP 20 (the Zen of Python) was never intended to be taken seriously as a set of rules for the language, as opposed to one core dev's tongue in cheek ideas :)