Package list python-procrunner / a6dc28ff-da3f-4c28-82fe-10c5f07593f4/main docs / usage.rst
a6dc28ff-da3f-4c28-82fe-10c5f07593f4/main

Tree @a6dc28ff-da3f-4c28-82fe-10c5f07593f4/main (Download .tar.gz)

usage.rst @a6dc28ff-da3f-4c28-82fe-10c5f07593f4/mainraw · history · blame

=====
Usage
=====

To use ProcRunner in a project::

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

To test for successful completion::

    assert not result['exitcode']
    assert result['exitcode'] == 0 # alternatively

To test for no STDERR output::

    assert not result['stderr']
    assert result['stderr'] == b'' # alternatively

To run with a specific environment variable set::

    result = procrunner.run(..., environment_override={ 'VARIABLE': 'value' })

To run with a specific environment::

    result = procrunner.run(..., environment={ 'VARIABLE': 'value' })

To run in a specific directory::

    result = procrunner.run(..., working_directory='/some/path')