listify_lookup_plugin_terms deprecate dataloader (#78244)

* listify_lookup_plugin_terms deprecate dataloader

  deprecated useless dataloader pass to function
  also removed from callers in core


Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>

changelogs/fragments/loader_in_listify.yml

@@ -0,0 +1,4 @@
+deprecated_features:
+  - listify_lookup_plugin_terms, deprecate 'loader/dataloader' parameter as it not used.
+minor_changes:
+  - calls to listify_lookup_plugin_terms in core do not pass in loader/dataloader anymore.

lib/ansible/executor/task_executor.py

@@ -226,8 +226,7 @@ class TaskExecutor:
                     # first_found loops are special. If the item is undefined then we want to fall through to the next value rather than failing.
                     fail = False
 
-                loop_terms = listify_lookup_plugin_terms(terms=self._task.loop, templar=templar, loader=self._loader, fail_on_undefined=fail,
-                                                         convert_bare=False)
+                loop_terms = listify_lookup_plugin_terms(terms=self._task.loop, templar=templar, fail_on_undefined=fail, convert_bare=False)
                 if not fail:
                     loop_terms = [t for t in loop_terms if not templar.is_template(t)]
 

lib/ansible/plugins/lookup/nested.py

@@ -60,7 +60,7 @@ class LookupModule(LookupBase):
         results = []
         for x in terms:
             try:
-                intermediate = listify_lookup_plugin_terms(x, templar=self._templar, loader=self._loader, fail_on_undefined=True)
+                intermediate = listify_lookup_plugin_terms(x, templar=self._templar, fail_on_undefined=True)
             except UndefinedError as e:
                 raise AnsibleUndefinedVariable("One of the nested variables was undefined. The error was: %s" % e)
             results.append(intermediate)

lib/ansible/plugins/lookup/subelements.py

@@ -101,7 +101,7 @@ class LookupModule(LookupBase):
             raise AnsibleError(
                 "subelements lookup expects a list of two or three items, " + msg)
 
-        terms[0] = listify_lookup_plugin_terms(terms[0], templar=self._templar, loader=self._loader)
+        terms[0] = listify_lookup_plugin_terms(terms[0], templar=self._templar)
 
         # check lookup terms - check number of terms
         if not isinstance(terms, list) or not 2 <= len(terms) <= 3:

lib/ansible/plugins/lookup/together.py

@@ -53,7 +53,7 @@ class LookupModule(LookupBase):
     def _lookup_variables(self, terms):
         results = []
         for x in terms:
-            intermediate = listify_lookup_plugin_terms(x, templar=self._templar, loader=self._loader)
+            intermediate = listify_lookup_plugin_terms(x, templar=self._templar)
             results.append(intermediate)
         return results
 

lib/ansible/template/__init__.py

@@ -978,7 +978,7 @@ class Templar:
         allow_unsafe = kwargs.pop('allow_unsafe', C.DEFAULT_ALLOW_UNSAFE_LOOKUPS)
         errors = kwargs.pop('errors', 'strict')
 
-        loop_terms = listify_lookup_plugin_terms(terms=args, templar=self, loader=self._loader, fail_on_undefined=True, convert_bare=False)
+        loop_terms = listify_lookup_plugin_terms(terms=args, templar=self, fail_on_undefined=True, convert_bare=False)
         # safely catch run failures per #5059
         try:
             ran = instance.run(loop_terms, variables=self._available_variables, **kwargs)

lib/ansible/utils/listify.py

@@ -22,12 +22,18 @@ __metaclass__ = type
 from collections.abc import Iterable
 
 from ansible.module_utils.six import string_types
+from ansible.utils.display import Display
 
+display = Display()
 
 __all__ = ['listify_lookup_plugin_terms']
 
 
-def listify_lookup_plugin_terms(terms, templar, loader, fail_on_undefined=True, convert_bare=False):
+def listify_lookup_plugin_terms(terms, templar, loader=None, fail_on_undefined=True, convert_bare=False):
+
+    if loader is not None:
+        display.deprecated('"listify_lookup_plugin_terms" does not use "dataloader" anymore, the ability to pass it in will be removed in future versions.',
+                           version='2.18')
 
     if isinstance(terms, string_types):
         terms = templar.template(terms.strip(), convert_bare=convert_bare, fail_on_undefined=fail_on_undefined)

lib/ansible/vars/manager.py

@@ -550,8 +550,7 @@ class VariableManager:
                     # first_found loops are special. If the item is undefined then we want to fall through to the next
                     fail = False
                 try:
-                    loop_terms = listify_lookup_plugin_terms(terms=task.loop, templar=templar,
-                                                             loader=self._loader, fail_on_undefined=fail, convert_bare=False)
+                    loop_terms = listify_lookup_plugin_terms(terms=task.loop, templar=templar, fail_on_undefined=fail, convert_bare=False)
 
                     if not fail:
                         loop_terms = [t for t in loop_terms if not templar.is_template(t)]