README.md 2.69 KB
Newer Older
Nigel Kukard's avatar
Nigel Kukard committed
1
2
3
[![pipeline status](https://gitlab.devlabs.linuxassist.net/allworldit/python/forkedsubprocess/badges/master/pipeline.svg)](https://gitlab.devlabs.linuxassist.net/allworldit/python/forkedsubprocess/commits/master)
[![coverage report](https://gitlab.devlabs.linuxassist.net/allworldit/python/forkedsubprocess/badges/master/coverage.svg)](https://gitlab.devlabs.linuxassist.net/allworldit/python/forkedsubprocess/commits/master)

Nigel Kukard's avatar
Nigel Kukard committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Forked subprocess support for Python

This package allows for the running of a subprocess in the background, including the sending of data to the subprocess and
receiving of data from it. Threads are used to achieve the reading/writing of data.


## Basic usage

```python
from forkedsubprocess import ForkedSubprocess

process = ForkedSubprocess(['cat'])
process.run()
process.send('some string')
returncode = process.wait()

stdout = process.stdout
stderr = process.stderr
output = process.output
```


## Writing output to console

Output can be written to the console at the same time using `enable_output=True`.

```python
from forkedsubprocess import ForkedSubprocess

process = ForkedSubprocess(['cat'], enable_output=True)
process.run()
process.send('some string')
returncode = process.wait()

stdout = process.stdout
stderr = process.stderr
output = process.output
```


## Using a callback

A callback can be used for each line of output received.

```python
from forkedsubprocess import ForkedSubprocess

def my_callback(line: str):
	print(f'LINE: {line}')

process = ForkedSubprocess(['cat'], output_callback=my_callback)
process.run()
process.send('some string')
returncode = process.wait()

stdout = process.stdout
stderr = process.stderr
output = process.output
```


# License
Nigel Kukard's avatar
Nigel Kukard committed
66
<pre>
Nigel Kukard's avatar
Nigel Kukard committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Nigel Kukard's avatar
Nigel Kukard committed
84
</pre>