Skip to content

app#

Example Universal Directory Tree App

UniversalDirectoryTreeApp #

Bases: App

The power of upath and fsspec in a Textual app

Source code in textual_universal_directorytree/app.py 
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
class UniversalDirectoryTreeApp(App):
    """
    The power of upath and fsspec in a Textual app
    """

    TITLE = "UniversalDirectoryTree"

    CSS = """
    UniversalDirectoryTree {
        max-width: 50%;
        width: auto;
        height: 100%;
        dock: left;
    }
    """

    BINDINGS: ClassVar[list[BindingType]] = [
        ("q", "quit", "Quit"),
    ]

    def __init__(self, path: str | UPath, *args: Any, **kwargs: Any):
        super().__init__(*args, **kwargs)
        self.universal_path = UPath(path).resolve()
        self.directory_tree = UniversalDirectoryTree(path=self.universal_path)
        self.file_content = Static(expand=True)

    def compose(self) -> ComposeResult:
        yield Header()
        yield Horizontal(self.directory_tree, VerticalScroll(self.file_content))
        yield Footer()

    @on(DirectoryTree.FileSelected)
    def handle_file_selected(self, message: DirectoryTree.FileSelected) -> None:
        """
        Do something with the selected file.

        Objects returned by the FileSelected event are upath.UPath objects and
        they are compatible with the familiar pathlib.Path API built into Python.
        """
        self.sub_title = str(message.path)
        try:
            file_content = message.path.read_text()
        except UnicodeDecodeError:
            self.file_content.update("")
            return None
        lexer = Syntax.guess_lexer(path=message.path.name, code=file_content)
        code = Syntax(code=file_content, lexer=lexer)
        self.file_content.update(code)

handle_file_selected(message) #

Do something with the selected file.

Objects returned by the FileSelected event are upath.UPath objects and they are compatible with the familiar pathlib.Path API built into Python.

Source code in textual_universal_directorytree/app.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@on(DirectoryTree.FileSelected)
def handle_file_selected(self, message: DirectoryTree.FileSelected) -> None:
    """
    Do something with the selected file.

    Objects returned by the FileSelected event are upath.UPath objects and
    they are compatible with the familiar pathlib.Path API built into Python.
    """
    self.sub_title = str(message.path)
    try:
        file_content = message.path.read_text()
    except UnicodeDecodeError:
        self.file_content.update("")
        return None
    lexer = Syntax.guess_lexer(path=message.path.name, code=file_content)
    code = Syntax(code=file_content, lexer=lexer)
    self.file_content.update(code)

cli() #

Command Line Interface for the example App

Source code in textual_universal_directorytree/app.py 
72
73
74
75
76
77
78
79
80
def cli() -> None:
    """
    Command Line Interface for the example App
    """
    parser = argparse.ArgumentParser(description="Universal Directory Tree")
    parser.add_argument("path", type=str, help="Path to open", default=".")
    args = parser.parse_args()
    cli_app = UniversalDirectoryTreeApp(path=args.path)
    cli_app.run()