Skip to content

CLEAR

Clear

Bases: Command

Command for clearing either the history log or console log.

Source code in src/textual_shell/commands/clear.py 
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
class Clear(Command):
    """
    Command for clearing either the history log or 
    console log.
    """

    DEFINITION = {
        'clear': CommandNode(
            name='clear',
            description='Clear either the ConsoleLog or the HistoryLog.',
            children={
                'console': CommandNode(
                    name='console',
                    description='Clear the ConsoleLog',
                ),
                'history': CommandNode(
                    name='history',
                    description='Clear the HistoryLog.'
                )
            }
        )
    }

    def create_job(self, *args) -> Console | History:
        """Create the job to clear either the console or history."""
        if len(args) != 1:
            self.send_log('Invalid args!', logging.ERROR)
            return

        elif args[0] == 'console':
            return Console(
                shell=self.shell,
                cmd=self.name
            )

        elif args[0] == 'history':
            return History(
                shell=self.shell,
                cmd=self.name
            )

        else:
            self.shell.notify(
                message='Invalid subcommand.',
                title='Command: clear',
                severity='error'
            )

create_job(*args)

Create the job to clear either the console or history.

Source code in src/textual_shell/commands/clear.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def create_job(self, *args) -> Console | History:
    """Create the job to clear either the console or history."""
    if len(args) != 1:
        self.send_log('Invalid args!', logging.ERROR)
        return

    elif args[0] == 'console':
        return Console(
            shell=self.shell,
            cmd=self.name
        )

    elif args[0] == 'history':
        return History(
            shell=self.shell,
            cmd=self.name
        )

    else:
        self.shell.notify(
            message='Invalid subcommand.',
            title='Command: clear',
            severity='error'
        )

Console

Bases: Job

Job to clear the console.

Source code in src/textual_shell/commands/clear.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
class Console(Job):
    """Job to clear the console."""

    class Clear(Message):
        """Signal the app to clear the console."""
        pass

    async def execute(self):
        self.running()
        self.shell.post_message(
            self.Clear()
        )
        self.completed()

Clear

Bases: Message

Signal the app to clear the console.

Source code in src/textual_shell/commands/clear.py 
28
29
30
class Clear(Message):
    """Signal the app to clear the console."""
    pass

History

Bases: Job

Job to clear the history.

Source code in src/textual_shell/commands/clear.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
class History(Job):
    """Job to clear the history."""

    class Clear(Message):
        """Signal the app to clear the history."""
        pass

    async def execute(self):
        self.running()
        self.shell.post_message(
            self.Clear()
        )
        self.completed()

Clear

Bases: Message

Signal the app to clear the history.

Source code in src/textual_shell/commands/clear.py 
13
14
15
class Clear(Message):
    """Signal the app to clear the history."""
    pass