Remove run(debug=...)

Author: Anthchirp

HISTORY.rst

@@ -10,6 +10,8 @@ History
   (those were deprecated in `#60 <https://github.com/DiamondLightSource/python-procrunner/pull/60>`_)
 * Calling the run() function with multiple unnamed arguments is no longer supported
   (previously deprecated in `#62 <https://github.com/DiamondLightSource/python-procrunner/pull/62>`_)
+* The run() function no longer accepts a 'debug' argument
+  (previously deprecated in `#63 <https://github.com/DiamondLightSource/python-procrunner/pull/63>`_)
 
 2.3.1 (2021-10-25)
 ------------------

src/procrunner/__init__.py

@@ -304,7 +304,6 @@ def run(
     command,
     *,
     timeout: Optional[float] = None,
-    debug=None,
     stdin: Optional[bytes] = None,
     print_stdout: bool = True,
     print_stderr: bool = True,
@@ -324,7 +323,6 @@ def run(
 
     :param array command: Command line to be run, specified as array.
     :param timeout: Terminate program execution after this many seconds.
-    :param boolean debug: Enable further debug messages. (deprecated)
     :param stdin: Optional bytestring that is passed to command stdin.
     :param boolean print_stdout: Pass stdout through to sys.stdout.
     :param boolean print_stderr: Pass stderr through to sys.stderr.
@@ -357,10 +355,6 @@ def run(
     else:
         assert sys.platform != "win32", "stdin argument not supported on Windows"
         stdin_pipe = subprocess.PIPE
-    if debug is not None:
-        warnings.warn(
-            "Use of the debug parameter is deprecated", DeprecationWarning, stacklevel=3
-        )
 
     start_time = timeit.default_timer()
     if timeout is not None:
@@ -406,7 +400,6 @@ def run(
     stdout = _NonBlockingStreamReader(
         p.stdout,
         output=print_stdout,
-        debug=debug,
         notify=notifier.close,
         callback=callback_stdout,
     )
@@ -415,25 +408,19 @@ def run(
     stderr = _NonBlockingStreamReader(
         p.stderr,
         output=print_stderr,
-        debug=debug,
         notify=notifier.close,
         callback=callback_stderr,
     )
     if stdin is not None:
         notifyee, notifier = Pipe(False)
         thread_pipe_pool.append(notifyee)
-        _NonBlockingStreamWriter(
-            p.stdin, data=stdin, debug=debug, notify=notifier.close
-        )
+        _NonBlockingStreamWriter(p.stdin, data=stdin, notify=notifier.close)
 
     timeout_encountered = False
 
     while (p.returncode is None) and (
         (timeout is None) or (timeit.default_timer() < max_time)
     ):
-        if debug and timeout is not None:
-            logger.debug("still running (T%.2fs)", timeit.default_timer() - max_time)
-
         # wait for some time or until a stream is closed
         try:
             if thread_pipe_pool:
@@ -450,8 +437,6 @@ def run(
                 if event:
                     # One-shot, so remove stream and watch remaining streams
                     thread_pipe_pool.pop(0)
-                    if debug:
-                        logger.debug("Event received from stream thread")
             else:
                 time.sleep(0.5)
         except KeyboardInterrupt:
@@ -465,8 +450,7 @@ def run(
     if p.returncode is None:
         # timeout condition
         timeout_encountered = True
-        if debug:
-            logger.debug("timeout (T%.2fs)", timeit.default_timer() - max_time)
+        logger.debug("timeout (T%.2fs)", timeit.default_timer() - max_time)
 
         # send terminate signal and wait some time for buffers to be read
         p.terminate()

tests/test_procrunner.py

@@ -26,7 +26,7 @@ def test_run_command_aborts_after_timeout_legacy(
 
     with pytest.raises(RuntimeError):
         with pytest.warns(DeprecationWarning, match="timeout"):
-            procrunner.run(task, timeout=-1, debug=False)
+            procrunner.run(task, timeout=-1)
 
     assert mock_subprocess.Popen.called
     assert mock_process.terminate.called
@@ -95,14 +95,12 @@ def streamreader_processing(*args, **kwargs):
             mock.call(
                 stream_stdout,
                 output=mock.ANY,
-                debug=None,
                 notify=mock.ANY,
                 callback=mock.sentinel.callback_stdout,
             ),
             mock.call(
                 stream_stderr,
                 output=mock.ANY,
-                debug=None,
                 notify=mock.ANY,
                 callback=mock.sentinel.callback_stderr,
             ),
@@ -128,17 +126,6 @@ def test_default_process_environment_is_parent_environment(mock_subprocess):
     assert mock_subprocess.Popen.call_args[1]["env"] == os.environ
 
 
-@mock.patch("procrunner.subprocess")
-def test_using_debug_parameter_raises_warning(mock_subprocess):
-    mock_subprocess.Popen.side_effect = NotImplementedError()  # cut calls short
-    with pytest.warns(DeprecationWarning, match="debug"):
-        with pytest.raises(NotImplementedError):
-            procrunner.run([mock.Mock()], debug=True)
-    with pytest.warns(DeprecationWarning, match="debug"):
-        with pytest.raises(NotImplementedError):
-            procrunner.run([mock.Mock()], debug=False)
-
-
 @mock.patch("procrunner.subprocess")
 def test_pass_custom_environment_to_process(mock_subprocess):
     mock_subprocess.Popen.side_effect = NotImplementedError()  # cut calls short