Skip to content

Comments

docs: clarify local vs global config precedence#10676

Merged
radoering merged 2 commits intopython-poetry:mainfrom
nothing-991:docs-config-precedence-10329
Jan 2, 2026
Merged

docs: clarify local vs global config precedence#10676
radoering merged 2 commits intopython-poetry:mainfrom
nothing-991:docs-config-precedence-10329

Conversation

@nothing-991
Copy link
Contributor

@nothing-991 nothing-991 commented Dec 31, 2025

Resolves: #10329

This PR clarifies how Poetry handles conflicting configuration settings when the same setting is defined both locally (in poetry.toml) and globally (in config.toml).
A new note has been added to the Configuration documentation:
Note: If a setting is defined in both poetry.toml (local/project) and config.toml (global), the local/project configuration takes precedence over the global configuration.
This change helps contributors and users understand which configuration will apply without needing to test it themselves.
No code changes were made—only the documentation has been updated.

Summary by Sourcery

Documentation:

  • Document that local/project configuration in poetry.toml overrides global configuration in config.toml when the same setting is defined in both.

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 31, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documents that when the same configuration key is set both locally in poetry.toml and globally in config.toml, the local/project setting takes precedence, by adding a note to the configuration documentation.

File-Level Changes

Change Details Files
Document precedence between local/project and global Poetry configuration settings.
  • Add a documentation note stating that when a setting exists in both local poetry.toml and global config.toml, the local/project configuration wins
  • Place the new note directly after the existing explanation of poetry.toml and before the warning about checking in this file
docs/configuration.md

Possibly linked issues


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 found 1 issue, and left some high level feedback:

  • While you’re updating this section, consider fixing the existing shortcode mismatch where the {{% warning %}} block is closed with {{% /note %}}, which could lead to rendering issues in the docs.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- While you’re updating this section, consider fixing the existing shortcode mismatch where the `{{% warning %}}` block is closed with `{{% /note %}}`, which could lead to rendering issues in the docs.

## Individual Comments

### Comment 1
<location> `docs/configuration.md:43-44` </location>
<code_context>
+the local/project configuration takes precedence over the global configuration.
+{{% /note %}}
+
 {{% warning %}}
 Be mindful about checking in this file into your repository since it may contain user-specific or sensitive information.
 {{% /note %}}
</code_context>

<issue_to_address>
**suggestion (typo):** Consider rephrasing this sentence to avoid the awkward "checking in this file into" construction.

The phrase "Be mindful about checking in this file into your repository" is grammatically awkward because of the "about … into" combination. Consider rewording to something like "Be mindful when checking this file into your repository" or "Be mindful about checking this file into your repository" for better flow.
</issue_to_address>

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.

Comment on lines 43 to 44
{{% warning %}}
Be mindful about checking in this file into your repository since it may contain user-specific or sensitive information.
Copy link

Choose a reason for hiding this comment

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

suggestion (typo): Consider rephrasing this sentence to avoid the awkward "checking in this file into" construction.

The phrase "Be mindful about checking in this file into your repository" is grammatically awkward because of the "about … into" combination. Consider rewording to something like "Be mindful when checking this file into your repository" or "Be mindful about checking this file into your repository" for better flow.

@nothing-991 nothing-991 force-pushed the docs-config-precedence-10329 branch from c48c984 to 8d0ec74 Compare December 31, 2025 10:53
@radoering radoering added the impact/docs Contains or requires documentation changes label Jan 2, 2026
@github-actions
Copy link

github-actions bot commented Jan 2, 2026

Deploy preview for website ready!

✅ Preview
https://website-dbz3qirmf-python-poetry.vercel.app

Built with commit 8d0ec74.
This pull request is being automatically deployed with vercel-action

@radoering radoering changed the title docs: clarify local vs global config precedence (#10329) docs: clarify local vs global config precedence Jan 2, 2026
@radoering radoering merged commit 5e1fd5e into python-poetry:main Jan 2, 2026
57 checks passed
@nothing-991 nothing-991 deleted the docs-config-precedence-10329 branch January 4, 2026 04:49
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]>
@github-actions
Copy link

github-actions bot commented Feb 4, 2026

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 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

impact/docs Contains or requires documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

local-configurations VS global-configurations, which takes precedence

2 participants