mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
9773a1f289
* Add a Singleton class, use it with Display * update six import * Move remaining failes to display singleton * Fix rebase issues * Singleton improvements * Add code-smell for 'from __main__ import display'. ci_complete * s/self/cls/g * Add docs for no-main-display * Address linting issues * Add changelog fragment. ci_complete * Implement reentrant lock for class instantiation in Singleton * Add Display singleton porting guide
81 lines
2.5 KiB
Python
81 lines
2.5 KiB
Python
# (c) 2017 Ansible By Red Hat
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
from ansible.playbook import Play
|
|
from ansible.playbook.block import Block
|
|
from ansible.playbook.role import Role
|
|
from ansible.playbook.task import Task
|
|
from ansible.utils.display import Display
|
|
|
|
display = Display()
|
|
|
|
|
|
def get_reserved_names(include_private=True):
|
|
''' this function returns the list of reserved names associated with play objects'''
|
|
|
|
public = set()
|
|
private = set()
|
|
result = set()
|
|
|
|
# FIXME: find a way to 'not hardcode', possibly need role deps/includes
|
|
class_list = [Play, Role, Block, Task]
|
|
|
|
for aclass in class_list:
|
|
aobj = aclass()
|
|
|
|
# build ordered list to loop over and dict with attributes
|
|
for attribute in aobj.__dict__['_attributes']:
|
|
if 'private' in attribute:
|
|
private.add(attribute)
|
|
else:
|
|
public.add(attribute)
|
|
|
|
# local_action is implicit with action
|
|
if 'action' in public:
|
|
public.add('local_action')
|
|
|
|
# loop implies with_
|
|
# FIXME: remove after with_ is not only deprecated but removed
|
|
if 'loop' in private or 'loop' in public:
|
|
public.add('with_')
|
|
|
|
if include_private:
|
|
result = public.union(private)
|
|
else:
|
|
result = public
|
|
|
|
return result
|
|
|
|
|
|
def warn_if_reserved(myvars):
|
|
''' this function warns if any variable passed conflicts with internally reserved names '''
|
|
|
|
varnames = set(myvars)
|
|
varnames.discard('vars') # we add this one internally, so safe to ignore
|
|
for varname in varnames.intersection(_RESERVED_NAMES):
|
|
display.warning('Found variable using reserved name: %s' % varname)
|
|
|
|
|
|
def is_reserved_name(name):
|
|
return name in _RESERVED_NAMES
|
|
|
|
|
|
_RESERVED_NAMES = frozenset(get_reserved_names())
|