Skip to content

pager

Classes

DataViewPane

Bases: Static

A widget that displays a data preview.

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DataViewPane(Static):

    """A widget that displays a data preview."""

    value_view = reactive(None)
    # is_scrollable = True

    def __init__(self, *args, **kwargs) -> None:

        super().__init__(*args, **kwargs)

    def watch_value_view(self, value_view: Union[RenderableType, None]) -> None:
        """Update the data preview."""
        if not value_view:
            self.update("-- no value --")
        else:
            self.update(value_view)

Attributes

value_view = reactive(None) instance-attribute class-attribute

Functions

watch_value_view(value_view: Union[RenderableType, None]) -> None

Update the data preview.

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
26
27
28
29
30
31
def watch_value_view(self, value_view: Union[RenderableType, None]) -> None:
    """Update the data preview."""
    if not value_view:
        self.update("-- no value --")
    else:
        self.update(value_view)

DataViewControl

Bases: Static

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
 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
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
class DataViewControl(Static):

    current_value: Union[str, None] = None
    related_scenes: Union[None, Mapping[str, Union[None, RenderScene]]] = None
    scene_keys: Union[None, Dict[str, Union[None, RenderScene]]] = None
    max_level: int = 0
    control_table: Union[None, RenderableType] = None
    reserved_keys: Tuple[str, ...] = ()

    def on_mount(self):

        self.compute_related_scenes(None)
        self.commit()

    def set_reserved_keys(self, keys: Iterable[str]):
        self.reserved_keys = tuple(keys)

    def get_title(
        self,
        key: str,
        scene: Union[None, RenderScene],
        scene_keys: Dict[str, Union[None, RenderScene]],
    ) -> RenderableType:

        last_token = key.split(".")[-1]

        title = None
        found_key = None
        for idx, command_key in enumerate(last_token):
            if (
                command_key.lower() not in self.reserved_keys
                and command_key.lower() not in (x.lower() for x in scene_keys.keys())
            ):
                replaced = last_token.replace(command_key, f"\[{command_key}]", 1)
                if scene is None or scene.disabled:
                    title = Text.from_markup(f"[grey46]{replaced}[/grey46]")
                else:
                    title = Text.from_markup(replaced)
                found_key = command_key
                break

        if title is None:
            raise NotImplementedError("Could not find free command key.")
        if found_key is None:
            raise NotImplementedError("Invalid key.")

        scene_keys[found_key] = scene  # tpye: ignore
        return title

    def render_sub_command_table(
        self,
        scene: Union[None, RenderScene],
        scene_keys: Dict[str, Union[None, RenderScene]],
        forced_titles: Dict[str, RenderableType],
        row_list: Union[None, List[List[RenderableType]]] = None,
        level: int = 0,
    ) -> Tuple[List[List[RenderableType]], int]:

        if row_list is None:
            row_list = []

        if not scene:
            return (row_list, level)

        if not scene.related_scenes:
            return (row_list, level)

        level = level + 1
        sub_list: List[RenderableType] = []

        for scene_key, sub_scene in scene.related_scenes.items():

            if scene_key in forced_titles.keys():
                new_scene_key: RenderableType = forced_titles[scene_key]
            else:
                new_scene_key = self.get_title(
                    key=scene_key, scene=sub_scene, scene_keys=scene_keys
                )

            sub_list.append(new_scene_key)

        row_list.append(sub_list)

        for scene_key, sub_scene in scene.related_scenes.items():
            _, level = self.render_sub_command_table(
                scene=sub_scene,
                scene_keys=scene_keys,
                forced_titles=forced_titles,
                row_list=row_list,
                level=level,
            )

        return (row_list, level)

    def render_sub_command_tree(
        self,
        key: str,
        scene: Union[RenderScene, None],
        scene_keys: Dict[str, Union[None, RenderScene]],
        forced_titles: Dict[str, RenderableType],
        node: Union[Tree, None] = None,
        level: int = 0,
    ):

        if key in forced_titles.keys():
            title: RenderableType = forced_titles[key]
        else:
            title = self.get_title(key=key, scene=scene, scene_keys=scene_keys)

        if node is None:
            node = Tree(title)
        else:
            node = node.add(title)

        if scene:
            for scene_key, sub_scene in scene.related_scenes.items():
                _, level = self.render_sub_command_tree(
                    key=f"{key}.{scene_key}",
                    scene=sub_scene,
                    scene_keys=scene_keys,
                    forced_titles=forced_titles,
                    node=node,
                    level=level + 1,
                )

        return (node, level)

    def render_command_table(self) -> Tuple[RenderableType, int]:

        max_level = 0

        if self.related_scenes is None:
            return "", max_level

        scene_keys: Dict[str, Union[None, RenderScene]] = {}

        forced_titles = {}
        for key, scene in self.related_scenes.items():

            title = self.get_title(key=key, scene=scene, scene_keys=scene_keys)
            forced_titles[key] = title

        render_as_tree = False
        if render_as_tree:
            row = []
            table = Table(show_header=False, box=box.SIMPLE)
            for key, scene in self.related_scenes.items():

                table.add_column(f"category: {key}")
                node, level = self.render_sub_command_tree(
                    key=key,
                    scene=scene,
                    scene_keys=scene_keys,
                    forced_titles=forced_titles,
                )
                row.append(node)

                control_height = ((level * 2) - 1) + 2
                if control_height > max_level:
                    max_level = control_height

            table.add_row(*row)

        else:
            main_scene = RenderScene(
                title=f"Value: {self.current_value}",
                disabled=False,
                description=f"Preview of value: {self.current_value}",
                manifest_hash="",
                render_config={},
                related_scenes=self.related_scenes,
            )
            row_list, level = self.render_sub_command_table(
                scene=main_scene,
                scene_keys=scene_keys,
                forced_titles=forced_titles,
            )

            table = Table(show_header=False, box=box.SIMPLE, show_lines=True)
            if not row_list:
                max_level = 0
            else:
                max_len = max([len(x) for x in row_list])
                for i in range(0, max_len):
                    table.add_column(f"col_{i}")

                for row in row_list:
                    table.add_row(*row)

            if level > max_level:
                max_level = level

        self.scene_keys = scene_keys
        return table, max_level

    def compute_related_scenes(
        self, related_scenes: Union[None, Mapping[str, Union[None, RenderScene]]]
    ) -> int:

        self.related_scenes = related_scenes
        self.control_table, self.max_level = self.render_command_table()

        return self.max_level

    def commit(self):

        self.update(self.control_table)

    def get_scene_for_key(self, key: str) -> Union[None, RenderScene]:

        if self.scene_keys is None:
            return None

        if key in self.scene_keys.keys():
            return self.scene_keys[key]

        for x in self.scene_keys.keys():
            if x.lower() == key.lower():
                return self.scene_keys[x]

        return None

Attributes

current_value: Union[str, None] = None instance-attribute class-attribute
related_scenes: Union[None, Mapping[str, Union[None, RenderScene]]] = None instance-attribute class-attribute
scene_keys: Union[None, Dict[str, Union[None, RenderScene]]] = None instance-attribute class-attribute
max_level: int = 0 instance-attribute class-attribute
control_table: Union[None, RenderableType] = None instance-attribute class-attribute
reserved_keys: Tuple[str, ...] = () instance-attribute class-attribute

Functions

on_mount()
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
43
44
45
46
def on_mount(self):

    self.compute_related_scenes(None)
    self.commit()
set_reserved_keys(keys: Iterable[str])
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
48
49
def set_reserved_keys(self, keys: Iterable[str]):
    self.reserved_keys = tuple(keys)
get_title(key: str, scene: Union[None, RenderScene], scene_keys: Dict[str, Union[None, RenderScene]]) -> RenderableType
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
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
def get_title(
    self,
    key: str,
    scene: Union[None, RenderScene],
    scene_keys: Dict[str, Union[None, RenderScene]],
) -> RenderableType:

    last_token = key.split(".")[-1]

    title = None
    found_key = None
    for idx, command_key in enumerate(last_token):
        if (
            command_key.lower() not in self.reserved_keys
            and command_key.lower() not in (x.lower() for x in scene_keys.keys())
        ):
            replaced = last_token.replace(command_key, f"\[{command_key}]", 1)
            if scene is None or scene.disabled:
                title = Text.from_markup(f"[grey46]{replaced}[/grey46]")
            else:
                title = Text.from_markup(replaced)
            found_key = command_key
            break

    if title is None:
        raise NotImplementedError("Could not find free command key.")
    if found_key is None:
        raise NotImplementedError("Invalid key.")

    scene_keys[found_key] = scene  # tpye: ignore
    return title
render_sub_command_table(scene: Union[None, RenderScene], scene_keys: Dict[str, Union[None, RenderScene]], forced_titles: Dict[str, RenderableType], row_list: Union[None, List[List[RenderableType]]] = None, level: int = 0) -> Tuple[List[List[RenderableType]], int]
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def render_sub_command_table(
    self,
    scene: Union[None, RenderScene],
    scene_keys: Dict[str, Union[None, RenderScene]],
    forced_titles: Dict[str, RenderableType],
    row_list: Union[None, List[List[RenderableType]]] = None,
    level: int = 0,
) -> Tuple[List[List[RenderableType]], int]:

    if row_list is None:
        row_list = []

    if not scene:
        return (row_list, level)

    if not scene.related_scenes:
        return (row_list, level)

    level = level + 1
    sub_list: List[RenderableType] = []

    for scene_key, sub_scene in scene.related_scenes.items():

        if scene_key in forced_titles.keys():
            new_scene_key: RenderableType = forced_titles[scene_key]
        else:
            new_scene_key = self.get_title(
                key=scene_key, scene=sub_scene, scene_keys=scene_keys
            )

        sub_list.append(new_scene_key)

    row_list.append(sub_list)

    for scene_key, sub_scene in scene.related_scenes.items():
        _, level = self.render_sub_command_table(
            scene=sub_scene,
            scene_keys=scene_keys,
            forced_titles=forced_titles,
            row_list=row_list,
            level=level,
        )

    return (row_list, level)
render_sub_command_tree(key: str, scene: Union[RenderScene, None], scene_keys: Dict[str, Union[None, RenderScene]], forced_titles: Dict[str, RenderableType], node: Union[Tree, None] = None, level: int = 0)
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def render_sub_command_tree(
    self,
    key: str,
    scene: Union[RenderScene, None],
    scene_keys: Dict[str, Union[None, RenderScene]],
    forced_titles: Dict[str, RenderableType],
    node: Union[Tree, None] = None,
    level: int = 0,
):

    if key in forced_titles.keys():
        title: RenderableType = forced_titles[key]
    else:
        title = self.get_title(key=key, scene=scene, scene_keys=scene_keys)

    if node is None:
        node = Tree(title)
    else:
        node = node.add(title)

    if scene:
        for scene_key, sub_scene in scene.related_scenes.items():
            _, level = self.render_sub_command_tree(
                key=f"{key}.{scene_key}",
                scene=sub_scene,
                scene_keys=scene_keys,
                forced_titles=forced_titles,
                node=node,
                level=level + 1,
            )

    return (node, level)
render_command_table() -> Tuple[RenderableType, int]
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
def render_command_table(self) -> Tuple[RenderableType, int]:

    max_level = 0

    if self.related_scenes is None:
        return "", max_level

    scene_keys: Dict[str, Union[None, RenderScene]] = {}

    forced_titles = {}
    for key, scene in self.related_scenes.items():

        title = self.get_title(key=key, scene=scene, scene_keys=scene_keys)
        forced_titles[key] = title

    render_as_tree = False
    if render_as_tree:
        row = []
        table = Table(show_header=False, box=box.SIMPLE)
        for key, scene in self.related_scenes.items():

            table.add_column(f"category: {key}")
            node, level = self.render_sub_command_tree(
                key=key,
                scene=scene,
                scene_keys=scene_keys,
                forced_titles=forced_titles,
            )
            row.append(node)

            control_height = ((level * 2) - 1) + 2
            if control_height > max_level:
                max_level = control_height

        table.add_row(*row)

    else:
        main_scene = RenderScene(
            title=f"Value: {self.current_value}",
            disabled=False,
            description=f"Preview of value: {self.current_value}",
            manifest_hash="",
            render_config={},
            related_scenes=self.related_scenes,
        )
        row_list, level = self.render_sub_command_table(
            scene=main_scene,
            scene_keys=scene_keys,
            forced_titles=forced_titles,
        )

        table = Table(show_header=False, box=box.SIMPLE, show_lines=True)
        if not row_list:
            max_level = 0
        else:
            max_len = max([len(x) for x in row_list])
            for i in range(0, max_len):
                table.add_column(f"col_{i}")

            for row in row_list:
                table.add_row(*row)

        if level > max_level:
            max_level = level

    self.scene_keys = scene_keys
    return table, max_level
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
229
230
231
232
233
234
235
236
def compute_related_scenes(
    self, related_scenes: Union[None, Mapping[str, Union[None, RenderScene]]]
) -> int:

    self.related_scenes = related_scenes
    self.control_table, self.max_level = self.render_command_table()

    return self.max_level
commit()
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
238
239
240
def commit(self):

    self.update(self.control_table)
get_scene_for_key(key: str) -> Union[None, RenderScene]
Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/kiara/interfaces/tui/widgets/pager.py
242
243
244
245
246
247
248
249
250
251
252
253
254
def get_scene_for_key(self, key: str) -> Union[None, RenderScene]:

    if self.scene_keys is None:
        return None

    if key in self.scene_keys.keys():
        return self.scene_keys[key]

    for x in self.scene_keys.keys():
        if x.lower() == key.lower():
            return self.scene_keys[x]

    return None