LCORE-2850: renamed pydantic ai utils module#2117
Conversation
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (6)
📜 Recent review details⏰ Context from checks skipped due to timeout. (13)
🧰 Additional context used📓 Path-based instructions (4)src/**/*.py📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*📄 CodeRabbit inference engine (Custom checks)
Files:
src/app/**/*.py📄 CodeRabbit inference engine (AGENTS.md)
Files:
tests/**/*.py📄 CodeRabbit inference engine (AGENTS.md)
Files:
🧠 Learnings (3)📚 Learning: 2026-06-24T13:45:37.249ZApplied to files:
📚 Learning: 2026-07-06T15:26:18.398ZApplied to files:
📚 Learning: 2026-04-06T20:18:07.852ZApplied to files:
🛑 Comments failed to post (2)
🔇 Additional comments (7)
WalkthroughA new ChangesPydantic AI helper migration
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 7✅ Passed checks (7 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/utils/pydantic_ai_helpers.py`:
- Line 31: Update the docstrings for both affected functions in
pydantic_ai_helpers.py to rename the section header from “Args:” to
“Parameters:”. Leave the documented parameters and all implementation code
unchanged.
- Line 27: Replace every Optional type annotation in pydantic_ai_helpers.py with
the equivalent modern X | None syntax, including the skills_config parameter and
the other referenced annotations. Preserve the existing types and function
behavior while keeping the annotation style consistent with build_agent’s client
parameter.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2a8a13f2-d8ad-415a-afbf-42af1ab6091e
📒 Files selected for processing (6)
src/app/endpoints/a2a.pysrc/app/endpoints/tools.pysrc/utils/agents/query.pysrc/utils/agents/streaming.pysrc/utils/pydantic_ai_helpers.pytests/unit/utils/test_pydantic_ai.py
📜 Review details
⏰ Context from checks skipped due to timeout. (13)
- GitHub Check: integration_tests (3.13)
- GitHub Check: integration_tests (3.12)
- GitHub Check: unit_tests (3.12)
- GitHub Check: Pylinter
- GitHub Check: spectral
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-7-on-pull-request
- GitHub Check: E2E Tests for Lightspeed Evaluation job
- GitHub Check: E2E: library mode / ci / group 3
- GitHub Check: E2E: library mode / ci / group 2
- GitHub Check: E2E: library mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 3
- GitHub Check: E2E: server mode / ci / group 2
🧰 Additional context used
📓 Path-based instructions (4)
src/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
src/**/*.py: Use absolute imports for internal modules:from authentication import get_auth_dependency
Llama Stack imports: Usefrom llama_stack_client import AsyncLlamaStackClient
Checkconstants.pyfor shared constants before defining new ones
All modules must start with descriptive docstrings explaining purpose
Uselogger = get_logger(__name__)fromlog.pyfor module logging
All functions must have complete type annotations for parameters and return types, use modern syntax (str | int), and include descriptive docstrings
Use snake_case with descriptive, action-oriented names for functions (get_, validate_, check_)
Avoid in-place parameter modification anti-patterns; return new data structures instead of modifying function parameters
Useasync deffor I/O operations and external API calls
Use standard log levels with clear purposes:debug()for diagnostic info,info()for program execution,warning()for unexpected events,error()for serious problems
All classes must have descriptive docstrings explaining purpose and use PascalCase with standard suffixes:Configuration,Error/Exception,Resolver,Interface
Abstract classes must use ABC with@abstractmethoddecorators
Follow Google Python docstring conventions with required sections: Parameters, Returns, Raises, and Attributes for classes
Files:
src/utils/agents/query.pysrc/utils/agents/streaming.pysrc/app/endpoints/tools.pysrc/app/endpoints/a2a.pysrc/utils/pydantic_ai_helpers.py
**/*
📄 CodeRabbit inference engine (Custom checks)
**/*: Flag meaningful O(n^2)+ algorithms on non-trivial inputs, including handlers and Kubernetes list operations.
Flag N+1 patterns that list items and then query once per item, including Kubernetes API and database access.
Flag expensive work inside loops, including API calls, JSON parsing, and regex compilation.
Flag unbounded growth in caches, watchers, or buffers when eviction or limits are missing.
Flag missing pagination or limits on list operations and API endpoints.
Flag secrets or tokens logged in plaintext or hardcoded in source.
Flag API endpoints missing authentication or authorization.
Flag injection vulnerabilities, including SQL injection, command injection, and path traversal.
Flag sensitive data leaked in API responses, WebSocket messages, or logs.
Flag Kubernetes Secrets and Red Hat secrets missing OwnerReferences.
Files:
src/utils/agents/query.pysrc/utils/agents/streaming.pysrc/app/endpoints/tools.pytests/unit/utils/test_pydantic_ai.pysrc/app/endpoints/a2a.pysrc/utils/pydantic_ai_helpers.py
src/app/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
src/app/**/*.py: FastAPI dependencies: Import fromfastapimodule forAPIRouter,HTTPException,Request,status,Depends
Use FastAPIHTTPExceptionwith appropriate status codes for API endpoints and handleAPIConnectionErrorfrom Llama Stack
Files:
src/app/endpoints/tools.pysrc/app/endpoints/a2a.py
tests/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
tests/**/*.py: Use pytest for all unit and integration tests; do not use unittest
Usepytest.mark.asynciomarker for async tests
Files:
tests/unit/utils/test_pydantic_ai.py
🧠 Learnings (3)
📚 Learning: 2026-06-24T13:45:37.249Z
Learnt from: Jdubrick
Repo: lightspeed-core/lightspeed-stack PR: 1971
File: src/utils/markdown_repair.py:31-36
Timestamp: 2026-06-24T13:45:37.249Z
Learning: In the lightspeed-stack repository, docstrings must use the section header name "Parameters:" (not "Args:") for function arguments, even if the project references Google Python docstring conventions. Ensure docstrings follow the project’s established "Parameters:" header format for any documented function parameters.
Applied to files:
src/utils/agents/query.pysrc/utils/agents/streaming.pysrc/app/endpoints/tools.pytests/unit/utils/test_pydantic_ai.pysrc/app/endpoints/a2a.pysrc/utils/pydantic_ai_helpers.py
📚 Learning: 2026-07-06T15:26:18.398Z
Learnt from: Jdubrick
Repo: lightspeed-core/lightspeed-stack PR: 2071
File: src/models/config.py:2416-2422
Timestamp: 2026-07-06T15:26:18.398Z
Learning: In this repo’s Python code under src/**, don’t treat differences in string concatenation style as a style inconsistency when Black has effectively forced (or made clearer) use of explicit `+` string concatenation in multi-line logger/string expressions. If adjacent-literal implicit concatenation is avoided/changed specifically to accommodate Black’s formatting in these call sites, accept the `+` usage and don’t recommend converting it solely for consistency with nearby blocks that use implicit concatenation.
Applied to files:
src/utils/agents/query.pysrc/utils/agents/streaming.pysrc/app/endpoints/tools.pysrc/app/endpoints/a2a.pysrc/utils/pydantic_ai_helpers.py
📚 Learning: 2026-04-06T20:18:07.852Z
Learnt from: major
Repo: lightspeed-core/lightspeed-stack PR: 1463
File: src/app/endpoints/rlsapi_v1.py:266-271
Timestamp: 2026-04-06T20:18:07.852Z
Learning: In the lightspeed-stack codebase, within `src/app/endpoints/` inference/MCP endpoints, treat `tools: Optional[list[Any]]` in MCP tool definitions as an intentional, consistent typing pattern (used across `query`, `responses`, `streaming_query`, `rlsapi_v1`). Do not raise or suggest this as a typing issue during code review; changing it in isolation could break endpoint typing consistency across the codebase.
Applied to files:
src/app/endpoints/tools.pysrc/app/endpoints/a2a.py
🔇 Additional comments (7)
src/utils/pydantic_ai_helpers.py (2)
76-80: LGTM!Also applies to: 83-104
20-23: 📐 Maintainability & Code QualityNo duplicate constants in
src/constants.pysrc/app/endpoints/a2a.py (1)
66-66: LGTM!src/app/endpoints/tools.py (1)
31-31: LGTM!src/utils/agents/query.py (1)
45-45: LGTM!src/utils/agents/streaming.py (1)
60-60: LGTM!tests/unit/utils/test_pydantic_ai.py (1)
13-13: LGTM!
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/utils/pydantic_ai_helpers.py`:
- Line 31: Update the docstrings for both affected functions in
pydantic_ai_helpers.py to rename the section header from “Args:” to
“Parameters:”. Leave the documented parameters and all implementation code
unchanged.
- Line 27: Replace every Optional type annotation in pydantic_ai_helpers.py with
the equivalent modern X | None syntax, including the skills_config parameter and
the other referenced annotations. Preserve the existing types and function
behavior while keeping the annotation style consistent with build_agent’s client
parameter.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2a8a13f2-d8ad-415a-afbf-42af1ab6091e
📒 Files selected for processing (6)
src/app/endpoints/a2a.pysrc/app/endpoints/tools.pysrc/utils/agents/query.pysrc/utils/agents/streaming.pysrc/utils/pydantic_ai_helpers.pytests/unit/utils/test_pydantic_ai.py
📜 Review details
🔇 Additional comments (7)
src/utils/pydantic_ai_helpers.py (2)
76-80: LGTM!Also applies to: 83-104
20-23: 📐 Maintainability & Code QualityNo duplicate constants in
src/constants.pysrc/app/endpoints/a2a.py (1)
66-66: LGTM!src/app/endpoints/tools.py (1)
31-31: LGTM!src/utils/agents/query.py (1)
45-45: LGTM!src/utils/agents/streaming.py (1)
60-60: LGTM!tests/unit/utils/test_pydantic_ai.py (1)
13-13: LGTM!
🛑 Comments failed to post (2)
src/utils/pydantic_ai_helpers.py (2)
27-27: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Use modern
X | Nonesyntax instead ofOptional[X].The coding guidelines require modern type annotation syntax (
str | int).build_agentalready uses|for theclientparameter (line 160), butOptional[X]is used elsewhere — inconsistent within the same file. Withfrom __future__ import annotationspresent,X | Noneworks on all supported Python versions.As per coding guidelines, all functions must use modern syntax (
str | int) for type annotations.♻️ Proposed refactor
-from typing import Any, Final, Optional +from typing import Any, FinalThen replace all
Optional[X]withX | None:def _skills_capability( - skills_config: Optional[SkillsConfiguration], -) -> Optional[SkillsCapability]: + skills_config: SkillsConfiguration | None, +) -> SkillsCapability | None:def _json_schema_to_parameters( - schema: Optional[dict[str, Any]], + schema: dict[str, Any] | None, ) -> list[dict[str, Any]]:def get_agent_capability_tools( - skills: Optional[SkillsConfiguration], + skills: SkillsConfiguration | None, ) -> list[dict[str, Any]]:def _agent_capabilities( - skills: Optional[SkillsConfiguration], + skills: SkillsConfiguration | None, no_tools: bool = False, -) -> Optional[list[AgentCapability[object]]]: +) -> list[AgentCapability[object]] | None:def build_agent( client: AsyncLlamaStackClient | AsyncLlamaStackAsLibraryClient, responses_params: ResponsesApiParams, - skills: Optional[SkillsConfiguration], + skills: SkillsConfiguration | None, no_tools: bool = False, ) -> Agent[None, str]:Also applies to: 28-28, 46-46, 108-108, 132-132, 134-134, 162-162
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/utils/pydantic_ai_helpers.py` at line 27, Replace every Optional type annotation in pydantic_ai_helpers.py with the equivalent modern X | None syntax, including the skills_config parameter and the other referenced annotations. Preserve the existing types and function behavior while keeping the annotation style consistent with build_agent’s client parameter.Source: Coding guidelines
31-31: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use
Parameters:instead ofArgs:in docstrings.Two functions use the
Args:section header, but this repo's convention isParameters:.Based on learnings, docstrings must use the section header name "Parameters:" (not "Args:") for function arguments.
📝 Proposed fix
def _skills_capability( skills_config: Optional[SkillsConfiguration], ) -> Optional[SkillsCapability]: """Return a skills capability when skill paths are configured. - Args: + Parameters: skills_config: Agent skills configuration from LCS, or None when skills are disabled.def _agent_capabilities( skills: Optional[SkillsConfiguration], no_tools: bool = False, ) -> Optional[list[AgentCapability[object]]]: """Assemble pydantic-ai capabilities for an LCS agent. - Args: + Parameters: skills: Agent skills configuration from LCS, or None when skills are disabled. no_tools: When True, omit capabilities that expose a toolset via ``get_toolset()``.Also applies to: 137-137
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/utils/pydantic_ai_helpers.py` at line 31, Update the docstrings for both affected functions in pydantic_ai_helpers.py to rename the section header from “Args:” to “Parameters:”. Leave the documented parameters and all implementation code unchanged.Source: Learnings
Description
LCORE-2850: renamed
pydantic_aiutils module to avoid tool confusion.Type of change
Tools used to create PR
Related Tickets & Documents
Summary by CodeRabbit
New Features
Bug Fixes