fextract.tui package

Submodules

fextract.tui.app module

class lbfextract.fextract.tui.app.FextractApp(path='/home/docs/checkouts/readthedocs.org/user_builds/lbf/checkouts/latest/docs/source', signal_type: str = 'extract_coverage')

Bases: App

BINDINGS: ClassVar[list[BindingType]] = [('ctrl+t', 'toggle_tree', 'Toggle Files'), ('q', 'quit', 'Quit'), ('ctrl+p', 'toggle_processes_pane', 'Toggle Processes Pane'), ('ctrl+r', 'check_task_status', 'Check Task Status')]

CSS_PATH: CSSPathType = 'app.css'

action_check_task_status() → None

Called in response to key binding.

action_toggle_processes_pane() → None

Called in response to key binding.

action_toggle_tree() → None

Called in response to key binding.

compose() → Iterable[Widget]

Yield child widgets for a container.

async on_button_pressed(event: Pressed) → None

on_checkbox_changed(event: Changed) → None

on_directory_tree_file_click(event: FileClick) → None

on_input_changed(event: Changed) → None

pressed_botton = None

async run_command()

show_tree = False

lbfextract.fextract.tui.app.Scrollview(param)

class lbfextract.fextract.tui.app.Welcome(renderable: ConsoleRenderable | RichCast | str = '', *, expand: bool = False, shrink: bool = False, markup: bool = True, name: str | None = None, id: str | None = None, classes: str | None = None)

Bases: Static

DEFAULT_CSS: ClassVar[str] = '\n        Welcome {\n            width: 100%;\n            height: 100%;\n            background: $surface;\n        }\n\n        Welcome Container {\n            padding: 1;\n            background: $panel;\n            color: $text;\n        }\n\n        Welcome #text {\n            margin:  0 1;\n        }\n\n        Welcome #close {\n            dock: bottom;\n            width: 100%;        \n        }\n    '

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose() → Iterable[Widget]

Called by Textual to create child widgets.

Extend this to build a UI.

Example:

```python def compose(self) -> ComposeResult:

yield Header() yield Container(

TreeControl(), Viewer()

) yield Footer()

```

lbfextract.fextract.tui.app.generate_bool_element(label: str)

lbfextract.fextract.tui.app.generate_form_from_command(command)

Generate a form from a command.

lbfextract.fextract.tui.app.generate_path_element(label: str)

lbfextract.fextract.tui.app.generate_static(label, help)

lbfextract.fextract.tui.app.get_element_id(element_name)

fextract.tui.my_directory_tree module

class lbfextract.fextract.tui.my_directory_tree.DirEntry(path: 'str', is_dir: 'bool')

Bases: object

is_dir: bool

path: str

class lbfextract.fextract.tui.my_directory_tree.DirectoryTree(path: str, *, name: str | None = None, id: str | None = None, classes: str | None = None)

Bases: TreeControl[DirEntry]

class FileClick(sender: MessageTarget, path: str)

Bases: Message

bubble: ClassVar[bool] = True

name

namespace: ClassVar[str] = 'directory_tree'

no_dispatch: ClassVar[bool] = False

sender: MessageTarget

time

verbose: ClassVar[bool] = False

can_focus: bool = True

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

async load_directory(node: TreeNode[DirEntry])

on_mount() → None

on_styles_updated() → None

async on_tree_control_node_selected(message: NodeSelected[DirEntry]) → None

render_node(node: TreeNode[DirEntry]) → ConsoleRenderable | RichCast | str

render_tree_label(node: TreeNode[DirEntry], is_dir: bool, expanded: bool, is_cursor: bool, is_hover: bool, has_focus: bool) → ConsoleRenderable | RichCast | str

Module contents