feat(cli): make build command build-system agnostic

[finswimmer]

Resolves: #8807 #8403

Pull Request Check List

For easier testing I split out the actual logic from the BuildCommand class into a separate class.

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

Summary by Sourcery

Refactor the build process to be build-system agnostic, using PEP 517.

Build:

• Support alternative build backends by specifying them in the pyproject.toml file.

Documentation:

• Update documentation on building and publishing libraries, including information on alternative build backends and PEP 517.
• Document the --config-settings option for the build command.
• Deprecate the --local-version option in favor of --config-settings local-version=<version>.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request refactors the build command to be build-system agnostic, supporting the passing of config settings to the backend. It also deprecates the --local-version option in favor of --config-settings local-version=<version>. The build process now supports isolated builds when required by the project's build system configuration.

Sequence diagram for the build process

sequenceDiagram
    participant User
    participant BuildCommand
    participant BuildHandler
    participant Builder

    User->>BuildCommand: poetry build
    BuildCommand->>BuildCommand: prepare config settings
    BuildCommand->>BuildCommand: prepare formats
    BuildCommand->>BuildHandler: create handler
    BuildCommand->>BuildOptions: create options
    BuildCommand->>BuildHandler: build(options)
    BuildHandler->>BuildHandler: check if isolated build required
    alt Requires isolated build
        BuildHandler->>Builder: isolated_build()
    else Standard build
        BuildHandler->>Builder: build()
    end
    Builder-->>BuildHandler: build result
    BuildHandler-->>BuildCommand: status code
    BuildCommand-->>User: build complete

Loading

Class diagram for the new build command structure

classDiagram
    class BuildCommand {
        +handle(): int
        -_prepare_config_settings(local_version, config_settings, io): dict
        -_prepare_formats(fmt): list
    }

    class BuildHandler {
        -poetry: Poetry
        -env: Env
        -io: IO
        +build(options: BuildOptions): int
        -_build(fmt, executable, target_dir, config_settings): void
        -_isolated_build(fmt, executable, target_dir, config_settings): void
        -_requires_isolated_build(): bool
        -_get_builder(): Callable
    }

    class BuildOptions {
        +clean: bool
        +formats: list[DistributionType]
        +output: str
        +config_settings: dict
        +__post_init__(): void
    }

    BuildCommand ..> BuildHandler: creates
    BuildCommand ..> BuildOptions: creates
    BuildHandler ..> BuildOptions: uses

    note for BuildHandler "New class that handles
the build process"
    note for BuildOptions "New dataclass for
build configuration"

Loading

Flow diagram for build system selection

flowchart TD
    A[Start Build] --> B{Check Build System}
    B -->|Has build script| C[Use Isolated Build]
    B -->|Multiple build deps| C
    B -->|Non poetry-core| C
    B -->|poetry-core version mismatch| C
    B -->|poetry-core from VCS| C
    B -->|Standard poetry-core| D[Use Direct Build]
    C --> E[Build Package]
    D --> E
    E --> F[End Build]

Loading

File-Level Changes

Change	Details	Files
Refactor the build command to be build-system agnostic.	Introduce a BuildHandler class to encapsulate the build logic. Implement isolated builds when required by the project's build system configuration. Determine if an isolated build is required based on the project's build system dependencies and configuration. Support passing config settings to the backend during the build process. Use the build system defined in pyproject.toml.	src/poetry/console/commands/build.py
Deprecate the --local-version option.	Deprecate the --local-version option in favor of --config-settings local-version=<version>. Add a warning message when the deprecated option is used.	src/poetry/console/commands/build.py
Add support for config settings.	Add a --config-settings option to pass config settings to the backend. Parse the config settings from the command line.	src/poetry/console/commands/build.py
Update tests to support Python 3.7.	Update test dependencies to Python 3.7. Add tests for the new build options. Add tests for isolated builds.	tests/console/commands/test_build.py tests/masonry/builders/test_editable_builder.py
Update documentation.	Update documentation to reflect the changes to the build command. Add documentation for the new --config-settings option. Add documentation for the build system configuration. Add documentation for alternative build backends.	docs/libraries.md docs/cli.md
Add test fixtures for different build systems.	Add test fixtures for different build systems.	tests/fixtures/build_systems/no_core/pyproject.toml tests/fixtures/build_systems/has_build_script/pyproject.toml tests/fixtures/build_systems/core_from_git/pyproject.toml tests/fixtures/build_systems/core_in_range/pyproject.toml tests/fixtures/build_systems/core_not_in_range/pyproject.toml tests/fixtures/build_systems/multiple_build_deps/pyproject.toml tests/fixtures/build_systems/core_from_git/README.md tests/fixtures/build_systems/core_in_range/README.md tests/fixtures/build_systems/core_not_in_range/README.md tests/fixtures/build_systems/has_build_script/README.md tests/fixtures/build_systems/multiple_build_deps/README.md tests/fixtures/build_systems/no_core/README.md

---

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.

[finswimmer]

@sourcery-ai review

[sourcery-ai]

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

Overall Comments:

• Please add tests for the new build system implementation to verify the behavior matches expectations.
• Documentation needs to be updated to reflect the new build system agnostic approach.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 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]

@sourcery-ai review

[sourcery-ai]

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

Overall Comments:

• Using poetry-core from git main branch (poetry-core @ git+https://github.com/python-poetry/poetry-core.git@main) could lead to stability issues. Consider using a released version instead.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 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]

@sourcery-ai review

[sourcery-ai]

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

Overall Comments:

• Using poetry-core from git main branch (poetry-core @ git+https://github.com/python-poetry/poetry-core.git@main) is risky for production code. Consider using a stable release version instead to ensure reproducible builds.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 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.}

[sourcery-ai]

issue: Add validation for empty key or value in config settings

The code should validate that both key and value are non-empty strings after splitting to prevent invalid configuration settings.

[finswimmer]

@sourcery-ai review

[sourcery-ai]

Hey @finswimmer - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 2 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.}

[abn]

Overall looks great, some minor comments.

[github-actions]

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.