a JDf.@s2UdZddlmZddlZeeZddlZddlm Z m Z m Z m Z m Z mZddlmmZddlmZddlmZmZddlmZd d lmZmZe rdd lmZmZdd l m!Z!d Z"Gddde Z#Gddde Z$edZ%e&e'e fZ(de)d<e*e$e+fZ,de)d<Gddde Z-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_CHECKINGAnyClassVarGeneric TypedDictTypeVar)serialize_json)Buffer Serialized)ID) MessageError ProtocolError) NotRequired TypeAlias) WebSocketClientConnectionWrapper)Messagec@s.eZdZUded<ded<ded<ded<d S) Headerr msgidstrmsgtypezNotRequired[ID]reqidzNotRequired[int] num_buffersN__name__ __module__ __qualname____annotations__r r c/nfs/NAS7/SABIOD/METHODE/ermites/ermites_venv/lib/python3.9/site-packages/bokeh/protocol/message.pyrds rc@seZdZUded<dS) BufferHeaderr idNrr r r r!r"js r"ContentrMetadata BufferRefc@s eZdZdS)EmptyN)rrrr r r r!r'ssr'c@seZdZUdZded<ded<ded<ded <ded <d ed <ded <ded<dd dddddZddddZedddddddZdddddZ d d!dd"d#d$Z dKd&d'd(d)d*d+Z edLd-dd.d/d0Z d&d(d1d2d3Z ed'dd4d5Zed6dd7d8Zeddd9d:Zejddd;dZeddd?d@Zejddd;dAd@ZedddBdCZed ddDdEZejd dd;dFdEZedddGdHZedddIdJZd,S)Mrz 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_jsonr% _metadata_metadata_jsonz list[Buffer]_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)r0r1r2r.)selfr0r1r2r r r!__init__szMessage.__init__r)r3cCsd|jd|jS)NzMessage z content: )rr2r4r r r!__repr__szMessage.__repr__zMessage[Content]) header_json metadata_json content_jsonr3cCszt|}Wnty(tdYn0zt|}WntyRtdYn0zt|}Wnty|tdYn0||||}||_||_||_|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+)clsr8r9r:r0r1r2msgr r r!assembles"    zMessage.assembler )bufferr3cCs>d|jvr|jdd7<n d|jd<d|_|j|dS)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 rrN)r(r)r.append)r4rAr r r! add_buffers   zMessage.add_bufferr"bytes) buf_header buf_payloadr3cCsD|jdd}|t|jkr*td||jt|d|dS)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 rrz$too many buffers received expecting r#N)r0getlenr.rrBr )r4rErFrr r r!assemble_bufferszMessage.assemble_bufferTrboolint)connlockedr3csv|durtdd}|jD]V}t|j}|}|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 NonerrMT)binaryrM)r=r.r;dumpsrefto_bytes write_messagerH)r4rLrMsentrAr0payloadr r r! write_bufferss  zMessage.write_buffersNz ID | None) request_idr3cCs&tt|jd}|dur"||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>rWr0r r r! create_headers zMessage.create_header)rLr3cs|durtd|jIdHd}|j|jddIdH|t|j7}|j|jddIdH|t|j7}|j|jddIdH|t|j7}||j|ddIdH7}|WdS1s0YdS)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 NonerFrN) r=Z write_lockacquirerSr8rHr9r:rV)r4rLrTr r r!send&s z Message.sendcCs6|jduo4|jduo4|jduo4|jddt|jkS)z Returns whether all required parts of a message are present. Returns: bool : True if the message is complete, False otherwise Nrr)r0r1r2rGrHr.r6r r r!completeIs zMessage.completezSerialized[Content]cCst|j|jSN)r r2buffersr6r r r!rUVszMessage.payloadcCs|jSr])r(r6r r r!r0\szMessage.header)valuer3cCs||_d|_dSr])r(r)r4r_r r r!r0`scCs|jst|j|_|jSr])r)r;rPr0r6r r r!r8eszMessage.header_jsoncCs|jSr])r*r6r r r!r2mszMessage.contentcCs||_d|_dSr])r*r+r`r r r!r2qscCs|jst|j|_|jSr])r+r rUr6r r r!r:vs zMessage.content_jsoncCs|jSr])r,r6r r r!r1~szMessage.metadatacCs||_d|_dSr])r,r-r`r r r!r1scCs|jst|j|_|jSr])r-r;rPr1r6r r r!r9szMessage.metadata_jsoncCs t|jSr])listr.r6r r r!r^szMessage.buffers)T)N)rrr__doc__rr5r7 classmethodr@rCrIrVrYr[propertyr\rUr0setterr8r2r:r1r9r^r r r r!rvsV )# r)/rb __future__rlogging getLoggerrlogr;typingrrrrrrZbokeh.util.serializationutilZ serializationrXZcore.json_encoderr Zcore.serializationr r Z core.typesr exceptionsrrZtyping_extensionsrrZclient.websocketr__all__rr"r$dictrr%rtuplerDr&r'rr r r r!s*+