Skip to content

files

CurrentFileInfoBar #

Bases: Widget

A Widget that displays information about the currently selected file

Thanks, Kupo. https://github.com/darrenburns/kupo

Source code in browsr/widgets/files.py 
 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
 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
class CurrentFileInfoBar(Widget):
    """
    A Widget that displays information about the currently selected file

    Thanks, Kupo. https://github.com/darrenburns/kupo
    """

    file_info: FileInfo | None = reactive(None)

    class FileInfoUpdate(Message):
        """
        File Info Bar Update
        """

        def __init__(self, new_file: FileInfo | None) -> None:
            self.new_file = new_file
            super().__init__()

    def watch_file_info(self, new_file: FileInfo | None) -> None:
        """
        Watch the file_info property for changes
        """
        if new_file is None:
            self.display = False
        else:
            self.display = True

    @classmethod
    def _convert_size(cls, size_bytes: int) -> str:
        """
        Convert Bytes to Human Readable String
        """
        if size_bytes == 0:
            return " 0B"
        size_name = ("B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB")
        index = int(math.floor(math.log(size_bytes, 1024)))
        p = math.pow(1024, index)
        number = round(size_bytes / p, 2)
        unit = size_name[index]
        return f"{number:.0f}{unit}"

    def render(self) -> RenderableType:
        """
        Render the Current File Info Bar
        """
        status_string = self.render_file_protocol()
        if self.file_info is None:
            return Text(status_string)
        elif self.file_info.is_file:
            file_options = self.render_file_options()
            status_string += file_options
        if (
            self.file_info.last_modified is not None
            and self.file_info.last_modified.timestamp() != 0
        ):
            modify_time = self.file_info.last_modified.strftime("%b %d, %Y %I:%M %p")
            status_string += f"  📅  {modify_time}"
        directory_options = self.render_directory_options()
        status_string += directory_options
        return Text(status_string.strip(), style="dim")

    def render_file_options(self) -> str:
        """
        Render the file options
        """
        status_string = ""
        if not self.file_info:
            return status_string
        if self.file_info.is_file:
            file_size = self._convert_size(self.file_info.size)
            status_string += f"  🗄️️  {file_size}"
        if self.file_info.owner not in ["", None]:
            status_string += f"  👤  {self.file_info.owner}"
        if self.file_info.group.strip() not in ["", None]:
            status_string += f"  🏠  {self.file_info.group}"
        return status_string

    def render_directory_options(self) -> str:
        """
        Render the directory options
        """
        status_string = ""
        if not self.file_info:
            return status_string
        if self.file_info.is_file:
            directory_name = self.file_info.file.parent.name
            if not directory_name or (
                self.file_info.file.protocol
                and f"{self.file_info.file.protocol}://" in directory_name
            ):
                directory_name = str(self.file_info.file.parent)
                directory_name = directory_name.lstrip(
                    f"{self.file_info.file.protocol}://"
                )
                directory_name = directory_name.rstrip("/")
            status_string += f"  📂  {directory_name}"
            status_string += f"  💾  {self.file_info.file.name}"
        else:
            status_string += f"  📂  {self.file_info.file.name}"
        return status_string

    def render_file_protocol(self) -> str:
        """
        Render the file protocol
        """
        status_string = ""
        if not self.file_info:
            return status_string
        if is_remote_path(self.file_info.file):
            if isinstance(self.file_info.file, GitHubTextualPath):
                protocol = "GitHub"
            elif isinstance(self.file_info.file, S3TextualPath):
                protocol = "S3"
            elif isinstance(self.file_info.file, SFTPTextualPath):
                protocol = "SFTP"
            else:
                protocol = self.file_info.file.protocol
            status_string += f"🗂️  {protocol}"
        return status_string

FileInfoUpdate #

Bases: Message

File Info Bar Update

Source code in browsr/widgets/files.py 
29
30
31
32
33
34
35
36
class FileInfoUpdate(Message):
    """
    File Info Bar Update
    """

    def __init__(self, new_file: FileInfo | None) -> None:
        self.new_file = new_file
        super().__init__()

_convert_size(size_bytes) classmethod #

Convert Bytes to Human Readable String

Source code in browsr/widgets/files.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
@classmethod
def _convert_size(cls, size_bytes: int) -> str:
    """
    Convert Bytes to Human Readable String
    """
    if size_bytes == 0:
        return " 0B"
    size_name = ("B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB")
    index = int(math.floor(math.log(size_bytes, 1024)))
    p = math.pow(1024, index)
    number = round(size_bytes / p, 2)
    unit = size_name[index]
    return f"{number:.0f}{unit}"

render() #

Render the Current File Info Bar

Source code in browsr/widgets/files.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def render(self) -> RenderableType:
    """
    Render the Current File Info Bar
    """
    status_string = self.render_file_protocol()
    if self.file_info is None:
        return Text(status_string)
    elif self.file_info.is_file:
        file_options = self.render_file_options()
        status_string += file_options
    if (
        self.file_info.last_modified is not None
        and self.file_info.last_modified.timestamp() != 0
    ):
        modify_time = self.file_info.last_modified.strftime("%b %d, %Y %I:%M %p")
        status_string += f"  📅  {modify_time}"
    directory_options = self.render_directory_options()
    status_string += directory_options
    return Text(status_string.strip(), style="dim")

render_directory_options() #

Render the directory options

Source code in browsr/widgets/files.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def render_directory_options(self) -> str:
    """
    Render the directory options
    """
    status_string = ""
    if not self.file_info:
        return status_string
    if self.file_info.is_file:
        directory_name = self.file_info.file.parent.name
        if not directory_name or (
            self.file_info.file.protocol
            and f"{self.file_info.file.protocol}://" in directory_name
        ):
            directory_name = str(self.file_info.file.parent)
            directory_name = directory_name.lstrip(
                f"{self.file_info.file.protocol}://"
            )
            directory_name = directory_name.rstrip("/")
        status_string += f"  📂  {directory_name}"
        status_string += f"  💾  {self.file_info.file.name}"
    else:
        status_string += f"  📂  {self.file_info.file.name}"
    return status_string

render_file_options() #

Render the file options

Source code in browsr/widgets/files.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def render_file_options(self) -> str:
    """
    Render the file options
    """
    status_string = ""
    if not self.file_info:
        return status_string
    if self.file_info.is_file:
        file_size = self._convert_size(self.file_info.size)
        status_string += f"  🗄️️  {file_size}"
    if self.file_info.owner not in ["", None]:
        status_string += f"  👤  {self.file_info.owner}"
    if self.file_info.group.strip() not in ["", None]:
        status_string += f"  🏠  {self.file_info.group}"
    return status_string

render_file_protocol() #

Render the file protocol

Source code in browsr/widgets/files.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def render_file_protocol(self) -> str:
    """
    Render the file protocol
    """
    status_string = ""
    if not self.file_info:
        return status_string
    if is_remote_path(self.file_info.file):
        if isinstance(self.file_info.file, GitHubTextualPath):
            protocol = "GitHub"
        elif isinstance(self.file_info.file, S3TextualPath):
            protocol = "S3"
        elif isinstance(self.file_info.file, SFTPTextualPath):
            protocol = "SFTP"
        else:
            protocol = self.file_info.file.protocol
        status_string += f"🗂️  {protocol}"
    return status_string

watch_file_info(new_file) #

Watch the file_info property for changes

Source code in browsr/widgets/files.py 
38
39
40
41
42
43
44
45
def watch_file_info(self, new_file: FileInfo | None) -> None:
    """
    Watch the file_info property for changes
    """
    if new_file is None:
        self.display = False
    else:
        self.display = True