Skip to content

code_browser

The App Screen

CodeBrowserScreen #

Bases: Screen

Code Browser Screen

Source code in browsr/screens/code_browser.py 
 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
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
class CodeBrowserScreen(Screen):
    """
    Code Browser Screen
    """

    BINDINGS: ClassVar[list[BindingType]] = [
        Binding(key="f", action="toggle_files", description="Files"),
        Binding(key="t", action="theme", description="Theme"),
        Binding(key="n", action="linenos", description="Line Numbers"),
        Binding(key="r", action="reload", description="Reload"),
        Binding(key=".", action="parent_dir", description="Parent Directory"),
    ]

    def __init__(
        self,
        config_object: TextualAppContext | None = None,
    ) -> 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__()
        self.config_object = config_object or TextualAppContext()
        traceback.install(show_locals=True)
        self.header = Header()
        self.code_browser = CodeBrowser(config_object=self.config_object)
        self.file_information = CurrentFileInfoBar()
        self.info_bar = Horizontal(
            self.file_information,
            id="file-info-bar",
        )
        if self.code_browser.selected_file_path is not None:
            self.file_information.file_info = get_file_info(
                file_path=self.code_browser.selected_file_path
            )
        else:
            self.file_information.file_info = get_file_info(self.config_object.path)
        self.footer = Footer()

    def compose(self) -> Iterable[Widget]:
        """
        Compose our UI.
        """
        yield self.header
        yield self.code_browser
        yield self.info_bar
        yield self.footer

    @on(Mount)
    def start_up_app(self) -> None:
        """
        On Application Mount - See If a File Should be Displayed
        """
        if self.code_browser.selected_file_path is not None:
            self.code_browser.show_tree = self.code_browser.force_show_tree
            self.code_browser.window_switcher.render_file(
                file_path=self.code_browser.selected_file_path
            )
            if (
                self.code_browser.show_tree is False
                and self.code_browser.static_window.display is True
            ):
                self.code_browser.window_switcher.focus()
            elif (
                self.code_browser.show_tree is False
                and self.code_browser.datatable_window.display is True
            ):
                self.code_browser.datatable_window.focus()
        else:
            self.code_browser.show_tree = True

    @on(CurrentFileInfoBar.FileInfoUpdate)
    def update_file_info(self, message: CurrentFileInfoBar.FileInfoUpdate) -> None:
        """
        Update the file_info property
        """
        self.file_information.file_info = message.new_file

    def action_toggle_files(self) -> None:
        """
        Called in response to key binding.
        """
        self.code_browser.show_tree = not self.code_browser.show_tree

    def action_parent_dir(self) -> None:
        """
        Go to the parent directory
        """
        directory_tree_open = self.code_browser.has_class("-show-tree")
        if not directory_tree_open:
            return
        if (
            self.code_browser.directory_tree.path
            != self.code_browser.directory_tree.path.parent
        ):
            self.code_browser.directory_tree.path = (
                self.code_browser.directory_tree.path.parent
            )
            self.notify(
                title="Directory Changed",
                message=str(self.code_browser.directory_tree.path),
                severity="information",
                timeout=1,
            )

    def action_theme(self) -> None:
        """
        An action to toggle rich theme.
        """
        self.code_browser.window_switcher.next_theme()

    def action_linenos(self) -> None:
        """
        An action to toggle line numbers.
        """
        if self.code_browser.selected_file_path is None:
            return
        self.code_browser.static_window.linenos = (
            not self.code_browser.static_window.linenos
        )

    def action_reload(self) -> None:
        """
        Refresh the directory and file
        """
        reload_file = self.code_browser.selected_file_path is not None
        reload_directory = self.code_browser.has_class("-show-tree")
        message_lines = []
        if reload_directory:
            self.code_browser.directory_tree.reload()
            directory_name = self.code_browser.directory_tree.path.name or "/"
            message_lines.append(
                "[bold]Directory:[/bold] " f"[italic]{directory_name}[/italic]"
            )
        if reload_file:
            selected_file_path = cast(UPath, self.code_browser.selected_file_path)
            file_name = selected_file_path.name
            self.code_browser.window_switcher.render_file(
                file_path=selected_file_path,
                scroll_home=False,
            )
            message_lines.append("[bold]File:[/bold] " f"[italic]{file_name}[/italic]")
        if message_lines:
            self.notify(
                title="Reloaded",
                message="\n".join(message_lines),
                severity="information",
                timeout=1,
            )

__init__(config_object=None) #

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/screens/code_browser.py 
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
def __init__(
    self,
    config_object: TextualAppContext | None = None,
) -> 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__()
    self.config_object = config_object or TextualAppContext()
    traceback.install(show_locals=True)
    self.header = Header()
    self.code_browser = CodeBrowser(config_object=self.config_object)
    self.file_information = CurrentFileInfoBar()
    self.info_bar = Horizontal(
        self.file_information,
        id="file-info-bar",
    )
    if self.code_browser.selected_file_path is not None:
        self.file_information.file_info = get_file_info(
            file_path=self.code_browser.selected_file_path
        )
    else:
        self.file_information.file_info = get_file_info(self.config_object.path)
    self.footer = Footer()

action_linenos() #

An action to toggle line numbers.

Source code in browsr/screens/code_browser.py 
141
142
143
144
145
146
147
148
149
def action_linenos(self) -> None:
    """
    An action to toggle line numbers.
    """
    if self.code_browser.selected_file_path is None:
        return
    self.code_browser.static_window.linenos = (
        not self.code_browser.static_window.linenos
    )

action_parent_dir() #

Go to the parent directory

Source code in browsr/screens/code_browser.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def action_parent_dir(self) -> None:
    """
    Go to the parent directory
    """
    directory_tree_open = self.code_browser.has_class("-show-tree")
    if not directory_tree_open:
        return
    if (
        self.code_browser.directory_tree.path
        != self.code_browser.directory_tree.path.parent
    ):
        self.code_browser.directory_tree.path = (
            self.code_browser.directory_tree.path.parent
        )
        self.notify(
            title="Directory Changed",
            message=str(self.code_browser.directory_tree.path),
            severity="information",
            timeout=1,
        )

action_reload() #

Refresh the directory and file

Source code in browsr/screens/code_browser.py 
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
def action_reload(self) -> None:
    """
    Refresh the directory and file
    """
    reload_file = self.code_browser.selected_file_path is not None
    reload_directory = self.code_browser.has_class("-show-tree")
    message_lines = []
    if reload_directory:
        self.code_browser.directory_tree.reload()
        directory_name = self.code_browser.directory_tree.path.name or "/"
        message_lines.append(
            "[bold]Directory:[/bold] " f"[italic]{directory_name}[/italic]"
        )
    if reload_file:
        selected_file_path = cast(UPath, self.code_browser.selected_file_path)
        file_name = selected_file_path.name
        self.code_browser.window_switcher.render_file(
            file_path=selected_file_path,
            scroll_home=False,
        )
        message_lines.append("[bold]File:[/bold] " f"[italic]{file_name}[/italic]")
    if message_lines:
        self.notify(
            title="Reloaded",
            message="\n".join(message_lines),
            severity="information",
            timeout=1,
        )

action_theme() #

An action to toggle rich theme.

Source code in browsr/screens/code_browser.py 
135
136
137
138
139
def action_theme(self) -> None:
    """
    An action to toggle rich theme.
    """
    self.code_browser.window_switcher.next_theme()

action_toggle_files() #

Called in response to key binding.

Source code in browsr/screens/code_browser.py 
108
109
110
111
112
def action_toggle_files(self) -> None:
    """
    Called in response to key binding.
    """
    self.code_browser.show_tree = not self.code_browser.show_tree

compose() #

Compose our UI.

Source code in browsr/screens/code_browser.py 
69
70
71
72
73
74
75
76
def compose(self) -> Iterable[Widget]:
    """
    Compose our UI.
    """
    yield self.header
    yield self.code_browser
    yield self.info_bar
    yield self.footer

start_up_app() #

On Application Mount - See If a File Should be Displayed

Source code in browsr/screens/code_browser.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@on(Mount)
def start_up_app(self) -> None:
    """
    On Application Mount - See If a File Should be Displayed
    """
    if self.code_browser.selected_file_path is not None:
        self.code_browser.show_tree = self.code_browser.force_show_tree
        self.code_browser.window_switcher.render_file(
            file_path=self.code_browser.selected_file_path
        )
        if (
            self.code_browser.show_tree is False
            and self.code_browser.static_window.display is True
        ):
            self.code_browser.window_switcher.focus()
        elif (
            self.code_browser.show_tree is False
            and self.code_browser.datatable_window.display is True
        ):
            self.code_browser.datatable_window.focus()
    else:
        self.code_browser.show_tree = True

update_file_info(message) #

Update the file_info property

Source code in browsr/screens/code_browser.py 
101
102
103
104
105
106
@on(CurrentFileInfoBar.FileInfoUpdate)
def update_file_info(self, message: CurrentFileInfoBar.FileInfoUpdate) -> None:
    """
    Update the file_info property
    """
    self.file_information.file_info = message.new_file