build: consider all files in explicitly included/excluded directories by radoering · Pull Request #874 · python-poetry/poetry-core

radoering · 2025-06-09T05:56:23Z

Closes: #850

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

A simpler and more general alternative to #850 to handle not only directories in includes but also in excludes.

Summary by Sourcery

Expand directory patterns in explicit include/exclude rules when computing ignored files

Enhancements:

Recursively include all files under explicitly included directories
Recursively mark all files under explicitly excluded directories as ignored

Tests:

Add test to verify directory-based include/exclude behavior in find_excluded_files

sourcery-ai · 2025-06-09T05:56:28Z

Reviewer's Guide

This PR refactors Builder.find_excluded_files to recursively expand directories into their constituent files (both for explicitly included and excluded paths) and adds tests and fixtures to validate directory-based include/exclude behavior.

Sequence Diagram for Directory Expansion in find_excluded_files

sequenceDiagram
    participant F EF as Builder.find_excluded_files
    participant AAF as add_all_files
    participant FS as FileSystem

    F EF->>F EF: Process package.exclude / module.explicit_includes
    loop For each glob_pattern in exclude/include lists
        F EF->>FS: self._path.glob(glob_pattern)
        FS-->>F EF: matching_paths
        loop For each path_item in matching_paths
            F EF->>AAF: add_all_files(path_item, target_set)
            AAF->>FS: path_item.is_dir()?
            FS-->>AAF: is_directory
            alt is_directory is true
                AAF->>FS: path_item.glob("**/*") (get all files)
                FS-->>AAF: files_in_dir
                loop For each file in files_in_dir
                    AAF->>AAF: Add file.relative_to(self._path).as_posix() to target_set
                end
            else is_directory is false (path_item is a file)
                AAF->>AAF: Add path_item.relative_to(self._path).as_posix() to target_set
            end
            AAF-->>F EF: 
        end
    end

Updated Class Diagram for Builder

classDiagram
    class Builder {
        #_path: Path
        #_package: Package
        #_module: Module
        +find_excluded_files(fmt: str | None) set~str~
    }

File-Level Changes

Change	Details	Files
Added helper to expand directories into all contained files	Introduced add_all_files(path, target) to collect files under a directory or single file Replaced single-file additions for exclude entries with add_all_files calls Replaced single-file additions for include entries with add_all_files calls	`src/poetry/core/masonry/builders/builder.py`
Enhanced tests to cover directory-based include/exclude logic	Added test_builder_find_excluded_files_dirs to verify nested directory handling Created pyproject.toml fixture defining exclude and include directory patterns	`tests/masonry/builders/test_builder.py` `tests/masonry/builders/fixtures/exclude-include-dir/pyproject.toml`

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 @radoering - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Documentation: all looks good

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

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]>

sourcery-ai bot reviewed Jun 9, 2025

View reviewed changes

radoering requested a review from a team June 9, 2025 08:22

build: consider all files in explicitly included/excluded directories

ffdaab9

radoering force-pushed the include-exclude-dirs branch from 9029862 to ffdaab9 Compare June 29, 2025 15:17

radoering merged commit bf9cb4d into python-poetry:main Jul 7, 2025
18 checks passed

This was referenced Sep 13, 2025

release: bump version to 2.2.0 #885

Merged

release: bump version to 2.2.0 python-poetry/poetry#10546

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

build: consider all files in explicitly included/excluded directories#874

build: consider all files in explicitly included/excluded directories#874
radoering merged 1 commit intopython-poetry:mainfrom
radoering:include-exclude-dirs

radoering commented Jun 9, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jun 9, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Conversation

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

Uh oh!

Summary by Sourcery

Uh oh!

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

Uh oh!

Reviewer's Guide

Sequence Diagram for Directory Expansion in find_excluded_files

Updated Class Diagram for Builder

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

radoering commented Jun 9, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 9, 2025 •

edited

Loading