Fix type disagreement for required_headers in service code#145
Merged
Conversation
satya-achanta-venkata
approved these changes
Jun 4, 2025
michael-iden
approved these changes
Jun 4, 2025
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.
This change is a: (check at least one)
Is this a breaking change? (check one)
Is the:
What does this change address?
Consumers of
apironcould run into type errors when overridingrequired_headersin a service they define.required_headersattribute inServiceBaseis writeable, but consuming code that tried to overriderequired_headersas a property would makerequired_headersread-only, which breaks the Liskov substitutability principle.required_headersattribute inServiceBasewas not as restrictive as the return type of therequired_headersproperty inServiceMeta, potentially leading to type disagreements in consuming codeHow does this change work?
required_headersin theServiceBaseclass to be a property, matching the definition inServiceMetaand making it overridable as a property in consuming code.ServiceBaseas inServiceMeta.