Fix linting and typing errors

Author: Shrews

src/ansible_runner/__main__.py

@@ -44,7 +44,8 @@
 from ansible_runner import run
 from ansible_runner import output
 from ansible_runner import cleanup
-from ansible_runner.utils import dump_artifact, Bunch, register_for_cleanup
+from ansible_runner._internal._dump_artifacts import dump_artifact
+from ansible_runner.utils import Bunch, register_for_cleanup
 from ansible_runner.utils.capacity import get_cpu_count, get_mem_in_bytes, ensure_uuid
 from ansible_runner.utils.importlib_compat import importlib_metadata
 from ansible_runner.runner import Runner
@@ -822,14 +823,11 @@ def main(sys_args=None):
             else:
                 vargs['inventory'] = abs_inv
 
-    output.configure()
-
-    # enable or disable debug mode
-    output.set_debug('enable' if vargs.get('debug') else 'disable')
-
-    # set the output logfile
+    debug = bool(vargs.get('debug'))
+    logfile = ''
     if ('logfile' in args) and vargs.get('logfile'):
-        output.set_logfile(vargs.get('logfile'))
+        logfile = vargs.get('logfile')
+    output.configure(debug, logfile)
 
     output.debug('starting debug logging')
 

src/ansible_runner/_internal/_dump_artifacts.py

@@ -8,20 +8,23 @@
 import tempfile
 
 from collections.abc import MutableMapping
+from typing import Any
 
 from ansible_runner.config.runner import RunnerConfig
 from ansible_runner.utils import isinventory, isplaybook
 
 
 def dump_artifacts(config: RunnerConfig) -> None:
     """Introspect the arguments and dump objects to disk"""
+    private_data_dir = config.private_data_dir or ""
+
     if config.role:
-        role = {'name': config.role}
+        role: dict[str, Any] = {'name': config.role}
         if config.role_vars:
             role['vars'] = config.role_vars
 
         hosts = config.host_pattern or 'all'
-        play = [{'hosts': hosts, 'roles': [role]}]
+        play: list[dict[str, Any]] = [{'hosts': hosts, 'roles': [role]}]
 
         if config.role_skip_facts:
             play[0]['gather_facts'] = False
@@ -33,9 +36,9 @@ def dump_artifacts(config: RunnerConfig) -> None:
 
         roles_path = config.roles_path
         if not roles_path:
-            roles_path = os.path.join(config.private_data_dir, 'roles')
+            roles_path = os.path.join(private_data_dir, 'roles')
         else:
-            roles_path += f":{os.path.join(config.private_data_dir, 'roles')}"
+            roles_path += f":{os.path.join(private_data_dir, 'roles')}"
 
         config.envvars['ANSIBLE_ROLES_PATH'] = roles_path
 
@@ -46,12 +49,12 @@ def dump_artifacts(config: RunnerConfig) -> None:
             playbook = [playbook]
 
         if isplaybook(playbook):
-            path = os.path.join(config.private_data_dir, 'project')
+            path = os.path.join(private_data_dir, 'project')
             config.playbook = dump_artifact(json.dumps(playbook), path, 'main.json')
 
     obj = config.inventory
     if obj and isinventory(obj):
-        path = os.path.join(config.private_data_dir, 'inventory')
+        path = os.path.join(private_data_dir, 'inventory')
         if isinstance(obj, MutableMapping):
             config.inventory = dump_artifact(json.dumps(obj), path, 'hosts.json')
         elif isinstance(obj, str):
@@ -65,14 +68,14 @@ def dump_artifacts(config: RunnerConfig) -> None:
     if not config.suppress_env_files:
         for key in ('envvars', 'extravars', 'passwords', 'settings'):
             obj = getattr(config, key, None)
-            if obj and not os.path.exists(os.path.join(config.private_data_dir, 'env', key)):
-                path = os.path.join(config.private_data_dir, 'env')
+            if obj and not os.path.exists(os.path.join(private_data_dir, 'env', key)):
+                path = os.path.join(private_data_dir, 'env')
                 dump_artifact(json.dumps(obj), path, key)
 
         for key in ('ssh_key', 'cmdline'):
             obj = getattr(config, key, None)
-            if obj and not os.path.exists(os.path.join(config.private_data_dir, 'env', key)):
-                path = os.path.join(config.private_data_dir, 'env')
+            if obj and not os.path.exists(os.path.join(private_data_dir, 'env', key)):
+                path = os.path.join(private_data_dir, 'env')
                 dump_artifact(obj, path, key)
 
 

src/ansible_runner/interface.py

@@ -67,19 +67,20 @@ def init_runner(
 
     if streamer:
         # undo any full paths that were dumped by dump_artifacts above in the streamer case
-        private_data_dir = config.private_data_dir
+        private_data_dir = config.private_data_dir or ""
         project_dir = os.path.join(private_data_dir, 'project')
 
         playbook_path = config.playbook or ''
-        if os.path.isabs(playbook_path) and playbook_path.startswith(project_dir):
+        if isinstance(playbook_path, str) and os.path.isabs(playbook_path) and playbook_path.startswith(project_dir):
             config.playbook = os.path.relpath(playbook_path, project_dir)
 
         inventory_path = config.inventory or ''
-        if os.path.isabs(inventory_path) and inventory_path.startswith(private_data_dir):
+        if isinstance(inventory_path, str) and os.path.isabs(inventory_path) and inventory_path.startswith(private_data_dir):
             config.inventory = os.path.relpath(inventory_path, private_data_dir)
 
-        envvars = config.envvars or {}
-        roles_path = envvars.get('ANSIBLE_ROLES_PATH') or ''
+        if config.envvars is None:
+            config.envvars = {}
+        roles_path = config.envvars.get('ANSIBLE_ROLES_PATH') or ''
         if os.path.isabs(roles_path) and roles_path.startswith(private_data_dir):
             config.envvars['ANSIBLE_ROLES_PATH'] = os.path.relpath(roles_path, private_data_dir)
 

src/ansible_runner/output.py

@@ -64,7 +64,7 @@ def set_traceback(value: str) -> None:
     TRACEBACK_ENABLED = value.lower() == 'enable'
 
 
-def configure(debug: bool, logfile: str) -> None:
+def configure(enable_debug: bool, logfile: str) -> None:
     '''
     Configures the logging facility
 
@@ -90,6 +90,6 @@ def configure(debug: bool, logfile: str) -> None:
         stdout_handler.setFormatter(formatter)
         _display_logger.addHandler(stdout_handler)
 
-    set_debug('enable' if debug is True else 'disable')
+    set_debug('enable' if enable_debug is True else 'disable')
     if logfile:
         set_logfile(logfile)

src/ansible_runner/streaming.py

@@ -1,7 +1,6 @@
 from __future__ import annotations  # allow newer type syntax until 3.10 is our minimum
 
 import codecs
-import io
 import json
 import os
 import stat
@@ -13,6 +12,7 @@
 from collections.abc import Mapping
 from functools import wraps
 from threading import Event, RLock, Thread
+from typing import BinaryIO
 
 import ansible_runner
 from ansible_runner.exceptions import ConfigurationError
@@ -38,7 +38,7 @@ def __init__(self, settings):
 
 
 class Transmitter:
-    def __init__(self, only_transmit_kwargs: bool, _output: io.FileIO | None, **kwargs):
+    def __init__(self, only_transmit_kwargs: bool, _output: BinaryIO | None, **kwargs):
         if _output is None:
             _output = sys.stdout.buffer
         self._output = _output

test/integration/test_display_callback.py

@@ -6,6 +6,7 @@
 
 import pytest
 
+from ansible_runner import RunnerConfig
 from ansible_runner.interface import init_runner
 
 
@@ -29,13 +30,15 @@ def executor(tmp_path, request):
 
     inventory = 'localhost ansible_connection=local ansible_python_interpreter="{{ ansible_playbook_python }}"'
 
-    r = init_runner(
-        private_data_dir=private_data_dir,
+    rc = RunnerConfig(
+        private_data_dir=str(private_data_dir),
         inventory=inventory,
         envvars=envvars,
         playbook=yaml.safe_load(playbook)
     )
 
+    r = init_runner(rc, '', False)
+
     return r
 
 
@@ -355,12 +358,14 @@ def test_output_when_given_invalid_playbook(tmp_path):
     #
     # But no test validated it.  This does that.
     private_data_dir = str(tmp_path)
-    ex = init_runner(
+
+    rc = RunnerConfig(
         private_data_dir=private_data_dir,
         inventory='localhost ansible_connection=local ansible_python_interpreter="{{ ansible_playbook_python }}"',
         envvars={"ANSIBLE_DEPRECATION_WARNINGS": "False"},
         playbook=os.path.join(private_data_dir, 'fake_playbook.yml')
     )
+    ex = init_runner(rc, '', False)
 
     ex.run()
     with ex.stdout as f:
@@ -392,11 +397,12 @@ def test_output_when_given_non_playbook_script(tmp_path):
     with open(os.path.join(private_data_dir, "env", "settings"), 'w') as settings_file:
         settings_file.write("pexpect_timeout: 0.2")
 
-    ex = init_runner(
+    rc = RunnerConfig(
         private_data_dir=private_data_dir,
         inventory='localhost ansible_connection=local ansible_python_interpreter="{{ ansible_playbook_python }}"',
         envvars={"ANSIBLE_DEPRECATION_WARNINGS": "False"}
     )
+    ex = init_runner(rc, '', False)
 
     ex.run()
 

test/integration/test_transmit_worker_process.py

@@ -142,6 +142,7 @@ def test_keepalive_setting(self, tmp_path, project_fixtures, keepalive_setting):
             buffer.name = 'foo'
 
         status, rc = Transmitter(
+            only_transmit_kwargs=False,
             _output=outgoing_buffer, private_data_dir=project_fixtures / 'sleep',
             playbook='sleep.yml', extravars={'sleep_interval': 2}, verbosity=verbosity
         ).run()
@@ -341,7 +342,7 @@ def transmit_stream(project_fixtures, tmp_path):
 
     transmit_dir = project_fixtures / 'debug'
     with outgoing_buffer.open('wb') as f:
-        transmitter = Transmitter(_output=f, private_data_dir=transmit_dir, playbook='debug.yml')
+        transmitter = Transmitter(only_transmit_kwargs=False, _output=f, private_data_dir=transmit_dir, playbook='debug.yml')
         status, rc = transmitter.run()
 
         assert rc in (None, 0)

test/unit/test_interface.py

@@ -1,24 +1,26 @@
 import pytest
 
+from ansible_runner import RunnerConfig
 from ansible_runner.interface import init_runner
 
 
 def test_default_callback_set(mocker):
     mocker.patch('ansible_runner.interface.signal_handler', side_effect=AttributeError('Raised intentionally'))
 
     with pytest.raises(AttributeError, match='Raised intentionally'):
-        init_runner(ignore_logging=True)
+        init_runner(RunnerConfig(), "", False)
 
 
 def test_set_cancel_callback(mocker):
     mock_runner = mocker.patch('ansible_runner.interface.Runner', side_effect=AttributeError('Raised intentionally'))
-    mock_runner_config = mocker.patch('ansible_runner.interface.RunnerConfig')
-    mock_runner_config.prepare.return_value = None
+    mock_runner_config_prepare = mocker.patch('ansible_runner.interface.RunnerConfig.prepare')
+    mock_runner_config_prepare.return_value = None
 
     def custom_cancel_callback():
-        return 'custom'
+        return True
 
     with pytest.raises(AttributeError, match='Raised intentionally'):
-        init_runner(ignore_logging=True, cancel_callback=custom_cancel_callback)
+        rc = RunnerConfig(cancel_callback=custom_cancel_callback)
+        init_runner(rc, "", False)
 
     assert mock_runner.call_args.kwargs['cancel_callback'] is custom_cancel_callback

test/unit/test_utils.py

@@ -1,7 +1,7 @@
 import os
 import stat
 
-from ansible_runner.utils import dump_artifact
+from ansible_runner._internal._dump_artifacts import dump_artifact
 
 
 def test_artifact_permissions(tmp_path):