164881d871
* Remove UnsafeProxy Move the work from UnsafeProxy to wrap_var and add support for bytes. Where wrap_var is not needed, use AnsibleUnsafeBytes/AnsibleUnsafeText directly. Fixes #59606 * item is not always text * Address issues from reviews * ci_complete
128 lines
4.6 KiB
Python
128 lines
4.6 KiB
Python
# PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
|
|
# --------------------------------------------
|
|
#
|
|
# 1. This LICENSE AGREEMENT is between the Python Software Foundation
|
|
# ("PSF"), and the Individual or Organization ("Licensee") accessing and
|
|
# otherwise using this software ("Python") in source or binary form and
|
|
# its associated documentation.
|
|
#
|
|
# 2. Subject to the terms and conditions of this License Agreement, PSF hereby
|
|
# grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
|
|
# analyze, test, perform and/or display publicly, prepare derivative works,
|
|
# distribute, and otherwise use Python alone or in any derivative version,
|
|
# provided, however, that PSF's License Agreement and PSF's notice of copyright,
|
|
# i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
|
|
# 2011, 2012, 2013, 2014 Python Software Foundation; All Rights Reserved" are
|
|
# retained in Python alone or in any derivative version prepared by Licensee.
|
|
#
|
|
# 3. In the event Licensee prepares a derivative work that is based on
|
|
# or incorporates Python or any part thereof, and wants to make
|
|
# the derivative work available to others as provided herein, then
|
|
# Licensee hereby agrees to include in any such work a brief summary of
|
|
# the changes made to Python.
|
|
#
|
|
# 4. PSF is making Python available to Licensee on an "AS IS"
|
|
# basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
|
|
# IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
|
|
# DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
|
|
# FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
|
|
# INFRINGE ANY THIRD PARTY RIGHTS.
|
|
#
|
|
# 5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
|
|
# FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
|
|
# A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
|
|
# OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
|
|
#
|
|
# 6. This License Agreement will automatically terminate upon a material
|
|
# breach of its terms and conditions.
|
|
#
|
|
# 7. Nothing in this License Agreement shall be deemed to create any
|
|
# relationship of agency, partnership, or joint venture between PSF and
|
|
# Licensee. This License Agreement does not grant permission to use PSF
|
|
# trademarks or trade name in a trademark sense to endorse or promote
|
|
# products or services of Licensee, or any third party.
|
|
#
|
|
# 8. By copying, installing or otherwise using Python, Licensee
|
|
# agrees to be bound by the terms and conditions of this License
|
|
# Agreement.
|
|
#
|
|
# Original Python Recipe for Proxy:
|
|
# http://code.activestate.com/recipes/496741-object-proxying/
|
|
# Author: Tomer Filiba
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.common._collections_compat import Mapping, MutableSequence, Set
|
|
from ansible.module_utils.six import string_types, binary_type, text_type
|
|
|
|
|
|
__all__ = ['AnsibleUnsafe', 'wrap_var']
|
|
|
|
|
|
class AnsibleUnsafe(object):
|
|
__UNSAFE__ = True
|
|
|
|
|
|
class AnsibleUnsafeBytes(binary_type, AnsibleUnsafe):
|
|
pass
|
|
|
|
|
|
class AnsibleUnsafeText(text_type, AnsibleUnsafe):
|
|
pass
|
|
|
|
|
|
class UnsafeProxy(object):
|
|
def __new__(cls, obj, *args, **kwargs):
|
|
from ansible.utils.display import Display
|
|
Display().deprecated(
|
|
'UnsafeProxy is being deprecated. Use wrap_var or AnsibleUnsafeBytes/AnsibleUnsafeText directly instead',
|
|
version='2.13'
|
|
)
|
|
# In our usage we should only receive unicode strings.
|
|
# This conditional and conversion exists to sanity check the values
|
|
# we're given but we may want to take it out for testing and sanitize
|
|
# our input instead.
|
|
if isinstance(obj, AnsibleUnsafe):
|
|
return obj
|
|
|
|
if isinstance(obj, string_types):
|
|
obj = AnsibleUnsafeText(to_text(obj, errors='surrogate_or_strict'))
|
|
return obj
|
|
|
|
|
|
def _wrap_dict(v):
|
|
for k in v.keys():
|
|
if v[k] is not None:
|
|
v[wrap_var(k)] = wrap_var(v[k])
|
|
return v
|
|
|
|
|
|
def _wrap_list(v):
|
|
for idx, item in enumerate(v):
|
|
if item is not None:
|
|
v[idx] = wrap_var(item)
|
|
return v
|
|
|
|
|
|
def _wrap_set(v):
|
|
return set(item if item is None else wrap_var(item) for item in v)
|
|
|
|
|
|
def wrap_var(v):
|
|
if isinstance(v, AnsibleUnsafe):
|
|
return v
|
|
|
|
if isinstance(v, Mapping):
|
|
v = _wrap_dict(v)
|
|
elif isinstance(v, MutableSequence):
|
|
v = _wrap_list(v)
|
|
elif isinstance(v, Set):
|
|
v = _wrap_set(v)
|
|
elif isinstance(v, binary_type):
|
|
v = AnsibleUnsafeBytes(v)
|
|
elif isinstance(v, text_type):
|
|
v = AnsibleUnsafeText(v)
|
|
|
|
return v
|