windows

Content Windows

BaseCodeWindow

Bases: Widget

Base code view widget

Source code in browsr/widgets/windows.py

class BaseCodeWindow(Widget):
    """
    Base code view widget
    """

    archive_extensions: ClassVar[list[str]] = [".tar", ".gz", ".zip", ".tgz"]

    class WindowSwitch(Message):
        """
        Switch to the window
        """

        def __init__(self, window: type[BaseCodeWindow], scroll_home: bool = False):
            self.window: type[BaseCodeWindow] = window
            self.scroll_home: bool = scroll_home
            super().__init__()

    def file_to_string(self, file_path: UPath, max_lines: int | None = None) -> str:
        """
        Load a file into a string
        """
        try:
            if file_path.suffix in self.archive_extensions:
                message = f"Cannot render archive file {file_path}."
                raise ArchiveFileError(message)
            text = file_path.read_text(encoding="utf-8")
        except Exception as e:
            text = self.handle_exception(exception=e)
        if max_lines:
            text = "\n".join(text.split("\n")[:max_lines])
        return text

    def file_to_image(self, file_path: UPath) -> Pixels:
        """
        Load a file into an image
        """
        screen_width = self.app.size.width / 4
        content = open_image(document=file_path, screen_width=screen_width)
        return content

    def file_to_json(self, file_path: UPath, max_lines: int | None = None) -> str:
        """
        Load a file into a JSON object
        """
        code_str = self.file_to_string(file_path=file_path)
        try:
            code_obj = json.loads(code_str)
            code_str = json.dumps(code_obj, indent=2)
        except JSONDecodeError:
            pass
        if max_lines:
            code_str = "\n".join(code_str.split("\n")[:max_lines])
        return code_str

    @classmethod
    def handle_file_size(cls, file_info: FileInfo, max_file_size: int = 5) -> None:
        """
        Handle a File Size
        """
        file_size_mb = file_info.size / 1000 / 1000
        too_large = file_size_mb >= max_file_size
        if too_large:
            raise FileSizeError("File too large")

    @classmethod
    def handle_exception(cls, exception: Exception) -> str:
        """
        Handle an exception

        This method is used to handle exceptions that occur when rendering a file.
        When an uncommon exception occurs, the method will raise the exception.

        Parameters
        ----------
        exception: Exception
            The exception that occurred.

        Raises
        ------
        Exception
            If the exception is not one of the expected exceptions.

        Returns
        -------
        str
            The error message to display.
        """
        font = "univers"
        if isinstance(exception, ArchiveFileError):
            error_message = (
                text2art("ARCHIVE", font=font) + "\n\n" + text2art("FILE", font=font)
            )
        elif isinstance(exception, FileSizeError):
            error_message = (
                text2art("FILE TOO", font=font) + "\n\n" + text2art("LARGE", font=font)
            )
        elif isinstance(exception, PermissionError):
            error_message = (
                text2art("PERMISSION", font=font)
                + "\n\n"
                + text2art("ERROR", font=font)
            )
        elif isinstance(exception, UnicodeError):
            error_message = (
                text2art("ENCODING", font=font) + "\n\n" + text2art("ERROR", font=font)
            )
        elif isinstance(exception, FileNotFoundError):
            error_message = (
                text2art("FILE NOT", font=font) + "\n\n" + text2art("FOUND", font=font)
            )
        else:
            raise exception from exception
        return error_message

WindowSwitch

Bases: Message

Switch to the window

Source code in browsr/widgets/windows.py

class WindowSwitch(Message):
    """
    Switch to the window
    """

    def __init__(self, window: type[BaseCodeWindow], scroll_home: bool = False):
        self.window: type[BaseCodeWindow] = window
        self.scroll_home: bool = scroll_home
        super().__init__()

file_to_image(file_path)

Load a file into an image

Source code in browsr/widgets/windows.py

def file_to_image(self, file_path: UPath) -> Pixels:
    """
    Load a file into an image
    """
    screen_width = self.app.size.width / 4
    content = open_image(document=file_path, screen_width=screen_width)
    return content

file_to_json(file_path, max_lines=None)

Load a file into a JSON object

Source code in browsr/widgets/windows.py

def file_to_json(self, file_path: UPath, max_lines: int | None = None) -> str:
    """
    Load a file into a JSON object
    """
    code_str = self.file_to_string(file_path=file_path)
    try:
        code_obj = json.loads(code_str)
        code_str = json.dumps(code_obj, indent=2)
    except JSONDecodeError:
        pass
    if max_lines:
        code_str = "\n".join(code_str.split("\n")[:max_lines])
    return code_str

file_to_string(file_path, max_lines=None)

Load a file into a string

Source code in browsr/widgets/windows.py

def file_to_string(self, file_path: UPath, max_lines: int | None = None) -> str:
    """
    Load a file into a string
    """
    try:
        if file_path.suffix in self.archive_extensions:
            message = f"Cannot render archive file {file_path}."
            raise ArchiveFileError(message)
        text = file_path.read_text(encoding="utf-8")
    except Exception as e:
        text = self.handle_exception(exception=e)
    if max_lines:
        text = "\n".join(text.split("\n")[:max_lines])
    return text

handle_exception(exception) classmethod

Handle an exception

This method is used to handle exceptions that occur when rendering a file. When an uncommon exception occurs, the method will raise the exception.

Parameters:

Name	Type	Description	Default
exception	Exception	The exception that occurred.	required

Raises:

Type	Description
Exception	If the exception is not one of the expected exceptions.

Returns:

Type	Description
str	The error message to display.

Source code in browsr/widgets/windows.py

@classmethod
def handle_exception(cls, exception: Exception) -> str:
    """
    Handle an exception

    This method is used to handle exceptions that occur when rendering a file.
    When an uncommon exception occurs, the method will raise the exception.

    Parameters
    ----------
    exception: Exception
        The exception that occurred.

    Raises
    ------
    Exception
        If the exception is not one of the expected exceptions.

    Returns
    -------
    str
        The error message to display.
    """
    font = "univers"
    if isinstance(exception, ArchiveFileError):
        error_message = (
            text2art("ARCHIVE", font=font) + "\n\n" + text2art("FILE", font=font)
        )
    elif isinstance(exception, FileSizeError):
        error_message = (
            text2art("FILE TOO", font=font) + "\n\n" + text2art("LARGE", font=font)
        )
    elif isinstance(exception, PermissionError):
        error_message = (
            text2art("PERMISSION", font=font)
            + "\n\n"
            + text2art("ERROR", font=font)
        )
    elif isinstance(exception, UnicodeError):
        error_message = (
            text2art("ENCODING", font=font) + "\n\n" + text2art("ERROR", font=font)
        )
    elif isinstance(exception, FileNotFoundError):
        error_message = (
            text2art("FILE NOT", font=font) + "\n\n" + text2art("FOUND", font=font)
        )
    else:
        raise exception from exception
    return error_message

handle_file_size(file_info, max_file_size=5) classmethod

Handle a File Size

Source code in browsr/widgets/windows.py

@classmethod
def handle_file_size(cls, file_info: FileInfo, max_file_size: int = 5) -> None:
    """
    Handle a File Size
    """
    file_size_mb = file_info.size / 1000 / 1000
    too_large = file_size_mb >= max_file_size
    if too_large:
        raise FileSizeError("File too large")

DataTableWindow

Bases: VimDataTable, BaseCodeWindow

A DataTable widget for displaying code.

Source code in browsr/widgets/windows.py

class DataTableWindow(VimDataTable, BaseCodeWindow):
    """
    A DataTable widget for displaying code.
    """

    def refresh_from_file(self, file_path: UPath, max_lines: int | None = None) -> None:
        """
        Load a file into a DataTable
        """
        if ".csv" in file_path.suffixes:
            df = pd.read_csv(file_path, nrows=max_lines)
        elif file_path.suffix.lower() in [".parquet"]:
            df = pd.read_parquet(file_path).head(max_lines)
        elif file_path.suffix.lower() in [".feather", ".fea"]:
            df = pd.read_feather(file_path).head(max_lines)
        else:
            msg = f"Cannot render file as a DataTable, {file_path}."
            raise NotImplementedError(msg)
        self.refresh_from_df(df)

    def refresh_from_df(
        self,
        pandas_dataframe: pd.DataFrame,
        show_index: bool = True,
        index_name: str | None = None,
    ) -> None:
        """
        Convert a pandas.DataFrame obj into a rich.Table obj.

        Parameters
        ----------
        pandas_dataframe: pd.DataFrame
            A Pandas DataFrame to be converted to a rich Table.
        show_index: bool
            Add a column with a row count to the table. Defaults to True.
        index_name: Optional[str]
            The column name to give to the index column.
            Defaults to None, showing no value.

        Returns
        -------
        DataTableWindow[str]
            The DataTable instance passed, populated with the DataFrame values.
        """
        self.clear(columns=True)
        if show_index:
            index_name = str(index_name) if index_name else ""
            self.add_column(index_name)
        for column in pandas_dataframe.columns:
            self.add_column(str(column))
        pandas_dataframe.replace([np.NaN], [""], inplace=True)
        for index, value_list in enumerate(pandas_dataframe.values.tolist()):
            row = [str(index)] if show_index else []
            row += [str(x) for x in value_list]
            self.add_row(*row)

refresh_from_df(pandas_dataframe, show_index=True, index_name=None)

Convert a pandas.DataFrame obj into a rich.Table obj.

Parameters:

Name	Type	Description	Default
pandas_dataframe	DataFrame	A Pandas DataFrame to be converted to a rich Table.	required
show_index	bool	Add a column with a row count to the table. Defaults to True.	True
index_name	str | None	The column name to give to the index column. Defaults to None, showing no value.	None

Returns:

Type	Description
DataTableWindow[str]	The DataTable instance passed, populated with the DataFrame values.

Source code in browsr/widgets/windows.py

def refresh_from_df(
    self,
    pandas_dataframe: pd.DataFrame,
    show_index: bool = True,
    index_name: str | None = None,
) -> None:
    """
    Convert a pandas.DataFrame obj into a rich.Table obj.

    Parameters
    ----------
    pandas_dataframe: pd.DataFrame
        A Pandas DataFrame to be converted to a rich Table.
    show_index: bool
        Add a column with a row count to the table. Defaults to True.
    index_name: Optional[str]
        The column name to give to the index column.
        Defaults to None, showing no value.

    Returns
    -------
    DataTableWindow[str]
        The DataTable instance passed, populated with the DataFrame values.
    """
    self.clear(columns=True)
    if show_index:
        index_name = str(index_name) if index_name else ""
        self.add_column(index_name)
    for column in pandas_dataframe.columns:
        self.add_column(str(column))
    pandas_dataframe.replace([np.NaN], [""], inplace=True)
    for index, value_list in enumerate(pandas_dataframe.values.tolist()):
        row = [str(index)] if show_index else []
        row += [str(x) for x in value_list]
        self.add_row(*row)

refresh_from_file(file_path, max_lines=None)

Load a file into a DataTable

Source code in browsr/widgets/windows.py

def refresh_from_file(self, file_path: UPath, max_lines: int | None = None) -> None:
    """
    Load a file into a DataTable
    """
    if ".csv" in file_path.suffixes:
        df = pd.read_csv(file_path, nrows=max_lines)
    elif file_path.suffix.lower() in [".parquet"]:
        df = pd.read_parquet(file_path).head(max_lines)
    elif file_path.suffix.lower() in [".feather", ".fea"]:
        df = pd.read_feather(file_path).head(max_lines)
    else:
        msg = f"Cannot render file as a DataTable, {file_path}."
        raise NotImplementedError(msg)
    self.refresh_from_df(df)

StaticWindow

Bases: Static, BaseCodeWindow

A static widget for displaying code.

Source code in browsr/widgets/windows.py

class StaticWindow(Static, BaseCodeWindow):
    """
    A static widget for displaying code.
    """

    linenos: Reactive[bool] = reactive(False)
    theme: Reactive[str] = reactive(favorite_themes[0])

    rich_themes: ClassVar[list[str]] = favorite_themes

    def __init__(
        self, config_object: TextualAppContext, *args: Any, **kwargs: Any
    ) -> None:
        super().__init__(*args, **kwargs)
        self.config_object = config_object

    def file_to_markdown(
        self, file_path: UPath, max_lines: int | None = None
    ) -> Markdown:
        """
        Load a file into a Markdown
        """
        return Markdown(
            self.file_to_string(file_path, max_lines=max_lines),
            code_theme=self.theme,
            hyperlinks=True,
        )

    def text_to_syntax(self, text: str, file_path: str | UPath) -> Syntax:
        """
        Convert text to syntax
        """
        lexer = Syntax.guess_lexer(str(file_path), code=text)
        return Syntax(
            code=text,
            lexer=lexer,
            line_numbers=self.linenos,
            word_wrap=False,
            indent_guides=False,
            theme=self.theme,
        )

    def watch_linenos(self, linenos: bool) -> None:
        """
        Called when linenos is modified.
        """
        if isinstance(self.renderable, Syntax):
            self.renderable.line_numbers = linenos

    def watch_theme(self, theme: str) -> None:
        """
        Called when theme is modified.
        """
        if isinstance(self.renderable, Syntax):
            updated_syntax = Syntax(
                code=self.renderable.code,
                lexer=self.renderable.lexer,
                line_numbers=self.renderable.line_numbers,
                word_wrap=False,
                indent_guides=False,
                theme=theme,
            )
            self.update(updated_syntax)
        elif isinstance(self.renderable, Markdown):
            self.renderable.code_theme = self.theme

    def next_theme(self) -> str | None:
        """
        Switch to the next theme
        """
        if not isinstance(self.renderable, (Syntax, Markdown)):
            return None
        current_index = favorite_themes.index(self.theme)
        next_theme = favorite_themes[(current_index + 1) % len(favorite_themes)]
        self.theme = next_theme
        return next_theme

file_to_markdown(file_path, max_lines=None)

Load a file into a Markdown

Source code in browsr/widgets/windows.py

def file_to_markdown(
    self, file_path: UPath, max_lines: int | None = None
) -> Markdown:
    """
    Load a file into a Markdown
    """
    return Markdown(
        self.file_to_string(file_path, max_lines=max_lines),
        code_theme=self.theme,
        hyperlinks=True,
    )

next_theme()

Switch to the next theme

Source code in browsr/widgets/windows.py

def next_theme(self) -> str | None:
    """
    Switch to the next theme
    """
    if not isinstance(self.renderable, (Syntax, Markdown)):
        return None
    current_index = favorite_themes.index(self.theme)
    next_theme = favorite_themes[(current_index + 1) % len(favorite_themes)]
    self.theme = next_theme
    return next_theme

text_to_syntax(text, file_path)

Convert text to syntax

Source code in browsr/widgets/windows.py

def text_to_syntax(self, text: str, file_path: str | UPath) -> Syntax:
    """
    Convert text to syntax
    """
    lexer = Syntax.guess_lexer(str(file_path), code=text)
    return Syntax(
        code=text,
        lexer=lexer,
        line_numbers=self.linenos,
        word_wrap=False,
        indent_guides=False,
        theme=self.theme,
    )

watch_linenos(linenos)

Called when linenos is modified.

Source code in browsr/widgets/windows.py

def watch_linenos(self, linenos: bool) -> None:
    """
    Called when linenos is modified.
    """
    if isinstance(self.renderable, Syntax):
        self.renderable.line_numbers = linenos

watch_theme(theme)

Called when theme is modified.

Source code in browsr/widgets/windows.py

def watch_theme(self, theme: str) -> None:
    """
    Called when theme is modified.
    """
    if isinstance(self.renderable, Syntax):
        updated_syntax = Syntax(
            code=self.renderable.code,
            lexer=self.renderable.lexer,
            line_numbers=self.renderable.line_numbers,
            word_wrap=False,
            indent_guides=False,
            theme=theme,
        )
        self.update(updated_syntax)
    elif isinstance(self.renderable, Markdown):
        self.renderable.code_theme = self.theme

WindowSwitcher

Bases: Container

A container that contains the file content windows

Source code in browsr/widgets/windows.py

class WindowSwitcher(Container):
    """
    A container that contains the file content windows
    """

    show_tree: Reactive[bool] = reactive(True)

    datatable_extensions: ClassVar[list[str]] = [
        ".csv",
        ".parquet",
        ".feather",
        ".fea",
        ".csv.gz",
    ]
    image_extensions: ClassVar[list[str]] = image_file_extensions.copy()
    markdown_extensions: ClassVar[list[str]] = [".md"]
    json_extensions: ClassVar[list[str]] = [".json"]

    def __init__(
        self, config_object: TextualAppContext, *args: Any, **kwargs: Any
    ) -> None:
        super().__init__(*args, **kwargs)
        self.config_object = config_object
        self.static_window = StaticWindow(expand=True, config_object=config_object)
        self.datatable_window = DataTableWindow(
            zebra_stripes=True, show_header=True, show_cursor=True, id="table-view"
        )
        self.datatable_window.display = False
        self.vim_scroll = VimScroll(self.static_window)
        self.rendered_file: UPath | None = None

    def compose(self) -> ComposeResult:
        """
        Compose the widget
        """
        yield self.vim_scroll
        yield self.datatable_window

    def get_active_widget(self) -> Widget:
        """
        Get the active widget
        """
        if self.vim_scroll.display:
            return self.vim_scroll
        elif self.datatable_window.display:
            return self.datatable_window

    def switch_window(self, window: BaseCodeWindow) -> None:
        """
        Switch to the window
        """
        screens: dict[Widget, Widget] = {
            self.static_window: self.vim_scroll,
            self.datatable_window: self.datatable_window,
        }
        for window_screen in screens:
            if window is window_screen:
                screens[window_screen].display = True
            else:
                screens[window_screen].display = False

    def render_file(self, file_path: UPath, scroll_home: bool = True) -> None:
        """
        Render a file
        """
        switch_window = self.static_window
        joined_suffixes = "".join(file_path.suffixes).lower()
        if joined_suffixes in self.datatable_extensions:
            self.datatable_window.refresh_from_file(
                file_path=file_path, max_lines=self.config_object.max_lines
            )
            switch_window = self.datatable_window
        elif file_path.suffix.lower() in self.image_extensions:
            image = self.static_window.file_to_image(file_path=file_path)
            self.static_window.update(image)
        elif file_path.suffix.lower() in self.markdown_extensions:
            markdown = self.static_window.file_to_markdown(
                file_path=file_path, max_lines=self.config_object.max_lines
            )
            self.static_window.update(markdown)
        elif file_path.suffix.lower() in self.json_extensions:
            json_str = self.static_window.file_to_json(
                file_path=file_path, max_lines=self.config_object.max_lines
            )
            json_syntax = self.static_window.text_to_syntax(
                text=json_str, file_path=file_path
            )
            self.static_window.update(json_syntax)
            switch_window = self.static_window
        else:
            string = self.static_window.file_to_string(
                file_path=file_path, max_lines=self.config_object.max_lines
            )
            syntax = self.static_window.text_to_syntax(text=string, file_path=file_path)
            self.static_window.update(syntax)
            switch_window = self.static_window
        self.switch_window(switch_window)
        active_widget = self.get_active_widget()
        if scroll_home:
            if active_widget is self.vim_scroll:
                self.vim_scroll.scroll_home(animate=False)
            else:
                switch_window.scroll_home(animate=False)
        if active_widget is self.vim_scroll:
            self.app.sub_title = str(file_path) + f" [{self.static_window.theme}]"
        else:
            self.app.sub_title = str(file_path)
        self.rendered_file = file_path

    def next_theme(self) -> str | None:
        """
        Switch to the next theme
        """
        if self.get_active_widget() is not self.vim_scroll:
            return None
        current_index = favorite_themes.index(self.static_window.theme)
        next_theme = favorite_themes[(current_index + 1) % len(favorite_themes)]
        self.static_window.theme = next_theme
        self.app.sub_title = str(self.rendered_file) + f" [{self.static_window.theme}]"
        return next_theme

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

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

action_toggle_files()

Called in response to key binding.

Source code in browsr/widgets/windows.py

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

compose()

Compose the widget

Source code in browsr/widgets/windows.py

def compose(self) -> ComposeResult:
    """
    Compose the widget
    """
    yield self.vim_scroll
    yield self.datatable_window

get_active_widget()

Get the active widget

Source code in browsr/widgets/windows.py

def get_active_widget(self) -> Widget:
    """
    Get the active widget
    """
    if self.vim_scroll.display:
        return self.vim_scroll
    elif self.datatable_window.display:
        return self.datatable_window

next_theme()

Switch to the next theme

Source code in browsr/widgets/windows.py

def next_theme(self) -> str | None:
    """
    Switch to the next theme
    """
    if self.get_active_widget() is not self.vim_scroll:
        return None
    current_index = favorite_themes.index(self.static_window.theme)
    next_theme = favorite_themes[(current_index + 1) % len(favorite_themes)]
    self.static_window.theme = next_theme
    self.app.sub_title = str(self.rendered_file) + f" [{self.static_window.theme}]"
    return next_theme

render_file(file_path, scroll_home=True)

Render a file

Source code in browsr/widgets/windows.py

def render_file(self, file_path: UPath, scroll_home: bool = True) -> None:
    """
    Render a file
    """
    switch_window = self.static_window
    joined_suffixes = "".join(file_path.suffixes).lower()
    if joined_suffixes in self.datatable_extensions:
        self.datatable_window.refresh_from_file(
            file_path=file_path, max_lines=self.config_object.max_lines
        )
        switch_window = self.datatable_window
    elif file_path.suffix.lower() in self.image_extensions:
        image = self.static_window.file_to_image(file_path=file_path)
        self.static_window.update(image)
    elif file_path.suffix.lower() in self.markdown_extensions:
        markdown = self.static_window.file_to_markdown(
            file_path=file_path, max_lines=self.config_object.max_lines
        )
        self.static_window.update(markdown)
    elif file_path.suffix.lower() in self.json_extensions:
        json_str = self.static_window.file_to_json(
            file_path=file_path, max_lines=self.config_object.max_lines
        )
        json_syntax = self.static_window.text_to_syntax(
            text=json_str, file_path=file_path
        )
        self.static_window.update(json_syntax)
        switch_window = self.static_window
    else:
        string = self.static_window.file_to_string(
            file_path=file_path, max_lines=self.config_object.max_lines
        )
        syntax = self.static_window.text_to_syntax(text=string, file_path=file_path)
        self.static_window.update(syntax)
        switch_window = self.static_window
    self.switch_window(switch_window)
    active_widget = self.get_active_widget()
    if scroll_home:
        if active_widget is self.vim_scroll:
            self.vim_scroll.scroll_home(animate=False)
        else:
            switch_window.scroll_home(animate=False)
    if active_widget is self.vim_scroll:
        self.app.sub_title = str(file_path) + f" [{self.static_window.theme}]"
    else:
        self.app.sub_title = str(file_path)
    self.rendered_file = file_path

switch_window(window)

Switch to the window

Source code in browsr/widgets/windows.py

def switch_window(self, window: BaseCodeWindow) -> None:
    """
    Switch to the window
    """
    screens: dict[Widget, Widget] = {
        self.static_window: self.vim_scroll,
        self.datatable_window: self.datatable_window,
    }
    for window_screen in screens:
        if window is window_screen:
            screens[window_screen].display = True
        else:
            screens[window_screen].display = False

watch_show_tree(show_tree)

Called when show_tree is modified.

Source code in browsr/widgets/windows.py

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