procrunner 2.3.3
Versatile utility function to run external processes
License: BSD
Requires Python: >=3.6
Keywords: procrunner

==========
ProcRunner
==========


.. image:: https://img.shields.io/pypi/v/procrunner.svg
        :target: https://pypi.python.org/pypi/procrunner
        :alt: PyPI release

.. image:: https://img.shields.io/conda/vn/conda-forge/procrunner.svg
        :target: https://anaconda.org/conda-forge/procrunner
        :alt: Conda Version

.. image:: https://dev.azure.com/DLS-tooling/procrunner/_apis/build/status/CI?branchName=master
        :target: https://github.com/DiamondLightSource/python-procrunner/commits/master
        :alt: Build status

.. image:: https://ci.appveyor.com/api/projects/status/jtq4brwri5q18d0u/branch/master
        :target: https://ci.appveyor.com/project/Anthchirp/python-procrunner
        :alt: Build status

.. image:: https://readthedocs.org/projects/procrunner/badge/?version=latest
        :target: https://procrunner.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://img.shields.io/pypi/pyversions/procrunner.svg
        :target: https://pypi.python.org/pypi/procrunner
        :alt: Supported Python versions

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
        :target: https://github.com/ambv/black
        :alt: Code style: black

Versatile utility function to run external processes

* Free software: BSD license
* Documentation: https://procrunner.readthedocs.io.


Features
--------

* runs an external process and waits for it to finish
* does not deadlock, no matter the process stdout/stderr output behaviour
* returns the exit code, stdout, stderr (separately, both as bytestrings),
  as a subprocess.CompletedProcess object
* process can run in a custom environment, either as a modification of
  the current environment or in a new environment from scratch
* stdin can be fed to the process
* stdout and stderr is printed by default, can be disabled
* stdout and stderr can be passed to any arbitrary function for
  live processing (separately, both as unicode strings)
* optionally enforces a time limit on the process, raising a
  subprocess.TimeoutExpired exception if it is exceeded.


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

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,
  rather than to connect through the existing stdin, which is the current default

2.3.1 (2021-10-25)
------------------
* Add Python 3.10 support

2.3.0 (2020-10-29)
------------------
* Add Python 3.9 support, drop Python 3.5 support
* Fix a file descriptor leak on subprocess execution

2.2.0 (2020-09-07)
------------------
* Calling the run() function with unnamed arguments (other than the command
  list as the first argument) is now deprecated. As a number of arguments
  will be removed in a future version the use of unnamed arguments will
  cause future confusion. `Use explicit keyword arguments instead (#62). <https://github.com/DiamondLightSource/python-procrunner/pull/62>`_
* `The run() function debug argument has been deprecated (#63). <https://github.com/DiamondLightSource/python-procrunner/pull/63>`_
  This is only used to debug the NonBlockingStream* classes. Those are due
  to be replaced in a future release, so the argument will no longer serve
  a purpose. Debugging information remains available via standard logging
  mechanisms.
* Final version supporting Python 3.5

2.1.0 (2020-09-05)
------------------
* `Deprecated array access on the return object (#60). <https://github.com/DiamondLightSource/python-procrunner/pull/60>`_
  The return object will become a subprocess.CompletedProcess in a future
  release, which no longer allows array-based access. For a translation table
  of array elements to attributes please see the pull request linked above.
* Add a `new parameter 'raise_timeout_exception' (#61). <https://github.com/DiamondLightSource/python-procrunner/pull/61>`_
  When set to 'True' a subprocess.TimeoutExpired exception is raised when the
  process runtime exceeds the timeout threshold. This defaults to 'False' and
  will be set to 'True' in a future release.

2.0.0 (2020-06-24)
------------------
* Python 3.5+ only, support for Python 2.7 has been dropped
* Deprecated function alias run_process() has been removed
* Fixed a stability issue on Windows

1.1.0 (2019-11-04)
------------------
* Add Python 3.8 support, drop Python 3.4 support

1.0.2 (2019-05-20)
------------------
* Stop environment override variables leaking into the process environment

1.0.1 (2019-04-16)
------------------
* Minor fixes on the return object (implement equality,
  mark as unhashable)

1.0.0 (2019-03-25)
------------------
* Support file system path objects (PEP-519) in arguments
* Change the return object to make it similar to
  subprocess.CompletedProcess, introduced with Python 3.5+

0.9.1 (2019-02-22)
------------------
* Have deprecation warnings point to correct code locations

0.9.0 (2018-12-07)
------------------
* Trap UnicodeEncodeError when printing output. Offending characters
  are replaced and a warning is logged once. Hints at incorrectly set
  PYTHONIOENCODING.

0.8.1 (2018-12-04)
------------------
* Fix a few deprecation warnings

0.8.0 (2018-10-09)
------------------
* Add parameter working_directory to set the working directory
  of the subprocess

0.7.2 (2018-10-05)
------------------
* Officially support Python 3.7

0.7.1 (2018-09-03)
------------------
* Accept environment variable overriding with numeric values.

0.7.0 (2018-05-13)
------------------
* Unicode fixes. Fix crash on invalid UTF-8 input.
* Clarify that stdout/stderr values are returned as bytestrings.
* Callbacks receive the data decoded as UTF-8 unicode strings
  with unknown characters replaced by \ufffd (unicode replacement
  character). Same applies to printing of output.
* Mark stdin broken on Windows.

0.6.1 (2018-05-02)
------------------
* Maintenance release to add some tests for executable resolution.

0.6.0 (2018-05-02)
------------------
* Fix Win32 API executable resolution for commands containing a dot ('.') in
  addition to a file extension (say '.bat').

0.5.1 (2018-04-27)
------------------
* Fix Win32API dependency installation on Windows.

0.5.0 (2018-04-26)
------------------
* New keyword 'win32resolve' which only takes effect on Windows and is enabled
  by default. This causes procrunner to call the Win32 API FindExecutable()
  function to try and lookup non-.exe files with the corresponding name. This
  means .bat/.cmd/etc.. files can now be run without explicitly specifying
  their extension. Only supported on Python 2.7 and 3.5+.

0.4.0 (2018-04-23)
------------------
* Python 2.7 support on Windows. Python3 not yet supported on Windows.

0.3.0 (2018-04-17)
------------------
* run_process() renamed to run()
* Python3 compatibility fixes

0.2.0 (2018-03-12)
------------------
* Procrunner is now Python3 3.3-3.6 compatible.

0.1.0 (2018-03-12)
------------------
* First release on PyPI.