Skip to content

Commit

Permalink
aws_kms_info: Correct deprecation of keys_attr (ansible-collections#851)
Browse files Browse the repository at this point in the history
aws_kms_info: Correct deprecation of keys_attr

SUMMARY
fixup derecation of keys_attr.
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
aws_kms_info
ADDITIONAL INFORMATION
ansible-collections#838

Reviewed-by: Markus Bergholz <[email protected]>
Reviewed-by: Jill R <None>
Reviewed-by: None <None>
  • Loading branch information
tremble authored Jan 7, 2022
1 parent cd9e061 commit c56dbee
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions aws_kms_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,11 @@
type: bool
keys_attr:
description:
- Whether to return the results in the C(keys) attribute as well as the
C(kms_keys) attribute.
- Returning the C(keys) attribute conflicts with the builtin keys()
method on dictionaries and as such has been deprecated.
- After version C(3.0.0) this parameter will do nothing, and after
version C(4.0.0) this parameter will be removed.
- Returning the C(keys) attribute conflicted with the builtin keys()
method on dictionaries and as such was deprecated.
- This parameter now does nothing, and after version C(4.0.0) this
parameter will be removed.
type: bool
default: True
version_added: 2.0.0
extends_documentation_fragment:
- amazon.aws.aws
Expand Down Expand Up @@ -451,7 +448,7 @@ def main():
key_id=dict(aliases=['key_arn']),
filters=dict(type='dict'),
pending_deletion=dict(type='bool', default=False),
keys_attr=dict(type='bool', default=True),
keys_attr=dict(type='bool'),
)

module = AnsibleAWSModule(argument_spec=argument_spec,
Expand All @@ -468,11 +465,11 @@ def main():
ret_params = dict(kms_keys=filtered_keys)

# We originally returned "keys"
if module.params['keys_attr']:
if module.params.get('keys_attr') is not None:
module.deprecate("Returning results in the 'keys' attribute conflicts with the builtin keys() method on "
"dicts and as such is deprecated and is now ignored. Please use the kms_keys attribute. This warning can be "
"silenced by setting keys_attr to False.",
version='3.0.0', collection_name='community.aws')
"dicts and as such was removed in version 3.0.0. Please use the kms_keys attribute. "
"This parameter is now ignored and will be removed in version 4.0.0.",
version='4.0.0', collection_name='community.aws')
module.exit_json(**ret_params)


Expand Down

0 comments on commit c56dbee

Please sign in to comment.