feat: Py310 & Runtime Python Verison Check #368
Conversation
Issues a WARNING if the Python Version will become unsupported. Prints an ERROR to STDERR if Python Version is unsupported. Will start issuing WARNING for Python Version less than 3.6. Will start printing ERROR for Python Version less than 3.5 AFTER Jan 1st, 2022.
src/aws_encryption_sdk/__init__.py
Outdated
| @@ -36,6 +35,8 @@ | |||
| StreamEncryptor, | |||
| ) | |||
|
|
|||
| check_python_version() | |||
There was a problem hiding this comment.
@farleyb-amazon I do not know how to force a Runtime Check, but I think this will work.
Do you know of another way?
I fear that this could run multiple times in an application if they load the library multiple times; but I guess I am willing to allow that to happen.
I also assume that __init__ will ALWAYS be parsed if any part of this library is used. I think that assumption is accurate... but I cannot swear it.
There was a problem hiding this comment.
By my understanding __init__ will run anytime the module is imported, so this should be good. As you said it might run multiple times, but I don't mind that either.
Replaces check_python_version with _warn_deprecated_python. _warn_deprecated_python is copied from the AWS SDK for Python (boto3/compat.py) and refactored for the ESDK. No Error will ever be logged, only a warning for Pythons 2.7, 3.4, and 3.5. Testing is added that not only checks the logic of the function, but also parses the SUPPORT_POLICY.rst for dates and ensures that the dates saved in compatability.py are accurate.
src/aws_encryption_sdk/__init__.py
Outdated
| @@ -36,6 +35,8 @@ | |||
| StreamEncryptor, | |||
| ) | |||
|
|
|||
| check_python_version() | |||
There was a problem hiding this comment.
By my understanding __init__ will run anytime the module is imported, so this should be good. As you said it might run multiple times, but I don't mind that either.
| """Parses SUPPORT_POLICY.rst for Major Version Dates | ||
|
|
||
| The code here is strongly tied to the format of SUPPORT_POLICY.rst. | ||
| If the format changes, this logic will need to be refactored as well. | ||
|
|
||
| :rtype Mapping[str, str] | ||
| :return Mapping of keys from DEPRECATION_DATE_MAP to parsed date | ||
| """ |
There was a problem hiding this comment.
This idea of parsing the policy file seems like a lot of complexity and future maintenance for not a lot of value. Is it necessary?
There was a problem hiding this comment.
It is the only way I can think of automatically ensuring the dates in the two files are the same.
I hate it. If we can just trust our selves to keep the two places in sync, then let's delete all this.
If we cannot, then this is the best I can think of.
In terms of Data: The Boto3 library does not bother checking that the dates are aligned. That team just trusts that the dates entered are accurate.
I would prefer trashing all this test logic, and having faith that the date is right.
Issue #, if available: No Issue
Description of changes:
This PR:
The Runtime Check runs when
__init__.pyis loaded.The Runtime Check:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Check any applicable: