NAS-129755 / 25.04 / Introduce docstrings and type annotations #7
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
bugclerk
changed the title
yocalebo
changed the title
themylogin
requested changes
Aug 16, 2024
creatorcary
force-pushed
the
NAS-129755
branch
from
d74d208
to
bbeb359
Compare
themylogin
approved these changes
Aug 30, 2024
|
JIRA ticket https://ixsystems.atlassian.net/browse/NAS-129755 is targeted to the following versions which have not received their corresponding PRs: 25.04 |
|
This PR has been merged and conversations have been locked. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The main features of this PR are:
jsonrpc.pyusingTypedDictpytypefor CI type checking to enforce type safetyMinor syntactical changes were made in some places to appease pytype and other type checkers, esp. pyright.
As a follow-up to this PR, I recommend we import the type specification defined in
jsonrpc.pyin middleware and use it to enforce type safety on the server-side as well.Note: I have skipped adding type hints/docstrings in
legacy.py.