summaryrefslogtreecommitdiff
path: root/examples/paged_output.py
blob: 9005a4da4238e2b4c8a7f02a01862bca25ae0722 (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
30
31
32
33
#!/usr/bin/env python
# coding=utf-8
"""A simple example demonstrating the using paged output via the ppaged() method.
"""
import functools

import cmd2
from cmd2 import with_argument_list


class PagedOutput(cmd2.Cmd):
    """ Example cmd2 application where we create commands that just print the arguments they are called with."""

    def __init__(self):
        cmd2.Cmd.__init__(self)

    @with_argument_list
    def do_page_file(self, args):
        """Read in a text file and display its output in a pager."""
        if not args:
            self.perror('page_file requires a path to a file as an argument', traceback_war=False)
            return

        with open(args[0], 'r') as f:
            text = f.read()
        self.ppaged(text)

    complete_page_file = functools.partial(cmd2.path_complete)


if __name__ == '__main__':
    app = PagedOutput()
    app.cmdloop()