-
Notifications
You must be signed in to change notification settings - Fork 8
/
events.html
784 lines (749 loc) · 69.6 KB
/
events.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
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
<!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="Platform-specific tips and tricks" href="platform-issues.html" /><link rel="prev" title="Built-in Aliases" href="aliases.html" />
<link rel="shortcut icon" href="_static/magic_conch.ico"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
<title>Core Events - xonsh 0.16.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=c8b63bf6" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<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></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.5" 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.5" 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-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="contents.html"><div class="brand">xonsh 0.16.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></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">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</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/ascii_conch_part_transparent_tight.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">xonsh 0.16.0 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="packages.html">Package Manager</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">Docker container</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_hist.html">Tutorial: History</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_macros.html">Tutorial: Macros</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_xontrib.html">Tutorial: Extensions (Xontribs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_xonsh_projects.html">Tutorial: Xonsh Projects</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_events.html">Tutorial: Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_completers.html">Tutorial: Programmable Tab-Completion</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_history_backend.html">Tutorial: Write Your Own History Backend</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_subproc_strings.html">Tutorial: Subprocess Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_ptk.html">Tutorial: <code class="docutils literal notranslate"><span class="pre">prompt_toolkit</span></code> custom keybindings</a></li>
<li class="toctree-l1"><a class="reference internal" href="bash_to_xsh.html">Bash to Xonsh Translation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="editors.html">Editor and IDE Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="subproc_types.html">Subprocess Types Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_virtual_environments.html">Python Virtual Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts</a></li>
</ul>
<ul class="current">
<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="customization.html">Updating and customizing xonsh</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 current current-page"><a class="current reference internal" href="#">Core Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="platform-issues.html">Platform-specific tips and tricks</a></li>
</ul>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="api/index.html">Xonsh API</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Xonsh API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.lexer.html">xonsh.lexer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.parser.html">xonsh.parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.ast.html">xonsh.ast</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.execer.html">xonsh.execer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.imphooks.html">xonsh.imphooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.built_ins.html">xonsh.built_ins</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.environ.html">xonsh.environ</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.aliases.html">xonsh.aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.dirstack.html">xonsh.dirstack</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.jobs.html">xonsh.jobs</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.html">xonsh.procs</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of xonsh.procs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.pipelines.html">xonsh.procs.pipelines</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.posix.html">xonsh.procs.posix</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.proxies.html">xonsh.procs.proxies</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.readers.html">xonsh.procs.readers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.specs.html">xonsh.procs.specs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.inspectors.html">xonsh.inspectors</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.html">xonsh.history</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of xonsh.history</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.base.html">xonsh.history.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.dummy.html">xonsh.history.dummy</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.json.html">xonsh.history.json</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.main.html">xonsh.history.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.sqlite.html">xonsh.history.sqlite</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completer.html">xonsh.completer</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.html">xonsh.completers</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of xonsh.completers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.base.html">xonsh.completers.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.bash.html">xonsh.completers.bash</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.bash_completion.html">xonsh.completers.bash_completion</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.commands.html">xonsh.completers.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.completer.html">xonsh.completers.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.dirs.html">xonsh.completers.dirs</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.environment.html">xonsh.completers.environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.imports.html">xonsh.completers.imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.init.html">xonsh.completers.init</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.man.html">xonsh.completers.man</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.path.html">xonsh.completers.path</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.python.html">xonsh.completers.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.tools.html">xonsh.completers.tools</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.html">xonsh.prompt</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of xonsh.prompt</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.base.html">xonsh.prompt.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.cwd.html">xonsh.prompt.cwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.env.html">xonsh.prompt.env</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.gitstatus.html">xonsh.prompt.gitstatus</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.job.html">xonsh.prompt.job</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.times.html">xonsh.prompt.times</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.vc.html">xonsh.prompt.vc</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shell.html">xonsh.shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.base_shell.html">xonsh.base_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.readline_shell.html">xonsh.readline_shell</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.html">xonsh.ptk_shell</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of xonsh.ptk_shell</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.completer.html">xonsh.ptk_shell.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.formatter.html">xonsh.ptk_shell.formatter</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.history.html">xonsh.ptk_shell.history</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.key_bindings.html">xonsh.ptk_shell.key_bindings</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.shell.html">xonsh.ptk_shell.shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.updator.html">xonsh.ptk_shell.updator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.pretty.html">xonsh.pretty</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.diff_history.html">xonsh.diff_history</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.html">xonsh.xoreutils</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of xonsh.xoreutils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.cat.html">xonsh.xoreutils.cat</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.echo.html">xonsh.xoreutils.echo</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.pwd.html">xonsh.xoreutils.pwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.tee.html">xonsh.xoreutils.tee</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.tty.html">xonsh.xoreutils.tty</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.ulimit.html">xonsh.xoreutils.ulimit</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.umask.html">xonsh.xoreutils.umask</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.uname.html">xonsh.xoreutils.uname</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.uptime.html">xonsh.xoreutils.uptime</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.util.html">xonsh.xoreutils.util</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.which.html">xonsh.xoreutils.which</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.yes.html">xonsh.xoreutils.yes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.events.html">xonsh.events</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.html">xonsh.lib</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of xonsh.lib</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.collections.html">xonsh.lib.collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.itertools.html">xonsh.lib.itertools</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.modules.html">xonsh.lib.modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.os.html">xonsh.lib.os</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.subprocess.html">xonsh.lib.subprocess</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.tools.html">xonsh.tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.platform.html">xonsh.platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.jsonutils.html">xonsh.jsonutils</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lazyjson.html">xonsh.lazyjson</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lazyasd.html">xonsh.lazyasd</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.openpy.html">xonsh.openpy</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.foreign_shells.html">xonsh.foreign_shells</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.commands_cache.html">xonsh.commands_cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.tracer.html">xonsh.tracer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.main.html">xonsh.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.color_tools.html">xonsh.color_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.pyghooks.html">xonsh.pyghooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.dumb_shell.html">xonsh.dumb_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.wizard.html">xonsh.wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.xonfig.html">xonsh.xonfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.xontribs.html">xonsh.xontribs</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.codecache.html">xonsh.codecache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.contexts.html">xonsh.contexts</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/xontribs/xontrib.html">xontrib</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of xontrib</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/xontribs/xontrib.coreutils.html">xontrib.coreutils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced_events.html">Advanced Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="devguide.html">Developer’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Xonsh Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">Wishlist & To-Dos</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="edit-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/edit/main/docs/events.rst" title="Edit this page">
<svg aria-hidden="true" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<path d="M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" />
<line x1="13.5" y1="6.5" x2="17.5" y2="10.5" />
</svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></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">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="core-events">
<h1>Core Events<a class="headerlink" href="#core-events" title="Link to this heading">¶</a></h1>
<p>The following events are defined by xonsh itself. For more information about events,
see <a class="reference external" href="tutorial_events.html">the events tutorial</a>.</p>
<div class="table-wrapper docutils container">
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#on-chdir"><span class="std std-ref">on_chdir</span></a></p></td>
<td><p><a class="reference internal" href="#on-command-not-found"><span class="std std-ref">on_command_not_found</span></a></p></td>
<td><p><a class="reference internal" href="#on-envvar-change"><span class="std std-ref">on_envvar_change</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#on-envvar-new"><span class="std std-ref">on_envvar_new</span></a></p></td>
<td><p><a class="reference internal" href="#on-exit"><span class="std std-ref">on_exit</span></a></p></td>
<td><p><a class="reference internal" href="#on-import-post-create-module"><span class="std std-ref">on_import_post_create_module</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#on-import-post-exec-module"><span class="std std-ref">on_import_post_exec_module</span></a></p></td>
<td><p><a class="reference internal" href="#on-import-post-find-spec"><span class="std std-ref">on_import_post_find_spec</span></a></p></td>
<td><p><a class="reference internal" href="#on-import-pre-create-module"><span class="std std-ref">on_import_pre_create_module</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#on-import-pre-exec-module"><span class="std std-ref">on_import_pre_exec_module</span></a></p></td>
<td><p><a class="reference internal" href="#on-import-pre-find-spec"><span class="std std-ref">on_import_pre_find_spec</span></a></p></td>
<td><p><a class="reference internal" href="#on-lscolors-change"><span class="std std-ref">on_lscolors_change</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#on-post-cmdloop"><span class="std std-ref">on_post_cmdloop</span></a></p></td>
<td><p><a class="reference internal" href="#on-post-init"><span class="std std-ref">on_post_init</span></a></p></td>
<td><p><a class="reference internal" href="#on-post-prompt"><span class="std std-ref">on_post_prompt</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#on-post-rc"><span class="std std-ref">on_post_rc</span></a></p></td>
<td><p><a class="reference internal" href="#on-postcommand"><span class="std std-ref">on_postcommand</span></a></p></td>
<td><p><a class="reference internal" href="#on-pre-cmdloop"><span class="std std-ref">on_pre_cmdloop</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#on-pre-prompt"><span class="std std-ref">on_pre_prompt</span></a></p></td>
<td><p><a class="reference internal" href="#on-pre-prompt-format"><span class="std std-ref">on_pre_prompt_format</span></a></p></td>
<td><p><a class="reference internal" href="#on-pre-rc"><span class="std std-ref">on_pre_rc</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#on-pre-spec-run-ls"><span class="std std-ref">on_pre_spec_run_ls</span></a></p></td>
<td><p><a class="reference internal" href="#on-precommand"><span class="std std-ref">on_precommand</span></a></p></td>
<td><p><a class="reference internal" href="#on-ptk-create"><span class="std std-ref">on_ptk_create</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#on-transform-command"><span class="std std-ref">on_transform_command</span></a></p></td>
<td><p><a class="reference internal" href="#on-xonfig-info-requested"><span class="std std-ref">on_xonfig_info_requested</span></a></p></td>
<td><p><a class="reference internal" href="#on-xontribs-loaded"><span class="std std-ref">on_xontribs_loaded</span></a></p></td>
</tr>
</tbody>
</table>
</div>
<section id="listing">
<h2>Listing<a class="headerlink" href="#listing" title="Link to this heading">¶</a></h2>
<section id="on-chdir-olddir-str-newdir-str-none">
<span id="on-chdir"></span><h3><code class="docutils literal notranslate"><span class="pre">on_chdir(olddir:</span> <span class="pre">str,</span> <span class="pre">newdir:</span> <span class="pre">str)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-chdir-olddir-str-newdir-str-none" title="Link to this heading">¶</a></h3>
<p>Fires when the current directory is changed for any reason.</p>
<hr class="docutils" />
</section>
<section id="on-command-not-found-cmd-list-str-none">
<span id="on-command-not-found"></span><h3><code class="docutils literal notranslate"><span class="pre">on_command_not_found(cmd:</span> <span class="pre">list[str])</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-command-not-found-cmd-list-str-none" title="Link to this heading">¶</a></h3>
<p>Fires if a command is not found (only in interactive sessions).</p>
<p>Parameters:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">cmd</span></code>: The command that was attempted</p></li>
</ul>
<hr class="docutils" />
</section>
<section id="on-envvar-change-name-str-oldvalue-any-newvalue-any-none">
<span id="on-envvar-change"></span><h3><code class="docutils literal notranslate"><span class="pre">on_envvar_change(name:</span> <span class="pre">str,</span> <span class="pre">oldvalue:</span> <span class="pre">Any,</span> <span class="pre">newvalue:</span> <span class="pre">Any)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-envvar-change-name-str-oldvalue-any-newvalue-any-none" title="Link to this heading">¶</a></h3>
<p>Fires after an environment variable is changed.
Note: Setting envvars inside the handler might
cause a recursion until the limit.</p>
<hr class="docutils" />
</section>
<section id="on-envvar-new-name-str-value-any-none">
<span id="on-envvar-new"></span><h3><code class="docutils literal notranslate"><span class="pre">on_envvar_new(name:</span> <span class="pre">str,</span> <span class="pre">value:</span> <span class="pre">Any)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-envvar-new-name-str-value-any-none" title="Link to this heading">¶</a></h3>
<p>Fires after a new environment variable is created.
Note: Setting envvars inside the handler might
cause a recursion until the limit.</p>
<hr class="docutils" />
</section>
<section id="on-exit-none">
<span id="on-exit"></span><h3><code class="docutils literal notranslate"><span class="pre">on_exit()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-exit-none" title="Link to this heading">¶</a></h3>
<p>Fired after all commands have been executed, before tear-down occurs.</p>
<p>NOTE: All the caveats of the <code class="docutils literal notranslate"><span class="pre">atexit</span></code> module also apply to this event.</p>
<hr class="docutils" />
</section>
<section id="on-import-post-create-module-module-module-spec-modulespec-none">
<span id="on-import-post-create-module"></span><h3><code class="docutils literal notranslate"><span class="pre">on_import_post_create_module(module:</span> <span class="pre">Module,</span> <span class="pre">spec:</span> <span class="pre">ModuleSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-import-post-create-module-module-module-spec-modulespec-none" title="Link to this heading">¶</a></h3>
<p>Fires after a module is created by its loader but before the loader returns it.
The parameters here are the module object itself and the spec object.
See importlib for more details.</p>
<hr class="docutils" />
</section>
<section id="on-import-post-exec-module">
<span id="id1"></span><h3><code class="docutils literal notranslate"><span class="pre">on_import_post_exec_module</span></code><a class="headerlink" href="#on-import-post-exec-module" title="Link to this heading">¶</a></h3>
<p>on_import_post_create_module(module: Module) -> None</p>
<p>Fires after a module is executed by its loader but before the loader returns it.
The only parameter is the module itself. See importlib for more details.</p>
<hr class="docutils" />
</section>
<section id="on-import-post-find-spec-spec-fullname-path-target-none">
<span id="on-import-post-find-spec"></span><h3><code class="docutils literal notranslate"><span class="pre">on_import_post_find_spec(spec,</span> <span class="pre">fullname,</span> <span class="pre">path,</span> <span class="pre">target)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-import-post-find-spec-spec-fullname-path-target-none" title="Link to this heading">¶</a></h3>
<p>Fires after all import find_spec() calls have been executed. The parameters
here the spec and the arguments importlib.abc.MetaPathFinder.find_spec(). Namely,</p>
<dl class="field-list simple">
<dt class="field-odd"><code class="docutils literal notranslate"><span class="pre">spec</span></code><span class="colon">:</span></dt>
<dd class="field-odd"><p>A ModuleSpec object if the spec was found, or None if it was not.</p>
</dd>
<dt class="field-even"><code class="docutils literal notranslate"><span class="pre">fullname</span></code><span class="colon">:</span></dt>
<dd class="field-even"><p>The full name of the module to import.</p>
</dd>
<dt class="field-odd"><code class="docutils literal notranslate"><span class="pre">path</span></code><span class="colon">:</span></dt>
<dd class="field-odd"><p>None if a top-level import, otherwise the <code class="docutils literal notranslate"><span class="pre">__path__</span></code> of the parent
package.</p>
</dd>
<dt class="field-even"><code class="docutils literal notranslate"><span class="pre">target</span></code><span class="colon">:</span></dt>
<dd class="field-even"><p>Target module used to make a better guess about the package spec.</p>
</dd>
</dl>
<hr class="docutils" />
</section>
<section id="on-import-pre-create-module-spec-modulespec-none">
<span id="on-import-pre-create-module"></span><h3><code class="docutils literal notranslate"><span class="pre">on_import_pre_create_module(spec:</span> <span class="pre">ModuleSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-import-pre-create-module-spec-modulespec-none" title="Link to this heading">¶</a></h3>
<p>Fires right before a module is created by its loader. The only parameter
is the spec object. See importlib for more details.</p>
<hr class="docutils" />
</section>
<section id="on-import-pre-exec-module-module-module-none">
<span id="on-import-pre-exec-module"></span><h3><code class="docutils literal notranslate"><span class="pre">on_import_pre_exec_module(module:</span> <span class="pre">Module)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-import-pre-exec-module-module-module-none" title="Link to this heading">¶</a></h3>
<p>Fires right before a module is executed by its loader. The only parameter
is the module itself. See importlib for more details.</p>
<hr class="docutils" />
</section>
<section id="on-import-pre-find-spec-fullname-str-path-str-target-module-or-none-none">
<span id="on-import-pre-find-spec"></span><h3><code class="docutils literal notranslate"><span class="pre">on_import_pre_find_spec(fullname:</span> <span class="pre">str,</span> <span class="pre">path:</span> <span class="pre">str,</span> <span class="pre">target:</span> <span class="pre">module</span> <span class="pre">or</span> <span class="pre">None)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-import-pre-find-spec-fullname-str-path-str-target-module-or-none-none" title="Link to this heading">¶</a></h3>
<p>Fires before any import find_spec() calls have been executed. The parameters
here are the same as importlib.abc.MetaPathFinder.find_spec(). Namely,</p>
<dl class="field-list simple">
<dt class="field-odd"><code class="docutils literal notranslate"><span class="pre">fullname</span></code><span class="colon">:</span></dt>
<dd class="field-odd"><p>The full name of the module to import.</p>
</dd>
<dt class="field-even"><code class="docutils literal notranslate"><span class="pre">path</span></code><span class="colon">:</span></dt>
<dd class="field-even"><p>None if a top-level import, otherwise the <code class="docutils literal notranslate"><span class="pre">__path__</span></code> of the parent
package.</p>
</dd>
<dt class="field-odd"><code class="docutils literal notranslate"><span class="pre">target</span></code><span class="colon">:</span></dt>
<dd class="field-odd"><p>Target module used to make a better guess about the package spec.</p>
</dd>
</dl>
<hr class="docutils" />
</section>
<section id="on-lscolors-change-key-str-oldvalue-any-newvalue-any-none">
<span id="on-lscolors-change"></span><h3><code class="docutils literal notranslate"><span class="pre">on_lscolors_change(key:</span> <span class="pre">str,</span> <span class="pre">oldvalue:</span> <span class="pre">Any,</span> <span class="pre">newvalue:</span> <span class="pre">Any)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-lscolors-change-key-str-oldvalue-any-newvalue-any-none" title="Link to this heading">¶</a></h3>
<p>Fires after a value in LS_COLORS changes, when a new key is added (oldvalue is None)
or when an existing key is deleted (newvalue is None).
LS_COLORS values must be (ANSI color) strings, None is unambiguous.
Does not fire when the whole environment variable changes (see on_envvar_change).
Does not fire for each value when LS_COLORS is first instantiated.
Normal usage is to arm the event handler, then read (not modify) all existing values.</p>
<hr class="docutils" />
</section>
<section id="on-post-cmdloop-none">
<span id="on-post-cmdloop"></span><h3><code class="docutils literal notranslate"><span class="pre">on_post_cmdloop()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-post-cmdloop-none" title="Link to this heading">¶</a></h3>
<p>Fired just after the command loop finishes, if it is.</p>
<p>NOTE: All the caveats of the <code class="docutils literal notranslate"><span class="pre">atexit</span></code> module also apply to this event.</p>
<hr class="docutils" />
</section>
<section id="on-post-init-none">
<span id="on-post-init"></span><h3><code class="docutils literal notranslate"><span class="pre">on_post_init()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-post-init-none" title="Link to this heading">¶</a></h3>
<p>Fired after all initialization is finished and we’re ready to do work.</p>
<p>NOTE: This is fired before the wizard is automatically started.</p>
<hr class="docutils" />
</section>
<section id="on-post-prompt-none">
<span id="on-post-prompt"></span><h3><code class="docutils literal notranslate"><span class="pre">on_post_prompt()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-post-prompt-none" title="Link to this heading">¶</a></h3>
<p>Fires just after the prompt returns</p>
<hr class="docutils" />
</section>
<section id="on-post-rc-none">
<span id="on-post-rc"></span><h3><code class="docutils literal notranslate"><span class="pre">on_post_rc()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-post-rc-none" title="Link to this heading">¶</a></h3>
<p>Fired just after rc files are loaded, if they are.</p>
<hr class="docutils" />
</section>
<section id="on-postcommand-cmd-str-rtn-int-out-str-or-none-ts-list-none">
<span id="on-postcommand"></span><h3><code class="docutils literal notranslate"><span class="pre">on_postcommand(cmd:</span> <span class="pre">str,</span> <span class="pre">rtn:</span> <span class="pre">int,</span> <span class="pre">out:</span> <span class="pre">str</span> <span class="pre">or</span> <span class="pre">None,</span> <span class="pre">ts:</span> <span class="pre">list)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-postcommand-cmd-str-rtn-int-out-str-or-none-ts-list-none" title="Link to this heading">¶</a></h3>
<p>Fires just after a command is executed. The arguments are the same as history.</p>
<p>Parameters:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">cmd</span></code>: The command that was executed (after transformation)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">rtn</span></code>: The result of the command executed (<code class="docutils literal notranslate"><span class="pre">0</span></code> for success)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">out</span></code>: If xonsh stores command output, this is the output</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ts</span></code>: Timestamps, in the order of <code class="docutils literal notranslate"><span class="pre">[starting,</span> <span class="pre">ending]</span></code></p></li>
</ul>
<hr class="docutils" />
</section>
<section id="on-pre-cmdloop-none">
<span id="on-pre-cmdloop"></span><h3><code class="docutils literal notranslate"><span class="pre">on_pre_cmdloop()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-cmdloop-none" title="Link to this heading">¶</a></h3>
<p>Fired just before the command loop is started, if it is.</p>
<hr class="docutils" />
</section>
<section id="on-pre-prompt-none">
<span id="on-pre-prompt"></span><h3><code class="docutils literal notranslate"><span class="pre">on_pre_prompt()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-prompt-none" title="Link to this heading">¶</a></h3>
<p>Fires just before showing the prompt</p>
<hr class="docutils" />
</section>
<section id="on-pre-prompt-format-none">
<span id="on-pre-prompt-format"></span><h3><code class="docutils literal notranslate"><span class="pre">on_pre_prompt_format()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-prompt-format-none" title="Link to this heading">¶</a></h3>
<p>Fires before the prompt will be formatted</p>
<hr class="docutils" />
</section>
<section id="on-pre-rc-none">
<span id="on-pre-rc"></span><h3><code class="docutils literal notranslate"><span class="pre">on_pre_rc()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-rc-none" title="Link to this heading">¶</a></h3>
<p>Fired just before rc files are loaded, if they are.</p>
<hr class="docutils" />
</section>
<section id="on-pre-spec-run-ls-spec-xonsh-built-ins-subprocspec-none">
<span id="on-pre-spec-run-ls"></span><h3><code class="docutils literal notranslate"><span class="pre">on_pre_spec_run_ls(spec:</span> <span class="pre">xonsh.built_ins.SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-spec-run-ls-spec-xonsh-built-ins-subprocspec-none" title="Link to this heading">¶</a></h3>
<p>Fires right before a SubprocSpec.run() is called for the ls
command.</p>
<hr class="docutils" />
</section>
<section id="on-precommand-cmd-str-none">
<span id="on-precommand"></span><h3><code class="docutils literal notranslate"><span class="pre">on_precommand(cmd:</span> <span class="pre">str)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-precommand-cmd-str-none" title="Link to this heading">¶</a></h3>
<p>Fires just before a command is executed.</p>
<hr class="docutils" />
</section>
<section id="on-ptk-create-prompter-promptsession-history-prompttoolkithistory-completer-prompttoolkitcompleter-bindings-keybindings">
<span id="on-ptk-create"></span><h3><code class="docutils literal notranslate"><span class="pre">on_ptk_create(prompter:</span> <span class="pre">PromptSession,</span> <span class="pre">history:</span> <span class="pre">PromptToolkitHistory,</span> <span class="pre">completer:</span> <span class="pre">PromptToolkitCompleter,</span> <span class="pre">bindings:</span> <span class="pre">KeyBindings)</span> <span class="pre">-></span></code><a class="headerlink" href="#on-ptk-create-prompter-promptsession-history-prompttoolkithistory-completer-prompttoolkitcompleter-bindings-keybindings" title="Link to this heading">¶</a></h3>
<p>Fired after prompt toolkit has been initialized</p>
<hr class="docutils" />
</section>
<section id="on-transform-command-cmd-str-str">
<span id="on-transform-command"></span><h3><code class="docutils literal notranslate"><span class="pre">on_transform_command(cmd:</span> <span class="pre">str)</span> <span class="pre">-></span> <span class="pre">str</span></code><a class="headerlink" href="#on-transform-command-cmd-str-str" title="Link to this heading">¶</a></h3>
<p>Fired to request xontribs to transform a command line. Return the transformed
command, or the same command if no transformation occurs. Only done for
interactive sessions.</p>
<p>This may be fired multiple times per command, with other transformers input or
output, so design any handlers for this carefully.</p>
<hr class="docutils" />
</section>
<section id="on-xonfig-info-requested-list-tuple-str-str">
<span id="on-xonfig-info-requested"></span><h3><code class="docutils literal notranslate"><span class="pre">on_xonfig_info_requested()</span> <span class="pre">-></span> <span class="pre">list[tuple[str,</span> <span class="pre">str]]</span></code><a class="headerlink" href="#on-xonfig-info-requested-list-tuple-str-str" title="Link to this heading">¶</a></h3>
<p>Register a callable that will return extra info when <code class="docutils literal notranslate"><span class="pre">xonfig</span> <span class="pre">info</span></code> is called.</p>
<hr class="docutils" />
</section>
<section id="on-xontribs-loaded-none">
<span id="on-xontribs-loaded"></span><h3><code class="docutils literal notranslate"><span class="pre">on_xontribs_loaded()</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-xontribs-loaded-none" title="Link to this heading">¶</a></h3>
<p>Fired after external xontribs with <code class="docutils literal notranslate"><span class="pre">entrypoints</span> <span class="pre">defined</span></code> are loaded.</p>
</section>
</section>
<section id="event-categories">
<h2>Event Categories<a class="headerlink" href="#event-categories" title="Link to this heading">¶</a></h2>
<p>Additionally, there are a few categories of events whose names are part of
the specification of the event. These events are fired if they exist, and
are ignored otherwise. Here are their specifications.</p>
<hr class="docutils" />
<section id="on-pre-spec-run-spec-subprocspec-none">
<h3><code class="docutils literal notranslate"><span class="pre">on_pre_spec_run(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-spec-run-spec-subprocspec-none" title="Link to this heading">¶</a></h3>
<p>This event fires whenever any command has its <code class="docutils literal notranslate"><span class="pre">SubprocSpec.run()</span></code>
method called. This is fired prior to the run call executing anything
at all. This receives the <code class="docutils literal notranslate"><span class="pre">SubprocSpec</span></code> object as <code class="docutils literal notranslate"><span class="pre">spec</span></code> that triggered
the event, allowing the handler to modify the spec if needed. For example,
if we wanted to intercept all specs, we could write:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@events</span><span class="o">.</span><span class="n">on_pre_spec_run</span>
<span class="k">def</span> <span class="nf">print_when_ls</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Running a command"</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="on-pre-spec-run-cmd-name-spec-subprocspec-none">
<h3><code class="docutils literal notranslate"><span class="pre">on_pre_spec_run_<cmd-name>(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-pre-spec-run-cmd-name-spec-subprocspec-none" title="Link to this heading">¶</a></h3>
<p>This event fires whenever a command with a give name (<code class="docutils literal notranslate"><span class="pre"><cmd-name></span></code>)
has its <code class="docutils literal notranslate"><span class="pre">SubprocSpec.run()</span></code> method called. This is fired
prior to the run call executing anything at all. This receives the
<code class="docutils literal notranslate"><span class="pre">SubprocSpec</span></code> object as <code class="docutils literal notranslate"><span class="pre">spec</span></code> that triggered the event, allowing
the handler to modify the spec if needed. For example, if we wanted to
intercept an <code class="docutils literal notranslate"><span class="pre">ls</span></code> spec, we could write:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@events</span><span class="o">.</span><span class="n">on_pre_spec_run_ls</span>
<span class="k">def</span> <span class="nf">print_when_ls</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Look at me list stuff!"</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="on-post-spec-run-spec-subprocspec-none">
<h3><code class="docutils literal notranslate"><span class="pre">on_post_spec_run(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-post-spec-run-spec-subprocspec-none" title="Link to this heading">¶</a></h3>
<p>This event fires whenever any command has its <code class="docutils literal notranslate"><span class="pre">SubprocSpec.run()</span></code>
method called. This is fired after to the run call has executed
everything except returning. This recieves the <code class="docutils literal notranslate"><span class="pre">SubprocSpec</span></code> object as
<code class="docutils literal notranslate"><span class="pre">spec</span></code> that triggered the event, allowing the handler to modify the spec
if needed. Note that because of the way process pipelines and specs work
in xonsh, the command will have started running, but won’t necessarily have
completed. This is because <code class="docutils literal notranslate"><span class="pre">SubprocSpec.run()</span></code> does not block.
For example, if we wanted to get any spec after a command has started running,
we could write:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@events</span><span class="o">.</span><span class="n">on_post_spec_run</span>
<span class="k">def</span> <span class="nf">print_while_ls</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"A command is running"</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="on-post-spec-run-cmd-name-spec-subprocspec-none">
<h3><code class="docutils literal notranslate"><span class="pre">on_post_spec_run_<cmd-name>(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code><a class="headerlink" href="#on-post-spec-run-cmd-name-spec-subprocspec-none" title="Link to this heading">¶</a></h3>
<p>This event fires whenever a command with a give name (<code class="docutils literal notranslate"><span class="pre"><cmd-name></span></code>)
has its <code class="docutils literal notranslate"><span class="pre">SubprocSpec.run()</span></code> method called. This is fired
after to the run call has executed everything except returning. This recieves the
<code class="docutils literal notranslate"><span class="pre">SubprocSpec</span></code> object as <code class="docutils literal notranslate"><span class="pre">spec</span></code> that triggered the event, allowing
the handler to modify the spec if needed. Note that because of the
way process pipelines and specs work in xonsh, the command will have
started running, but won’t necessarily have completed. This is because
<code class="docutils literal notranslate"><span class="pre">SubprocSpec.run()</span></code> does not block.
For example, if we wanted to get an <code class="docutils literal notranslate"><span class="pre">ls</span></code> spec after ls has started running,
we could write:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@events</span><span class="o">.</span><span class="n">on_post_spec_run_ls</span>
<span class="k">def</span> <span class="nf">print_while_ls</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Mom! I'm listing!"</span><span class="p">)</span>
</pre></div>
</div>
</section>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="platform-issues.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Platform-specific tips and tricks</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="aliases.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">Built-in Aliases</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2015, Anthony Scopatz
</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="#">Core Events</a><ul>
<li><a class="reference internal" href="#listing">Listing</a><ul>
<li><a class="reference internal" href="#on-chdir-olddir-str-newdir-str-none"><code class="docutils literal notranslate"><span class="pre">on_chdir(olddir:</span> <span class="pre">str,</span> <span class="pre">newdir:</span> <span class="pre">str)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-command-not-found-cmd-list-str-none"><code class="docutils literal notranslate"><span class="pre">on_command_not_found(cmd:</span> <span class="pre">list[str])</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-envvar-change-name-str-oldvalue-any-newvalue-any-none"><code class="docutils literal notranslate"><span class="pre">on_envvar_change(name:</span> <span class="pre">str,</span> <span class="pre">oldvalue:</span> <span class="pre">Any,</span> <span class="pre">newvalue:</span> <span class="pre">Any)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-envvar-new-name-str-value-any-none"><code class="docutils literal notranslate"><span class="pre">on_envvar_new(name:</span> <span class="pre">str,</span> <span class="pre">value:</span> <span class="pre">Any)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-exit-none"><code class="docutils literal notranslate"><span class="pre">on_exit()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-import-post-create-module-module-module-spec-modulespec-none"><code class="docutils literal notranslate"><span class="pre">on_import_post_create_module(module:</span> <span class="pre">Module,</span> <span class="pre">spec:</span> <span class="pre">ModuleSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-import-post-exec-module"><code class="docutils literal notranslate"><span class="pre">on_import_post_exec_module</span></code></a></li>
<li><a class="reference internal" href="#on-import-post-find-spec-spec-fullname-path-target-none"><code class="docutils literal notranslate"><span class="pre">on_import_post_find_spec(spec,</span> <span class="pre">fullname,</span> <span class="pre">path,</span> <span class="pre">target)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-import-pre-create-module-spec-modulespec-none"><code class="docutils literal notranslate"><span class="pre">on_import_pre_create_module(spec:</span> <span class="pre">ModuleSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-import-pre-exec-module-module-module-none"><code class="docutils literal notranslate"><span class="pre">on_import_pre_exec_module(module:</span> <span class="pre">Module)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-import-pre-find-spec-fullname-str-path-str-target-module-or-none-none"><code class="docutils literal notranslate"><span class="pre">on_import_pre_find_spec(fullname:</span> <span class="pre">str,</span> <span class="pre">path:</span> <span class="pre">str,</span> <span class="pre">target:</span> <span class="pre">module</span> <span class="pre">or</span> <span class="pre">None)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-lscolors-change-key-str-oldvalue-any-newvalue-any-none"><code class="docutils literal notranslate"><span class="pre">on_lscolors_change(key:</span> <span class="pre">str,</span> <span class="pre">oldvalue:</span> <span class="pre">Any,</span> <span class="pre">newvalue:</span> <span class="pre">Any)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-post-cmdloop-none"><code class="docutils literal notranslate"><span class="pre">on_post_cmdloop()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-post-init-none"><code class="docutils literal notranslate"><span class="pre">on_post_init()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-post-prompt-none"><code class="docutils literal notranslate"><span class="pre">on_post_prompt()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-post-rc-none"><code class="docutils literal notranslate"><span class="pre">on_post_rc()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-postcommand-cmd-str-rtn-int-out-str-or-none-ts-list-none"><code class="docutils literal notranslate"><span class="pre">on_postcommand(cmd:</span> <span class="pre">str,</span> <span class="pre">rtn:</span> <span class="pre">int,</span> <span class="pre">out:</span> <span class="pre">str</span> <span class="pre">or</span> <span class="pre">None,</span> <span class="pre">ts:</span> <span class="pre">list)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-pre-cmdloop-none"><code class="docutils literal notranslate"><span class="pre">on_pre_cmdloop()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-pre-prompt-none"><code class="docutils literal notranslate"><span class="pre">on_pre_prompt()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-pre-prompt-format-none"><code class="docutils literal notranslate"><span class="pre">on_pre_prompt_format()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-pre-rc-none"><code class="docutils literal notranslate"><span class="pre">on_pre_rc()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-pre-spec-run-ls-spec-xonsh-built-ins-subprocspec-none"><code class="docutils literal notranslate"><span class="pre">on_pre_spec_run_ls(spec:</span> <span class="pre">xonsh.built_ins.SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-precommand-cmd-str-none"><code class="docutils literal notranslate"><span class="pre">on_precommand(cmd:</span> <span class="pre">str)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-ptk-create-prompter-promptsession-history-prompttoolkithistory-completer-prompttoolkitcompleter-bindings-keybindings"><code class="docutils literal notranslate"><span class="pre">on_ptk_create(prompter:</span> <span class="pre">PromptSession,</span> <span class="pre">history:</span> <span class="pre">PromptToolkitHistory,</span> <span class="pre">completer:</span> <span class="pre">PromptToolkitCompleter,</span> <span class="pre">bindings:</span> <span class="pre">KeyBindings)</span> <span class="pre">-></span></code></a></li>
<li><a class="reference internal" href="#on-transform-command-cmd-str-str"><code class="docutils literal notranslate"><span class="pre">on_transform_command(cmd:</span> <span class="pre">str)</span> <span class="pre">-></span> <span class="pre">str</span></code></a></li>
<li><a class="reference internal" href="#on-xonfig-info-requested-list-tuple-str-str"><code class="docutils literal notranslate"><span class="pre">on_xonfig_info_requested()</span> <span class="pre">-></span> <span class="pre">list[tuple[str,</span> <span class="pre">str]]</span></code></a></li>
<li><a class="reference internal" href="#on-xontribs-loaded-none"><code class="docutils literal notranslate"><span class="pre">on_xontribs_loaded()</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#event-categories">Event Categories</a><ul>
<li><a class="reference internal" href="#on-pre-spec-run-spec-subprocspec-none"><code class="docutils literal notranslate"><span class="pre">on_pre_spec_run(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-pre-spec-run-cmd-name-spec-subprocspec-none"><code class="docutils literal notranslate"><span class="pre">on_pre_spec_run_<cmd-name>(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-post-spec-run-spec-subprocspec-none"><code class="docutils literal notranslate"><span class="pre">on_post_spec_run(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
<li><a class="reference internal" href="#on-post-spec-run-cmd-name-spec-subprocspec-none"><code class="docutils literal notranslate"><span class="pre">on_post_spec_run_<cmd-name>(spec:</span> <span class="pre">SubprocSpec)</span> <span class="pre">-></span> <span class="pre">None</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=ecbec2ee"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
<script src="_static/runthis-client.min.js?v=ad2a40d9"></script>
</body>
</html>