chore: breaking out models #225
Conversation
first attempt at breaking out models into a schema, ideally these would be their own files as it moves forwards, but i put them all in one place for the moment to minimize the changes required for review. each break out would likely be a simple chore style pr in the future.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @wyattearp, 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 undertakes a significant refactoring effort to improve the overall code organization by consolidating all Pydantic model definitions into a single api/schemas.py module. This change eliminates duplicate model declarations spread across various API endpoint files, resulting in a cleaner, more maintainable codebase and simplifying future modifications to data structures.
Highlights
- Code Organization: Centralized all Pydantic model definitions into a new, dedicated
api/schemas.pyfile. - Refactoring: Removed redundant Pydantic model declarations from
api/api.py,api/simple_chat.py, andapi/websocket_wiki.py. - Dependency Management: Updated import statements across affected files to reference the consolidated models from the new
api/schemasmodule.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request successfully refactors Pydantic models by consolidating them into a new api/schemas.py file. This is a good step towards better code organization and modularity. The changes are clean and achieve the stated goal.
My review focuses on further improving the new schemas.py file by enhancing type safety for one of the model fields and adhering to standard Python file formatting conventions (PEP 8).
| title: str | ||
| content: str | ||
| filePaths: List[str] | ||
| importance: str # Should ideally be Literal['high', 'medium', 'low'] |
There was a problem hiding this comment.
The comment correctly notes that importance should ideally use Literal. Using Literal provides better type safety, enables more effective static analysis, and ensures that only valid values ('high', 'medium', 'low') are accepted by Pydantic during validation. This makes the model more robust and self-documenting.
| importance: str # Should ideally be Literal['high', 'medium', 'low'] | |
| importance: Literal['high', 'medium', 'low'] # Specifies allowed string values |
There was a problem hiding this comment.
Normally I would agree with this type of change; however, there's a lot of other spots in the code where this is used in both api/ and src/ -- a more correct answer would be to create a pass where this is appropriately handled as a literal in both the python and the typescript.
pep8 suggestion -- but also python black would solve a lot of these. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
comment / changes welcome -- this falls into the "i'm not sure how much to do at once" bucket. |
first attempt at breaking out models into a schema, ideally these would be their own files as it moves forwards, but i put them all in one place for the moment to minimize the changes required for review (diff works easier that way on the if you're looking at them). each break out would likely be a simple chore style pr in the future.