ansible-core 2.16.5__py3-none-any.whl → 2.17.0b1__py3-none-any.whl

ansible/plugins/lookup/first_found.py

@@ -1,8 +1,7 @@
 # (c) 2013, seth vidal <skvidal@fedoraproject.org> red hat, inc
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: first_found
@@ -147,6 +146,7 @@ from jinja2.exceptions import UndefinedError
 from ansible.errors import AnsibleLookupError, AnsibleUndefinedVariable
 from ansible.module_utils.six import string_types
 from ansible.plugins.lookup import LookupBase
+from ansible.utils.path import unfrackpath
 
 
 def _splitter(value, chars):
@@ -198,7 +198,7 @@ class LookupModule(LookupBase):
             # NOTE: this is used as 'global' but  can be set many times?!?!?
             skip = self.get_option('skip')
 
-            # magic extra spliting to create lists
+            # magic extra splitting to create lists
             filelist = _split_on(files, ',;')
             pathlist = _split_on(paths, ',:;')
 
@@ -209,7 +209,7 @@ class LookupModule(LookupBase):
                         f = os.path.join(path, fn)
                         total_search.append(f)
             elif filelist:
-                # NOTE: this is now 'extend', previouslly it would clobber all options, but we deemed that a bug
+                # NOTE: this is now 'extend', previously it would clobber all options, but we deemed that a bug
                 total_search.extend(filelist)
             else:
                 total_search.append(term)
@@ -218,8 +218,9 @@ class LookupModule(LookupBase):
 
     def run(self, terms, variables, **kwargs):
 
+        self.set_options(var_options=variables, direct=kwargs)
+
         if not terms:
-            self.set_options(var_options=variables, direct=kwargs)
             terms = self.get_option('files')
 
         total_search, skip = self._process_terms(terms, variables, kwargs)
@@ -246,10 +247,10 @@ class LookupModule(LookupBase):
 
             # exit if we find one!
             if path is not None:
-                return [path]
+                return [unfrackpath(path, follow=False)]
 
         # if we get here, no file was found
         if skip:
-            # NOTE: global skip wont matter, only last 'skip' value in dict term
+            # NOTE: global skip won't matter, only last 'skip' value in dict term
             return []
         raise AnsibleLookupError("No file was found when using first_found.")

ansible/plugins/lookup/indexed_items.py

@@ -1,8 +1,7 @@
 # (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: indexed_items

ansible/plugins/lookup/ini.py

@@ -1,8 +1,7 @@
 # (c) 2015, Yannig Perre <yannig.perre(at)gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: ini
@@ -155,16 +154,20 @@ class LookupModule(LookupBase):
                 params = _parse_params(term, paramvals)
                 try:
                     updated_key = False
+                    updated_options = False
                     for param in params:
                         if '=' in param:
                             name, value = param.split('=')
                             if name not in paramvals:
                                 raise AnsibleLookupError('%s is not a valid option.' % name)
-                            paramvals[name] = value
+                            self.set_option(name, value)
+                            updated_options = True
                         elif key == term:
                             # only take first, this format never supported multiple keys inline
                             key = param
                             updated_key = True
+                    if updated_options:
+                        paramvals = self.get_options()
                 except ValueError as e:
                     # bad params passed
                     raise AnsibleLookupError("Could not use '%s' from '%s': %s" % (param, params, to_native(e)), orig_exc=e)

ansible/plugins/lookup/inventory_hostnames.py

@@ -3,8 +3,7 @@
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: inventory_hostnames

ansible/plugins/lookup/items.py

@@ -1,8 +1,7 @@
 # (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: items

ansible/plugins/lookup/lines.py

@@ -2,8 +2,7 @@
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: lines

ansible/plugins/lookup/list.py

@@ -1,10 +1,8 @@
 # (c) 2012-17 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-# Make coding more python3-ish
-from __future__ import (absolute_import, division, print_function)
+from __future__ import annotations
 
-__metaclass__ = type
 
 DOCUMENTATION = """
     name: list

ansible/plugins/lookup/nested.py

@@ -1,8 +1,7 @@
 # (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: nested

ansible/plugins/lookup/password.py

@@ -3,8 +3,7 @@
 # (c) 2013, Maykel Moya <mmoya@speedyrails.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: password
@@ -332,29 +331,32 @@ class LookupModule(LookupBase):
         if invalid_params:
             raise AnsibleError('Unrecognized parameter(s) given to password lookup: %s' % ', '.join(invalid_params))
 
-        # Set defaults
-        params['length'] = int(params.get('length', self.get_option('length')))
-        params['encrypt'] = params.get('encrypt', self.get_option('encrypt'))
-        params['ident'] = params.get('ident', self.get_option('ident'))
-        params['seed'] = params.get('seed', self.get_option('seed'))
+        # update options with what we got
+        if params:
+            self.set_options(direct=params)
 
-        params['chars'] = params.get('chars', self.get_option('chars'))
-        if params['chars'] and isinstance(params['chars'], string_types):
+        # chars still might need more
+        chars = params.get('chars', self.get_option('chars'))
+        if chars and isinstance(chars, string_types):
             tmp_chars = []
-            if u',,' in params['chars']:
+            if u',,' in chars:
                 tmp_chars.append(u',')
-            tmp_chars.extend(c for c in params['chars'].replace(u',,', u',').split(u',') if c)
-            params['chars'] = tmp_chars
+            tmp_chars.extend(c for c in chars.replace(u',,', u',').split(u',') if c)
+            self.set_option('chars', tmp_chars)
+
+        # return processed params
+        for field in VALID_PARAMS:
+            params[field] = self.get_option(field)
 
         return relpath, params
 
     def run(self, terms, variables, **kwargs):
         ret = []
 
-        self.set_options(var_options=variables, direct=kwargs)
-
         for term in terms:
 
+            self.set_options(var_options=variables, direct=kwargs)
+
             changed = None
             relpath, params = self._parse_parameters(term)
             path = self._loader.path_dwim(relpath)

ansible/plugins/lookup/pipe.py

@@ -1,8 +1,7 @@
 # (c) 2012, Daniel Hokka Zakrisson <daniel@hozac.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = r"""
     name: pipe

ansible/plugins/lookup/random_choice.py

@@ -1,8 +1,7 @@
 # (c) 2013, Michael DeHaan <michael.dehaan@gmail.com>
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: random_choice

ansible/plugins/lookup/sequence.py

@@ -1,8 +1,7 @@
 # (c) 2013, Jayson Vantuyl <jayson@aggressive.ly>
 # (c) 2012-17 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: sequence
@@ -20,21 +19,21 @@ DOCUMENTATION = """
     options:
       start:
         description: number at which to start the sequence
-        default: 0
+        default: 1
         type: integer
       end:
         description: number at which to end the sequence, dont use this with count
         type: integer
-        default: 0
       count:
         description: number of elements in the sequence, this is not to be used with end
         type: integer
-        default: 0
       stride:
         description: increments between sequence numbers, the default is 1 unless the end is less than the start, then it is -1.
         type: integer
+        default: 1
       format:
         description: return a string with the generated number formatted in
+        default: "%d"
 """
 
 EXAMPLES = """
@@ -98,6 +97,7 @@ SHORTCUT = re_compile(
     "(:(.+))?$",  # Group 5, Group 6: Format String
     IGNORECASE
 )
+FIELDS = frozenset(('start', 'end', 'stride', 'count', 'format'))
 
 
 class LookupModule(LookupBase):
@@ -139,30 +139,12 @@ class LookupModule(LookupBase):
     calculating the number of entries in a sequence when a stride is specified.
     """
 
-    def reset(self):
-        """set sensible defaults"""
-        self.start = 1
-        self.count = None
-        self.end = None
-        self.stride = 1
-        self.format = "%d"
-
     def parse_kv_args(self, args):
         """parse key-value style arguments"""
-        for arg in ["start", "end", "count", "stride"]:
-            try:
-                arg_raw = args.pop(arg, None)
-                if arg_raw is None:
-                    continue
-                arg_cooked = int(arg_raw, 0)
-                setattr(self, arg, arg_cooked)
-            except ValueError:
-                raise AnsibleError(
-                    "can't parse %s=%s as integer"
-                    % (arg, arg_raw)
-                )
-        if 'format' in args:
-            self.format = args.pop("format")
+        for arg in FIELDS:
+            value = args.pop(arg, None)
+            if value is not None:
+                self.set_option(arg, value)
         if args:
             raise AnsibleError(
                 "unrecognized arguments to with_sequence: %s"
@@ -177,33 +159,17 @@ class LookupModule(LookupBase):
 
         dummy, start, end, dummy, stride, dummy, format = match.groups()
 
-        if start is not None:
-            try:
-                start = int(start, 0)
-            except ValueError:
-                raise AnsibleError("can't parse start=%s as integer" % start)
-        if end is not None:
-            try:
-                end = int(end, 0)
-            except ValueError:
-                raise AnsibleError("can't parse end=%s as integer" % end)
-        if stride is not None:
-            try:
-                stride = int(stride, 0)
-            except ValueError:
-                raise AnsibleError("can't parse stride=%s as integer" % stride)
-
-        if start is not None:
-            self.start = start
-        if end is not None:
-            self.end = end
-        if stride is not None:
-            self.stride = stride
-        if format is not None:
-            self.format = format
+        for key in FIELDS:
+            value = locals().get(key, None)
+            if value is not None:
+                self.set_option(key, value)
 
         return True
 
+    def set_fields(self):
+        for f in FIELDS:
+            setattr(self, f, self.get_option(f))
+
     def sanity_check(self):
         if self.count is None and self.end is None:
             raise AnsibleError("must specify count or end in with_sequence")
@@ -246,7 +212,8 @@ class LookupModule(LookupBase):
 
         for term in terms:
             try:
-                self.reset()  # clear out things for this iteration
+                # set defaults/global
+                self.set_options(direct=kwargs)
                 try:
                     if not self.parse_simple_args(term):
                         self.parse_kv_args(parse_kv(term))
@@ -255,7 +222,9 @@ class LookupModule(LookupBase):
                 except Exception as e:
                     raise AnsibleError("unknown error parsing with_sequence arguments: %r. Error was: %s" % (term, e))
 
+                self.set_fields()
                 self.sanity_check()
+
                 if self.stride != 0:
                     results.extend(self.generate_sequence())
             except AnsibleError:

ansible/plugins/lookup/subelements.py

@@ -1,8 +1,7 @@
 # (c) 2013, Serge van Ginderachter <serge@vanginderachter.be>
 # (c) 2012-17 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: subelements

ansible/plugins/lookup/template.py

@@ -2,8 +2,7 @@
 # Copyright: (c) 2012-17, Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: template

ansible/plugins/lookup/together.py

@@ -1,8 +1,7 @@
 # (c) 2013, Bradley Young <young.bradley@gmail.com>
 # (c) 2012-17 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: together

ansible/plugins/lookup/unvault.py

@@ -1,7 +1,6 @@
 # (c) 2020 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: unvault

ansible/plugins/lookup/url.py

@@ -1,8 +1,7 @@
 # (c) 2015, Brian Coca <bcoca@ansible.com>
 # (c) 2012-17 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
 name: url
@@ -88,7 +87,7 @@ options:
         - section: url_lookup
           key: force_basic_auth
   follow_redirects:
-    description: String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information
+    description: String of urllib2, all/yes, safe, none to determine how redirects are followed
     type: string
     version_added: "2.10"
     default: 'urllib2'
@@ -99,6 +98,13 @@ options:
     ini:
         - section: url_lookup
           key: follow_redirects
+    choices:
+        - urllib2
+        - all
+        - 'yes'
+        - safe
+        - none
+        - 'no'
   use_gssapi:
     description:
     - Use GSSAPI handler of requests

ansible/plugins/lookup/varnames.py

@@ -1,7 +1,6 @@
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: varnames

ansible/plugins/lookup/vars.py

@@ -1,7 +1,6 @@
 # (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = """
     name: vars

ansible/plugins/netconf/__init__.py

@@ -16,8 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 #
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 from abc import abstractmethod
 from functools import wraps

ansible/plugins/shell/__init__.py

@@ -14,8 +14,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import os.path
@@ -65,12 +64,12 @@ class ShellBase(AnsiblePlugin):
         # TODO: config system should already resolve this so we should be able to just iterate over dicts
         env = self.get_option('environment')
         if isinstance(env, string_types):
-            raise AnsibleError('The "envirionment" keyword takes a list of dictionaries or a dictionary, not a string')
+            raise AnsibleError('The "environment" keyword takes a list of dictionaries or a dictionary, not a string')
         if not isinstance(env, Sequence):
             env = [env]
         for env_dict in env:
             if not isinstance(env_dict, Mapping):
-                raise AnsibleError('The "envirionment" keyword takes a list of dictionaries (or single dictionary), but got a "%s" instead' % type(env_dict))
+                raise AnsibleError('The "environment" keyword takes a list of dictionaries (or single dictionary), but got a "%s" instead' % type(env_dict))
             self.env.update(env_dict)
 
         # We can remove the try: except in the future when we make ShellBase a proper subset of

ansible/plugins/shell/cmd.py

@@ -1,7 +1,6 @@
 # Copyright (c) 2019 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = '''
 name: cmd

ansible/plugins/shell/powershell.py

@@ -1,8 +1,7 @@
 # Copyright (c) 2014, Chris Church <chris@ninemoreminutes.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = '''
 name: powershell

ansible/plugins/shell/sh.py

@@ -1,8 +1,7 @@
 # Copyright (c) 2014, Chris Church <chris@ninemoreminutes.com>
 # Copyright (c) 2017 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = '''
 name: sh

ansible/plugins/strategy/__init__.py

@@ -15,9 +15,7 @@
 # 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 __future__ import annotations
 
 import cmd
 import functools
@@ -555,12 +553,19 @@ class StrategyBase:
         seen = []
         for handler in handlers:
             if listeners := handler.listen:
-                if notification in handler.get_validated_value(
+                listeners = handler.get_validated_value(
                     'listen',
                     handler.fattributes.get('listen'),
                     listeners,
                     templar,
-                ):
+                )
+                if handler._role is not None:
+                    for listener in listeners.copy():
+                        listeners.extend([
+                            handler._role.get_name(include_role_fqcn=True) + ' : ' + listener,
+                            handler._role.get_name(include_role_fqcn=False) + ' : ' + listener
+                        ])
+                if notification in listeners:
                     if handler.name and handler.name in seen:
                         continue
                     seen.append(handler.name)
@@ -845,7 +850,7 @@ class StrategyBase:
 
         return ti_copy
 
-    def _load_included_file(self, included_file, iterator, is_handler=False):
+    def _load_included_file(self, included_file, iterator, is_handler=False, handle_stats_and_callbacks=True):
         '''
         Loads an included YAML file of tasks, applying the optional set of variables.
 
@@ -853,6 +858,15 @@ class StrategyBase:
         in such case the caller is responsible for marking the host(s) as failed
         using PlayIterator.mark_host_failed().
         '''
+        if handle_stats_and_callbacks:
+            display.deprecated(
+                "Reporting play recap stats and running callbacks functionality for "
+                "``include_tasks`` in ``StrategyBase._load_included_file`` is deprecated. "
+                "See ``https://github.com/ansible/ansible/pull/79260`` for guidance on how to "
+                "move the reporting into specific strategy plugins to account for "
+                "``include_role`` tasks as well.",
+                version="2.21"
+            )
         display.debug("loading included file: %s" % included_file._filename)
         try:
             data = self._loader.load_from_file(included_file._filename)
@@ -872,11 +886,9 @@ class StrategyBase:
                 loader=self._loader,
                 variable_manager=self._variable_manager,
             )
-
-            # since we skip incrementing the stats when the task result is
-            # first processed, we do so now for each host in the list
-            for host in included_file._hosts:
-                self._tqm._stats.increment('ok', host.name)
+            if handle_stats_and_callbacks:
+                for host in included_file._hosts:
+                    self._tqm._stats.increment('ok', host.name)
         except AnsibleParserError:
             raise
         except AnsibleError as e:
@@ -884,18 +896,18 @@ class StrategyBase:
                 reason = "Could not find or access '%s' on the Ansible Controller." % to_text(e.file_name)
             else:
                 reason = to_text(e)
-
-            for r in included_file._results:
-                r._result['failed'] = True
-
-            for host in included_file._hosts:
-                tr = TaskResult(host=host, task=included_file._task, return_data=dict(failed=True, reason=reason))
-                self._tqm._stats.increment('failures', host.name)
-                self._tqm.send_callback('v2_runner_on_failed', tr)
+            if handle_stats_and_callbacks:
+                for r in included_file._results:
+                    r._result['failed'] = True
+
+                for host in included_file._hosts:
+                    tr = TaskResult(host=host, task=included_file._task, return_data=dict(failed=True, reason=reason))
+                    self._tqm._stats.increment('failures', host.name)
+                    self._tqm.send_callback('v2_runner_on_failed', tr)
             raise AnsibleError(reason) from e
 
-        # finally, send the callback and return the list of blocks loaded
-        self._tqm.send_callback('v2_playbook_on_include', included_file)
+        if handle_stats_and_callbacks:
+            self._tqm.send_callback('v2_playbook_on_include', included_file)
         display.debug("done processing included file")
         return block_list
 

ansible/plugins/strategy/debug.py

@@ -12,8 +12,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 DOCUMENTATION = '''
     name: debug