Skip to content

refactor!: breaking change of the interface design#30

Merged
Ki-Seki merged 3 commits intomainfrom
Ki-Seki/issue14
Sep 21, 2025
Merged

refactor!: breaking change of the interface design#30
Ki-Seki merged 3 commits intomainfrom
Ki-Seki/issue14

Conversation

@Ki-Seki
Copy link
Member

@Ki-Seki Ki-Seki commented Sep 21, 2025

Fixes #14 #19 #20 #21 #23

@codecov
Copy link

codecov bot commented Sep 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Ki-Seki and others added 2 commits September 22, 2025 01:39
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Ki-Seki Ki-Seki merged commit cb880ae into main Sep 21, 2025
9 checks passed
@Ki-Seki Ki-Seki deleted the Ki-Seki/issue14 branch September 21, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants