Codebase list python-procrunner / 79d5885 docs / usage.rst
79d5885

Tree @79d5885 (Download .tar.gz)

usage.rst @79d5885 — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
=====
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' })