ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

MH: deprecate features (#8280)

Browse source 
* deprecate features

* add changelog frag
This commit is contained in:
Alexei Znamensky 2024-04-30 03:27:06 +12:00 committed by GitHub
parent 85f9d89510
commit b48293ca31
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 19 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
changelogs/fragments/8280-mh-deprecations.yml Normal file
View file

@ -0,0 +1,8 @@
deprecated_features:
- MH DependencyCtxMgr module_utils - deprecate ``module_utils.mh.mixin.deps.DependencyCtxMgr`` in favour of ``module_utils.deps`` (https://github.com/ansible-collections/community.general/pull/8280).
- ModuleHelper module_utils - deprecate ``plugins.module_utils.module_helper.AnsibleModule`` (https://github.com/ansible-collections/community.general/pull/8280).
- ModuleHelper module_utils - deprecate ``plugins.module_utils.module_helper.StateMixin`` (https://github.com/ansible-collections/community.general/pull/8280).
- ModuleHelper module_utils - deprecate ``plugins.module_utils.module_helper.DependencyCtxMgr`` (https://github.com/ansible-collections/community.general/pull/8280).
- ModuleHelper module_utils - deprecate ``plugins.module_utils.module_helper.VarMeta`` (https://github.com/ansible-collections/community.general/pull/8280).
- ModuleHelper module_utils - deprecate ``plugins.module_utils.module_helper.VarDict,`` (https://github.com/ansible-collections/community.general/pull/8280).
- ModuleHelper module_utils - deprecate ``plugins.module_utils.module_helper.VarsMixin`` (https://github.com/ansible-collections/community.general/pull/8280).

6
plugins/module_utils/mh/mixins/deps.py
View file

@ -9,6 +9,12 @@ __metaclass__ = type
class DependencyCtxMgr(object): class DependencyCtxMgr(object):
"""
DEPRECATION WARNING
This class is deprecated and will be removed in community.general 11.0.0
Modules should use plugins/module_utils/deps.py instead.
"""
def __init__(self, name, msg=None): def __init__(self, name, msg=None):
self.name = name self.name = name
self.msg = msg self.msg = msg

10
plugins/module_utils/module_helper.py
View file

@ -9,14 +9,14 @@ __metaclass__ = type
# pylint: disable=unused-import # pylint: disable=unused-import
from ansible_collections.community.general.plugins.module_utils.mh.module_helper import ( from ansible_collections.community.general.plugins.module_utils.mh.module_helper import (
ModuleHelper, StateModuleHelper, AnsibleModule ModuleHelper, StateModuleHelper,
AnsibleModule # remove in 11.0.0
) )
from ansible_collections.community.general.plugins.module_utils.mh.mixins.state import StateMixin # noqa: F401 from ansible_collections.community.general.plugins.module_utils.mh.mixins.state import StateMixin # noqa: F401 remove in 11.0.0
from ansible_collections.community.general.plugins.module_utils.mh.mixins.deps import DependencyCtxMgr # noqa: F401 from ansible_collections.community.general.plugins.module_utils.mh.mixins.deps import DependencyCtxMgr # noqa: F401 remove in 11.0.0
from ansible_collections.community.general.plugins.module_utils.mh.exceptions import ModuleHelperException # noqa: F401 from ansible_collections.community.general.plugins.module_utils.mh.exceptions import ModuleHelperException # noqa: F401
from ansible_collections.community.general.plugins.module_utils.mh.deco import ( from ansible_collections.community.general.plugins.module_utils.mh.deco import (
cause_changes, module_fails_on_exception, check_mode_skip, check_mode_skip_returns, cause_changes, module_fails_on_exception, check_mode_skip, check_mode_skip_returns,
) )
from ansible_collections.community.general.plugins.module_utils.mh.mixins.vars import VarMeta, VarDict, VarsMixin # noqa: F401 from ansible_collections.community.general.plugins.module_utils.mh.mixins.vars import VarMeta, VarDict, VarsMixin # noqa: F401 remove in 11.0.0