poetry: expose build-system dependencies

[abn]

This change allows for a Poetry project instance's build-system requirements to be accessed as Dependency instances. Preserving useful parsing from #58 as original PR was dropped.

Summary by Sourcery

New Features:

• Access build-system requirements as Dependency instances.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
1.6% Duplication

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[abn]

@sourcery-ai review

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request exposes the build-system dependencies of a Poetry project as Dependency instances. This allows for easier access and manipulation of these dependencies.

Sequence diagram for build system dependency resolution

sequenceDiagram
    participant Poetry
    participant PyProjectTOML
    participant Dependency

    Poetry->>PyProjectTOML: Get build_system
    PyProjectTOML-->>Poetry: Return build system config
    loop For each requirement
        Poetry->>Dependency: create_from_pep_508(requirement)
        alt PEP 508 parsing successful
            Dependency-->>Poetry: Return Dependency instance
        else PEP 508 parsing failed
            Note over Poetry: Try as file/directory path
            alt Is file
                Poetry->>Poetry: Create FileDependency
            else Is directory
                Poetry->>Poetry: Create DirectoryDependency
            end
        end
    end

Loading

Class diagram showing Poetry class modifications

classDiagram
    class Poetry {
        -_build_system_dependencies: list[Dependency]
        +pyproject: PyProjectTOML
        +package: ProjectPackage
        +local_config: dict[str, Any]
        +build_system_dependencies: list[Dependency]
        +get_project_config(config: str, default: Any): Any
    }

    class Dependency {
        +create_from_pep_508(requirement: str): Dependency
    }

    class FileDependency {
        +name: str
        +path: Path
    }

    class DirectoryDependency {
        +name: str
        +path: Path
    }

    Poetry --> "*" Dependency : has
    FileDependency --|> Dependency : extends
    DirectoryDependency --|> Dependency : extends

    note for Poetry "New property build_system_dependencies
parses requirements into Dependency objects"

Loading

File-Level Changes

Change	Details	Files
Expose build-system dependencies as Dependency instances	Added a new property build_system_dependencies to the Poetry class that returns a list of Dependency objects representing the build-system dependencies. Added tests to verify the functionality of the new property, including cases with various dependency types (PEP 508 strings, directory dependencies, and file dependencies).	src/poetry/core/poetry.py tests/test_factory.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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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 @abn - I've reviewed your changes - here's some feedback:

Overall Comments:

• The test appears to have issues: there's a typo in the parameter name 'requries' and the test implementation doesn't match the parametrized cases - it only tests 'sample_project' while declaring two different test scenarios.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟡 Testing: 3 issues found
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[finswimmer]

Just a small thing.

[abn]

@sourcery-ai review

[sourcery-ai]

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

Overall Comments:

• There appears to be a bug in the logging - the 'Skipping build system dependency' debug message is logged when a dependency is successfully added, which is incorrect. The log message should either be moved to the else branch when skipping, or the message should be changed to indicate successful addition.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}