summaryrefslogtreecommitdiff
path: root/examples/event_loops.py
blob: 86dc01fba90cf4338ac284a3ce5431f49927d85c (plain)
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
#!/usr/bin/env python
# coding=utf-8
"""A sample application for integrating cmd2 with external event loops.

This is an example of how to use cmd2 in a way so that cmd2 doesn't own the inner event loop of your application.

This opens up the possibility of registering cmd2 input with event loops, like asyncio, without occupying the main loop.
"""
import cmd2


class Cmd2EventBased(cmd2.Cmd):
    """Basic example of how to run cmd2 without it controlling the main loop."""

    def __init__(self):
        super().__init__()

    # ... your class code here ...


if __name__ == '__main__':
    app = Cmd2EventBased()
    app.preloop()

    # Do this within whatever event loop mechanism you wish to run a single command.
    # In this case, no prompt is generated, so you need to provide one and read the user's input.
    app.onecmd_plus_hooks("help history")

    app.postloop()