mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-03-22 05:09:12 +00:00
74 lines
2.6 KiB
Python
74 lines
2.6 KiB
Python
# (c) 2020, Alexei Znamensky <russoz@gmail.com>
|
|
# Copyright (c) 2020, Ansible Project
|
|
# Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
from __future__ import annotations
|
|
|
|
import typing as t
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
class DeprecateAttrsMixin:
|
|
def _deprecate_setup(
|
|
self, attr: str, target: object | None, module: AnsibleModule | None
|
|
) -> tuple[object, AnsibleModule, dict[str, t.Any], dict[str, t.Any]]:
|
|
if target is None:
|
|
target = self
|
|
if not hasattr(target, attr):
|
|
raise ValueError(f"Target {target} has no attribute {attr}")
|
|
if module is None:
|
|
if isinstance(target, AnsibleModule):
|
|
module = target
|
|
elif hasattr(target, "module") and isinstance(target.module, AnsibleModule):
|
|
module = target.module
|
|
else:
|
|
raise ValueError(
|
|
"Failed to automatically discover the AnsibleModule instance. Pass 'module' parameter explicitly."
|
|
)
|
|
|
|
# setup internal state dicts
|
|
value_attr = "__deprecated_attr_value"
|
|
trigger_attr = "__deprecated_attr_trigger"
|
|
if not hasattr(target, value_attr):
|
|
setattr(target, value_attr, {})
|
|
if not hasattr(target, trigger_attr):
|
|
setattr(target, trigger_attr, {})
|
|
value_dict = getattr(target, value_attr)
|
|
trigger_dict = getattr(target, trigger_attr)
|
|
return target, module, value_dict, trigger_dict
|
|
|
|
def _deprecate_attr(
|
|
self,
|
|
attr: str,
|
|
msg: str,
|
|
version: str | None = None,
|
|
date: str | None = None,
|
|
collection_name: str | None = None,
|
|
target: object | None = None,
|
|
value=None,
|
|
module: AnsibleModule | None = None,
|
|
) -> None:
|
|
target, module, value_dict, trigger_dict = self._deprecate_setup(attr, target, module)
|
|
|
|
value_dict[attr] = getattr(target, attr, value)
|
|
trigger_dict[attr] = False
|
|
|
|
def _trigger():
|
|
if not trigger_dict[attr]:
|
|
module.deprecate(msg, version=version, date=date, collection_name=collection_name)
|
|
trigger_dict[attr] = True
|
|
|
|
def _getter(_self):
|
|
_trigger()
|
|
return value_dict[attr]
|
|
|
|
def _setter(_self, new_value):
|
|
_trigger()
|
|
value_dict[attr] = new_value
|
|
|
|
# override attribute
|
|
prop = property(_getter)
|
|
setattr(target, attr, prop)
|
|
setattr(target, f"_{attr}_setter", prop.setter(_setter))
|