Display Functions

Functions to format and display the discovered information:

safe_print


def safe_print(
    args:VAR_POSITIONAL, kwargs:VAR_KEYWORD
):

Print with broken pipe error handling.

This wrapper function catches BrokenPipeError and IOError exceptions that occur when output is piped to commands like head, tail, etc.

show_navigation_breadcrumbs


def show_navigation_breadcrumbs(
    breadcrumbs:List, # List of breadcrumb items
    config:Optional=None, # Optional configuration
):

Display navigation breadcrumbs.

display_modules


def display_modules(
    config:Optional=None, # Library configuration (uses active config if not provided)
):

Display all available utility modules with their documentation.

display_module_factories


def display_module_factories(
    module_name:str, # Name of the module to display factories for
    config:Optional=None, # Library configuration (uses active config if not provided)
):

Display all factories in a specific module.

display_all_factories


def display_all_factories(
    config:Optional=None, # Library configuration (uses active config if not provided)
):

Display all factories across all modules.

display_module_examples


def display_module_examples(
    module_name:str, # Name of the module to display examples for
    config:Optional=None, # Optional configuration to use
):

Display all usage examples in a specific module.

display_all_examples


def display_all_examples(
    config:Optional=None, # Optional configuration to use
):

Display all usage examples across all modules.

display_example_source


def display_example_source(
    module_name:str, # Name of the module containing the example
    feature:str, # Feature name identifying the example
    config:Optional=None, # Optional configuration to use
):

Display the source code of a specific example function.

display_module_helpers


def display_module_helpers(
    module_name:str, # Name of the module to display helpers for
    config:Optional=None, # Optional configuration to use
):

Display helper functions available in a specific module.

display_helper_source


def display_helper_source(
    module_name:str, # Name of the module containing the helper
    helper_name:str, # Name of the helper function
    config:Optional=None, # Optional configuration to use
):

Display the source code of a specific helper function.

display_all_helpers


def display_all_helpers(
    config:Optional=None, # Optional configuration to use
):

Display all helper functions across all modules.

display_factory_info


def display_factory_info(
    module_name:str, # Name of the module containing the factory
    factory_name:str, # Name of the factory to display info for
    config:Optional=None, # Optional configuration to use
):

Display detailed information about a specific factory.

display_search_results


def display_search_results(
    results:List, # List of search results to display
    query:str, # The search query that was executed
    config:Optional=None, # Optional configuration to use
):

Display search results in a formatted way.

display_core_utility_source


def display_core_utility_source(
    util_name:str, # Name of the core utility function
    config:Optional=None, # Optional configuration to use
):

Display the source code of a specific core utility function.

display_core_utilities


def display_core_utilities(
    config:Optional=None, # Optional configuration to use
):

Display all core utility functions.

display_imports


def display_imports(
    modules:Optional=None, # List of specific modules to get imports for (None for all)
    config:Optional=None, # Optional configuration to use
):

Display recommended import statements.

display_test_code_result


def display_test_code_result(
    success:bool, # Whether the code executed successfully
    stdout:str, # Standard output from the code execution
    stderr:str, # Standard error from the code execution
    code:str, # The code that was executed
    config:Optional=None, # Optional configuration to use
):

Display the results of test code execution.

Export