Skip to content

SettingsDisplay

SettingsDisplay

Bases: Widget

Custom widget for displaying settings for the shell.

Parameters:

Name Type Description Default
config_path str

The path to the config file.

 None
Source code in src/textual_shell/widgets/settings.py 
 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
class SettingsDisplay(Widget):
    """
    Custom widget for displaying settings for the shell.

    Args:
        config_path (str): The path to the config file.
    """

    DEFAULT_CSS = """

        SettingsDisplay {
            grid-size: 2;
            grid-columns: 1fr;
            grid-rows: auto 1fr;
            border: solid white;
            height: 15;

            Label {
                text-align: center;
                column-span: 2;
            }

            DataTable {
                column-span: 2;
                border-top: solid white;
            }
        }
    """

    def __init__(
        self,
        config_path: Annotated[str, 'THe path to the config file.']=None,
        *args, **kwargs
    ) -> None:
        super().__init__(*args, **kwargs)
        self.config_path = config_path

    def compose(self) -> ComposeResult:
        yield Label('Settings')
        yield DataTable()

    def load_settings(self) -> None:
        """Load the settings from the config on mount."""
        table = self.query_one(DataTable)
        config = configure.get_config(self.config_path)
        for section in config:
            for key, val in config[section].items():
                if key == 'description':
                    continue

                setting = f'{section}.{key}'
                value = val['value']
                row = (setting, value)
                table.add_row(*row, key=setting)

    def reload(self) -> None:
        """Reload the DataTable if config has changed."""
        table = self.query_one(DataTable)
        table.clear()
        self.load_settings()

    def on_mount(self) -> None:
        table = self.query_one(DataTable)
        table.can_focus = False
        self.column_keys = table.add_columns('setting', 'value')
        self.load_settings()

load_settings()

Load the settings from the config on mount.

Source code in src/textual_shell/widgets/settings.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
def load_settings(self) -> None:
    """Load the settings from the config on mount."""
    table = self.query_one(DataTable)
    config = configure.get_config(self.config_path)
    for section in config:
        for key, val in config[section].items():
            if key == 'description':
                continue

            setting = f'{section}.{key}'
            value = val['value']
            row = (setting, value)
            table.add_row(*row, key=setting)

reload()

Reload the DataTable if config has changed.

Source code in src/textual_shell/widgets/settings.py 
64
65
66
67
68
def reload(self) -> None:
    """Reload the DataTable if config has changed."""
    table = self.query_one(DataTable)
    table.clear()
    self.load_settings()