A common util method of formatting history for agent graders.

[weizhang25]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @weizhang25, 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 focuses on improving code maintainability and reducing redundancy within the agent grader modules. By extracting the _format_history method into a shared utility function, the change centralizes common logic, making the codebase cleaner and easier to manage. This refactoring ensures that history formatting is handled consistently across various agent graders without duplicating the implementation.

Highlights

• Code Refactoring: The _format_history method, previously duplicated across multiple agent grader classes, has been extracted into a common utility function.
• Centralized Utility: A new format_history function is introduced in openjudge/graders/agent/utils.py to handle the formatting of history steps.
• Reduced Duplication: All affected agent grader classes now import and utilize this single utility function, eliminating redundant code and improving maintainability.

🧠 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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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 is a great refactoring that centralizes the format_history function into a common utility, removing duplicated code from several grader classes. This improves maintainability and follows the DRY principle. My review includes a suggestion to further improve the new utility function by using more specific type hints and refining the implementation for cleaner output.

[gemini-code-assist]

The type hint for history can be more specific. Using Optional[List[Dict[str, Any]]] instead of Optional[list] would be more descriptive and enhance type safety, as history is a list of dictionaries.

Additionally, the current implementation adds an extra newline before the closing </History Steps> tag. The logic can be refactored to be more concise and produce a cleaner output without this extra newline.

Here is a suggested improvement that addresses both points:

def format_history(history: Optional[List[Dict[str, Any]]] = None) -> str:
    """Format history steps for evaluation.

    Args:
        history: Optional list of previous step dictionaries

    Returns:
        Formatted history string, or empty string if no history
    """
    if not history:
        return ""

    step_strings = []
    for i, hist_step in enumerate(history):
        step_lines = [f"Step {i + 1}:"]
        step_lines.extend(
            f"{key.capitalize()}: {value}" for key, value in hist_step.items() if value
        )
        step_strings.append("\n".join(step_lines))

    history_body = "\n\n".join(step_strings)
    return f"<History Steps>\n{history_body}\n</History Steps>"

[ployts]

LGTM