-e%.UdZddlmZddlZejeZddlZddlm Z m Z m Z m Z m Z mZddlmcmZddlmZddlmZmZddlmZd d lmZmZe rdd lmZmZdd l m!Z!d Z"Gdde Z#Gdde Z$edZ%e&e'e fZ(de)d<e*e$e+fZ,de)d<Gdde Z-Gdde 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)Messagec8eZdZUded<ded<ded<ded<d S) HeaderrmsgidstrmsgtypezNotRequired[ID]reqidzNotRequired[int] num_buffersN__name__ __module__ __qualname____annotations__6lib/python3.11/site-packages/bokeh/protocol/message.pyrrds< IIILLL!!!!!!r#rceZdZUded<dS) BufferHeaderridNrr"r#r$r&r&js FFFFFr#r&ContentrMetadata BufferRefceZdZdS)EmptyN)rrr r"r#r$r,r,ssDr#r,ceZdZUdZded<ded<ded<ded <ded <d ed <ded <ded<d?dZd@dZedAdZdBdZ dCd$Z dDdEd+Z edFdGd/Z dHd0Z edId1ZedJd3ZedKd4ZejdLd6Zed@d7ZedMd8ZejdNd9Zed@d:ZedOd;ZejdPd<Zed@d=ZedQd>Zd,S)Rrz 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_json list[Buffer]_buffersheadermetadatacontentreturnNonec>||_||_||_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)r6r7r8r5)selfr6r7r8s r$__init__zMessage.__init__s$$     r#rc&d|jd|jS)NzMessage z content: )rr8r<s r$__repr__zMessage.__repr__sD$,DDDLDDDr# header_json metadata_json content_jsonMessage[Content]c| tj|}n#t$rtdwxYw tj|}n#t$rtdwxYw tj|}n#t$rtdwxYw||||}||_||_||_|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/r3r1)clsrArBrCr6r7r8msgs r$assemblezMessage.assembles& >Z ,,FF > > ><== = > @z-00HH @ @ @>?? ? @ ?j..GG ? ? ?=>> > ?c&(G,,&*( s1A A$(A==Bbufferr cd|jvr|jdxxdz cc<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/r5append)r<rLs r$ add_bufferzMessage.add_buffersb DL ( ( L ' ' '1 , ' ' ' '*+DL '  V$$$$$r# buf_headerr& buf_payloadbytesc|jdd}|t|jkrt d||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)r6getlenr5rrNr )r<rPrQrs r$assemble_bufferzMessage.assemble_buffersp koomQ77 #dm,, , , T{ T TUU U VJt$4kBBCCCCCr#TconnrlockedboolintcXK|tdd}|jD]}tj|j}|}|||d{V||d|d{V|t|t|zz }|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 NonerrXT)binaryrX)rHr5rFdumpsrefto_bytes write_messagerU)r<rWrXsentrLr6payloads r$ write_bufferszMessage.write_bufferss <FGG Gm / /FZ ++Foo''G$$VF$;; ; ; ; ; ; ; ;$$WT&$II I I I I I I I CKK#g,,. .DD r#N request_id ID | Nonecbttj|j}|||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)rbkserialmake_idr)rIrer6s r$ create_headerzMessage.create_headers?&((k     !(F7O r#c8K|td|jd{V5d}||jdd{V|t |jz }||jdd{V|t |jz }||jdd{V|t |jz }|||dd{Vz }|cdddS#1swxYwYdS)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 NonerFr\) rH write_lockacquirerarArUrBrCrd)r<rWrbs r$sendz Message.send&s <=>> >?**,, , , , , , ,  D$$T%5e$DD D D D D D D D C()) )D $$T%7$FF F F F F F F F C*++ +D $$T%6u$EE E E E E E E E C)** *D $,,T%,@@@@@@@@ @D)                  sCDDDc|jduoB|jduo9|jduo0|jddt |jkS)z Returns whether all required parts of a message are present. Returns: bool : True if the message is complete, False otherwise Nrr)r6r7r8rTrUr5r?s r$completezMessage.completeIs^{$&G}D(G|4'G{}a00C 4F4FF Gr#Serialized[Content]c6t|j|jSN)r r8buffersr?s r$rczMessage.payloadVs$, 555r#c|jSrs)r.r?s r$r6zMessage.header\s |r#valuec"||_d|_dSrs)r.r/r<rvs r$r6zMessage.header`s  r#cZ|jstj|j|_|jSrs)r/rFr^r6r?s r$rAzMessage.header_jsones*  8 $ 4; 7 7D   r#c|jSrs)r0r?s r$r8zMessage.contentms }r#c"||_d|_dSrs)r0r1rxs r$r8zMessage.contentqs !r#cP|jst|j|_|jSrs)r1r rcr?s r$rCzMessage.content_jsonvs(! >!/ !=!=D !!r#c|jSrs)r2r?s r$r7zMessage.metadata~s ~r#c"||_d|_dSrs)r2r3rxs r$r7zMessage.metadatas"r#cZ|jstj|j|_|jSrs)r3rFr^r7r?s r$rBzMessage.metadata_jsons*" <"&*T]";";D ""r#c*t|jSrs)listr5r?s r$rtzMessage.bufferssDM"""r#)r6rr7r)r8r(r9r:)r9r)rArrBrrCrr9rD)rLr r9r:)rPr&rQrRr9r:)T)rWrrXrYr9rZrs)rerfr9r)rWrr9rZ)r9rY)r9rq)r9r)rvrr9r:)r9r()rvr(r9r:)r9r))rvr)r9r:)r9r4)rrr __doc__r!r=r@ classmethodrKrOrVrdrjrnpropertyrprcr6setterrAr8rCr7rBrtr"r#r$rrvs OOO.EEEE'''['R%%%%,DDDD*2[&!!!!F G G GX G666X6 X ]!!!]!!!!X!X ^"""^""""X"X_###_####X####X###r#r)/r __future__rlogging getLoggerrlogrFtypingrrrrrr bokeh.util.serializationutil serializationrhcore.json_encoderr core.serializationr r core.typesr exceptionsrrtyping_extensionsrrclient.websocketr__all__rr&r(dictrr)r!tuplerRr*r,rr"r#r$rsR&&&V#"""""g!! ,++++++++/.....3333333333333333D88888888CCCCCC  """""Y"""      9    ')  38n$$$$\501 1111     I   [#[#[#[#[#gg[#[#[#[#[#r#