-
Notifications
You must be signed in to change notification settings - Fork 2
/
streamcapture.html
654 lines (619 loc) · 38.6 KB
/
streamcapture.html
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
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>streamcapture API documentation</title>
<meta name="description" content="streamcapture: capture the outputs of Python streams, such as sys.stdout and sys.stderr …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Package <code>streamcapture</code></h1>
</header>
<section id="section-intro">
<h2 id="streamcapture-capture-the-outputs-of-python-streams-such-as-sysstdout-and-sysstderr">streamcapture: capture the outputs of Python streams, such as sys.stdout and sys.stderr</h2>
<h3 id="author-sebastien-loisel">Author: Sébastien Loisel</h3>
<h1 id="installation">Installation</h1>
<p><code>pip install <a title="streamcapture" href="#streamcapture">streamcapture</a></code></p>
<h1 id="example-usage">Example usage</h1>
<pre><code class="language-python">import streamcapture, sys, os
print("This does not get saved to the log file")
with streamcapture.StreamCapture(sys.stdout,open('logfile.txt','wb')):
os.write(sys.stdout.fileno(),b"Hello, captured world!\n")
os.system('echo Hello from the shell')
print("More capturing")
print("This also does not get saved to the log file")
</code></pre>
<p>After execution, this will create a file <code>logfile.txt</code> in the current directory, containing
the relevant captured outputs.</p>
<h1 id="documentation">Documentation</h1>
<p>Class <code>StreamCapture(stream, writer, echo=True, monkeypatch=None)</code> is able to capture,
at the operating system level, the data being written to the given <code>stream</code>.
A typical use is to capture all outputs to <code>sys.stdout</code> and <code>sys.stderr</code>
and log them to a file. This will even capture the outputs of spawned shell commands.</p>
<p><code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> works by essentially using <code>os.dup2</code> to send <code>stream.fileno()</code> to a <code>os.pipe()</code>.
A separate thread is used to listen to that <code>os.pipe</code> and send the outputs to the destination
<code>writer</code> stream. <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> also uses <code>os.dup</code> to duplicate the original filedescriptor to be able
to restore it at the end. This duplicated filedescriptor is stored in <code>StreamCapture.dup_fd</code>, and
writing to this filedescriptor results in writing to the original file, before it was redirected.
For example, when redirecting <code>sys.stdout</code>, one can still write to the terminal by writing directly
to <code>StreamCapture.dup_fd</code> with <code>os.write()</code>.</p>
<p>On Windows, <code>sys.stdout</code> and <code>sys.stderr</code> do not take kindly to their <code>fileno()</code> being
redirected with <code>os.dup2</code>. <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> features an optional workaround, enabled by the
<code>monkeypatch</code> optional parameter to the constructor. When enabled, the workaround
overwrites <code>stream.write(…)</code> by an implementation that sends everything to <code>os.write(self.fd,…)</code>.
This workaround is enabled when <code>monkeypatch=True</code> and disabled when <code>monkeypatch=False</code>.
The default is <code>monkeypatch=None</code>, in which case monkeypatching is enabled only when
<code>platform.system()=='Windows'</code>.</p>
<p>When writing to multiple streams and file descriptors, sometimes the order in which the writes
appear can be surprising. For example, when writing to stderr and stdout, these outputs do not
necessarily appear in the order in which they occurred during the program execution, because
of various levels of buffering that occur in Python, the C library or the operating system.</p>
<p>At the Python level, streams can be <code>flush()</code>ed to attempt to reduce the delay before a <code>write()</code>
has delivered its payload. Furthermore, <code>os.fsync()</code> can be used on some, but not all, file descriptors.
However, <code>os.fsync()</code> usually causes an exception if it is called on <code>sys.stdout.fileno()</code> or on a
<code>os.pipe()</code>. In principle, the operating system should promtly flush any buffers when a file descriptor
is <code>os.close()</code>d, but there is no guarantee. To complicate matters, although one usually prefers minimal
buffering for outputs that go to the console, Python tries very hard to force some sort of buffering on
text-mode files.</p>
<p>We have tried to prevent most forms of buffering at the Python level and at the operating system levels,
but when multiple file descriptors are used, or at the boundary when a <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> starts or stops
capturing the underlying stream, some outputs that go to the console may appear in an unexpected order.</p>
<p>More sophisticated behaviors can be handled by implementing a custom stream-like object.
The <code>writer</code> object should implement functions <code>writer.write(data)</code>, where <code>data</code> is a byte string,
and <code>writer.close()</code>.</p>
<p>The <code>echo</code> flag can be set at construction time <code>StreamCapture(...,echo=True)</code> and defaults to <code>True</code>.
In this mode, all captured outputs are sent both to the <code>writer</code> and also to <code>StreamCapture.dup_fd</code>.
This allows one to send, e.g. <code>stdout</code> to a log file while simultaneously printing it to the console,
similar to the <code>tee</code> console command in Unix. The <code>echo</code> flag can be set to <code>False</code> to disable this.</p>
<p>One can call <code><a title="streamcapture.StreamCapture.close" href="#streamcapture.StreamCapture.close">StreamCapture.close()</a></code> to cleanly unwind the captured streams. This is automatically
done if <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> is used in a <code>with</code> block.</p>
<p>One may also wish to capture a filedescriptor without the overhead of a wrapping Python stream.
To that end, one may use <code>FDCapture(fd,writer,echo=True)</code>. The parameter <code>fd</code> is an integer filedescriptor
to be captured. <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> is a thin wrapper around <code><a title="streamcapture.FDCapture" href="#streamcapture.FDCapture">FDCapture</a></code>, it mainly adds the monkeypatching
capability.</p>
<p><code><a title="streamcapture.Writer" href="#streamcapture.Writer">Writer</a></code> is a thin wrapper around an underlying stream, that allows sharing a stream
between multiple threads in a thread-safe manner, guaranteeing that the underlying stream is closed
only when all threads have called <code>close</code>. <code><a title="streamcapture.Writer" href="#streamcapture.Writer">Writer</a></code> objects are constructed by
<code>streamcapture.Writer(stream,count,lock_write = False)</code>.</p>
<p><code>stream</code>: is a stream that is being wrapped, e.g. <code>stream = open('logfile.txt','wb')</code></p>
<p><code>count</code>: is the number of times that <code><a title="streamcapture.Writer.close" href="#streamcapture.Writer.close">Writer.close()</a></code> will be called before the writer
is finally closed. This is so that a single stream can be used from multiple threads.</p>
<p><code>lock_write</code>: set this to <code>True</code> if you want calls to <code>stream.write()</code> to be serialized.
This causes <code>Writer.write</code> to acquire <code>Writer.lock</code> before calling <code>stream.write</code>.
If <code>lock_write=False</code> then <code>Writer.lock</code> is not acquired. Use this when <code>stream.write</code> is
thread-safe. <code>lock_write=False</code> is the default.</p>
<p>Example usage:</p>
<pre><code class="language-python">import sys, streamcapture
writer = streamcapture.Writer(open('logfile.txt','wb'),2)
with streamcapture.StreamCapture(sys.stdout,writer), streamcapture.StreamCapture(sys.stderr,writer):
print("This goes to stdout and is captured to logfile.txt")
print("This goes to stderr and is also captured to logfile.txt",file=sys.stderr)
</code></pre>
<p>In the above example, writer will be closed twice: once from the <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a>(sys.stdout,…)</code>
object, and once from the <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a>(sys.stderr,…)</code> object. Correspondingly, the <code>count</code> parameter
of the <code><a title="streamcapture.Writer" href="#streamcapture.Writer">Writer</a></code> was set to <code>2</code>, so that the underlying stream is only closed after 2
calls to <code>writer.close()</code>.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">r"""
## streamcapture: capture the outputs of Python streams, such as sys.stdout and sys.stderr
### Author: Sébastien Loisel
# Installation
`pip install streamcapture`
# Example usage
```python
import streamcapture, sys, os
print("This does not get saved to the log file")
with streamcapture.StreamCapture(sys.stdout,open('logfile.txt','wb')):
os.write(sys.stdout.fileno(),b"Hello, captured world!\n")
os.system('echo Hello from the shell')
print("More capturing")
print("This also does not get saved to the log file")
```
After execution, this will create a file `logfile.txt` in the current directory, containing
the relevant captured outputs.
# Documentation
Class `StreamCapture(stream, writer, echo=True, monkeypatch=None)` is able to capture,
at the operating system level, the data being written to the given `stream`.
A typical use is to capture all outputs to `sys.stdout` and `sys.stderr`
and log them to a file. This will even capture the outputs of spawned shell commands.
`StreamCapture` works by essentially using `os.dup2` to send `stream.fileno()` to a `os.pipe()`.
A separate thread is used to listen to that `os.pipe` and send the outputs to the destination
`writer` stream. `StreamCapture` also uses `os.dup` to duplicate the original filedescriptor to be able
to restore it at the end. This duplicated filedescriptor is stored in `StreamCapture.dup_fd`, and
writing to this filedescriptor results in writing to the original file, before it was redirected.
For example, when redirecting `sys.stdout`, one can still write to the terminal by writing directly
to `StreamCapture.dup_fd` with `os.write()`.
On Windows, `sys.stdout` and `sys.stderr` do not take kindly to their `fileno()` being
redirected with `os.dup2`. `StreamCapture` features an optional workaround, enabled by the
`monkeypatch` optional parameter to the constructor. When enabled, the workaround
overwrites `stream.write(...)` by an implementation that sends everything to `os.write(self.fd,...)`.
This workaround is enabled when `monkeypatch=True` and disabled when `monkeypatch=False`.
The default is `monkeypatch=None`, in which case monkeypatching is enabled only when
`platform.system()=='Windows'`.
When writing to multiple streams and file descriptors, sometimes the order in which the writes
appear can be surprising. For example, when writing to stderr and stdout, these outputs do not
necessarily appear in the order in which they occurred during the program execution, because
of various levels of buffering that occur in Python, the C library or the operating system.
At the Python level, streams can be `flush()`ed to attempt to reduce the delay before a `write()`
has delivered its payload. Furthermore, `os.fsync()` can be used on some, but not all, file descriptors.
However, `os.fsync()` usually causes an exception if it is called on `sys.stdout.fileno()` or on a
`os.pipe()`. In principle, the operating system should promtly flush any buffers when a file descriptor
is `os.close()`d, but there is no guarantee. To complicate matters, although one usually prefers minimal
buffering for outputs that go to the console, Python tries very hard to force some sort of buffering on
text-mode files.
We have tried to prevent most forms of buffering at the Python level and at the operating system levels,
but when multiple file descriptors are used, or at the boundary when a `StreamCapture` starts or stops
capturing the underlying stream, some outputs that go to the console may appear in an unexpected order.
More sophisticated behaviors can be handled by implementing a custom stream-like object.
The `writer` object should implement functions `writer.write(data)`, where `data` is a byte string,
and `writer.close()`.
The `echo` flag can be set at construction time `StreamCapture(...,echo=True)` and defaults to `True`.
In this mode, all captured outputs are sent both to the `writer` and also to `StreamCapture.dup_fd`.
This allows one to send, e.g. `stdout` to a log file while simultaneously printing it to the console,
similar to the `tee` console command in Unix. The `echo` flag can be set to `False` to disable this.
One can call `StreamCapture.close()` to cleanly unwind the captured streams. This is automatically
done if `StreamCapture` is used in a `with` block.
One may also wish to capture a filedescriptor without the overhead of a wrapping Python stream.
To that end, one may use `FDCapture(fd,writer,echo=True)`. The parameter `fd` is an integer filedescriptor
to be captured. `StreamCapture` is a thin wrapper around `FDCapture`, it mainly adds the monkeypatching
capability.
`streamcapture.Writer` is a thin wrapper around an underlying stream, that allows sharing a stream
between multiple threads in a thread-safe manner, guaranteeing that the underlying stream is closed
only when all threads have called `close`. `Writer` objects are constructed by
`streamcapture.Writer(stream,count,lock_write = False)`.
`stream`: is a stream that is being wrapped, e.g. `stream = open('logfile.txt','wb')`
`count`: is the number of times that `Writer.close()` will be called before the writer
is finally closed. This is so that a single stream can be used from multiple threads.
`lock_write`: set this to `True` if you want calls to `stream.write()` to be serialized.
This causes `Writer.write` to acquire `Writer.lock` before calling `stream.write`.
If `lock_write=False` then `Writer.lock` is not acquired. Use this when `stream.write` is
thread-safe. `lock_write=False` is the default.
Example usage:
```python
import sys, streamcapture
writer = streamcapture.Writer(open('logfile.txt','wb'),2)
with streamcapture.StreamCapture(sys.stdout,writer), streamcapture.StreamCapture(sys.stderr,writer):
print("This goes to stdout and is captured to logfile.txt")
print("This goes to stderr and is also captured to logfile.txt",file=sys.stderr)
```
In the above example, writer will be closed twice: once from the `StreamCapture(sys.stdout,...)`
object, and once from the `StreamCapture(sys.stderr,...)` object. Correspondingly, the `count` parameter
of the `streamcapture.Writer` was set to `2`, so that the underlying stream is only closed after 2
calls to `writer.close()`.
"""
import os, sys, threading, platform, select
class Writer:
def __init__(self,stream,count = None,lock_write = False):
"""`Writer` constructor."""
(self.stream,self.lock_write) = (stream,lock_write)
if count is None:
(self.count,self.increment) = (0,1)
else:
(self.count,self.increment) = (count,0)
self.lock = threading.Lock()
self._write = self.locked_write if lock_write else stream.write
def write_from(self,data,cap):
self._write(data)
def writer_open(self):
with self.lock:
self.count += self.increment
def close(self):
"""When one is done using a `Writer`, one calls `Writer.close()`. This acquires `Writer.lock` so it is
thread-safe. Each time `Writer.close()` is called, `Writer.count` is decremented. When `Writer.count`
reaches `0`, `stream.close()` is called."""
with self.lock:
self.count -= 1
if self.count>0:
return
self.stream.close()
def locked_write(self,z):
with self.lock:
self.stream.write(z)
class FDCapture:
def __init__(self,fd,writer,echo=True,magic=b'\x04\x81\x00\xff'):
"""`FDCapture` constructor."""
if(hasattr(writer,'writer_open')):
writer.writer_open()
(self.active, self.writer, self.fd, self.echo, self.magic) = (True,writer,fd,echo,magic)
self.write = (lambda data: self.writer.write_from(data,self)) if hasattr(writer,'write_from') else writer.write
(self.pipe_read_fd, self.pipe_write_fd) = os.pipe()
self.dup_fd = os.dup(fd)
os.dup2(self.pipe_write_fd,fd)
self.thread = threading.Thread(target=self.printer)
self.thread.start()
def printer(self):
"""This is the thread that listens to the pipe output and passes it to the writer stream."""
try:
looping = True
while looping:
data = os.read(self.pipe_read_fd,100000)
foo = data.split(self.magic)
if len(foo)>=2:
looping = False
for segment in foo:
if len(segment) == 0:
# Pipe is closed
looping = False
break
self.write(segment)
if self.echo:
os.write(self.dup_fd,segment)
finally:
os.close(self.pipe_read_fd)
def close(self):
"""When you want to "uncapture" a stream, use this method."""
if not self.active:
return
self.active = False
os.write(self.fd,self.magic)
self.thread.join()
os.dup2(self.dup_fd,self.fd)
os.close(self.pipe_write_fd)
os.close(self.dup_fd)
def __enter__(self):
return self
def __exit__(self,a,b,c):
self.close()
class StreamCapture:
def __init__(self,stream,writer,echo=True,monkeypatch=None):
"""The `StreamCapture` constructor."""
self.fdcapture = FDCapture(stream.fileno(),writer,echo)
self.stream = stream
self.monkeypatch = platform.system()=='Windows' if monkeypatch is None else monkeypatch
if self.monkeypatch:
self.oldwrite = stream.write
stream.write = lambda z: os.write(stream.fileno(),z.encode() if hasattr(z,'encode') else z)
def close(self):
"""When you want to "uncapture" a stream, use this method."""
self.stream.flush()
self.fdcapture.close()
if self.monkeypatch:
self.stream.write = self.oldwrite
def __enter__(self):
return self
def __exit__(self,a,b,c):
self.close()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="streamcapture.FDCapture"><code class="flex name class">
<span>class <span class="ident">FDCapture</span></span>
<span>(</span><span>fd, writer, echo=True, magic=b'\x04\x81\x00\xff')</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="streamcapture.FDCapture" href="#streamcapture.FDCapture">FDCapture</a></code> constructor.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class FDCapture:
def __init__(self,fd,writer,echo=True,magic=b'\x04\x81\x00\xff'):
"""`FDCapture` constructor."""
if(hasattr(writer,'writer_open')):
writer.writer_open()
(self.active, self.writer, self.fd, self.echo, self.magic) = (True,writer,fd,echo,magic)
self.write = (lambda data: self.writer.write_from(data,self)) if hasattr(writer,'write_from') else writer.write
(self.pipe_read_fd, self.pipe_write_fd) = os.pipe()
self.dup_fd = os.dup(fd)
os.dup2(self.pipe_write_fd,fd)
self.thread = threading.Thread(target=self.printer)
self.thread.start()
def printer(self):
"""This is the thread that listens to the pipe output and passes it to the writer stream."""
try:
looping = True
while looping:
data = os.read(self.pipe_read_fd,100000)
foo = data.split(self.magic)
if len(foo)>=2:
looping = False
for segment in foo:
if len(segment) == 0:
# Pipe is closed
looping = False
break
self.write(segment)
if self.echo:
os.write(self.dup_fd,segment)
finally:
os.close(self.pipe_read_fd)
def close(self):
"""When you want to "uncapture" a stream, use this method."""
if not self.active:
return
self.active = False
os.write(self.fd,self.magic)
self.thread.join()
os.dup2(self.dup_fd,self.fd)
os.close(self.pipe_write_fd)
os.close(self.dup_fd)
def __enter__(self):
return self
def __exit__(self,a,b,c):
self.close()</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="streamcapture.FDCapture.close"><code class="name flex">
<span>def <span class="ident">close</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>When you want to "uncapture" a stream, use this method.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def close(self):
"""When you want to "uncapture" a stream, use this method."""
if not self.active:
return
self.active = False
os.write(self.fd,self.magic)
self.thread.join()
os.dup2(self.dup_fd,self.fd)
os.close(self.pipe_write_fd)
os.close(self.dup_fd)</code></pre>
</details>
</dd>
<dt id="streamcapture.FDCapture.printer"><code class="name flex">
<span>def <span class="ident">printer</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>This is the thread that listens to the pipe output and passes it to the writer stream.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def printer(self):
"""This is the thread that listens to the pipe output and passes it to the writer stream."""
try:
looping = True
while looping:
data = os.read(self.pipe_read_fd,100000)
foo = data.split(self.magic)
if len(foo)>=2:
looping = False
for segment in foo:
if len(segment) == 0:
# Pipe is closed
looping = False
break
self.write(segment)
if self.echo:
os.write(self.dup_fd,segment)
finally:
os.close(self.pipe_read_fd)</code></pre>
</details>
</dd>
</dl>
</dd>
<dt id="streamcapture.StreamCapture"><code class="flex name class">
<span>class <span class="ident">StreamCapture</span></span>
<span>(</span><span>stream, writer, echo=True, monkeypatch=None)</span>
</code></dt>
<dd>
<div class="desc"><p>The <code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code> constructor.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class StreamCapture:
def __init__(self,stream,writer,echo=True,monkeypatch=None):
"""The `StreamCapture` constructor."""
self.fdcapture = FDCapture(stream.fileno(),writer,echo)
self.stream = stream
self.monkeypatch = platform.system()=='Windows' if monkeypatch is None else monkeypatch
if self.monkeypatch:
self.oldwrite = stream.write
stream.write = lambda z: os.write(stream.fileno(),z.encode() if hasattr(z,'encode') else z)
def close(self):
"""When you want to "uncapture" a stream, use this method."""
self.stream.flush()
self.fdcapture.close()
if self.monkeypatch:
self.stream.write = self.oldwrite
def __enter__(self):
return self
def __exit__(self,a,b,c):
self.close()</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="streamcapture.StreamCapture.close"><code class="name flex">
<span>def <span class="ident">close</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>When you want to "uncapture" a stream, use this method.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def close(self):
"""When you want to "uncapture" a stream, use this method."""
self.stream.flush()
self.fdcapture.close()
if self.monkeypatch:
self.stream.write = self.oldwrite</code></pre>
</details>
</dd>
</dl>
</dd>
<dt id="streamcapture.Writer"><code class="flex name class">
<span>class <span class="ident">Writer</span></span>
<span>(</span><span>stream, count=None, lock_write=False)</span>
</code></dt>
<dd>
<div class="desc"><p><code><a title="streamcapture.Writer" href="#streamcapture.Writer">Writer</a></code> constructor.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Writer:
def __init__(self,stream,count = None,lock_write = False):
"""`Writer` constructor."""
(self.stream,self.lock_write) = (stream,lock_write)
if count is None:
(self.count,self.increment) = (0,1)
else:
(self.count,self.increment) = (count,0)
self.lock = threading.Lock()
self._write = self.locked_write if lock_write else stream.write
def write_from(self,data,cap):
self._write(data)
def writer_open(self):
with self.lock:
self.count += self.increment
def close(self):
"""When one is done using a `Writer`, one calls `Writer.close()`. This acquires `Writer.lock` so it is
thread-safe. Each time `Writer.close()` is called, `Writer.count` is decremented. When `Writer.count`
reaches `0`, `stream.close()` is called."""
with self.lock:
self.count -= 1
if self.count>0:
return
self.stream.close()
def locked_write(self,z):
with self.lock:
self.stream.write(z)</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="streamcapture.Writer.close"><code class="name flex">
<span>def <span class="ident">close</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>When one is done using a <code><a title="streamcapture.Writer" href="#streamcapture.Writer">Writer</a></code>, one calls <code><a title="streamcapture.Writer.close" href="#streamcapture.Writer.close">Writer.close()</a></code>. This acquires <code>Writer.lock</code> so it is
thread-safe. Each time <code><a title="streamcapture.Writer.close" href="#streamcapture.Writer.close">Writer.close()</a></code> is called, <code>Writer.count</code> is decremented. When <code>Writer.count</code>
reaches <code>0</code>, <code>stream.close()</code> is called.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def close(self):
"""When one is done using a `Writer`, one calls `Writer.close()`. This acquires `Writer.lock` so it is
thread-safe. Each time `Writer.close()` is called, `Writer.count` is decremented. When `Writer.count`
reaches `0`, `stream.close()` is called."""
with self.lock:
self.count -= 1
if self.count>0:
return
self.stream.close()</code></pre>
</details>
</dd>
<dt id="streamcapture.Writer.locked_write"><code class="name flex">
<span>def <span class="ident">locked_write</span></span>(<span>self, z)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def locked_write(self,z):
with self.lock:
self.stream.write(z)</code></pre>
</details>
</dd>
<dt id="streamcapture.Writer.write_from"><code class="name flex">
<span>def <span class="ident">write_from</span></span>(<span>self, data, cap)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def write_from(self,data,cap):
self._write(data)</code></pre>
</details>
</dd>
<dt id="streamcapture.Writer.writer_open"><code class="name flex">
<span>def <span class="ident">writer_open</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def writer_open(self):
with self.lock:
self.count += self.increment</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul>
<li><a href="#streamcapture-capture-the-outputs-of-python-streams-such-as-sysstdout-and-sysstderr">streamcapture: capture the outputs of Python streams, such as sys.stdout and sys.stderr</a><ul>
<li><a href="#author-sebastien-loisel">Author: Sébastien Loisel</a></li>
</ul>
</li>
<li><a href="#installation">Installation</a></li>
<li><a href="#example-usage">Example usage</a></li>
<li><a href="#documentation">Documentation</a></li>
</ul>
</div>
<ul id="index">
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="streamcapture.FDCapture" href="#streamcapture.FDCapture">FDCapture</a></code></h4>
<ul class="">
<li><code><a title="streamcapture.FDCapture.close" href="#streamcapture.FDCapture.close">close</a></code></li>
<li><code><a title="streamcapture.FDCapture.printer" href="#streamcapture.FDCapture.printer">printer</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="streamcapture.StreamCapture" href="#streamcapture.StreamCapture">StreamCapture</a></code></h4>
<ul class="">
<li><code><a title="streamcapture.StreamCapture.close" href="#streamcapture.StreamCapture.close">close</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="streamcapture.Writer" href="#streamcapture.Writer">Writer</a></code></h4>
<ul class="">
<li><code><a title="streamcapture.Writer.close" href="#streamcapture.Writer.close">close</a></code></li>
<li><code><a title="streamcapture.Writer.locked_write" href="#streamcapture.Writer.locked_write">locked_write</a></code></li>
<li><code><a title="streamcapture.Writer.write_from" href="#streamcapture.Writer.write_from">write_from</a></code></li>
<li><code><a title="streamcapture.Writer.writer_open" href="#streamcapture.Writer.writer_open">writer_open</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>