Skip to content

code_browser

The Primary Content Container

CodeBrowser #

Bases: Container

The Code Browser

This container contains the primary content of the application:

  • Universal Directory Tree
  • Space to view the selected file:
    • Code
    • Table
    • Image
    • Exceptions
Source code in browsr/widgets/code_browser.py 
 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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
class CodeBrowser(Container):
    """
    The Code Browser

    This container contains the primary content of the application:

    - Universal Directory Tree
    - Space to view the selected file:
        - Code
        - Table
        - Image
        - Exceptions
    """

    theme_index = var(0)
    rich_themes = favorite_themes
    show_tree = var(True)
    force_show_tree = var(False)
    selected_file_path: UPath | None | var[None] = var(None)

    hidden_table_view = var(False)
    table_view_status = var(False)
    static_window_status = var(False)

    def __init__(
        self,
        config_object: TextualAppContext,
        *args: Any,
        **kwargs: Any,
    ) -> None:
        """
        Initialize the Browsr Renderer
        """
        super().__init__(*args, **kwargs)
        self.config_object = config_object
        # Path Handling
        file_path = self.config_object.path
        if not file_path.exists():
            msg = f"Unknown File Path: {file_path}"
            raise FileNotFoundError(msg)
        elif file_path.is_file():
            self.selected_file_path = file_path
            file_path = file_path.parent
        elif file_path.is_dir() and file_path.joinpath("README.md").exists():
            self.selected_file_path = file_path.joinpath("README.md")
            self.force_show_tree = True
        self.initial_file_path = file_path
        self.directory_tree = BrowsrDirectoryTree(file_path, id="tree-view")
        self.window_switcher = WindowSwitcher(config_object=self.config_object)
        self.confirmation = ConfirmationPopUp()
        self.confirmation_window = ConfirmationWindow(
            self.confirmation, id="confirmation-container"
        )
        self.confirmation_window.display = False
        # Copy Pasting
        self._copy_function = pyperclip.determine_clipboard()[0]
        self._copy_supported = inspect.isfunction(self._copy_function)

    @property
    def datatable_window(self) -> DataTableWindow:
        """
        Get the datatable window
        """
        return self.window_switcher.datatable_window

    @property
    def static_window(self) -> StaticWindow:
        """
        Get the static window
        """
        return self.window_switcher.static_window

    def compose(self) -> ComposeResult:
        """
        Compose the content of the container
        """
        yield self.directory_tree
        yield self.window_switcher
        yield self.confirmation_window

    @on(Mount)
    def bind_keys(self) -> None:
        """
        Bind Keys
        """
        if self._copy_supported:
            self.app.bind(
                keys="c", action="copy_file_path", description="Copy Path", show=True
            )
        if is_remote_path(self.initial_file_path):
            self.app.bind(
                keys="x", action="download_file", description="Download File", show=True
            )

    def watch_show_tree(self, show_tree: bool) -> None:
        """
        Called when show_tree is modified.
        """
        self.set_class(show_tree, "-show-tree")

    def copy_file_path(self) -> None:
        """
        Copy the file path to the clipboard.
        """
        if self.selected_file_path and self._copy_supported:
            self._copy_function(str(self.selected_file_path))
            self.notify(
                message=f"{self.selected_file_path}",
                title="Copied to Clipboard",
                severity="information",
                timeout=1,
            )

    @on(ConfirmationPopUp.ConfirmationWindowDownload)
    def handle_download_confirmation(
        self, _: ConfirmationPopUp.ConfirmationWindowDownload
    ) -> None:
        """
        Handle the download confirmation.
        """
        self.download_selected_file()

    @on(ConfirmationPopUp.DisplayToggle)
    def handle_table_view_display_toggle(
        self, _: ConfirmationPopUp.DisplayToggle
    ) -> None:
        """
        Handle the table view display toggle.
        """
        self.datatable_window.display = self.table_view_status
        self.window_switcher.vim_scroll.display = self.static_window_status

    @on(DirectoryTree.FileSelected)
    def handle_file_selected(self, message: DirectoryTree.FileSelected) -> None:
        """
        Called when the user click a file in the directory tree.
        """
        self.selected_file_path = message.path
        file_info = get_file_info(file_path=self.selected_file_path)
        try:
            self.static_window.handle_file_size(
                file_info=file_info, max_file_size=self.config_object.max_file_size
            )
            self.window_switcher.render_file(file_path=self.selected_file_path)
        except FileSizeError as e:
            error_message = self.static_window.handle_exception(exception=e)
            error_syntax = self.static_window.text_to_syntax(
                text=error_message, file_path=self.selected_file_path
            )
            self.static_window.update(error_syntax)
            self.window_switcher.switch_window(self.static_window)
        self.post_message(CurrentFileInfoBar.FileInfoUpdate(new_file=file_info))

    @on(DoubleClickDirectoryTree.DirectoryDoubleClicked)
    def handle_directory_double_click(
        self, message: DoubleClickDirectoryTree.DirectoryDoubleClicked
    ) -> None:
        """
        Called when the user double clicks a directory in the directory tree.
        """
        self.directory_tree.path = message.path
        self.notify(
            title="Directory Changed",
            message=str(message.path),
            severity="information",
            timeout=1,
        )

    @on(DoubleClickDirectoryTree.FileDoubleClicked)
    def handle_file_double_click(
        self, message: DoubleClickDirectoryTree.FileDoubleClicked
    ) -> None:
        """
        Called when the user double clicks a file in the directory tree.
        """
        if self._copy_supported:
            self._copy_function(str(message.path))
            self.notify(
                message=f"{message.path}",
                title="Copied to Clipboard",
                severity="information",
                timeout=1,
            )

    def download_file_workflow(self) -> None:
        """
        Download the selected file.
        """
        if self.selected_file_path is None:
            return
        elif self.selected_file_path.is_dir():
            return
        elif is_remote_path(self.selected_file_path):
            handled_download_path = self._get_download_file_name()
            prompt_message: str = dedent(
                f"""
                ## File Download

                **Are you sure you want to download that file?**

                **File:** `{self.selected_file_path}`

                **Path:** `{handled_download_path}`
                """
            )
            self.confirmation.download_message.update(Markdown(prompt_message))
            self.confirmation.refresh()
            self.table_view_status = self.datatable_window.display
            self.static_window_status = self.window_switcher.vim_scroll.display
            self.datatable_window.display = False
            self.window_switcher.vim_scroll.display = False
            self.confirmation_window.display = True

    @work(thread=True)
    def download_selected_file(self) -> None:
        """
        Download the selected file.
        """
        if self.selected_file_path is None:
            return
        elif self.selected_file_path.is_dir():
            return
        elif is_remote_path(self.selected_file_path):
            handled_download_path = self._get_download_file_name()
            with self.selected_file_path.open("rb") as file_handle:
                with handled_download_path.open("wb") as download_handle:
                    shutil.copyfileobj(file_handle, download_handle)
            self.notify(
                message=str(handled_download_path),
                title="Download Complete",
                severity="information",
                timeout=2,
            )

    def _get_download_file_name(self) -> UPath:
        """
        Get the download file name.
        """
        download_dir = pathlib.Path.home() / "Downloads"
        if not download_dir.exists():
            msg = f"Download directory {download_dir} not found"
            raise FileNotFoundError(msg)
        download_path = download_dir / self.selected_file_path.name  # type: ignore[union-attr]
        handled_download_path = handle_duplicate_filenames(file_path=download_path)
        return handled_download_path

datatable_window: DataTableWindow property #

Get the datatable window

static_window: StaticWindow property #

Get the static window

__init__(config_object, *args, **kwargs) #

Initialize the Browsr Renderer

Source code in browsr/widgets/code_browser.py 
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
def __init__(
    self,
    config_object: TextualAppContext,
    *args: Any,
    **kwargs: Any,
) -> None:
    """
    Initialize the Browsr Renderer
    """
    super().__init__(*args, **kwargs)
    self.config_object = config_object
    # Path Handling
    file_path = self.config_object.path
    if not file_path.exists():
        msg = f"Unknown File Path: {file_path}"
        raise FileNotFoundError(msg)
    elif file_path.is_file():
        self.selected_file_path = file_path
        file_path = file_path.parent
    elif file_path.is_dir() and file_path.joinpath("README.md").exists():
        self.selected_file_path = file_path.joinpath("README.md")
        self.force_show_tree = True
    self.initial_file_path = file_path
    self.directory_tree = BrowsrDirectoryTree(file_path, id="tree-view")
    self.window_switcher = WindowSwitcher(config_object=self.config_object)
    self.confirmation = ConfirmationPopUp()
    self.confirmation_window = ConfirmationWindow(
        self.confirmation, id="confirmation-container"
    )
    self.confirmation_window.display = False
    # Copy Pasting
    self._copy_function = pyperclip.determine_clipboard()[0]
    self._copy_supported = inspect.isfunction(self._copy_function)

_get_download_file_name() #

Get the download file name.

Source code in browsr/widgets/code_browser.py 
276
277
278
279
280
281
282
283
284
285
286
def _get_download_file_name(self) -> UPath:
    """
    Get the download file name.
    """
    download_dir = pathlib.Path.home() / "Downloads"
    if not download_dir.exists():
        msg = f"Download directory {download_dir} not found"
        raise FileNotFoundError(msg)
    download_path = download_dir / self.selected_file_path.name  # type: ignore[union-attr]
    handled_download_path = handle_duplicate_filenames(file_path=download_path)
    return handled_download_path

bind_keys() #

Bind Keys

Source code in browsr/widgets/code_browser.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
@on(Mount)
def bind_keys(self) -> None:
    """
    Bind Keys
    """
    if self._copy_supported:
        self.app.bind(
            keys="c", action="copy_file_path", description="Copy Path", show=True
        )
    if is_remote_path(self.initial_file_path):
        self.app.bind(
            keys="x", action="download_file", description="Download File", show=True
        )

compose() #

Compose the content of the container

Source code in browsr/widgets/code_browser.py 
114
115
116
117
118
119
120
def compose(self) -> ComposeResult:
    """
    Compose the content of the container
    """
    yield self.directory_tree
    yield self.window_switcher
    yield self.confirmation_window

copy_file_path() #

Copy the file path to the clipboard.

Source code in browsr/widgets/code_browser.py 
142
143
144
145
146
147
148
149
150
151
152
153
def copy_file_path(self) -> None:
    """
    Copy the file path to the clipboard.
    """
    if self.selected_file_path and self._copy_supported:
        self._copy_function(str(self.selected_file_path))
        self.notify(
            message=f"{self.selected_file_path}",
            title="Copied to Clipboard",
            severity="information",
            timeout=1,
        )

download_file_workflow() #

Download the selected file.

Source code in browsr/widgets/code_browser.py 
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
def download_file_workflow(self) -> None:
    """
    Download the selected file.
    """
    if self.selected_file_path is None:
        return
    elif self.selected_file_path.is_dir():
        return
    elif is_remote_path(self.selected_file_path):
        handled_download_path = self._get_download_file_name()
        prompt_message: str = dedent(
            f"""
            ## File Download

            **Are you sure you want to download that file?**

            **File:** `{self.selected_file_path}`

            **Path:** `{handled_download_path}`
            """
        )
        self.confirmation.download_message.update(Markdown(prompt_message))
        self.confirmation.refresh()
        self.table_view_status = self.datatable_window.display
        self.static_window_status = self.window_switcher.vim_scroll.display
        self.datatable_window.display = False
        self.window_switcher.vim_scroll.display = False
        self.confirmation_window.display = True

download_selected_file() #

Download the selected file.

Source code in browsr/widgets/code_browser.py 
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
@work(thread=True)
def download_selected_file(self) -> None:
    """
    Download the selected file.
    """
    if self.selected_file_path is None:
        return
    elif self.selected_file_path.is_dir():
        return
    elif is_remote_path(self.selected_file_path):
        handled_download_path = self._get_download_file_name()
        with self.selected_file_path.open("rb") as file_handle:
            with handled_download_path.open("wb") as download_handle:
                shutil.copyfileobj(file_handle, download_handle)
        self.notify(
            message=str(handled_download_path),
            title="Download Complete",
            severity="information",
            timeout=2,
        )

handle_directory_double_click(message) #

Called when the user double clicks a directory in the directory tree.

Source code in browsr/widgets/code_browser.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
@on(DoubleClickDirectoryTree.DirectoryDoubleClicked)
def handle_directory_double_click(
    self, message: DoubleClickDirectoryTree.DirectoryDoubleClicked
) -> None:
    """
    Called when the user double clicks a directory in the directory tree.
    """
    self.directory_tree.path = message.path
    self.notify(
        title="Directory Changed",
        message=str(message.path),
        severity="information",
        timeout=1,
    )

handle_download_confirmation(_) #

Handle the download confirmation.

Source code in browsr/widgets/code_browser.py 
155
156
157
158
159
160
161
162
@on(ConfirmationPopUp.ConfirmationWindowDownload)
def handle_download_confirmation(
    self, _: ConfirmationPopUp.ConfirmationWindowDownload
) -> None:
    """
    Handle the download confirmation.
    """
    self.download_selected_file()

handle_file_double_click(message) #

Called when the user double clicks a file in the directory tree.

Source code in browsr/widgets/code_browser.py 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
@on(DoubleClickDirectoryTree.FileDoubleClicked)
def handle_file_double_click(
    self, message: DoubleClickDirectoryTree.FileDoubleClicked
) -> None:
    """
    Called when the user double clicks a file in the directory tree.
    """
    if self._copy_supported:
        self._copy_function(str(message.path))
        self.notify(
            message=f"{message.path}",
            title="Copied to Clipboard",
            severity="information",
            timeout=1,
        )

handle_file_selected(message) #

Called when the user click a file in the directory tree.

Source code in browsr/widgets/code_browser.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
@on(DirectoryTree.FileSelected)
def handle_file_selected(self, message: DirectoryTree.FileSelected) -> None:
    """
    Called when the user click a file in the directory tree.
    """
    self.selected_file_path = message.path
    file_info = get_file_info(file_path=self.selected_file_path)
    try:
        self.static_window.handle_file_size(
            file_info=file_info, max_file_size=self.config_object.max_file_size
        )
        self.window_switcher.render_file(file_path=self.selected_file_path)
    except FileSizeError as e:
        error_message = self.static_window.handle_exception(exception=e)
        error_syntax = self.static_window.text_to_syntax(
            text=error_message, file_path=self.selected_file_path
        )
        self.static_window.update(error_syntax)
        self.window_switcher.switch_window(self.static_window)
    self.post_message(CurrentFileInfoBar.FileInfoUpdate(new_file=file_info))

handle_table_view_display_toggle(_) #

Handle the table view display toggle.

Source code in browsr/widgets/code_browser.py 
164
165
166
167
168
169
170
171
172
@on(ConfirmationPopUp.DisplayToggle)
def handle_table_view_display_toggle(
    self, _: ConfirmationPopUp.DisplayToggle
) -> None:
    """
    Handle the table view display toggle.
    """
    self.datatable_window.display = self.table_view_status
    self.window_switcher.vim_scroll.display = self.static_window_status

watch_show_tree(show_tree) #

Called when show_tree is modified.

Source code in browsr/widgets/code_browser.py 
136
137
138
139
140
def watch_show_tree(self, show_tree: bool) -> None:
    """
    Called when show_tree is modified.
    """
    self.set_class(show_tree, "-show-tree")