suggestions

This module creates a custom exception handler that will send the error to OpenAI's ChatGPT in order to help debug the code. It will also display the error in the notebook as usual.

Stage

Bases: str, Enum

The stage of feedback generation

Source code in genai/suggestions.py

class Stage(str, Enum):
    """The stage of feedback generation"""

    STARTING = "starting"
    GENERATING = "generating"
    FINISHED = "finished"

can_handle_display_updates()

Determine (roughly) if the client can handle display updates.

Source code in genai/suggestions.py

def can_handle_display_updates():
    """Determine (roughly) if the client can handle display updates."""
    try:
        from IPython import get_ipython

        ipython = get_ipython()
        if ipython is None:
            return False

        name = ipython.__class__.__name__

        if name == "ZMQInteractiveShell":
            return True
        elif name == "TerminalInteractiveShell":
            return False
        else:
            # Just assume they can otherwise
            return True
    except ImportError:
        # No IPython, so no display updates whatsoever
        return False

register(ipython=None)

Register the exception handler with the given IPython instance.

Source code in genai/suggestions.py

def register(ipython=None):
    """Register the exception handler with the given IPython instance."""
    if ipython is None:
        ipython = get_ipython()

    ipython.set_custom_exc((Exception,), custom_exc)