Fix variable method type annotations - #544
Merged
Merged
Conversation
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
1 participant
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 #327
Summary
Type[Variable]subclasses rather than strings or instancesreplace_variable()to declare its existingNonereturn behavioradd_variables()positional-argument annotation and clarify the affected docstringsValidation
uv run --frozen pytest -q tests/core/test_reforms.py tests/core/test_countries.py(40 passed)uv run --frozen --extra dev ruff check policyengine_core/taxbenefitsystems/tax_benefit_system.pyuv run --frozen --extra dev ruff format --check policyengine_core/taxbenefitsystems/tax_benefit_system.pytyping.get_type_hints()No tests were added, per the requested scope.
Documentation review
External documentation changes are not required because runtime behavior is unchanged. The affected method docstrings now explicitly describe class arguments. Impact is low, confidence is high, and there are no known documentation gaps.