feat(checks): add print_report to result models

[kevinmessiaen]

Introduce a shared BaseResult with a print_report helper and make result models immutable (frozen).

This automatically print pretty result for Suite, Scenario and Check results

Example:

import asyncio
from giskard.checks import Scenario, Equals


def greet(name: str) -> str:
    return f"Hello, {name}!"


scenario = (
    Scenario("greet_alice")
    .interact(
        inputs="Alice",
        outputs=lambda inputs: greet(inputs),
    )
    .check(
        Equals(
            name="correct_greeting",
            expected_value="Hello, Alice!",
            key="trace.last.outputs",
        )
    )
)

result = asyncio.run(scenario.run())
result.print_report()

Result:

Solve #2289

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the core result models by introducing a shared base class, BaseResult, which centralizes the print_report functionality. It also enforces immutability across CheckResult, ScenarioResult, TestCaseResult, and SuiteResult to ensure consistent and predictable behavior of result objects, addressing issue #2289.

Highlights

• New BaseResult Class: Introduced a new BaseResult class to serve as a common base for various result models, centralizing shared functionality.
• Standardized Reporting: Added a print_report helper method to BaseResult for standardized and consistent reporting of results across different model types.
• Immutability Enforced: Configured CheckResult, ScenarioResult, TestCaseResult, and SuiteResult to be immutable by setting frozen=True, ensuring their state cannot be changed after creation.
• Inheritance Structure: Updated CheckResult, ScenarioResult, TestCaseResult, and SuiteResult to inherit from the new BaseResult class, promoting code reuse and a unified interface.
• Dependency Update: Updated the giskard-agents package version in uv.lock.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a BaseResult class to provide a shared print_report method for all result models (CheckResult, ScenarioResult, TestCaseResult, SuiteResult). It also makes these models immutable by setting frozen=True, which is a good practice for result objects. The changes are well-implemented and improve code reuse and consistency. I have one minor suggestion regarding code redundancy in the CheckResult class.