Ruggedize cmd2's runtime type annotation validation #1442
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
…g.get_type_hints Previously it was based on inspect.signature. The problem is that to Python 3.10, the inspect module doesn't have a safe way of evaluating type annotations that works equivalently both in the presence or absence of "from __future__ import annotations". Hence, any attempt at using that in an app would break cmd2. This change adds a get_types() helper function to the cmd2.utils module which uses typing.get_type_hints() to do the introspection in a safer way.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1442 +/- ##
==========================================
- Coverage 98.56% 98.55% -0.02%
==========================================
Files 20 20
Lines 5726 5742 +16
==========================================
+ Hits 5644 5659 +15
- Misses 82 83 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
… for this change I first verified that this test fails on the current master branch
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.
Change cmd2's runtime type annotation validation for hook callback function registration to be based on
typing.get_type_hintsPreviously it was based on
inspect.signature. The problem is that prior to Python 3.10, theinspectmodule doesn't have a safe way of evaluating type annotations that works equivalently both in the presence or absence offrom __future__ import annotations. Hence, any attempt at using that in an app would breakcmd2. Even in Python 3.10+, it requires an extra argument to be provided.This change adds a
get_types()helper function to thecmd2.utilsmodule which usestyping.get_type_hints()to do the introspection in a safer way.Down the road when
cmd2drops support for Python 3.9, we can evaluate to switching the underlying implementation to useinspect.get_annotations()if we wish.Closes #1443