chore: Retrofit type hints to neutron ml2 driver plugin API to improve dx #818
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
stevekeay
changed the title
stevekeay
force-pushed
the
hints
branch
3 times, most recently
from
60bf094 to
a568a83
Compare
skrobul
approved these changes
Apr 14, 2025
Collaborator
skrobul
left a comment
skrobul
left a comment
There was a problem hiding this comment.
LGTM, my only minor nitpick is usage of relative imports which is prohibited in Openstack's style guide but I'm not sure if we need to follow the same guide
cardoe
approved these changes
Apr 15, 2025
Contributor
cardoe
left a comment
cardoe
left a comment
There was a problem hiding this comment.
Yeah I'm okay with the relative. I still think we should submit this upstream. One of the things they want to do is type annotate more parts of the code base this cycle and you've done that.
Contributor
|
@stevekeay merge conflict with another PR of yours |
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.
Hacking on the ml2 driver plugin feels very uncertain due to the large number of inter-dependencies that the driver code has, and the poorly-documented API with confusing concepts, like the "context" argument means different things in different places.
I don't know if this is a valid approach to documenting the API, but adding type hints or comprehensive documentation upstream seems unlikely to be a quick or easy win, while this gets a bit of autocomplete working with minimal effort. While these type hints will surely get out of date, I assume that the ml2 API would be evolving quite slowly, so we won't see too much drift.