Skip to content

browsr

Browsr TUI App

This module contains the code browser app for the browsr package. This app was inspired by the CodeBrowser example from textual

Browsr #

Bases: SortedBindingsApp

Textual code browser app.

Source code in browsr/browsr.py 
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
class Browsr(SortedBindingsApp):
    """
    Textual code browser app.
    """

    TITLE = __application__
    CSS_PATH = "browsr.css"
    BINDINGS: ClassVar[list[BindingType]] = [
        Binding(key="q", action="quit", description="Quit"),
        Binding(key="d", action="toggle_dark", description="Dark Mode"),
    ]
    BINDING_WEIGHTS: ClassVar[dict[str, int]] = {
        "ctrl+c": 1,
        "q": 2,
        "f": 3,
        "t": 4,
        "n": 5,
        "d": 6,
        "r": 995,
        ".": 996,
        "c": 997,
        "x": 998,
    }

    def __init__(
        self,
        config_object: TextualAppContext | None = None,
        *args: Any,
        **kwargs: Any,
    ) -> None:
        """
        Like the textual.app.App class, but with an extra config_object property

        Parameters
        ----------
        config_object: Optional[TextualAppContext]
            A configuration object. This is an optional python object,
            like a dictionary to pass into an application
        """
        super().__init__(*args, **kwargs)
        self.config_object = config_object or TextualAppContext()
        self.code_browser_screen = CodeBrowserScreen(config_object=self.config_object)
        self.install_screen(self.code_browser_screen, name="code-browser")

    @on(Mount)
    async def mount_screen(self) -> None:
        """
        Mount the screen
        """
        await self.push_screen(screen=self.code_browser_screen)

    def action_copy_file_path(self) -> None:
        """
        Copy the file path to the clipboard
        """
        self.code_browser_screen.code_browser.copy_file_path()

    def action_download_file(self) -> None:
        """
        Copy the file path to the clipboard
        """
        self.code_browser_screen.code_browser.download_file_workflow()

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

Like the textual.app.App class, but with an extra config_object property

Parameters:

Name Type Description Default
config_object TextualAppContext | None

A configuration object. This is an optional python object, like a dictionary to pass into an application

 None
Source code in browsr/browsr.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def __init__(
    self,
    config_object: TextualAppContext | None = None,
    *args: Any,
    **kwargs: Any,
) -> None:
    """
    Like the textual.app.App class, but with an extra config_object property

    Parameters
    ----------
    config_object: Optional[TextualAppContext]
        A configuration object. This is an optional python object,
        like a dictionary to pass into an application
    """
    super().__init__(*args, **kwargs)
    self.config_object = config_object or TextualAppContext()
    self.code_browser_screen = CodeBrowserScreen(config_object=self.config_object)
    self.install_screen(self.code_browser_screen, name="code-browser")

action_copy_file_path() #

Copy the file path to the clipboard

Source code in browsr/browsr.py 
77
78
79
80
81
def action_copy_file_path(self) -> None:
    """
    Copy the file path to the clipboard
    """
    self.code_browser_screen.code_browser.copy_file_path()

action_download_file() #

Copy the file path to the clipboard

Source code in browsr/browsr.py 
83
84
85
86
87
def action_download_file(self) -> None:
    """
    Copy the file path to the clipboard
    """
    self.code_browser_screen.code_browser.download_file_workflow()

mount_screen() async #

Mount the screen

Source code in browsr/browsr.py 
70
71
72
73
74
75
@on(Mount)
async def mount_screen(self) -> None:
    """
    Mount the screen
    """
    await self.push_screen(screen=self.code_browser_screen)