refactor!: breaking change of the interface design#30
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This was
linked to
issues
Sep 21, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This is a major refactoring that introduces breaking changes to the interface design, addressing multiple issues. The changes restructure the API to separate concerns between tag creation (guides), query construction (Query), and response handling (Response).
- Replaced stateful Guide class with stateless guide functions that create tags without auto-incrementing IDs
- Split parsing and context management into separate Query and Response classes
- Moved tag creation utilities to a dedicated guides module with mixin-based organization
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_tag.py | Removed - functionality moved to other test files |
| tests/test_schemas.py | Updated to test new MaskedTag API and parsing functions |
| tests/test_guides.py | New tests for the stateless guide functionality |
| tests/test_guide.py | Removed - replaced by guides and contexts tests |
| tests/test_contexts.py | New comprehensive tests for Query and Response classes |
| src/gimkit/schemas.py | Major refactor of MaskedTag with new parsing and validation logic |
| src/gimkit/guides.py | New module with mixin-based guide classes |
| src/gimkit/contexts.py | New module with Query and Response context classes |
| src/gimkit/init.py | Updated exports to reflect new API structure |
| examples/gimkit_quickstart.py | Updated example to use new Query-based API |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #14 #19 #20 #21 #23