Skip to content

fix(toolset): access model fields via class #540

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

emmanuel-ferdman
Copy link

PR Summary

This small PR updates the usage of field metadata access within the Toolset model to align with the Pydantic V2 API and resolve PydanticDeprecatedSince211 warnings. Specifically:

  • Replaced instance-level access self.model_fields with class-level self.__class__.model_fields in holmes/core/tools.py, as required by the Pydantic V2 convention for accessing model fields.

These changes ensure compatibility with Pydantic V2+ and address deprecation warnings related to model_fields, as seen in the CI logs:

/home/runner/work/holmesgpt/holmesgpt/holmes/core/tools.py:346: PydanticDeprecatedSince211: Accessing the 'model_fields' attribute on the instance is deprecated. Instead, you should access this attribute from the model class. Deprecated in Pydantic V2.11 to be removed in V3.0.

Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Copy link
Contributor

coderabbitai bot commented Jun 19, 2025

Walkthrough

The override_with method in the Toolset class was modified to reference the class-level model_fields attribute instead of the instance-level attribute when determining which fields can be overridden. No changes were made to public interfaces or method signatures.

Changes

File Change Summary
holmes/core/tools.py Updated Toolset.override_with to check self.__class__.model_fields instead of self.model_fields.

Sequence Diagram(s)

Loading
sequenceDiagram
    participant SourceToolset as Source Toolset Instance
    participant TargetToolset as Target Toolset Instance

    SourceToolset->>TargetToolset: override_with(SourceToolset)
    loop For each field in SourceToolset
        TargetToolset->>TargetToolset: Check if field in TargetToolset.__class__.model_fields
        alt Field exists
            TargetToolset->>TargetToolset: Override field value
        end
    end

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fea7861 and 007a60f.

📒 Files selected for processing (1)
  • holmes/core/tools.py (1 hunks)
🔇 Additional comments (1)
holmes/core/tools.py (1)

346-346: LGTM! Correctly addresses the Pydantic V2 deprecation warning.

This change properly updates the code to access model_fields at the class level instead of the instance level, which aligns with Pydantic V2 API conventions and resolves the PydanticDeprecatedSince211 warning. The functionality remains identical while ensuring future compatibility when the deprecated instance-level access is removed in Pydantic V3.0.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@CLAassistant
Copy link

CLAassistant commented Jun 19, 2025

CLA assistant check
All committers have signed the CLA.

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.

2 participants