Add type hints to ansible.utils.display::Display (ansible#81400)

* Add type hints to ansible.utils.display::Display Fixes ansible#80841 * Avoid circular import * Fix sanity * type hint some of the functions of the module? * Fix units * Not sure about this * Fix some of the issues from reviews * Add changelog * ... * Update lib/ansible/utils/display.py Co-authored-by: Sviatoslav Sydorenko <[email protected]> * remove py2 boilerplate --------- Co-authored-by: Sviatoslav Sydorenko <[email protected]>
bmfp · Sep 5, 2023 · 4d40988 · 4d40988
1 parent 48d8e06
commit 4d40988
Show file tree

Hide file tree

Showing 7 changed files with 104 additions and 59 deletions.
diff --git a/changelogs/fragments/80841-display-type-annotation.yml b/changelogs/fragments/80841-display-type-annotation.yml
@@ -0,0 +1,4 @@
+minor_changes:
+  - Add Python type hints to the Display class (https://github.com/ansible/ansible/issues/80841)
+bugfixes:
+  - vars_prompt - internally convert the ``unsafe`` value to ``bool``
diff --git a/lib/ansible/executor/playbook_executor.py b/lib/ansible/executor/playbook_executor.py
@@ -148,7 +148,7 @@ def run(self):
                             encrypt = var.get("encrypt", None)
                             salt_size = var.get("salt_size", None)
                             salt = var.get("salt", None)
-                            unsafe = var.get("unsafe", None)
+                            unsafe = boolean(var.get("unsafe", False))
 
                             if vname not in self._variable_manager.extra_vars:
                                 if self._tqm:

diff --git a/lib/ansible/playbook/play_context.py b/lib/ansible/playbook/play_context.py
@@ -119,15 +119,15 @@ class PlayContext(Base):
     def verbosity(self):
         display.deprecated(
             "PlayContext.verbosity is deprecated, use ansible.utils.display.Display.verbosity instead.",
-            version=2.18
+            version="2.18"
         )
         return self._internal_verbosity
 
     @verbosity.setter
     def verbosity(self, value):
         display.deprecated(
             "PlayContext.verbosity is deprecated, use ansible.utils.display.Display.verbosity instead.",
-            version=2.18
+            version="2.18"
         )
         self._internal_verbosity = value
 

diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py
@@ -528,7 +528,7 @@ def wrapped(self: Connection, *args: P.args, **kwargs: P.kwargs) -> tuple[int, b
                     if self._play_context.no_log:
                         display.vvv(u'rc=%s, stdout and stderr censored due to no log' % return_tuple[0], host=self.host)
                     else:
-                        display.vvv(return_tuple, host=self.host)
+                        display.vvv(str(return_tuple), host=self.host)
                     # 0 = success
                     # 1-254 = remote command return code
                     # 255 could be a failure from the ssh command itself