interface

appimage_updater.ui.output.interface

Output formatter interface and protocol definitions.

OutputFormat

Supported output formats.

HTML = 'html' class-attribute instance-attribute

JSON = 'json' class-attribute instance-attribute

PLAIN = 'plain' class-attribute instance-attribute

RICH = 'rich' class-attribute instance-attribute

OutputFormatter

Protocol defining the output formatter interface.

This protocol defines the common interface that all output formatters must implement. Different formatters can provide format-specific implementations while maintaining a consistent API.

end_section()

End the current output section.

Source code in src/appimage_updater/ui/output/interface.py

def end_section(self) -> None:
    """End the current output section."""
    ...

finalize()

Finalize output and return content if applicable.

For formats like JSON and HTML, this returns the complete formatted output. For console formats, this returns None.

Returns:

Type	Description
str | None	Complete formatted output or None for console formats

Source code in src/appimage_updater/ui/output/interface.py

def finalize(self) -> str | None:
    """Finalize output and return content if applicable.

    For formats like JSON and HTML, this returns the complete
    formatted output. For console formats, this returns None.

    Returns:
        Complete formatted output or None for console formats
    """
    ...

print(message, **kwargs)

Print a message with optional styling.

Parameters:

Name	Type	Description	Default
message	str	The message to print	required
**kwargs	Any	Format-specific styling options	{}

Source code in src/appimage_updater/ui/output/interface.py

def print(self, message: str, **kwargs: Any) -> None:
    """Print a message with optional styling.

    Args:
        message: The message to print
        **kwargs: Format-specific styling options
    """
    ...

print_application_list(applications)

Display application list.

Parameters:

Name	Type	Description	Default
applications	list[dict[str, Any]]	List of application dictionaries	required

Source code in src/appimage_updater/ui/output/interface.py

def print_application_list(self, applications: list[dict[str, Any]]) -> None:
    """Display application list.

    Args:
        applications: List of application dictionaries
    """
    ...

print_check_results(results)

Display check results in format-appropriate way.

Parameters:

Name	Type	Description	Default
results	list[dict[str, Any]]	List of check result dictionaries	required

Source code in src/appimage_updater/ui/output/interface.py

def print_check_results(self, results: list[dict[str, Any]]) -> None:
    """Display check results in format-appropriate way.

    Args:
        results: List of check result dictionaries
    """
    ...

print_config_settings(settings)

Display configuration settings.

Parameters:

Name	Type	Description	Default
settings	dict[str, Any]	Dictionary of configuration settings	required

Source code in src/appimage_updater/ui/output/interface.py

def print_config_settings(self, settings: dict[str, Any]) -> None:
    """Display configuration settings.

    Args:
        settings: Dictionary of configuration settings
    """
    ...

print_error(message)

Display error message.

Parameters:

Name	Type	Description	Default
message	str	Error message to display	required

Source code in src/appimage_updater/ui/output/interface.py

def print_error(self, message: str) -> None:
    """Display error message.

    Args:
        message: Error message to display
    """
    ...

print_info(message)

Display info message.

Parameters:

Name	Type	Description	Default
message	str	Info message to display	required

Source code in src/appimage_updater/ui/output/interface.py

def print_info(self, message: str) -> None:
    """Display info message.

    Args:
        message: Info message to display
    """
    ...

print_progress(current, total, description='')

Display progress information.

Parameters:

Name	Type	Description	Default
current	int	Current progress value	required
total	int	Total progress value	required
description	str	Optional progress description	''

Source code in src/appimage_updater/ui/output/interface.py

def print_progress(self, current: int, total: int, description: str = "") -> None:
    """Display progress information.

    Args:
        current: Current progress value
        total: Total progress value
        description: Optional progress description
    """
    ...

print_success(message)

Display success message.

Parameters:

Name	Type	Description	Default
message	str	Success message to display	required

Source code in src/appimage_updater/ui/output/interface.py

def print_success(self, message: str) -> None:
    """Display success message.

    Args:
        message: Success message to display
    """
    ...

print_table(data, title='', headers=None)

Display tabular data.

Parameters:

Name	Type	Description	Default
data	list[dict[str, Any]]	List of dictionaries representing table rows	required
title	str	Optional table title	''
headers	list[str] | None	Optional custom headers (uses dict keys if not provided)	None

Source code in src/appimage_updater/ui/output/interface.py

def print_table(self, data: list[dict[str, Any]], title: str = "", headers: list[str] | None = None) -> None:
    """Display tabular data.

    Args:
        data: List of dictionaries representing table rows
        title: Optional table title
        headers: Optional custom headers (uses dict keys if not provided)
    """
    ...

print_warning(message)

Display warning message.

Parameters:

Name	Type	Description	Default
message	str	Warning message to display	required

Source code in src/appimage_updater/ui/output/interface.py

def print_warning(self, message: str) -> None:
    """Display warning message.

    Args:
        message: Warning message to display
    """
    ...

start_section(title)

Start a new output section.

Parameters:

Name	Type	Description	Default
title	str	Section title	required

Source code in src/appimage_updater/ui/output/interface.py

def start_section(self, title: str) -> None:
    """Start a new output section.

    Args:
        title: Section title
    """
    ...