Skip to content

universal_directory_tree

A universal directory tree widget for Textual.

BrowsrDirectoryTree #

Bases: DoubleClickDirectoryTree, UniversalDirectoryTree

A DirectoryTree that can handle any filesystem.

Source code in browsr/widgets/universal_directory_tree.py 
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
class BrowsrDirectoryTree(DoubleClickDirectoryTree, UniversalDirectoryTree):
    """
    A DirectoryTree that can handle any filesystem.
    """

    BINDINGS: ClassVar[list[BindingType]] = [
        *UniversalDirectoryTree.BINDINGS,
        *vim_cursor_bindings,
    ]

    @classmethod
    def _handle_top_level_bucket(cls, dir_path: UPath) -> Iterable[UPath] | None:
        """
        Handle scenarios when someone wants to browse all of s3

        This is because S3FS handles the root directory differently
        than other filesystems
        """
        if str(dir_path) == "s3:/":
            sub_buckets = sorted(
                UPath(f"s3://{bucket.name}") for bucket in dir_path.iterdir()
            )
            return sub_buckets
        return None

    def _populate_node(
        self, node: TreeNode[DirEntry], content: Iterable[UPath]
    ) -> None:
        """
        Populate the given tree node with the given directory content.

        This function overrides the original textual method to handle root level
        cloud buckets.
        """
        top_level_buckets = self._handle_top_level_bucket(dir_path=node.data.path)
        if top_level_buckets is not None:
            content = top_level_buckets
        node.remove_children()
        for path in content:
            if top_level_buckets is not None:
                path_name = str(path).replace("s3://", "").rstrip("/")
            else:
                path_name = path.name
            node.add(
                path_name,
                data=DirEntry(path),
                allow_expand=self._safe_is_dir(path),
            )
        node.expand()

_handle_top_level_bucket(dir_path) classmethod #

Handle scenarios when someone wants to browse all of s3

This is because S3FS handles the root directory differently than other filesystems

Source code in browsr/widgets/universal_directory_tree.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@classmethod
def _handle_top_level_bucket(cls, dir_path: UPath) -> Iterable[UPath] | None:
    """
    Handle scenarios when someone wants to browse all of s3

    This is because S3FS handles the root directory differently
    than other filesystems
    """
    if str(dir_path) == "s3:/":
        sub_buckets = sorted(
            UPath(f"s3://{bucket.name}") for bucket in dir_path.iterdir()
        )
        return sub_buckets
    return None

_populate_node(node, content) #

Populate the given tree node with the given directory content.

This function overrides the original textual method to handle root level cloud buckets.

Source code in browsr/widgets/universal_directory_tree.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def _populate_node(
    self, node: TreeNode[DirEntry], content: Iterable[UPath]
) -> None:
    """
    Populate the given tree node with the given directory content.

    This function overrides the original textual method to handle root level
    cloud buckets.
    """
    top_level_buckets = self._handle_top_level_bucket(dir_path=node.data.path)
    if top_level_buckets is not None:
        content = top_level_buckets
    node.remove_children()
    for path in content:
        if top_level_buckets is not None:
            path_name = str(path).replace("s3://", "").rstrip("/")
        else:
            path_name = path.name
        node.add(
            path_name,
            data=DirEntry(path),
            allow_expand=self._safe_is_dir(path),
        )
    node.expand()