Skip to content

HELP

Help

Bases: Command

Display the help for a given command

Examples:

help

Source code in src/textual_shell/commands/help.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class Help(Command):
    """
    Display the help for a given command

    Examples:
        help <command>
    """
    DEFINITION = {
        'help': CommandNode(
            name='help',
            description='Show the help dialog for the requested command.'
        )
    }

    def create_job(self, *args) -> HelpJob:
        """Create the job to display the help text."""
        return HelpJob(
            args[0],
            shell=self.shell,
            cmd=self.name
        )

create_job(*args)

Create the job to display the help text.

Source code in src/textual_shell/commands/help.py 
 94
 95
 96
 97
 98
 99
100
def create_job(self, *args) -> HelpJob:
    """Create the job to display the help text."""
    return HelpJob(
        args[0],
        shell=self.shell,
        cmd=self.name
    )

HelpJob

Bases: Job

Source code in src/textual_shell/commands/help.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
class HelpJob(Job):

    def __init__(
        self,
        cmd_to_show: Annotated[Command, 'The command to generate the help screen for.'],
        *args, **kwargs
    ) -> None:
        super().__init__(*args, **kwargs)
        self.cmd_to_show = cmd_to_show

    async def execute(self):
        """Display the Help screen."""
        self.running()
        help_text = self.cmd_to_show.help()
        help_screen = HelpScreen(help_text)
        await self.shell.app.push_screen_wait(help_screen)
        self.completed()

execute() async

Display the Help screen.

Source code in src/textual_shell/commands/help.py 
71
72
73
74
75
76
77
async def execute(self):
    """Display the Help screen."""
    self.running()
    help_text = self.cmd_to_show.help()
    help_screen = HelpScreen(help_text)
    await self.shell.app.push_screen_wait(help_screen)
    self.completed()

HelpScreen

Bases: ModalScreen

Default Help screen Modal. Displays the text generated by the help function on Commands.

Parameters:

Name Type Description Default
help_text str

The help text to display.

 required
Source code in src/textual_shell/commands/help.py 
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
class HelpScreen(ModalScreen):
    """
    Default Help screen Modal. Displays the text generated 
    by the help function on Commands.

    Args:
        help_text (str): The help text to display.
    """
    BINDINGS = [
        Binding('q', 'dismiss_screen', 'Close the help box.'),
        Binding('escape', 'dismiss_screen', 'Close the help box.', show=False),
    ]

    DEFAULT_CSS = """
        HelpScreen {
            align: center middle;

        }

        #help-dialog {
            height: auto;
            width: auto;
            background: $surface;
            padding: 0;
            max-height: 75%;
            max-width: 65%;
        }
    """

    def __init__(
        self,
        help_text: Annotated[str, 'The help text to display in the modal']
    ) -> None:
        super().__init__()
        self.help_text = help_text

    def compose(self) -> ComposeResult:
        yield RichLog(id='help-dialog', markup=True)

    def on_mount(self) -> None:
        """Write the help text when the DOM is ready."""
        rich_log = self.query_one(RichLog)
        rich_log.write(self.help_text)

    def action_dismiss_screen(self) -> None:
        """Close the help screen."""
        self.dismiss(True)

action_dismiss_screen()

Close the help screen.

Source code in src/textual_shell/commands/help.py 
56
57
58
def action_dismiss_screen(self) -> None:
    """Close the help screen."""
    self.dismiss(True)

on_mount()

Write the help text when the DOM is ready.

Source code in src/textual_shell/commands/help.py 
51
52
53
54
def on_mount(self) -> None:
    """Write the help text when the DOM is ready."""
    rich_log = self.query_one(RichLog)
    rich_log.write(self.help_text)