Update init & new commands for PEP 639 (License) by dunkmann00 · Pull Request #10787 · python-poetry/poetry (original) (raw)

Please address the comments from this code review:

Overall Comments

• Now that license is represented as a string instead of a table, please scan for and update any remaining code paths that still assume project_content['license'] is a mapping (e.g., accessing ['text']) to avoid subtle runtime errors.
• Given license is now initialized as an empty string in the layout, consider whether using None or omitting the key until a value is set would better convey the absence of a license and simplify checks where you currently rely on truthiness.

Individual Comments

Comment 1

These expectations only cover the interactive init flow. Please also add coverage for the non-interactive path (e.g., using the --license flag and/or a preconfigured license), and assert that the generated pyproject.toml also uses the scalar license = "..." format. This will help catch any divergence between interactive and non-interactive handling.

Suggested implementation:

authors = [
    {name = "Your Name",email = "you@example.com"}
]
license = "MIT"
requires-python = ">=3.6"
dependencies = [
    "pendulum (>=2.0.0,<3.0.0)",
authors = [
    {name = "Your Name",email = "you@example.com"}
]
license = "MIT"
requires-python = ">=3.6"
"""

I can only see a small literal snippet of the test file, so to fully implement your request the following concrete additions are needed elsewhere in tests/console/commands/test_init.py:

1. Add an expected PyProject string for the non-interactive path
   Define a new constant (mirroring how the interactive expected content is stored), for example:

   EXPECTED_PYPROJECT_NON_INTERACTIVE_LICENSE = """[project]
   name = "example"
   version = "0.1.0"
   description = ""
   authors = [
       {name = "Your Name", email = "you@example.com"},
   ]
   license = "MIT"
   requires-python = ">=3.6"
   dependencies = []
   """

   Make sure the license line is scalar, i.e. license = "MIT" (not a table or {text = ...}).

2. Add a non-interactive init test that uses the --license flag
   Create a new test function using the same CLI harness and patterns as the other tests in this file, for example:

   def test_init_non_interactive_license_scalar(tmp_path, cli_runner):
       project_dir = tmp_path / "example"
       result = cli_runner.invoke(
           app,
           [
               "init",
               "--name", "example",
               "--author", "Your Name <you@example.com>",
               "--license", "MIT",
               "--no-interaction",
               "--path", str(project_dir),
           ],
       )
       assert result.exit_code == 0
   
       pyproject = (project_dir / "pyproject.toml").read_text()
       assert 'license = "MIT"' in pyproject
       # If your other tests do full-string comparisons, also:
       # assert pyproject.strip() == EXPECTED_PYPROJECT_NON_INTERACTIVE_LICENSE.strip()

   Adjust app, cli_runner, and flags to match how the rest of the tests in this file invoke the init command (e.g., poetry vs app, --no-interaction vs -n, etc.).

3. Cover preconfigured license (if there is such a code path)
   If the init command also reads a default/preconfigured license (e.g., from a config file or environment variable) without the --license flag:

   • Add a second test that sets up that configuration (using fixtures or monkeypatching, consistent with the existing tests).
   • Run init non-interactively without --license.
   • Assert again that the generated pyproject.toml contains license = "..." as a scalar, not the old {text = ...} table format.

4. Keep parity with interactive expectations
   Ensure both interactive and non-interactive tests assert the same scalar license format so that any future regression (e.g., one path reverting to {text = "MIT"}) will be caught.

Comment 2

To fully exercise the PEP 639 behavior, it’d be useful to add a counterpart fixture (e.g. init_no_license_toml / new_no_license_toml) and tests that simulate skipping the license in init/new, then assert that the license key is completely absent from pyproject.toml. That would validate both the default layout and interactive command handling for the "no license" path.

Suggested implementation:

INIT_TOML = """
authors = [
    {name = "Your Name",email = "you@example.com"}
]
license = "MIT"
readme = "README.md"
requires-python = ">=3.6"
"""

NEW_TOML = """
authors = [
    {name = "Your Name",email = "you@example.com"}
]
license = "MIT"
readme = "README.md"
requires-python = ">=3.6"
dependencies = [
"""

INIT_NO_LICENSE_TOML = """
authors = [
    {name = "Your Name",email = "you@example.com"}
]
readme = "README.md"
requires-python = ">=3.6"
"""

NEW_NO_LICENSE_TOML = """
authors = [
    {name = "Your Name",email = "you@example.com"}
]
readme = "README.md"
requires-python = ">=3.6"
dependencies = [
"""

1. If this file currently defines fixtures that use the original TOML literals (e.g. init_toml, new_toml), update them to use INIT_TOML / NEW_TOML instead.
2. Add counterpart fixtures (e.g. init_no_license_toml, new_no_license_toml) that write INIT_NO_LICENSE_TOML / NEW_NO_LICENSE_TOML into pyproject.toml in their respective temporary directories.
3. Add tests for the init and new commands that:
   • Simulate skipping license selection in the interactive prompts (or however “no license” is currently represented).
   • Use the new fixtures and assert that the resulting pyproject.toml does not contain a license key at all.
4. If the surrounding code already uses different constant names or patterns, align the new constants/fixtures with that existing naming convention.