Skip to content

feat: add A2ABaseModel#292

Merged
mikeas1 merged 5 commits intoa2aproject:mainfrom
ognis1205:feat/add-base-model
Jul 10, 2025
Merged

feat: add A2ABaseModel#292
mikeas1 merged 5 commits intoa2aproject:mainfrom
ognis1205:feat/add-base-model

Conversation

@ognis1205
Copy link
Contributor

Description

Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Follow the CONTRIBUTING Guide.
  • Make your Pull Request title in the https://www.conventionalcommits.org/ specification.
    • Important Prefixes for release-please:
      • fix: which represents bug fixes, and correlates to a SemVer patch.
      • feat: represents a new feature, and correlates to a SemVer minor.
      • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
  • Ensure the tests and linter pass (Run nox -s format from the repository root to format)
  • Appropriate docs were updated (if necessary)

Fixes #291 🦕

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
@ognis1205 ognis1205 requested a review from a team as a code owner July 9, 2025 20:52
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @ognis1205, I'm Gemini Code Assist1! 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 introduces a new, centralized Pydantic base model, A2ABaseModel, to standardize the configuration of all data models within the a2a library. By having all models inherit from this new base, it ensures consistent behavior, particularly regarding how data is populated, and streamlines future code generation processes.

Highlights

  • New Base Model Introduction: Introduced a new custom Pydantic base model, A2ABaseModel, in src/a2a/_base.py. This model inherits from pydantic.BaseModel and sets model_config = ConfigDict(populate_by_name=True).
  • Pydantic Model Inheritance Update: All existing Pydantic models within src/a2a/types.py (e.g., APIKeySecurityScheme, AgentExtension, JSONRPCError, Task, etc.) have been updated to inherit from the newly created A2ABaseModel instead of directly from pydantic.BaseModel.
  • Automated Code Generation Integration: The scripts/generate_types.sh script has been modified to include the --base-class a2a._base.A2ABaseModel argument for the datamodel-codegen command. This ensures that all future generated Pydantic models will automatically inherit from A2ABaseModel, maintaining consistency.
  • Pydantic V2 Compatibility/Feature: The populate_by_name=True configuration in A2ABaseModel is crucial for Pydantic v2, allowing model fields to be populated using their original Python attribute names, even when field aliases are defined (e.g., from JSON keys that differ from Python attribute names).
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new A2ABaseModel for all Pydantic types, which is a great way to apply common configuration across the generated models. The implementation correctly enables populate_by_name=True, improving the usability of models with field aliases. I have one suggestion to further enhance the robustness of these models by making them stricter about unexpected fields in payloads.

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
@pstephengoogle pstephengoogle requested a review from kthota-g July 10, 2025 14:22
…_name and validate_by_alias

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
@ognis1205 ognis1205 requested a review from mikeas1 July 10, 2025 15:16
@mikeas1 mikeas1 merged commit 24f2eb0 into a2aproject:main Jul 10, 2025
5 checks passed
@ognis1205 ognis1205 deleted the feat/add-base-model branch July 11, 2025 10:16
holtskinner pushed a commit that referenced this pull request Jul 14, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.2.12](v0.2.11...v0.2.12)
(2025-07-14)


### Features

* add `metadata` property to `RequestContext`
([#302](#302))
([e781ced](e781ced))
* add A2ABaseModel
([#292](#292))
([24f2eb0](24f2eb0))
* add support for notification tokens in PushNotificationSender
([#266](#266))
([75aa4ed](75aa4ed))
* Update A2A types from specification 🤖
([#289](#289))
([ecb321a](ecb321a))


### Bug Fixes

* add proper a2a request body documentation to Swagger UI
([#276](#276))
([4343be9](4343be9)),
closes [#274](#274)
* Handle asyncio.cancellederror and raise to propagate back
([#293](#293))
([9d6cb68](9d6cb68))
* Improve error handling in task creation
([#294](#294))
([6412c75](6412c75))
* Resolve dependency issue with sql stores
([#303](#303))
([2126828](2126828))
* Send push notifications for message/send
([#298](#298))
([0274112](0274112))
* **server:** Improve event consumer error handling
([#282](#282))
([a5786a1](a5786a1))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
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.

[Feat]: Support populate_by_name = True for Pydantic models

2 participants