git: improve error message in case a file lock could not be acquired while cloning a repo by radoering · Pull Request #10535 · python-poetry/poetry

radoering · 2025-09-07T14:32:47Z

Pull Request Check List

Resolves: #7832

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

Short error message: Failed to clone <repo_url> at <ref>, unable to acquire file lock for <path>.

Verbose error message:

Failed to clone <repo_url> at <ref>, unable to acquire file lock for <path>.

Note: This error arises from interacting with the specified vcs source and is likely not a Poetry issue.
This issue could be caused by any of the following;

- another process is holding the file lock
- another process crashed while holding the file lock

Try again later or remove the <lock file path> manually if you are sure no other process is holding it.

Summary by Sourcery

Improve Git clone error handling by catching file lock acquisition failures, providing a clear short message and an extended troubleshooting note, refining related message constants, and adding a test for locked refs.

New Features:

Catch Git file lock exceptions during clone and present a tailored error message with concise and verbose guidance

Enhancements:

Separate network issue messages into a distinct section start constant
Introduce a dedicated problems section for file lock issues with clear recovery steps

Tests:

Add test to verify cloning behavior when a Git ref is already locked, ensuring the new error is raised and formatted correctly

…while cloning a repo

sourcery-ai · 2025-09-07T14:32:52Z

Reviewer's Guide

Enhances the Git backend to handle file lock acquisition failures during cloning by introducing a specific error constant, extending exception handling with tailored messages, refactoring problem-section constants for clarity, and adding tests to validate the new behavior.

Sequence diagram for handling file lock acquisition failure during Git clone

sequenceDiagram
    participant GitBackend
    participant LocalRepo
    participant FileLock
    participant PoetryRuntimeError
    GitBackend->>LocalRepo: import_refs()
    LocalRepo->>FileLock: acquire()
    FileLock-->>LocalRepo: throws FileLocked
    LocalRepo-->>GitBackend: raises FileLocked
    GitBackend->>PoetryRuntimeError: create(reason, info)
    PoetryRuntimeError-->>GitBackend: raises error with detailed message

Class diagram for updated error handling in Git backend

classDiagram
    class GitBackend {
        +_clone_legacy(url, refspec, target)
        +_clone(url, refspec, target)
    }
    class PoetryRuntimeError {
        +create(reason, info, exception=None)
    }
    class FileLocked {
        +filename: bytes
        +lockfilename: bytes
    }
    GitBackend --> PoetryRuntimeError : raises
    LocalRepo --> FileLocked : may raise
    GitBackend ..> FileLocked : handles exception

File-Level Changes

Change	Details	Files
Define specific file-lock error guidance	Added ERROR_MESSAGE_FILE_LOCK constant with lock failure hints	`src/poetry/vcs/git/backend.py`
Handle FileLocked exception during ref import	Wrapped local.refs.import_refs call in try/except Converted exception paths to readable strings Raised PoetryRuntimeError with formatted short and verbose info	`src/poetry/vcs/git/backend.py`
Refactor problem-section constants for network context	Split ERROR_MESSAGE_PROBLEMS_SECTION_START into generic and network variants Replaced plain section start with NETWORK_ISSUES in clone paths	`src/poetry/vcs/git/backend.py`
Add test for locked-file scenario	Created test_clone_existing_locked_tag to simulate tag lock file Assert both short error and detailed verbose output Extended conftest to include a v1 tag in temp repo	`tests/vcs/git/test_backend.py` `tests/vcs/git/conftest.py`

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey there - I've reviewed your changes - here's some feedback:

Extract the inline to_str helper to a module-level function so it can be reused and the exception block stays concise.
Consider merging the two PROBLEMS_SECTION_START constants into a single parameterized template (e.g. injecting specific issue types) to reduce duplication and confusion.
Double-check whether the file-lock error should consistently use the NETWORK_ISSUES section start or a dedicated one to keep message formatting uniform.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Extract the inline to_str helper to a module-level function so it can be reused and the exception block stays concise.
- Consider merging the two PROBLEMS_SECTION_START constants into a single parameterized template (e.g. injecting specific issue types) to reduce duplication and confusion.
- Double-check whether the file-lock error should consistently use the NETWORK_ISSUES section start or a dedicated one to keep message formatting uniform.

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.}

jelmer · 2025-09-07T17:50:50Z

As dulwich upstream, looks good to me - but I'm not a poetry committer.

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [poetry](https://github.com/python-poetry/poetry) ([changelog](https://python-poetry.org/history/)) | minor | `2.1.4` -> `2.2.1` | --- ### Release Notes <details> <summary>python-poetry/poetry (poetry)</summary> ### [`v2.2.1`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#221---2025-09-21) [Compare Source](python-poetry/poetry@2.2.0...2.2.1) ##### Fixed - Fix an issue where `poetry self show` failed with a message about an invalid output format ([#10560](python-poetry/poetry#10560)). ##### Docs - Remove outdated statements about dependency groups ([#10561](python-poetry/poetry#10561)). ##### poetry-core ([`2.2.1`](https://github.com/python-poetry/poetry-core/releases/tag/2.2.1)) - Fix an issue where it was not possible to declare a PEP 735 dependency group as optional ([#888](python-poetry/poetry-core#888)). ### [`v2.2.0`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#220---2025-09-14) [Compare Source](python-poetry/poetry@2.1.4...2.2.0) ##### Added - **Add support for nesting dependency groups** ([#10166](python-poetry/poetry#10166)). - **Add support for PEP 735 dependency groups** ([#10130](python-poetry/poetry#10130)). - **Add support for PEP 639 license clarity** ([#10413](python-poetry/poetry#10413)). - Add a `--format` option to `poetry show` to alternatively output json format ([#10487](python-poetry/poetry#10487)). - Add official support for Python 3.14 ([#10514](python-poetry/poetry#10514)). ##### Changed - **Normalize dependency group names** ([#10387](python-poetry/poetry#10387)). - Change `installer.no-binary` and `installer.only-binary` so that explicit package names will take precedence over `:all:` ([#10278](python-poetry/poetry#10278)). - Improve log output during `poetry install` when a wheel is built from source ([#10404](python-poetry/poetry#10404)). - Improve error message in case a file lock could not be acquired while cloning a git repository ([#10535](python-poetry/poetry#10535)). - Require `dulwich>=0.24.0` ([#10492](python-poetry/poetry#10492)). - Allow `virtualenv>=20.33` again ([#10506](python-poetry/poetry#10506)). - Allow `findpython>=0.7` ([#10510](python-poetry/poetry#10510)). - Allow `importlib-metadata>=8.7` ([#10511](python-poetry/poetry#10511)). ##### Fixed - Fix an issue where `poetry new` did not create the project structure in an existing empty directory ([#10431](python-poetry/poetry#10431)). - Fix an issue where a dependency that was required for a specific Python version was not installed into an environment of a pre-release Python version ([#10516](python-poetry/poetry#10516)). ##### poetry-core ([`2.2.0`](https://github.com/python-poetry/poetry-core/releases/tag/2.2.0)) - Deprecate table values and values that are not valid SPDX expressions for `[project.license]` ([#870](python-poetry/poetry-core#870)). - Fix an issue where explicitly included files that are in `.gitignore` were not included in the distribution ([#874](python-poetry/poetry-core#874)). - Fix an issue where marker operations could result in invalid markers ([#875](python-poetry/poetry-core#875)). </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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.walbeck.it/walbeck-it/docker-python-poetry/pulls/1588 Co-authored-by: renovate-bot <[email protected]> Co-committed-by: renovate-bot <[email protected]>

github-actions · 2025-10-11T00:30:01Z

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.

git: improve error message in case a file lock could not be acquired …

670524e

…while cloning a repo

sourcery-ai bot reviewed Sep 7, 2025

View reviewed changes

This was referenced Sep 7, 2025

git: be more robust against dangling lock files #10532

Closed

(🐞) No error message when FileLocked appears for poetry show --outdated #7832

Closed

jelmer approved these changes Sep 7, 2025

View reviewed changes

radoering merged commit 5d4d6a2 into python-poetry:main Sep 10, 2025
53 checks passed

radoering mentioned this pull request Sep 13, 2025

release: bump version to 2.2.0 #10546

Merged

github-actions bot locked as resolved and limited conversation to collaborators Oct 11, 2025

radoering deleted the git-file-locked-error branch December 13, 2025 17:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

git: improve error message in case a file lock could not be acquired while cloning a repo#10535

git: improve error message in case a file lock could not be acquired while cloning a repo#10535
radoering merged 1 commit intopython-poetry:mainfrom
radoering:git-file-locked-error

radoering commented Sep 7, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Sep 7, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

jelmer commented Sep 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

github-actions bot commented Oct 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

radoering commented Sep 7, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Check List

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence diagram for handling file lock acquisition failure during Git clone

Class diagram for updated error handling in Git backend

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

jelmer commented Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

radoering commented Sep 7, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Sep 7, 2025 •

edited

Loading

jelmer commented Sep 7, 2025 •

edited

Loading