13478.bugfix.rst

Overview

This file documents a bug fix related to the handling of the `console_output_style` configuration option in the software project. Specifically, it addresses a crash that occurred when the `console_output_style` was set to ["times"](/projects/286/67343) and a module was skipped during execution.

The fix ensures that the system gracefully handles cases where modules are skipped without leading to a runtime error, improving the robustness of console output formatting and module execution flow.

Details of the Fix

Bug Description:
When the configuration option console_output_style was set to "times", and if a module was skipped during the runtime, the system would crash. This behavior was likely due to unhandled state or missing data related to skipped modules when generating console output.
Root Cause:
The crash stemmed from the console output logic assuming that all modules run would produce timing information. When a module was skipped, this assumption failed, resulting in an error.
Resolution:
The bug fix modifies the output style handling to properly detect skipped modules and avoid attempting to access or display timing data for them, thus preventing the crash.

Usage and Impact

Configuration Option:
console_output_style can be set to various modes for controlling how output is styled in the console. The "times" mode presumably displays timing information for modules.
Effect of the Fix:
Users who enable "times" style output can now safely skip modules during execution without causing the application to crash.
Example Scenario:
```
[pytest]
console_output_style = times
```
With this setting, if any modules are skipped (e.g., due to conditions, markers, or test selectors), the system will continue running and output timing information for executed modules only.

Implementation Details

The fix likely involves conditional checks in the console output rendering code that handle the skipped module state.
It prevents access to timing data or output formatting logic when such data is not available.
No additional classes or functions are introduced in this patch; it is a targeted bug fix on existing output handling logic.

Interaction with Other Components

Console Output Renderer:
The fix interacts with the component responsible for formatting and displaying console output, particularly the style mechanism controlled by console_output_style.
Module Execution Engine:
The module execution or test discovery system that may skip modules influences the state the output renderer receives.
Configuration System:
The console_output_style configuration value is used to select the output formatting style.
Overall, this patch improves the resilience of the interaction between the module execution system and the console output subsystem.

Visual Diagram

Below is a class diagram illustrating the relationship between the key concepts involved in this fix:

classDiagram
    class ConsoleOutputStyle {
        +style_name: str
        +render(module: Module)
    }

    class Module {
        +name: str
        +status: Enum{Executed, Skipped, Failed}
        +timing_info: TimingData
    }

    class TimingData {
        +start_time: datetime
        +end_time: datetime
        +duration(): timedelta
    }

    ConsoleOutputStyle "1" -- "many" Module : processes >
    Module "1" *-- "1" TimingData : has >

ConsoleOutputStyle represents the output formatting system that renders information based on the configured style.
Module represents individual modules or units of execution that may be executed or skipped.
TimingData holds timing information relevant when the style "times" is active.
The fix ensures that when a Module has status = Skipped, the ConsoleOutputStyle avoids accessing TimingData, preventing crashes.

Summary

This bug fix is a minor but important stability improvement focused on ensuring that the console output formatting subsystem handles skipped modules gracefully, especially when timing information is requested through the ["times"](/projects/286/67343) style. It prevents crashes and improves user experience for scenarios where test or module execution is selectively skipped.

*End of 13478.bugfix.rst documentation.*