Merge branch 'flag-forwarding'

Author: Anthchirp

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.3.2
+current_version = 2.3.3
 commit = True
 tag = True
 

HISTORY.rst

@@ -16,6 +16,11 @@ History
 * The run() function no longer accepts a 'debug' argument
   (previously deprecated in `#63 <https://github.com/DiamondLightSource/python-procrunner/pull/63>`_)
 
+2.3.3 (2022-03-23)
+------------------
+* Allow specifying 'preexec_fn' and 'creationflags' keywords, which will be passed through to
+  the subprocess call
+
 2.3.2 (2022-01-28)
 ------------------
 * The run() function now understands stdin=subprocess.DEVNULL to close the subprocess stdin,

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 name = procrunner
 description = Versatile utility function to run external processes
-version = 2.3.2
+version = 2.3.3
 author = Diamond Light Source - Scientific Software et al.
 author_email = [email protected]
 classifiers =

src/procrunner/__init__.py

@@ -46,7 +46,7 @@
 #   stderr=b'/bin/ls: cannot access /some/path/containing spaces: No such file or directory\n'
 # )
 
-__version__ = "2.3.2"
+__version__ = "2.3.3"
 
 logger = logging.getLogger("procrunner")
 logger.addHandler(logging.NullHandler())
@@ -304,16 +304,18 @@ def run(
     command,
     *,
     timeout: Optional[float] = None,
-    stdin: Optional[Union[bytes, int]] = None,
-    print_stdout: bool = True,
-    print_stderr: bool = True,
-    callback_stdout: Optional[Callable] = None,
     callback_stderr: Optional[Callable] = None,
+    callback_stdout: Optional[Callable] = None,
+    creationflags: int = 0,
     environment: Optional[dict[str, str]] = None,
     environment_override: Optional[dict[str, str]] = None,
+    preexec_fn: Optional[Callable] = None,
+    print_stderr: bool = True,
+    print_stdout: bool = True,
+    raise_timeout_exception: Any = ...,
+    stdin: Optional[Union[bytes, int]] = None,
     win32resolve: bool = True,
     working_directory: Optional[str] = None,
-    raise_timeout_exception: Any = ...,
 ) -> subprocess.CompletedProcess:
     """
     Run an external process.
@@ -331,9 +333,11 @@ def run(
                             stdout line.
     :param callback_stderr: Optional function which is called for each
                             stderr line.
+    :param creationflags: flags that will be passed to subprocess call
     :param dict environment: The full execution environment for the command.
     :param dict environment_override: Change environment variables from the
                                       current values for command execution.
+    :param preexec_fn: pre-execution function, will be passed to subprocess call
     :param boolean win32resolve: If on Windows, find the appropriate executable
                                  first. This allows running of .bat, .cmd, etc.
                                  files without explicitly specifying their
@@ -399,6 +403,8 @@ def run(
         stdin=stdin_pipe,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
+        creationflags=creationflags,
+        preexec_fn=preexec_fn,
     )
 
     thread_pipe_pool = []