refactor: extract type aliases to _types.py to fix import cycle#13
Merged
Conversation
Move JSONObject, JSONValue, JSONArray, JSONPrimitive, Key, KeyElement, and KeySpecifier type aliases to a new _types.py module. This breaks the circular import between _exceptions.py, _json.py, and _keys.py. The cycle existed because _exceptions.py needed type annotations from _json.py and _keys.py, but those modules import exceptions.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
CodSpeed Performance ReportMerging #13 will not alter performanceComparing Summary
Footnotes
|
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.
Summary
_types.pymodule containing all TypeAlias definitions for JSON and key types# pyright: reportImportCycles=falsepragma from_exceptions.py_json.pyand_keys.pyto import types from_types.pyand re-export for backwards compatibilityProblem
Circular import between:
_exceptions.py→ needsJSONObjectandKeyforConflictErrortype annotations_json.py→ needsParseError,LimitErrorfrom_exceptions.py_keys.py→ needsInvalidKeyError,LimitErrorfrom_exceptions.pySolution
Extract pure type aliases to
_types.pywith no dependencies on other JSONLT modules, breaking the cycle.Test plan
uv run basedpyright src/jsonlt/uv run pytest tests/