Enables Nullability for PythonVersionInfo #213
Merged
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
Annotates the PythonVersionInfo class to enable nullable references. This clears the warning and indicates intent to work with nullable references. C# 8.0 added this annotation to allow for fine-grain control on the nullability of references. This annotation also allows for the change to the SafeToLower and SafeExtract methods, that can potentially return null, to return Nullable strings which further enables null-safe checking. See Microsoft's documentation https://docs.microsoft.com/en-us/dotnet/csharp/nullable-references#nullable-annotation-context Resolves #199
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
Code Climate has analyzed commit 70bb764 and detected 0 issues on this pull request. View more on Code Climate. |
nickiemc
approved these changes
Jan 13, 2021
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.
Summary
This change annotates the PythonVersionInfo class to enable nullable references. This clears the warning and indicates intent to work with nullable references.
Details
C# 8.0 added the nullable annotation to allow for fine-grain control on the nullability of references. This annotation also allows for the change to the SafeToLower and SafeExtract methods, that can potentially return null, to return Nullable strings which further enables null-safe checking.
More information is available Microsoft's Nullable documentation.
Solution
Enabling this annotation and adding the nullable
?to thestringreturn types of SafeToLower and SafeExtract eliminated that warnings in the build and should help future development use these methods with care.If there is anything else that I did not take into account, please let me know! I'd be more than happy to make those changes.
Resolves #199