Skip to content

Comments

env use: fail if python version is not supported by the project#10685

Merged
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-env-use-not-supported
Jan 17, 2026
Merged

env use: fail if python version is not supported by the project#10685
radoering merged 1 commit intopython-poetry:mainfrom
radoering:fix-env-use-not-supported

Conversation

@radoering
Copy link
Member

@radoering radoering commented Jan 10, 2026

Pull Request Check List

Resolves: https://github.com/orgs/python-poetry/discussions/10523

use-poetry-python should only be relevant if no specific python version has been requested.

  • Added tests for changed code.
  • Updated documentation for changed code.

This bug originates from #4852 when the condition was not as clear as it is now:

if not executable and prefer_active_python:
    executable = self._detect_active_python(io)

...

if executable and not prefer_active_python:
    raise NoCompatiblePythonVersionFound(
        self._poetry.package.python_versions, python_patch
    )

Summary by Sourcery

Ensure env use and virtualenv creation fail cleanly when a specifically requested Python version is not compatible with the project, regardless of the use-poetry-python setting.

Bug Fixes:

  • Prevent creation or activation of virtualenvs when a user explicitly requests an unsupported Python version, independent of the virtualenvs.use-poetry-python configuration.

Tests:

  • Add tests verifying that env use does not create or activate environments for unsupported Python versions and that executable-based venv creation skips compatibility lookups for both values of use-poetry-python.

Chores:

  • Adjust test fixtures to use a dedicated virtualenv cache directory and assert its initial emptiness before environment creation.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 10, 2026

Reviewer's Guide

Ensures env use fails fast when a requested Python version is not supported by the project, regardless of the virtualenvs.use-poetry-python setting, and tightens tests around venv cache behavior and Python version selection.

Sequence diagram for env_use failing on unsupported_python_version

sequenceDiagram
    actor Developer
    participant EnvUseCommand
    participant EnvManager
    participant PoetryConfig
    participant PoetryPackage

    Developer->>EnvUseCommand: env use python_spec
    EnvUseCommand->>EnvManager: create_venv(python_spec)
    EnvManager->>EnvManager: determine specific_python_requested
    EnvManager->>PoetryConfig: get(virtualenvs.create)
    EnvManager->>PoetryConfig: get(virtualenvs.prompt)
    EnvManager->>PoetryPackage: read python_versions

    alt python_spec not_compatible_with PoetryPackage.python_versions
        EnvManager->>EnvManager: detect_no_compatible_python
        EnvManager-->>EnvUseCommand: raise NoCompatiblePythonVersionFoundError
        EnvUseCommand-->>Developer: display error unsupported Python version
    else python_spec compatible
        EnvManager->>EnvManager: proceed_with_venv_creation
        EnvManager-->>EnvUseCommand: return created_virtualenv
        EnvUseCommand-->>Developer: show success message
    end
Loading

Class diagram for EnvManager_create_venv Python_version_handling

classDiagram
    class EnvManager {
        +create_venv(python, io)
        -use_in_project_venv() bool
        -_poetry Poetry
    }

    class Poetry {
        +config Config
        +package Package
    }

    class Config {
        +get(key) any
    }

    class Package {
        +python_versions str
    }

    class NoCompatiblePythonVersionFoundError {
    }

    EnvManager --> Poetry : uses
    Poetry --> Config : has
    Poetry --> Package : has
    EnvManager ..> NoCompatiblePythonVersionFoundError : raises

    note for EnvManager "In create_venv:
- specific_python_requested is true when python is not None
- If specific_python_requested and requested version is incompatible
  with Package.python_versions, EnvManager now always raises
  NoCompatiblePythonVersionFoundError, regardless of
  Config[virtualenvs.use-poetry-python]"
Loading

File-Level Changes

Change Details Files
Change EnvManager.create_venv so that specifying an explicit Python executable always triggers an incompatibility error when the version is unsupported, independent of the use-poetry-python configuration.
  • Remove retrieval of the virtualenvs.use-poetry-python flag from the configuration in create_venv.
  • Treat the presence of an explicit python argument as the only condition for raising NoCompatiblePythonVersionFoundError when the resolved executable is incompatible.
  • Leave the fallback logic for auto-detecting compatible Python versions unchanged when no explicit Python is requested.
src/poetry/utils/env/env_manager.py
Add and adjust tests to cover behavior when unsupported Python versions are requested and to ensure venv cache directories are cleanly handled.
  • In the env use command tests, assert that the venv cache directory starts empty, invoke env use with an unsupported Python version, and verify that no virtualenvs or envs.toml are created when NoCompatiblePythonVersionFoundError is raised, parameterized over use-poetry-python.
  • Update the venv_cache fixture to create and return a dedicated subdirectory to avoid mixing with other tmp_path contents.
  • Parameterize the EnvManager test for skipping compatible-version search when an executable is provided over both True and False values of virtualenvs.use-poetry-python, instead of forcing it to True.
tests/console/commands/env/test_use.py
tests/console/commands/env/conftest.py
tests/utils/env/test_env_manager.py

Possibly linked issues

  • #0: PR changes create_venv logic so explicit env use Python wins over use-poetry-python, fixing the reported behavior.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • Consider adding a short inline comment near the if specific_python_requested: check in create_venv() to explain why use-poetry-python is intentionally ignored when an explicit Python is requested, to prevent future re-introduction of the previous behavior.
  • In the new tests that assert an empty cache (assert not list(venv_cache.iterdir())), you could factor this into a small helper or use a more explicit check (e.g. assert not any(venv_cache.iterdir())) to make the intent clearer and avoid repeating the pattern.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider adding a short inline comment near the `if specific_python_requested:` check in `create_venv()` to explain why `use-poetry-python` is intentionally ignored when an explicit Python is requested, to prevent future re-introduction of the previous behavior.
- In the new tests that assert an empty cache (`assert not list(venv_cache.iterdir())`), you could factor this into a small helper or use a more explicit check (e.g. `assert not any(venv_cache.iterdir())`) to make the intent clearer and avoid repeating the pattern.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@radoering radoering force-pushed the fix-env-use-not-supported branch from 9001c58 to 9bc4196 Compare January 16, 2026 16:25
@radoering radoering merged commit 0e02be7 into python-poetry:main Jan 17, 2026
54 checks passed
mwalbeck pushed a commit to mwalbeck/docker-python-poetry that referenced this pull request Jan 19, 2026
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [poetry](https://github.com/python-poetry/poetry) ([changelog](https://python-poetry.org/history/)) | minor | ` 2.2.1` -> `2.3.0` |

---

### Release Notes

<details>
<summary>python-poetry/poetry (poetry)</summary>

### [`v2.3.0`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#230---2026-01-18)

[Compare Source](python-poetry/poetry@2.2.1...2.3.0)

##### Added

- **Add support for exporting `pylock.toml` files with `poetry-plugin-export`** ([#&#8203;10677](python-poetry/poetry#10677)).
- Add support for specifying build constraints for dependencies ([#&#8203;10388](python-poetry/poetry#10388)).
- Add support for publishing artifacts whose version is determined dynamically by the build-backend ([#&#8203;10644](python-poetry/poetry#10644)).
- Add support for editable project plugins ([#&#8203;10661](python-poetry/poetry#10661)).
- Check `requires-poetry` before any other validation ([#&#8203;10593](python-poetry/poetry#10593)).
- Validate the content of `project.readme` when running `poetry check` ([#&#8203;10604](python-poetry/poetry#10604)).
- Add the option to clear all caches by making the cache name in `poetry cache clear` optional ([#&#8203;10627](python-poetry/poetry#10627)).
- Automatically update the cache for packages where the locked files differ from cached files ([#&#8203;10657](python-poetry/poetry#10657)).
- Suggest to clear the cache if running a command with `--no-cache` solves an issue ([#&#8203;10585](python-poetry/poetry#10585)).
- Propose `poetry init` when trying `poetry new` for an existing directory ([#&#8203;10563](python-poetry/poetry#10563)).
- Add support for `poetry publish --skip-existing` for new Nexus OSS versions ([#&#8203;10603](python-poetry/poetry#10603)).
- Show Poetry's own Python's path in `poetry debug info` ([#&#8203;10588](python-poetry/poetry#10588)).

##### Changed

- **Drop support for Python 3.9** ([#&#8203;10634](python-poetry/poetry#10634)).
- **Change the default of `installer.re-resolve` from `true` to `false`** ([#&#8203;10622](python-poetry/poetry#10622)).
- **PEP 735 dependency groups are considered in the lock file hash** ([#&#8203;10621](python-poetry/poetry#10621)).
- Deprecate `poetry.utils._compat.metadata`, which is sometimes used in plugins, in favor of `importlib.metadata` ([#&#8203;10634](python-poetry/poetry#10634)).
- Improve managing free-threaded Python versions with `poetry python` ([#&#8203;10606](python-poetry/poetry#10606)).
- Prefer JSON API to HTML API in legacy repositories ([#&#8203;10672](python-poetry/poetry#10672)).
- When running `poetry init`, only add the readme field in the `pyproject.toml` if the readme file exists ([#&#8203;10679](python-poetry/poetry#10679)).
- Raise an error if no hash can be determined for any distribution link of a package ([#&#8203;10673](python-poetry/poetry#10673)).
- Require `dulwich>=0.25.0` ([#&#8203;10674](python-poetry/poetry#10674)).

##### Fixed

- Fix an issue where `poetry remove` did not work for PEP 735 dependency groups with `include-group` items ([#&#8203;10587](python-poetry/poetry#10587)).
- Fix an issue where `poetry remove` caused dangling `include-group` references in PEP 735 dependency groups ([#&#8203;10590](python-poetry/poetry#10590)).
- Fix an issue where `poetry add` did not work for PEP 735 dependency groups with `include-group` items ([#&#8203;10636](python-poetry/poetry#10636)).
- Fix an issue where PEP 735 dependency groups were not considered in the lock file hash ([#&#8203;10621](python-poetry/poetry#10621)).
- Fix an issue where wrong markers were locked for a dependency that was required by several groups with different markers ([#&#8203;10613](python-poetry/poetry#10613)).
- Fix an issue where non-deterministic markers were created in a method used by `poetry-plugin-export` ([#&#8203;10667](python-poetry/poetry#10667)).
- Fix an issue where wrong wheels were chosen for installation in free-threaded Python environments if Poetry itself was not installed with free-threaded Python ([#&#8203;10614](python-poetry/poetry#10614)).
- Fix an issue where `poetry publish` used the metadata of the project instead of the metadata of the build artifact ([#&#8203;10624](python-poetry/poetry#10624)).
- Fix an issue where `poetry env use` just used another Python version instead of failing when the requested version was not supported by the project ([#&#8203;10685](python-poetry/poetry#10685)).
- Fix an issue where `poetry env activate` returned the wrong command for `dash` ([#&#8203;10696](python-poetry/poetry#10696)).
- Fix an issue where `data-dir` and `python.installation-dir` could not be set ([#&#8203;10595](python-poetry/poetry#10595)).
- Fix an issue where Python and pip executables were not correctly detected on Windows ([#&#8203;10645](python-poetry/poetry#10645)).
- Fix an issue where invalid template variables in `virtualenvs.prompt` caused an incomprehensible error message ([#&#8203;10648](python-poetry/poetry#10648)).

##### Docs

- Add a warning about `~/.netrc` for Poetry credential configuration ([#&#8203;10630](python-poetry/poetry#10630)).
- Clarify that the local configuration takes precedence over the global configuration ([#&#8203;10676](python-poetry/poetry#10676)).
- Add an explanation in which cases `packages` are automatically detected ([#&#8203;10680](python-poetry/poetry#10680)).

##### poetry-core ([`2.3.0`](https://github.com/python-poetry/poetry-core/releases/tag/2.3.0))

- Normalize versions ([#&#8203;893](python-poetry/poetry-core#893)).
- Fix an issue where unsatisfiable requirements did not raise an error ([#&#8203;891](python-poetry/poetry-core#891)).
- Fix an issue where the implicit main group did not exist if it was explicitly declared as not having any dependencies ([#&#8203;892](python-poetry/poetry-core#892)).
- Fix an issue where `python_full_version` markers with pre-release versions were parsed incorrectly ([#&#8203;893](python-poetry/poetry-core#893)).

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xNDYuMCIsInVwZGF0ZWRJblZlciI6IjQxLjE0Ni4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Reviewed-on: https://git.walbeck.it/walbeck-it/docker-python-poetry/pulls/1654
Co-authored-by: renovate-bot <[email protected]>
Co-committed-by: renovate-bot <[email protected]>
nothing-991 pushed a commit to nothing-991/python-poetry that referenced this pull request Feb 3, 2026
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 17, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant