Type more things #24
Merged
Type more things #24
Conversation
This file contains 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
TonyCTHsu
approved these changes
Jun 4, 2024
sig/graft/hook_point.rbs
Outdated
| @@ -66,7 +66,7 @@ module Graft | |||
|
|
|||
| def disabled?: (String key) -> bool | |||
|
|
|||
| module Prepend | |||
| module Prepend : HookPoint | |||
There was a problem hiding this comment.
What does this mean?
Does it mean HookPoint class will include this module?
There was a problem hiding this comment.
This self type parameter constraints the Prepend module to only be mixed in HookPoint, therefore Prepend can assume having access to HookPoint methods.
This happens automatically in HookPoint#initialize:
def initialize(hook_point, strategy = DEFAULT_STRATEGY)
@klass_name, @method_kind, @method_name = HookPoint.parse(hook_point)
@strategy = strategy
extend HookPoint.strategy_module(strategy)
end
The actual implementation of a given strategy is composed into HookPoint, which only provides a uniform interface largely independent of the strategy.
Steep does static type checking, so: a. sees the conditional `def` twice b. can't have conditional definitions c. uses one definition for both With `define_method`, Steep considers the definition dynamic and does not try to check the method.
Two main cases: - `attr_*` needs `@dynamic`: soutaro/steep#1036 - three `define_method` because of the `RUBY_VERSION` condition
This `self` constraint declares what the module can extend, and therefore makes the corresponding `self` methods visible inside these modules.
When using `case` steep types the unreachable `else` as `bot`, which ends up having no `#inspect`. Theoretically we would remove the unreachable fallback (`else` or simply code after `end`) but out of caution we want this safety check. Workaround it with a few `if`.
This is done in two steps: - Split per-version code, each into their own file - Type only for one (current) version category - Ignore the other (legacy) type category Both could be type-checked with targets, but this would need this issue to be solved: soutaro/steep#978
This also resolves steep typing without hints, and is actually more consistent.
|
And now typing passes! The trickier bits were mostly because:
|
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.
This is an attempt to fix as much typing issues as possible, ideally all.