U /eG-@sdZddlmZddlZeeZddlZddlm Z m Z m Z m Z m Z mZmZmZddlmZddlmmZddlmZdd lmZmZe rdd lmZd ZGd d d eZGdddeddZ e!Z"edZ#e e!e fZ$ee"e%fZ&GdddeZ'Gddde e#Z(dS)a Provide a base class for all Bokeh Server Protocol message types. Boker messages are comprised of a sequence of JSON fragments. Specified as Python JSON-like data, messages have the general form: .. code-block:: python [ # these are required b'{header}', # serialized header dict b'{metadata}', # serialized metadata dict b'{content}, # serialized content dict # these are optional, and come in pairs; header contains num_buffers b'{buf_header}', # serialized buffer header dict b'array' # raw buffer payload data ... ] The ``header`` fragment will have the form: .. code-block:: python header = { # these are required 'msgid' : # a unique id for the message 'msgtype' : # a message type, e.g. 'ACK', 'PATCH-DOC', etc # these are optional 'num_buffers' : # the number of additional buffers, if any } The ``metadata`` fragment may contain any arbitrary information. It is not processed by Bokeh for any purpose, but may be useful for external monitoring or instrumentation tools. The ``content`` fragment is defined by the specific message type. ) annotationsN) TYPE_CHECKINGAnyClassVarDictGenericListTupleTypeVar) TypedDict)ID) MessageError ProtocolError) WebSocketClientConnectionWrapper)Messagec@seZdZUded<ded<dS)_Headerr msgidstrmsgtypeN__name__ __module__ __qualname____annotations__rr:/tmp/pip-unpacked-wheel-f5fndrjf/bokeh/protocol/message.pyres rc@seZdZUded<ded<dS)Headerr reqidint num_buffersNrrrrrris rF)totalContentc@s eZdZdS)EmptyN)rrrrrrrr$wsr$c@seZdZUdZded<ded<ded<ded <ded <d ed <ded <ded<dd dddddZddddZedddddddZdddddd Z ddddd!d"Z dFd$d%d&d'd(d)Z edGd+dd,d-d.Z d$d&d/d0d1Z ed%dd2d3Zeddd4d5Zejddd6d7d5Zeddd8d9Zeddd:d;Zejddd6dZed dd?d@Zejd dd6dAd@ZedddBdCZedddDdEZd*S)Hrz The Message base class encapsulates creating, assembling, and validating the integrity of Bokeh Server messages. Additionally, it provide hooks z ClassVar[str]rr_headerz str | None _header_jsonr#_content _content_jsonMetadata _metadata_metadata_jsonzList[BufferRef]_buffersNone)headermetadatacontentreturncCs||_||_||_g|_dS)a Initialize a new message from header, metadata, and content dictionaries. To assemble a message from existing JSON fragments, use the ``assemble`` method. To create new messages with automatically generated headers, use subclass ``create`` methods. Args: header (JSON-like) : metadata (JSON-like) : content (JSON-like) : N)r.r/r0r,)selfr.r/r0rrr__init__szMessage.__init__r)r1cCsd|jd|jS)NzMessage z content: )rr0r2rrr__repr__szMessage.__repr__zMessage[Content]) header_json metadata_json content_jsonr1cCszt|}Wntk r*tdYnXzt|}Wntk rVtdYnXzt|}Wntk rtdYnX||||}||_||_||_|S)a Creates a new message, assembled from JSON fragments. Args: header_json (``JSON``) : metadata_json (``JSON``) : content_json (``JSON``) : Returns: Message subclass Raises: MessageError zheader could not be decodedzmetadata could not be decodedzcontent could not be decoded)jsonloads ValueErrorrr&r+r()clsr6r7r8r.r/r0msgrrrassembles" zMessage.assemble BufferHeaderbytes) buf_header buf_payloadr1cCsBd|jkr|jdd7<n d|jd<d|_|j||fdS)a Associate a buffer header and payload with this message. Args: buf_header (``JSON``) : a buffer header buf_payload (``JSON`` or bytes) : a buffer payload Returns: None Raises: MessageError r!rN)r%r&r,append)r2rArBrrr add_buffers   zMessage.add_buffercCs>|jdd}|t|jkr*td||j||fdS)a Add a buffer header and payload that we read from the socket. This differs from add_buffer() because we're validating vs. the header's num_buffers, instead of filling in the header. Args: buf_header (``JSON``) : a buffer header buf_payload (``JSON`` or bytes) : a buffer payload Returns: None Raises: ProtocolError r!rz$too many buffers received expecting N)r.getlenr,rrC)r2rArBr!rrrassemble_bufferszMessage.assemble_bufferTrboolr )connlockedr1csf|dkrtdd}|jD]F\}}|j||dIdH|j|d|dIdH|t|t|7}q|S)aa Write any buffer headers and payloads to the given connection. Args: conn (object) : May be any object with a ``write_message`` method. Typically, a Tornado ``WSHandler`` or ``WebSocketClientConnection`` locked (bool) : Returns: int : number of bytes sent Nz'Cannot write_buffers to connection NonerrJT)binaryrJ)r;r, write_messagerF)r2rIrJsentr.payloadrrr write_buffersszMessage.write_buffersNz ID | None) request_idr1cCs&tt|jd}|dk r"||d<|S)z Return a message header fragment dict. Args: request_id (str or None) : Message ID of the message this message replies to Returns: dict : a message header )rrNr)rbkserialZmake_idr)r<rQr.rrr create_headers zMessage.create_header)rIr1c s|dkrtd|jIdHd}|j|jddIdH|t|j7}|j|jddIdH|t|j7}|j|jddIdH|t|j7}||j|ddIdH7}|W5QRSQRXdS)z Send the message on the given connection. Args: conn (WebSocketHandler) : a WebSocketHandler to send messages Returns: int : number of bytes sent NzCannot send to connection NonerFrK) r;Z write_lockacquirerMr6rFr7r8rP)r2rIrNrrrsend)s z Message.sendcCs6|jdk o4|jdk o4|jdk o4|jddt|jkS)z Returns whether all required parts of a message are present. Returns: bool : True if the message is complete, False otherwise Nr!r)r.r/r0rErFr,r4rrrcompleteLs zMessage.completecCs|jSN)r%r4rrrr.[szMessage.header)valuer1cCs||_d|_dSrW)r%r&r2rXrrrr._scCs|jst|j|_|jSrW)r&r9dumpsr.r4rrrr6dszMessage.header_jsoncCs|jSrW)r'r4rrrr0lszMessage.contentcCs||_d|_dSrW)r'r(rYrrrr0pscCs|jst|j|_|jSrW)r(r9rZr0r4rrrr8uszMessage.content_jsoncCs|jSrW)r*r4rrrr/}szMessage.metadatacCs||_d|_dSrW)r*r+rYrrrr/scCs|jst|j|_|jSrW)r+r9rZr/r4rrrr7szMessage.metadata_jsoncCs|jSrW)r,r4rrrbuffersszMessage.buffers)T)N)rrr__doc__rr3r5 classmethodr>rDrGrPrSrUpropertyrVr.setterr6r0r8r/r7r[rrrrrzsR )#r))r\ __future__rlogging getLoggerrlogr9typingrrrrrrr r Ztyping_extensionsr Zbokeh.util.serializationutilZ serializationrRZ core.typesr exceptionsrrZclient.websocketr__all__rrrr?r#r)r@Z BufferRefr$rrrrrs(+  (