#-----------------------------------------------------------------------------
# Copyright (c) 2012 - 2021, Anaconda, Inc., and Bokeh Contributors.
# All rights reserved.
#
# The full license is in the file LICENSE.txt, distributed with this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Boilerplate
#-----------------------------------------------------------------------------
from __future__ import annotations
import logging # isort:skip
log = logging.getLogger(__name__)
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Standard library imports
import sys
from traceback import format_exception
from typing import Any
# External imports
from typing_extensions import TypedDict
# Bokeh imports
from ...core.types import ID
from ..message import Message
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
__all__ = (
'error',
)
#-----------------------------------------------------------------------------
# General API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Dev API
#-----------------------------------------------------------------------------
class Error(TypedDict):
text: str
traceback: str | None
[docs]class error(Message[Error]):
''' Define the ``ERROR`` message for reporting error conditions back to a
Bokeh server.
The ``content`` fragment of for this message is has the form:
.. code-block:: python
{
'text' : <error message text>
# this is optional
'traceback' : <traceback text>
}
'''
msgtype = 'ERROR'
def __repr__(self) -> str:
msg = super().__repr__()
msg += " --- "
msg += self.content['text']
if self.content["traceback"] is not None:
msg += "\n" + self.content['traceback']
return msg
[docs] @classmethod
def create(cls, request_id: ID, text: str, **metadata: Any) -> error:
''' Create an ``ERROR`` message
Args:
request_id (str) :
The message ID for the message the precipitated the error.
text (str) :
The text of any error message or traceback, etc.
Any additional keyword arguments will be put into the message
``metadata`` fragment as-is.
'''
header = cls.create_header(request_id=request_id)
ex_type, ex, tb = sys.exc_info()
traceback = "".join(format_exception(ex_type, ex, tb)) if ex_type else None
content = Error(text=text, traceback=traceback)
return cls(header, metadata, content)
#-----------------------------------------------------------------------------
# Private API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------