-eTdZddlmZddlZejeZddlmZm Z m Z ddl m Z erddl mZddlmZdd lmZdd lmZmZdd lmZmZmZdd lmZmZd dlmZd dlm Z m!Z!er(ddl"m#Z#m$Z$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-d dl.m/Z/dZ0e!eZ1dZ2 d5d6d%Z3 d7d8d(Z4 d9d:d3Z5Gd4d$Z6dS);a Provide a session object to service Bokeh documents in external Python clients to a Bokeh server. Use-Cases ~~~~~~~~~ A client session has two primary uses: * Implementing automated testing infrastructure around Bokeh server applications. * Creating and customizing specific sessions of a Bokeh server application (running *in the Bokeh server*) before passing them on to a specific viewer. ) annotationsN) TYPE_CHECKINGAnyLiteral) quote_plus)IOLoop)ID)Document)DEFAULT_SERVER_HTTP_URLSessionCoordinates) NEW_PARAM BrowserLike BrowserTarget)generate_jwt_tokengenerate_session_id) ErrorReason)server_url_for_websocket_urlwebsocket_url_for_server_url)DocumentPatchedEventSessionCallbackAddedSessionCallbackRemoved) UIElement) patch_doc) ServerInfoDocumentCallbackGroupClientConnectiondefault) ClientSession pull_session push_session show_session@ session_id ID | Noneurlstrio_loop IOLoop | None argumentsdict[str, str] | Nonemax_message_sizeintreturnr"ct||}t|t|j|||}||S)a Create a session by loading the current server-side document. ``session.document`` will be a fresh document loaded from the server. While the connection to the server is open, changes made on the server side will be applied to this document, and changes made on the client side will be synced to the server. If you don't plan to modify ``session.document`` you probably don't need to use this function; instead you can directly ``show_session()`` or ``server_session()`` without downloading the session's document into your process first. It's much more efficient to avoid downloading the session if you don't need to. In a production scenario, the ``session_id`` should be unique for each browser tab, which keeps users from stomping on each other. It's neither scalable nor secure to use predictable session IDs or to share session IDs across users. For a notebook running on a single machine, ``session_id`` could be something human-readable such as ``"default"`` for convenience. If you allow ``pull_session()`` to generate a unique ``session_id``, you can obtain the generated ID with the ``id`` property on the returned ``ClientSession``. Args: session_id (string, optional) : The name of the session, None to autogenerate a random one (default: None) url : (str, optional): The URL to a Bokeh application on a Bokeh server can also be `"default"` which will connect to the default app URL io_loop (``tornado.ioloop.IOLoop``, optional) : The ``IOLoop`` to use for the websocket arguments (dict[str, str], optional) : A dictionary of key/values to be passed as HTTP request arguments to Bokeh application code (default: None) Note that should only be provided when pulling new sessions. If ``session_id`` is not None, or a session with ``session_id`` already exists, these arguments will have no effect. max_message_size (int, optional) : Configure the Tornado max websocket message size. (default: 20 MB) Returns: ClientSession : A new ``ClientSession`` connected to the server r'r))r' websocket_urlr+r-r/)r r"rr)pull)r'r)r+r-r/coordssessions 4lib/python3.11/site-packages/bokeh/client/session.pyr#r#Ps]v :3 ? ? ?F-I&*-U-U_fr{O_```G LLNNN Ndocumentr ct||}t|jt|j||}|||S)a Create a session by pushing the given document to the server, overwriting any existing server-side document. ``session.document`` in the returned session will be your supplied document. While the connection to the server is open, changes made on the server side will be applied to this document, and changes made on the client side will be synced to the server. In a production scenario, the ``session_id`` should be unique for each browser tab, which keeps users from stomping on each other. It's neither scalable nor secure to use predictable session IDs or to share session IDs across users. For a notebook running on a single machine, ``session_id`` could be something human-readable such as ``"default"`` for convenience. If you allow ``push_session()`` to generate a unique ``session_id``, you can obtain the generated ID with the ``id`` property on the returned ``ClientSession``. Args: document : (bokeh.document.Document) The document to be pushed and set as session.document session_id : (string, optional) The name of the session, None to autogenerate a random one (default: None) url : (str, optional): The URL to a Bokeh application on a Bokeh server can also be `"default"` which will connect to the default app URL io_loop : (tornado.ioloop.IOLoop, optional) The IOLoop to use for the websocket max_message_size (int, optional) : Configure the Tornado max websocket message size. (default: 20 MB) Returns: ClientSession A new ClientSession connected to the server r3)r'r4r+r/)r r"r'rr)push)r:r'r)r+r/r6r7s r8r$r$sgX :3 ? ? ?Fv'8HdekeoHpHp{BUefffG LL Nr9tabr7ClientSession | Nonebrowser str | Nonenewr controllerBrowserLike | NoneNonec|!t|jj}|j}nt ||}|j}|j}|ddlm}||}||dzt|zt|dS)a Open a browser displaying a session document. If you have a session from ``pull_session()`` or ``push_session`` you can ``show_session(session=mysession)``. If you don't need to open a connection to the server yourself, you can show a new session in a browser by providing just the ``url``. Args: session_id (string, optional) : The name of the session, None to autogenerate a random one (default: None) url : (str, optional): The URL to a Bokeh application on a Bokeh server can also be `"default"` which will connect to the default app URL session (ClientSession, optional) : session to get session ID and server URL from If you specify this, you don't need to specify session_id and url browser (str, optional) : browser to show with (default: None) For systems that support it, the **browser** argument allows specifying which browser to display in, e.g. "safari", "firefox", "opera", "windows-default" (see the :doc:`webbrowser ` module documentation in the standard lib for more details). new (str, optional) : new file output mode (default: "tab") For file-based output, opens or raises the browser window showing the current output file. If **new** is 'tab', then opens a new tab. If **new** is 'window', then opens a new window. Nr3r)get_browser_controller)r?z?bokeh-session-id=)rA) r _connectionr)idr r'bokeh.util.browserrFopenrr) r'r)r7r?rArB server_urlr6rFs r8r%r%sH  5g6I6MNNJ JJ':3GGGFJ*J   A A A A A A//@@@J %99JzZd^dAZed_dBZd`dEZdUdFZdUdGZ dadIZ!dbdKZ"d S)cr"a[ Represents a websocket connection to a server-side session. Each server session stores a Document, which is kept in sync with the corresponding Document for this ``ClientSession`` instance. Updates on either side of the connection will automatically propagate to the other side, as long as the connection is open. ClientSession objects can (and usually should) be used as a context manager so that the session is properly closed: .. code-block:: python with pull_session(url=app_url) as mysession: # customize session here script = server_session(session_id=mysession.id, url=app_url) return render_template("embed.html", script=script, template="Flask") If you do not use ``ClientSession`` in this way, it is up to you to ensure that ``mysession.close()`` is called. Document | None _documentr _idr rGr _callbacksNr&r'r(r4r*r+r,r-r.r/r0cd|_|||_ddlm}|||||||_ddlm}||jj|_ dS)aJ A connection which attaches to a particular named session on the server. Always call either pull() or push() immediately after creating the session (until these are called ``session.document`` will be ``None``). The :func:`~bokeh.client.session.push_session` and :func:`~bokeh.client.session.pull_session()` functions will construct a ``ClientSession`` and push or pull in one step, so they are a good way to obtain a ``ClientSession``. Args: session_id (str) : The name of the session or None to generate one websocket_url (str) : Websocket URL to connect to io_loop (IOLoop, optional) : The IOLoop to use for the websocket arguments (dict[str, str], optional) : A dictionary of key/values to be passed as HTTP request arguments to Bokeh application code (default: None) Note that should only be provided when pulling new sessions. If ``session_id`` is not None, or a session with ``session_id`` already exists, these arguments will have no effect. max_message_size (int, optional) : Configure the Tornado max websocket message size. (default: 20 MB) Nrr)r7r+r4r-r/r r) rN_ensure_session_idrO connectionr rGserver.callbacksrr+rP)selfr'r4r+r-r/r rs r8__init__zClientSession.__init__sH**:66000000++D'Yfr{O_```<<<<<<//0@0HIIr9r1c|S) rUs r8 __enter__zClientSession.__enter__>s  r9exc_typer exc_value exc_tracebackrDc.|dS)rXN)close)rUr\r]r^s r8__exit__zClientSession.__exit__Ds r9boolc|jjS)z. Whether this session is currently connected. )rG connectedrZs r8rdzClientSession.connectedLs))r9ErrorReason | Nonec|jjSN)rG error_reasonrZs r8rhzClientSession.error_reasonQ,,r9 int | Nonec|jjSrg)rG error_coderZs r8rlzClientSession.error_codeUs**r9c|jjSrg)rG error_detailrZs r8rnzClientSession.error_detailYrir9c|jjSrg)rGr)rZs r8r)zClientSession.url]s##r9r c|jS)z A |Document| that will be kept in sync with the corresponding ``Document`` on the server. This value is initialized when :func:`pull` or :func:`push` succeeds. It will be ``None`` until then. )rNrZs r8r:zClientSession.documentas ~r9c|jS)z A unique ID for this session. )rOrZs r8rHzClientSession.idls xr9c*t|jS)z* A JWT token to authenticate the session. )rrHrZs r8tokenzClientSession.tokenqs"$'***r9c8|jdS)z2 Connect to a Bokeh server at the configured URL. N)rGconnectrZs r8ruzClientSession.connectxs   """""r9closedwhyc:|j|dS)z% Close the connection to the server. N)rGr`)rUrws r8r`zClientSession.close|s s#####r9c8|jdS)a  Force a round-trip request/reply to the server, sometimes needed to avoid race conditions. Mostly useful for testing. Outside of test suites, this method hurts performance and should not be needed. Returns: None N)rGforce_roundtriprZs r8rzzClientSession.force_roundtrips ((*****r9c|jsc|jtjurA|jdkrt d|jt d|jd|jt ddS)z Raises an error, when the connection could not have been established. Should be used, after a call to connect. Returns: None iz:Check your application path! The given Path is not valid: z9We received an HTTP-Error. Disconnected with error code: z, given message: zWWe failed to connect to the server (to start the server, try the 'bokeh serve' command)N)rdrhr HTTP_ERRORrlOSErrorr)rnrZs r8check_connection_errorsz%ClientSession.check_connection_errorss~ u K$:::?c))!"i_c_g"i"ijjjPZ^ZiPP}A}NPPQQQstt t  u ur9c|||jt}n|j}|j||j||dSdS)a  Pull the server's state and set it as session.document. If this is called more than once, session.document will be the same object instance but its contents will be overwritten. Automatically calls :func:`connect` before pulling. N)rur~r:r rGpull_doc_attach_document)rUdocs r8r5zClientSession.pulls~  $$&&& = **CC-C !!#&&& =  ! !# & & & & & ! r9r:c.|j|t}n|}n||j}ntd|||j||j||dSdS)a Push the given document to the server and record it as ``session.document``. If this is called more than once, the Document has to be the same (or None to mean ``session.document``). .. note:: Automatically calls :func:`~connect` before pushing. Args: document (|Document|, optional) : The document that will be kept in sync with the server document. None to use ``session.document`` or create a new document. NzACannot push() a different document from existing session.document) r:r ValueErrorrur~rGpush_docrNr)rUr:rs r8r<zClientSession.pushs = jjm !deee  $$&&& !!#&&& > !  ! !# & & & & & " !r9rc4|jS)zq Ask for information about the server. Returns: A dictionary of server attributes. )rGrequest_server_inforZs r8rz!ClientSession.request_server_infos33555r9r=objUIElement | Noner?r@rALiteral['tab', 'window']c~|r(||jjvr|j|t|||dS)a Open a browser displaying this session. Args: obj (UIElement object, optional) : a Layout (Row/Column), Plot or Widget object to display. The object will be added to the session's document. browser (str, optional) : browser to show with (default: None) For systems that support it, the **browser** argument allows specifying which browser to display in, e.g. "safari", "firefox", "opera", "windows-default" (see the :doc:`webbrowser ` module documentation in the standard lib for more details). new (str, optional) : new file output mode (default: "tab") For file-based output, opens or raises the browser window showing the current output file. If **new** is 'tab', then opens a new tab. If **new** is 'window', then opens a new window. )r7r?rAN)r:rootsadd_rootr%)rUrr?rAs r8showzClientSession.showsL*  (3dm111 M " "3 ' ' 'T7<<<<<>>>>r9c&|t}|Srg)r)clsr's r8rRz ClientSession._ensure_session_ids  ,..Jr9messagerc<||j|dSrg)apply_to_documentr:)rUrs r8 _handle_patchzClientSession._handle_patch s !!$-66666r9c8|jdS)z Execute a blocking loop that runs and executes event callbacks until the connection is closed (e.g. by hitting Ctrl-C). This function is intended to facilitate testing ONLY. N)rGloop_until_closedrZs r8_loop_until_closedz ClientSession._loop_until_closeds **,,,,,r9c~|j5|j||jdSdS)zR Called by the ClientConnection we are using to notify us of disconnect. N)r:remove_on_changerPremove_all_callbacksrZs r8_notify_disconnectedz"ClientSession._notify_disconnectedsD = $ M * *4 0 0 0 O 0 0 2 2 2 2 2 % $r9rcD|j|jdSrg)rPadd_session_callbackcallbackrs r8_session_callback_addedz%ClientSession._session_callback_added!s  ,,U^<<<<r?r@rArrBrCr1rD)7r __future__rlogging getLoggerrrtypingrrr urllib.parsertornado.ioloopr core.typesr r:r resourcesr r util.browserrrr util.tokenrrstatesrutilrrdocument.eventsrrr models.uirprotocol.messages.patch_docr#protocol.messages.server_info_replyrrTrrSr DEFAULT_SESSION_IDr__all__r#r$r%r"rYr9r8rs(#"""""g!!/.........######&%%%%%%CCCCCCCC@@@@@@@@@@@@@@@@@@LLLLLLLL-dddddddddd%%%%%%777777@@@@@@888888,,,,,, ;;