CLI_Interface.md

graph LR
    CLI_Entry_Point["CLI Entry Point"]
    Argument_Parser["Argument Parser"]
    Build_Reactor_Initializer["Build Reactor Initializer"]
    Logger_Initializer["Logger Initializer"]
    Build_Summary_Reporter["Build Summary Reporter"]
    Task_Lister["Task Lister"]
    CLI_Error_Handler["CLI Error Handler"]
    CLI_Entry_Point -- "calls" --> Argument_Parser
    CLI_Entry_Point -- "calls" --> Logger_Initializer
    CLI_Entry_Point -- "calls" --> Build_Reactor_Initializer
    CLI_Entry_Point -- "calls" --> Build_Summary_Reporter
    CLI_Entry_Point -- "calls" --> CLI_Error_Handler
    Argument_Parser -- "calls" --> CLI_Error_Handler

Loading

Details

The CLI Interface subsystem serves as the primary user interaction point for PyBuilder, responsible for parsing command-line arguments, initiating core build operations, and presenting build feedback.

CLI Entry Point

The core orchestrator of the command-line interface. It manages the overall flow, from parsing arguments and initializing the logger to setting up the build reactor and executing build tasks or displaying information.

Related Classes/Methods:

• pybuilder.cli:main

Argument Parser

Responsible for parsing and validating command-line arguments and options provided by the user. It translates raw input into structured configuration that guides the build process.

Related Classes/Methods:

• pybuilder.cli:parse_options

Build Reactor Initializer

Initializes and configures the PyBuilder build reactor, which is the core engine for managing the build lifecycle, plugins, and tasks. This component is the crucial link between the CLI and the underlying build execution framework.

Related Classes/Methods:

• pybuilder.cli:init_reactor

Logger Initializer

Sets up and configures the logging system, ensuring that build output, warnings, and errors are displayed to the user in a consistent and readable format.

Related Classes/Methods:

• pybuilder.cli:init_logger

Build Summary Reporter

Displays a high-level summary of the build process, including its final outcome (success/failure) and other relevant build statistics. It often leverages other printing utilities for detailed output.

Related Classes/Methods:

• pybuilder.cli:print_summary

Task Lister

A utility specifically designed for formatting and displaying a list of available build tasks to the user, typically invoked when a task listing option is requested via the CLI.

Related Classes/Methods:

• pybuilder.cli:print_task_list

CLI Error Handler

Manages and reports exceptions or invalid usage scenarios that occur within the command-line interface, providing user-friendly error messages and guidance.

Related Classes/Methods:

• pybuilder.cli:error

FAQ