Repository navigation
refactor: make base instruments generic over their config type - #286
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
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 #285.
The Cors, HealthChecks, Logging, OpenTelemetry, Prometheus and Swagger instruments each get a config type variable bound to their config class, and each framework instrument binds it:
Before this, every framework instrument re-annotated
bootstrap_configwith its own config type, and ty 0.0.87 rejected that asinvalid-mutable-override. The 20 ignores #284 added for this are gone. So is aninvalid-method-overrideignore onLitestarSwaggerInstrument.is_configured: itsLitestarConfigparameter is no longer narrower than the parameter it overrides.Nothing changes at runtime. Out-of-tree subclasses such as
class MyCors(CorsInstrument)keep working; ty just sees their config type as unknown until they bind the parameter.The 5 bootstrapper ignores stay. The issue explains why: making
BaseBootstrappergeneric over its config would either breakBaseBootstrapper[App]or need a typing-extensions TypeVar default.Locally with ty 0.0.87,
just lint-ciis clean andjust test-cipasses (362 passed, 100% coverage).