Added a method to provide plugin information that is included in artifact zip #167
Conversation
| @@ -49,7 +49,7 @@ repos: | |||
| - id: bandit | |||
| files: ^(src|python)/ | |||
| - repo: https://github.com/pre-commit/mirrors-mypy | |||
| rev: v0.711 | |||
| rev: v0.790 | |||
There was a problem hiding this comment.
Upgraded mypy because of python/mypy#9916.
| @@ -14,7 +14,7 @@ def recast_object( | |||
| if not isinstance(json_data, dict): | |||
| raise InvalidRequest(f"Can only parse dict items, not {type(json_data)}") | |||
| # if type is Any, we leave it as is | |||
| if cls == typing.Any: | |||
| if cls is typing.Any: | |||
There was a problem hiding this comment.
Made this change because of pylint error,
W0143: Comparing against a callable, did you omit the parenthesis? (comparison-with-callable)
| @@ -127,5 +127,5 @@ def get_forward_ref_type() -> Any: | |||
| # introspection is valid: | |||
| # https://docs.python.org/3/library/typing.html#typing.ForwardRef | |||
| if "ForwardRef" in dir(typing): | |||
| return typing.ForwardRef # type: ignore | |||
| return typing.ForwardRef | |||
There was a problem hiding this comment.
removed "# type: ignore" because of mypy complaining of unused 'type: ignore' comment
| @@ -169,6 +170,10 @@ def generate(self, project): | |||
|
|
|||
| LOG.debug("Generate complete") | |||
|
|
|||
| # pylint: disable=unused-argument | |||
There was a problem hiding this comment.
if project is unused then why is it in the method? add annotation on what method is returning plz
There was a problem hiding this comment.
Added comments as to why the argument project is part of the method signature but not used. Link to code in cloudformation-cli, https://github.com/aws-cloudformation/cloudformation-cli/blob/master/src/rpdk/core/project.py#L546
| @@ -15,6 +16,7 @@ | |||
| from rpdk.core.jsonutils.resolver import ContainerType, resolve_models | |||
| from rpdk.core.plugin_base import LanguagePlugin | |||
|
|
|||
| from . import __version__ | |||
There was a problem hiding this comment.
Check the _get_plugin_information() method below. Link
| if sys.version_info < (3, 7): | ||
| return typing._ForwardRef # type: ignore | ||
| return typing.ForwardRef |
There was a problem hiding this comment.
Made these changes because of the following failure, https://github.com/aws-cloudformation/cloudformation-cli-python-plugin/pull/167/checks?check_run_id=3909535606. But in the end because of issues highlighted in,
- Cannot silence "unused 'type: ignore'" in version specific code python/mypy#8823 and
- python version checks don't seem to work with 0.780 python/mypy#8990
I still had to use --no-warn-unused-ignores in .pre-commit-config.yaml.
But I believe using sys.version_info is the right way to go about it. (Reference)
I verified from python documentation that ForwardRef was introduced in python 3.7 (source code, link to python 3.6 source code for reference.
There was a problem hiding this comment.
Locally tested it.
Description of changes:
Added a method to provide plugin information that is included in artifact zip.
Plugin information includes,
plugin-tool-version - The version of the cli tool
plugin-name - "java"/"python"/"go". Here it is "python"
I also updated the mypy version and made few other changes based on pre-commit run.
Testing:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.