-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy patherror_handling.html
More file actions
834 lines (792 loc) · 74.8 KB
/
Copy patherror_handling.html
File metadata and controls
834 lines (792 loc) · 74.8 KB
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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Run Control File" href="xonshrc.html"><link rel="prev" title="Python" href="python.html">
<link rel="canonical" href="https://xon.sh/error_handling.html">
<link rel="prefetch" href="_static/xonsh_terminal_icon_256.png" as="image">
<link rel="shortcut icon" href="_static/magic_conch.ico"><!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
<title>Subprocess Error Handling - Xonsh 0.24.2 Documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=d27b64cb" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
<style>
body {
--color-code-background: #eeffcc;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style>
<script type="application/ld+json">{
"@context": "https://schema.org",
"@graph": [
{
"@type": "TechArticle",
"@id": "https://xon.sh/error_handling.html#techarticle",
"headline": "Subprocess Error Handling",
"url": "https://xon.sh/error_handling.html",
"isPartOf": {"@id": "https://xon.sh/#website"},
"about": {"@id": "https://xon.sh/#software"},
"inLanguage": "en",
"author": {"@id": "https://xon.sh/#org"},
"publisher": {"@id": "https://xon.sh/#org"}
},
{
"@type": "BreadcrumbList",
"itemListElement": [
{"@type": "ListItem", "position": 1, "name": "Home", "item": "https://xon.sh/"},{"@type": "ListItem", "position": 2, "name": "Contents", "item": "https://xon.sh/contents.html"}
,{"@type": "ListItem", "position": 3, "name": "Subprocess Error Handling", "item": "https://xon.sh/error_handling.html"}
]
}
]
}</script>
</head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</label>
</div>
<div class="header-center">
<a href="contents.html"><div class="brand">Xonsh 0.24.2 Documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="contents.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/xonsh_terminal_icon_256.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">Xonsh 0.24.2 Documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Xonsh Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="appimage.html">AppImage</a></li>
<li class="toctree-l1"><a class="reference internal" href="containers.html">Container</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="strings.html">Subprocess Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="subprocess.html">Subprocess</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Subprocess Error Handling</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/topics/xontrib">Extensions on Github</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/xonsh/xonsh/discussions">Ask question</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="xonshrc.html">Run Control File</a></li>
<li class="toctree-l1"><a class="reference internal" href="envvars.html">Environment Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="aliases.html">Built-in Aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts</a></li>
<li class="toctree-l1"><a class="reference internal" href="prompt.html">Prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Built-in Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="globbing.html">Globbing</a></li>
<li class="toctree-l1"><a class="reference internal" href="macros.html">Macros</a></li>
<li class="toctree-l1"><a class="reference internal" href="xonsh_session.html">Xonsh Session</a></li>
<li class="toctree-l1"><a class="reference internal" href="launch.html">Launch Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Cross-platform</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/xonsh/xonsh">Open technical issue</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="editors.html">Editor and IDE</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_virtual_environments.html">Virtual Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="xonsh_projects.html">Xonsh Projects</a></li>
<li class="toctree-l1"><a class="reference internal" href="callable_aliases.html">Callable Aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="events_tutorial.html">Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="env.html">Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="completers.html">Tab-Completion</a></li>
<li class="toctree-l1"><a class="reference internal" href="xontrib.html">Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="embedding.html">Embedding Xonsh</a></li>
<li class="toctree-l1"><a class="reference internal" href="debug.html">Debug</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">Xonsh API</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/xonsh/xontrib-template">Create an extension</a></li>
</ul>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="developer.html">Developer’s Guide</a><input aria-label="Toggle navigation of Developer’s Guide" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html">Xonsh Change Log</a></li>
<li class="toctree-l2"><a class="reference internal" href="talks_and_articles.html">Talks & Articles</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#see-also">See also</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="lib/index.html">Xonsh Library</a><input aria-label="Toggle navigation of Xonsh Library" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.parsers.lexer.html">xonsh.parsers.lexer</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.parser.html">xonsh.parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.parsers.ast.html">xonsh.parsers.ast</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.execer.html">xonsh.execer</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.imphooks.html">xonsh.imphooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.shell.html">xonsh.shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.built_ins.html">xonsh.built_ins</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.environ.html">xonsh.environ</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.aliases.html">xonsh.aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.dirstack.html">xonsh.dirstack</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.html">xonsh.procs</a><input aria-label="Toggle navigation of xonsh.procs" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.executables.html">xonsh.procs.executables</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.jobs.html">xonsh.procs.jobs</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.pipelines.html">xonsh.procs.pipelines</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.pipes.html">xonsh.procs.pipes</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.posix.html">xonsh.procs.posix</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.proxies.html">xonsh.procs.proxies</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.readers.html">xonsh.procs.readers</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.specs.html">xonsh.procs.specs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.lib.inspectors.html">xonsh.lib.inspectors</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.html">xonsh.history</a><input aria-label="Toggle navigation of xonsh.history" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.base.html">xonsh.history.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.diff_history.html">xonsh.history.diff_history</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.dummy.html">xonsh.history.dummy</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.json.html">xonsh.history.json</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.main.html">xonsh.history.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.sqlite.html">xonsh.history.sqlite</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completer.html">xonsh.completer</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.html">xonsh.completers</a><input aria-label="Toggle navigation of xonsh.completers" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.base.html">xonsh.completers.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.bash.html">xonsh.completers.bash</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.bash_completion.html">xonsh.completers.bash_completion</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.click.html">xonsh.completers.click</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.commands.html">xonsh.completers.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.completer.html">xonsh.completers.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.dirs.html">xonsh.completers.dirs</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.emoji.html">xonsh.completers.emoji</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.environment.html">xonsh.completers.environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.imports.html">xonsh.completers.imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.init.html">xonsh.completers.init</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.man.html">xonsh.completers.man</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.path.html">xonsh.completers.path</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.python.html">xonsh.completers.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.tools.html">xonsh.completers.tools</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.html">xonsh.prompt</a><input aria-label="Toggle navigation of xonsh.prompt" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.base.html">xonsh.prompt.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.cwd.html">xonsh.prompt.cwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.env.html">xonsh.prompt.env</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.gitstatus.html">xonsh.prompt.gitstatus</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.job.html">xonsh.prompt.job</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.times.html">xonsh.prompt.times</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.vc.html">xonsh.prompt.vc</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.html">xonsh.shells</a><input aria-label="Toggle navigation of xonsh.shells" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.base_shell.html">xonsh.shells.base_shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.dumb_shell.html">xonsh.shells.dumb_shell</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.html">xonsh.shells.ptk_shell</a><input aria-label="Toggle navigation of xonsh.shells.ptk_shell" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.completer.html">xonsh.shells.ptk_shell.completer</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.formatter.html">xonsh.shells.ptk_shell.formatter</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.history.html">xonsh.shells.ptk_shell.history</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.input_hook.html">xonsh.shells.ptk_shell.input_hook</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.key_bindings.html">xonsh.shells.ptk_shell.key_bindings</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.updator.html">xonsh.shells.ptk_shell.updator</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.readline_shell.html">xonsh.shells.readline_shell</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.base_shell.html">xonsh.shells.base_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.readline_shell.html">xonsh.shells.readline_shell</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.html">xonsh.shells.ptk_shell</a><input aria-label="Toggle navigation of xonsh.shells.ptk_shell" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.completer.html">xonsh.shells.ptk_shell.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.formatter.html">xonsh.shells.ptk_shell.formatter</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.history.html">xonsh.shells.ptk_shell.history</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.input_hook.html">xonsh.shells.ptk_shell.input_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.key_bindings.html">xonsh.shells.ptk_shell.key_bindings</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.updator.html">xonsh.shells.ptk_shell.updator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.lib.pretty.html">xonsh.lib.pretty</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.diff_history.html">xonsh.history.diff_history</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.html">xonsh.xoreutils</a><input aria-label="Toggle navigation of xonsh.xoreutils" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.cat.html">xonsh.xoreutils.cat</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.echo.html">xonsh.xoreutils.echo</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.pwd.html">xonsh.xoreutils.pwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.tee.html">xonsh.xoreutils.tee</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.tty.html">xonsh.xoreutils.tty</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.ulimit.html">xonsh.xoreutils.ulimit</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.umask.html">xonsh.xoreutils.umask</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.uname.html">xonsh.xoreutils.uname</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.uptime.html">xonsh.xoreutils.uptime</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.util.html">xonsh.xoreutils.util</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.which.html">xonsh.xoreutils.which</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.xcontext.html">xonsh.xoreutils.xcontext</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.yes.html">xonsh.xoreutils.yes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.events.html">xonsh.events</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.html">xonsh.lib</a><input aria-label="Toggle navigation of xonsh.lib" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.collections.html">xonsh.lib.collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.completion_quoting.html">xonsh.lib.completion_quoting</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.inspectors.html">xonsh.lib.inspectors</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.itertools.html">xonsh.lib.itertools</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.jsonutils.html">xonsh.lib.jsonutils</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyasd.html">xonsh.lib.lazyasd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyimps.html">xonsh.lib.lazyimps</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyjson.html">xonsh.lib.lazyjson</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.modules.html">xonsh.lib.modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.openpy.html">xonsh.lib.openpy</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.os.html">xonsh.lib.os</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.pretty.html">xonsh.lib.pretty</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.string.html">xonsh.lib.string</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.subprocess.html">xonsh.lib.subprocess</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.tools.html">xonsh.tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platform.html">xonsh.platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyjson.html">xonsh.lib.lazyjson</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyasd.html">xonsh.lib.lazyasd</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.openpy.html">xonsh.lib.openpy</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.foreign_shells.html">xonsh.foreign_shells</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.commands_cache.html">xonsh.commands_cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.tracer.html">xonsh.tracer</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.main.html">xonsh.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.color_tools.html">xonsh.color_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.pyghooks.html">xonsh.pyghooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.shells.dumb_shell.html">xonsh.shells.dumb_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.wizard.html">xonsh.wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.xonfig.html">xonsh.xonfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.xontribs.html">xonsh.xontribs</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.codecache.html">xonsh.codecache</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.contexts.html">xonsh.contexts</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.ansi_colors.html">xonsh.ansi_colors</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.style_tools.html">xonsh.style_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.cli_utils.html">xonsh.cli_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.timings.html">xonsh.timings</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.pygments_cache.html">xonsh.pygments_cache</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.html">xonsh.platforms</a><input aria-label="Toggle navigation of xonsh.platforms" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.macutils.html">xonsh.platforms.macutils</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.win_colors.html">xonsh.platforms.win_colors</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.winutils.html">xonsh.platforms.winutils</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.html">xonsh.webconfig</a><input aria-label="Toggle navigation of xonsh.webconfig" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.file_writes.html">xonsh.webconfig.file_writes</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.main.html">xonsh.webconfig.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.routes.html">xonsh.webconfig.routes</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.tags.html">xonsh.webconfig.tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.xonsh_data.html">xonsh.webconfig.xonsh_data</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.html">xompletions</a><input aria-label="Toggle navigation of xompletions" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.cd.html">xompletions.cd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.gh.html">xompletions.gh</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.git.html">xompletions.git</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.pip.html">xompletions.pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.python.html">xompletions.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.rmdir.html">xompletions.rmdir</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.sudo.html">xompletions.sudo</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/xontribs/xontrib.html">xontrib</a><input aria-label="Toggle navigation of xontrib" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xontribs/xontrib.coreutils.html">xontrib.coreutils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="history_backend.html">History Backend</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/blob/main/docs/error_handling.rst?plain=true" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div><div class="edit-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/edit/main/docs/error_handling.rst" rel="edit" title="Edit this page">
<svg><use href="#svg-pencil"></use></svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="subprocess-error-handling">
<span id="error-handling"></span><h1>Subprocess Error Handling<a class="headerlink" href="#subprocess-error-handling" title="Link to this heading">¶</a></h1>
<p>Xonsh treats shell commands as first-class code. When a command fails,
you usually want your script to <strong>stop</strong> instead of silently marching
past the failure — the way a Python exception would — but you also want
the flexibility of <code class="docutils literal notranslate"><span class="pre">&&</span></code>/<code class="docutils literal notranslate"><span class="pre">||</span></code> short-circuit logic that
the shell is built around.</p>
<p>This page walks through the rules xonsh uses to decide <em>when</em> a failing
subprocess raises a <code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code>, how those rules
interact with pipes, logical operators, captured forms and per-command
decorators, and how the interactive prompt displays (or hides) the
resulting exception.</p>
<section id="chains">
<h2>Chains<a class="headerlink" href="#chains" title="Link to this heading">¶</a></h2>
<p>To describe where exceptions are raised we use the word <strong>chain</strong> for a
grouping of subprocess commands that produces a single result:</p>
<ul class="simple">
<li><p><strong>single chain</strong> — one plain command: <code class="docutils literal notranslate"><span class="pre">ls</span> <span class="pre">file</span></code></p></li>
<li><p><strong>pipe chain</strong> — commands joined with <code class="docutils literal notranslate"><span class="pre">|</span></code>: <code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">1</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">1</span> <span class="pre">|</span> <span class="pre">head</span></code></p></li>
<li><p><strong>logical chain</strong> — commands joined with <code class="docutils literal notranslate"><span class="pre">&&</span></code>/<code class="docutils literal notranslate"><span class="pre">||</span></code>:
<code class="docutils literal notranslate"><span class="pre">ls</span> <span class="pre">file1</span> <span class="pre">||</span> <span class="pre">ls</span> <span class="pre">file2</span> <span class="pre">||</span> <span class="pre">echo</span> <span class="pre">gone</span></code></p></li>
</ul>
<p>Statements separated by <code class="docutils literal notranslate"><span class="pre">;</span></code> or newlines are <em>independent</em> chains.
For example, <code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">1</span> <span class="pre">&&</span> <span class="pre">echo</span> <span class="pre">2</span> <span class="pre">;</span> <span class="pre">echo</span> <span class="pre">3</span> <span class="pre">;</span> <span class="pre">echo</span> <span class="pre">1</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">1</span></code> contains
<strong>three</strong> chains.</p>
<p>Xonsh decides whether to raise <em>per chain</em>, not per individual command,
which is what gives <code class="docutils literal notranslate"><span class="pre">||</span></code>/<code class="docutils literal notranslate"><span class="pre">&&</span></code> their shell-like rescue semantics:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Chains example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">ls</span> <span class="o">/</span><span class="n">no</span> <span class="o">||</span> <span class="n">echo</span> <span class="n">rescued</span> <span class="c1"># one chain, rescued by ||</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go">rescued # no exception</span>
<span class="gp">@ </span><span class="n">echo</span> <span class="mi">1</span> <span class="o">&&</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span> <span class="o">&&</span> <span class="n">echo</span> <span class="n">never</span> <span class="c1"># one chain, ends on a failing ls</span>
<span class="go">1</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go"># CalledProcessError (the chain as a whole failed)</span>
<span class="gp">@ </span><span class="n">echo</span> <span class="n">a</span> <span class="p">;</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span> <span class="p">;</span> <span class="n">echo</span> <span class="n">b</span> <span class="c1"># three chains; second fails, third never runs</span>
<span class="go">a</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go"># CalledProcessError on the second chain</span>
</code></pre></div>
</div>
</section>
<section id="environment-variables">
<h2>Environment variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h2>
<p>Xonsh exposes three knobs for error handling. The first two control
<strong>whether</strong> a subprocess failure raises; the third controls <strong>display
of the exception</strong> at the interactive prompt.</p>
<section id="XONSH_SUBPROC_RAISE_ERROR___default_True">
<span id="xonsh-subproc-raise-error---default-true"></span><h3><code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_RAISE_ERROR</span></code> — default <code class="docutils literal notranslate"><span class="pre">True</span></code><a class="headerlink" href="#XONSH_SUBPROC_RAISE_ERROR___default_True" title="Link to this heading">¶</a></h3>
<p>Raises <code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code> when the <strong>final result of a
chain</strong> is a non-zero exit code. This is the rule that makes xonsh
scripts behave like Python: a failing command stops execution unless
you explicitly rescue it with <code class="docutils literal notranslate"><span class="pre">||</span></code> or <code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code>.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ls</span> <span class="pre">/no</span></code> → raises (single chain, failed)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ls</span> <span class="pre">/no</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">root</span></code> → raises (pipe chain, final stage failed)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ls</span> <span class="pre">/no</span> <span class="pre">||</span> <span class="pre">echo</span> <span class="pre">ok</span></code> → <strong>no</strong> raise (logical chain rescued by <code class="docutils literal notranslate"><span class="pre">||</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">1</span> <span class="pre">&&</span> <span class="pre">ls</span> <span class="pre">/no</span></code> → raises (chain ends on failing <code class="docutils literal notranslate"><span class="pre">ls</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">(echo</span> <span class="pre">1</span> <span class="pre">&&</span> <span class="pre">ls</span> <span class="pre">/etc)</span> <span class="pre">||</span> <span class="pre">echo</span> <span class="pre">fb</span></code> → no raise (outer <code class="docutils literal notranslate"><span class="pre">||</span></code> rescued
by a successful inner chain)</p></li>
</ul>
</section>
<section id="XONSH_SUBPROC_CMD_RAISE_ERROR___default_False">
<span id="xonsh-subproc-cmd-raise-error---default-false"></span><h3><code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_CMD_RAISE_ERROR</span></code> — default <code class="docutils literal notranslate"><span class="pre">False</span></code><a class="headerlink" href="#XONSH_SUBPROC_CMD_RAISE_ERROR___default_False" title="Link to this heading">¶</a></h3>
<p>Raises on <strong>every</strong> failing command regardless of chain context — any
non-zero exit is fatal. When <code class="docutils literal notranslate"><span class="pre">True</span></code> it short-circuits chain
semantics: <code class="docutils literal notranslate"><span class="pre">ls</span> <span class="pre">/no</span> <span class="pre">||</span> <span class="pre">echo</span> <span class="pre">fb</span></code> would raise on <code class="docutils literal notranslate"><span class="pre">ls</span></code>, the <code class="docutils literal notranslate"><span class="pre">||</span></code>
fallback never runs.</p>
<p>Reserved for scripts that really want “fail fast on anything”. The old
name <code class="docutils literal notranslate"><span class="pre">$RAISE_SUBPROC_ERROR</span></code> is kept as a deprecated alias that syncs
to <code class="docutils literal notranslate"><span class="pre">XONSH_SUBPROC_CMD_RAISE_ERROR</span></code>.</p>
</section>
<section id="XONSH_PROMPT_SHOW_SUBPROC_ERROR___default_False">
<span id="xonsh-prompt-show-subproc-error---default-false"></span><h3><code class="docutils literal notranslate"><span class="pre">$XONSH_PROMPT_SHOW_SUBPROC_ERROR</span></code> — default <code class="docutils literal notranslate"><span class="pre">False</span></code><a class="headerlink" href="#XONSH_PROMPT_SHOW_SUBPROC_ERROR___default_False" title="Link to this heading">¶</a></h3>
<p>This is a <strong>display</strong> flag — it does not change whether an exception
is raised, only whether the <strong>interactive prompt</strong> prints xonsh’s
<code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError:</span> <span class="pre">...</span></code> line after the command’s own
<code class="docutils literal notranslate"><span class="pre">stderr</span></code>. The command’s own <code class="docutils literal notranslate"><span class="pre">stderr</span></code> is always visible because
the subprocess writes it directly to the terminal.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code> <em>(default)</em> — interactive prompt stays quiet after a
failed command. You see the command’s <code class="docutils literal notranslate"><span class="pre">stderr</span></code>, the prompt
returns, and <code class="docutils literal notranslate"><span class="pre">$LAST_RETURN_CODE</span></code> reflects the failure.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code> — restores the historical behavior of printing
<code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError:</span> <span class="pre">Command</span> <span class="pre">'...'</span> <span class="pre">returned</span> <span class="pre">non-zero</span>
<span class="pre">exit</span> <span class="pre">status</span> <span class="pre">N.</span></code> under the command’s own output.</p></li>
</ul>
<p>Non-interactive scripts (<code class="docutils literal notranslate"><span class="pre">./script.xsh</span></code>, <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">-c</span></code>) are
<strong>unaffected</strong> — they always show the exception, because in script
mode you usually want to know which line blew up.</p>
<p>The per-command <code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> decorator <strong>always</strong> shows the
exception regardless of this flag — it is the explicit per-command
opt-in.</p>
</section>
</section>
<section id="captured-subprocess-is-the-only-exemption">
<h2>Captured subprocess <code class="docutils literal notranslate"><span class="pre">!()</span></code> is the only exemption<a class="headerlink" href="#captured-subprocess-is-the-only-exemption" title="Link to this heading">¶</a></h2>
<p>Every subprocess form raises on a non-zero return code by default —
bare commands, <code class="docutils literal notranslate"><span class="pre">![...]</span></code>, <code class="docutils literal notranslate"><span class="pre">$[...]</span></code>, <code class="docutils literal notranslate"><span class="pre">$(...)</span></code>, <code class="docutils literal notranslate"><span class="pre">@$(...)</span></code>. The
<strong>only</strong> exception is the full-capture form <code class="docutils literal notranslate"><span class="pre">!(...)</span></code>: it returns a
<code class="docutils literal notranslate"><span class="pre">CommandPipeline</span></code> object and xonsh leaves error handling entirely
up to you.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Captured subprocess !() is the only exemption example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">ls</span> <span class="n">nofile</span> <span class="c1"># exception</span>
<span class="gp">@ </span><span class="k">$</span><span class="p">(</span><span class="nb">ls</span> nofile<span class="p">)</span> <span class="c1"># exception</span>
<span class="gp">@ </span><span class="k">$</span><span class="p">[</span><span class="nb">ls</span> nofile<span class="p">]</span> <span class="c1"># exception</span>
<span class="gp">@ </span><span class="k">!</span><span class="p">[</span><span class="nb">ls</span> nofile<span class="p">]</span> <span class="c1"># exception</span>
<span class="gp">@ </span><span class="k">!</span><span class="p">(</span><span class="nb">ls</span> nofile<span class="p">)</span> <span class="c1"># no exception — returns a CommandPipeline</span>
</code></pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">!(...)</span></code> is designed to be tested directly, because
<code class="docutils literal notranslate"><span class="pre">CommandPipeline</span></code> is truthy when the command succeeded and falsy
when it failed:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Captured subprocess !() is the only exemption example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="k">if</span> <span class="k">!</span><span class="p">(</span><span class="nb">ls</span> nofile<span class="p">):</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="s2">"found"</span><span class="p">)</span>
<span class="gp"> </span><span class="k">else</span><span class="p">:</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="s2">"absent"</span><span class="p">)</span>
<span class="go">absent</span>
</code></pre></div>
</div>
<p>If you want a specific <code class="docutils literal notranslate"><span class="pre">!(...)</span></code> call to raise anyway, use the
<code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> decorator inside it — the decorator wins over the
<code class="docutils literal notranslate"><span class="pre">!()</span></code> exemption:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Captured subprocess !() is the only exemption example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="k">if</span> <span class="k">!</span><span class="p">(</span><span class="nb">@error_raise</span> ls nofile<span class="p">):</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="s2">"found"</span><span class="p">)</span>
<span class="go"># CalledProcessError — @error_raise overrides the !() exemption</span>
</code></pre></div>
</div>
</section>
<section id="per-command-decorators">
<h2>Per-command decorators<a class="headerlink" href="#per-command-decorators" title="Link to this heading">¶</a></h2>
<p>Two decorator aliases give you an escape hatch that is scoped to a
single command inside a larger chain.</p>
<section id="error-raise-always-raise">
<h3><code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> — always raise<a class="headerlink" href="#error-raise-always-raise" title="Link to this heading">¶</a></h3>
<p>Force <code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code> on this command, regardless of
<code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_RAISE_ERROR</span></code>, <code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_CMD_RAISE_ERROR</span></code>, or
whether the command sits inside a normally-rescuing chain:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@error_raise — always raise example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="nd">@error_raise</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span> <span class="o">||</span> <span class="n">echo</span> <span class="n">fb</span>
<span class="go"># CalledProcessError — @error_raise wins over ||</span>
<span class="gp">@ </span><span class="k">!</span><span class="p">(</span><span class="nb">@error_raise</span> ls /no<span class="p">)</span>
<span class="go"># CalledProcessError — @error_raise wins over !() exemption too</span>
</code></pre></div>
</div>
<p>It also <strong>always</strong> shows the exception at the interactive prompt,
overriding <code class="docutils literal notranslate"><span class="pre">$XONSH_PROMPT_SHOW_SUBPROC_ERROR</span> <span class="pre">=</span> <span class="pre">False</span></code>.</p>
</section>
<section id="error-ignore-never-raise">
<h3><code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code> — never raise<a class="headerlink" href="#error-ignore-never-raise" title="Link to this heading">¶</a></h3>
<p>The inverse — the command <em>never</em> raises, no matter the environment
settings or chain position:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@error_ignore — never raise example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="nd">@error_ignore</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go"># no exception</span>
<span class="gp">@ </span><span class="n">echo</span> <span class="mi">1</span> <span class="o">&&</span> <span class="nd">@error_ignore</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span> <span class="o">&&</span> <span class="n">echo</span> <span class="mi">2</span>
<span class="gp"> </span><span class="n">echo</span> <span class="mi">3</span>
<span class="go">1</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go">3</span>
<span class="go"># no exception; the `@error_ignore` also makes the chain</span>
<span class="go"># treat the failing ls as "don't raise on this final operand"</span>
</code></pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code> is especially handy when you want a command to
contribute to the chain’s return code but <strong>not</strong> its error behavior:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@error_ignore — never raise example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">echo</span> <span class="mi">1</span> <span class="o">|</span> <span class="nd">@error_ignore</span> <span class="n">grep</span> <span class="n">pattern</span> <span class="o">|</span> <span class="n">wc</span> <span class="o">-</span><span class="n">l</span>
<span class="go">0</span>
<span class="go"># grep returns 1 (no match), @error_ignore keeps the pipe quiet,</span>
<span class="go"># wc happily prints 0</span>
</code></pre></div>
</div>
</section>
</section>
<section id="catching-the-exception">
<h2>Catching the exception<a class="headerlink" href="#catching-the-exception" title="Link to this heading">¶</a></h2>
<p>The raised exception is a plain <code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code>, so
the usual Python idioms work:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Catching the exception example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
<span class="gp">@ </span><span class="k">try</span><span class="p">:</span>
<span class="gp"> </span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span>
<span class="gp"> </span><span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="s2">"rc ="</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="s2">"cmd ="</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">cmd</span><span class="p">)</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go">rc = 2</span>
<span class="go">cmd = ['ls', '/no']</span>
</code></pre></div>
</div>
<p>For scoped overrides, <code class="docutils literal notranslate"><span class="pre">env.swap</span></code> is often cleaner than catching:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Catching the exception example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="k">with</span> <span class="o">@.</span><span class="n">env</span><span class="o">.</span><span class="n">swap</span><span class="p">(</span><span class="n">XONSH_SUBPROC_RAISE_ERROR</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="gp"> </span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go"># no exception, even though the default is True</span>
</code></pre></div>
</div>
<p>For <strong>captured iteration</strong> there is also <code class="docutils literal notranslate"><span class="pre">CommandPipeline.itercheck()</span></code>
which raises <code class="docutils literal notranslate"><span class="pre">XonshCalledProcessError</span></code> (a subclass of
<code class="docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code> that additionally carries
<code class="docutils literal notranslate"><span class="pre">.completed_command</span></code> and <code class="docutils literal notranslate"><span class="pre">.stderr</span></code>):</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Catching the exception example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="k">try</span><span class="p">:</span>
<span class="gp"> </span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="k">!</span><span class="p">(</span><span class="nb">grep</span> -R TODO src/<span class="p">)</span><span class="o">.</span><span class="n">itercheck</span><span class="p">():</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="gp"> </span><span class="k">except</span> <span class="n">XonshCalledProcessError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="gp"> </span> <span class="nb">print</span><span class="p">(</span><span class="s2">"grep failed with rc"</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">returncode</span><span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="interactive-prompt-behavior-in-detail">
<h2>Interactive prompt behavior in detail<a class="headerlink" href="#interactive-prompt-behavior-in-detail" title="Link to this heading">¶</a></h2>
<p>With the default <code class="docutils literal notranslate"><span class="pre">$XONSH_PROMPT_SHOW_SUBPROC_ERROR</span> <span class="pre">=</span> <span class="pre">False</span></code>:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Interactive prompt behavior in detail example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">ls</span> <span class="o">/</span><span class="n">no</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="gp">@ </span><span class="n">echo</span> <span class="nv">$LAST_RETURN_CODE</span>
<span class="go">2</span>
<span class="gp">@ </span><span class="n">echo</span> <span class="n">hi</span> <span class="o">&&</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span> <span class="o">&&</span> <span class="n">echo</span> <span class="n">bye</span>
<span class="go">hi</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go">@</span>
</code></pre></div>
</div>
<p>With <code class="docutils literal notranslate"><span class="pre">$XONSH_PROMPT_SHOW_SUBPROC_ERROR</span> <span class="pre">=</span> <span class="pre">True</span></code>:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Interactive prompt behavior in detail example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="nv">$XONSH_PROMPT_SHOW_SUBPROC_ERROR</span> <span class="o">=</span> <span class="kc">True</span>
<span class="gp">@ </span><span class="n">ls</span> <span class="o">/</span><span class="n">no</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go">subprocess.CalledProcessError: Command '['ls', '/no']' returned non-zero exit status 2.</span>
<span class="go">@</span>
</code></pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> always shows:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="Interactive prompt behavior in detail example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="nd">@error_raise</span> <span class="n">ls</span> <span class="o">/</span><span class="n">no</span>
<span class="go">ls: cannot access '/no': No such file or directory</span>
<span class="go">subprocess.CalledProcessError: Command '['@error_raise', 'ls', '/no']' returned non-zero exit status 2.</span>
</code></pre></div>
</div>
</section>
<section id="see-also">
<h2>See also<a class="headerlink" href="#see-also" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="tutorial.html#tutorial"><span class="std std-ref">Tutorial</span></a> — the scripting section discusses
<code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_RAISE_ERROR</span></code> in the context of writing robust xonsh
scripts.</p></li>
<li><p><a class="reference internal" href="aliases.html#aliases"><span class="std std-ref">Built-in Aliases</span></a> — for <code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> / <code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code> and other
decorator aliases.</p></li>
</ul>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="xonshrc.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Run Control File</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="python.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Python</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © Xonsh Contributors / https://github.com/xonsh/xonsh/graphs/contributors?all=1
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Subprocess Error Handling</a><ul>
<li><a class="reference internal" href="#chains">Chains</a></li>
<li><a class="reference internal" href="#environment-variables">Environment variables</a><ul>
<li><a class="reference internal" href="#XONSH_SUBPROC_RAISE_ERROR___default_True"><code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_RAISE_ERROR</span></code> — default <code class="docutils literal notranslate"><span class="pre">True</span></code></a></li>
<li><a class="reference internal" href="#XONSH_SUBPROC_CMD_RAISE_ERROR___default_False"><code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_CMD_RAISE_ERROR</span></code> — default <code class="docutils literal notranslate"><span class="pre">False</span></code></a></li>
<li><a class="reference internal" href="#XONSH_PROMPT_SHOW_SUBPROC_ERROR___default_False"><code class="docutils literal notranslate"><span class="pre">$XONSH_PROMPT_SHOW_SUBPROC_ERROR</span></code> — default <code class="docutils literal notranslate"><span class="pre">False</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#captured-subprocess-is-the-only-exemption">Captured subprocess <code class="docutils literal notranslate"><span class="pre">!()</span></code> is the only exemption</a></li>
<li><a class="reference internal" href="#per-command-decorators">Per-command decorators</a><ul>
<li><a class="reference internal" href="#error-raise-always-raise"><code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> — always raise</a></li>
<li><a class="reference internal" href="#error-ignore-never-raise"><code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code> — never raise</a></li>
</ul>
</li>
<li><a class="reference internal" href="#catching-the-exception">Catching the exception</a></li>
<li><a class="reference internal" href="#interactive-prompt-behavior-in-detail">Interactive prompt behavior in detail</a></li>
<li><a class="reference internal" href="#see-also">See also</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=3a88403b"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
<script src="_static/runthis-client.min.js?v=ad2a40d9"></script>
</body>
</html>