Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PoC] extract build logic from the Command class #10075

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Secrus
Copy link
Member

@Secrus Secrus commented Jan 18, 2025

PoC of "actions" API, starting with the build command.

Summary by Sourcery

New Features:

  • Introduce a new build function to handle the build process.

Copy link

sourcery-ai bot commented Jan 18, 2025

Reviewer's Guide by Sourcery

This pull request extracts the build logic from the BuildCommand class into a static method, allowing it to be called from other commands, such as the PublishCommand.

Sequence diagram showing the new build process flow

sequenceDiagram
    participant PC as PublishCommand
    participant BC as BuildCommand
    participant Env as EnvManager
    participant Poetry

    PC->>Env: create_venv()
    Env-->>PC: env
    PC->>BC: build(poetry, env, io, output)
    BC->>Poetry: check is_package_mode
    BC->>BC: setup build environment
    BC->>BC: process build formats
    BC->>BC: build package
    BC-->>PC: return status
Loading

Class diagram showing the refactored BuildCommand class

classDiagram
    class BuildCommand {
        +handle() int
        +static build(poetry: Poetry, env: Env, io: IO, format: str, clean: bool, local_version_label: str, output: str) int
    }
    note for BuildCommand "Build logic extracted to static method"

    class PublishCommand {
        +handle() int
    }

    PublishCommand ..> BuildCommand : uses build()
Loading

File-Level Changes

Change Details Files
Extraction of build logic into a static method.
  • The _build method was removed.
  • A static method build was added to encapsulate the build logic.
  • The handle method now calls the static build method.
  • The build method now accepts poetry, env, and io as parameters.
src/poetry/console/commands/build.py
Calling the build command from the publish command.
  • The publish command now calls the static build method from the BuildCommand class.
  • The publish command now creates a virtual environment to pass to the build method.
src/poetry/console/commands/publish.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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant