B @\)@sdZddlmZmZmZmZddlZeeZ ddl m Z m Z ddl mZddlmmZddlmZmZdZGd d d eZdS) 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. )absolute_importdivisionprint_functionunicode_literalsN) json_decode json_encode)gen) MessageError ProtocolError)Messagec@seZdZdZddZddZeddZdd Zd d Z e j d'd dZ ed(ddZ e j ddZeddZeddZejddZeddZeddZejddZeddZed d!Zejd"d!Zed#d$Zed%d&ZdS))r z The Message base class encapsulates creating, assembling, and validating the integrity of Bokeh Server messages. Additionally, it provide hooks cCs||_||_||_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)headermetadatacontent_buffers)selfr rrr5lib/python3.7/site-packages/bokeh/protocol/message.py__init__\szMessage.__init__cCsd|j|j|jfS)Nz$Message %r (revision %d) content: %r)msgtypeZrevisionr)rrrr__repr__sszMessage.__repr__cCsy t|}Wntk r(tdYnXy t|}Wntk rRtdYnXy t|}Wntk r|tdYnX||||}||_||_||_|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)r ValueErrorr _header_json_metadata_json _content_json)cls header_json metadata_json content_jsonr rrmsgrrrassemblevs"    zMessage.assemblecCsBd|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 num_buffersr N)_headerrrappend)r buf_header buf_payloadrrr add_buffers   zMessage.add_buffercCsB|jddt|jkr.tdt|jd|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 getlenrr strr#)rr$r%rrrassemble_bufferszMessage.assemble_bufferTccsl|dkrtdd}xH|jD]>\}}|j||dV|j|d|dV|t|t|7}qWt|dS)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 Noner)lockedT)Zbinaryr+)rr write_messager(rReturn)rconnr+sentr Zpayloadrrr write_buffersszMessage.write_buffersNcCs$t|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 )ZmsgidrNZreqid)bkserialZmake_idr)rZ request_idr rrr create_headers  zMessage.create_headerc cs|dkrtd|jVd}|j|jddV|t|j7}|j|jddV|t|j7}|j|jddV|t|j7}||j|ddV7}t |WdQRXdS)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 NonerF)r+) rZ write_lockacquirer,rr(rrr0rr-)rr.r/rrrsends 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 rrr'r(r)rrrrcompletes   zMessage.completecCs|jS)N)r")rrrrr *szMessage.headercCs||_d|_dS)N)r"r)rvaluerrrr .scCs|jst|j|_|jS)N)rrr )rrrrr3s zMessage.header_jsoncCs|jS)N)_content)rrrrr;szMessage.contentcCs||_d|_dS)N)r7r)rr6rrrr?scCs|jst|j|_|jS)N)rrr)rrrrrDs zMessage.content_jsoncCs|jS)N) _metadata)rrrrrLszMessage.metadatacCs||_d|_dS)N)r8r)rr6rrrrPscCs|jst|j|_|jS)N)rrr)rrrrrUs zMessage.metadata_jsoncCs|jS)N)r)rrrrbuffers]szMessage.buffers)T)N)__name__ __module__ __qualname____doc__rr classmethodr r&r*r coroutiner0r2r4propertyr5r setterrrrrrr9rrrrr Us, *  $       r )r=Z __future__rrrrZloggingZ getLoggerr:logZtornado.escaperrZtornadorZbokeh.util.serializationutilZ serializationr1 exceptionsr r __all__objectr rrrr-s