Codebase list python-procrunner / d944faf7-9a03-457d-bb65-050eec4c9252/upstream/2.3.1+git20221110.1.77d55b7 docs / usage.rst

Tree @d944faf7-9a03-457d-bb65-050eec4c9252/upstream/2.3.1+git20221110.1.77d55b7 (Download .tar.gz)

usage.rst @d944faf7-9a03-457d-bb65-050eec4c9252/upstream/2.3.1+git20221110.1.77d55b7raw · history · blame


To use ProcRunner in a project::

    import procrunner
    result =['/bin/ls', '/some/path/containing spaces'])

To test for successful completion::

    assert not result.returncode
    assert result.returncode == 0  # alternatively
    result.check_returncode()  # raises subprocess.CalledProcessError()

To test for no STDERR output::

    assert not result.stderr
    assert result.stderr == b''  # alternatively

To run with a specific environment variable set::

    result =, environment_override={ 'VARIABLE': 'value' })

To run with a specific environment::

    result =, environment={ 'VARIABLE': 'value' })

To run in a specific directory::

    result =, working_directory='/some/path')