IR-ecddlZddlZddlZddlZddlZddlZddlmZddlm Z m Z ddl m Z m Z ddlmZddlmZddlmZmZd gZGd d ZdS) N) urlunparse)SAMP_STATUS_OKSAMP_STATUS_WARNING)SAMPClientError SAMPWarning) SAMPHubServer)ThreadingXMLRPCServer) get_num_args internet_on SAMPClientceZdZdZ d$dZdZd%dZed Zed Z d Z d Z d Z dZ dZdZdZdZdZdZd&dZd&dZd&dZdZd'dZd'dZdZd(dZdZdZdZd(d Zd(d!Z d"Z!d#Z"dS))r a Utility class which provides facilities to create and manage a SAMP compliant XML-RPC server that acts as SAMP callable client application. Parameters ---------- hub : :class:`~astropy.samp.SAMPHubProxy` An instance of :class:`~astropy.samp.SAMPHubProxy` to be used for messaging with the SAMP Hub. name : str, optional Client name (corresponding to ``samp.name`` metadata keyword). description : str, optional Client description (corresponding to ``samp.description.text`` metadata keyword). metadata : dict, optional Client application metadata in the standard SAMP format. addr : str, optional Listening address (or IP). This defaults to 127.0.0.1 if the internet is not reachable, otherwise it defaults to the host name. port : int, optional Listening XML-RPC server socket port. If left set to 0 (the default), the operating system will select a free port. callable : bool, optional Whether the client can receive calls and notifications. If set to `False`, then the client can send notifications and calls, but can not receive any. NrTcvd|_d|_|i}|||d<|||d<||_||_||_d|_||_d|_d|_d|_ d|_ i|_ |j ig|j igd|_i|_d|_t#rY t%j|_t%j|jp|j|jpdn#t*$r d|_YnwxYw||_|jr6t/j|j|_d|j_t9|jp|j|jfdd |_|j|j|jd |j|j d |j|j!d |jdkr)|jj"d |_d}tG||jp|jd|jddddf|_dSdS)NFz samp.namezsamp.description.text)z samp.app.pingzclient.env.getz 127.0.0.1r)targetT) logRequests allow_nonezsamp.client.receiveNotificationzsamp.client.receiveCallzsamp.client.receiveResponserhttp:)$ _is_running_is_registered _metadata_addr_port _xmlrpcAddr _callableclient _public_id _private_key_hub_id_notification_bindings_ping_client_env_get_call_bindings_response_bindings _host_namer socketgetfqdn getaddrinfoOSErrorhub threadingThread_serve_forever_threaddaemonr register_introspection_functionsregister_functionreceive_notification receive_callreceive_response getsocknamer) selfr+name descriptionmetadataaddrportcallableprotocols 3lib/python3.11/site-packages/astropy/samp/client.py__init__zSAMPClient.__init__:s!#  H  $(H[ !  "0;H, -!  !   &(#"j"-#3R8  #%% == . ."(."2"2"4:#@$*/PQRRRR . . ."- . ># $+43FGGGDL"&DL /.t ;!DK K 8 8 : : : K ) ))+L    K ) )$*;=V W W W K ) )%'D    zQ![/;;==a@ H)z4T_CCtzCC   D   5# # sACC10C1cN|jrd|_|dSdS)z Start the client in a separate thread (non-blocking). This only has an effect if ``callable`` was set to `True` when initializing the client. TN)rr _run_clientr7s r?startzSAMPClient.starts8 > #D           $@cd|_|jr3|jr|j||jrt d|ddS)z Stop the client. Parameters ---------- timeout : float Timeout after which to give up if the client cannot be cleanly shut down. Fz/Client was not shut down successfully (timeout=zs)N)rrr/is_alivejoinr)r7timeouts r?stopzSAMPClient.stops! > 'dl3355 ' L  g & & & < " " !M'MMM   rEc|jS)z: Whether the client is currently running. )rrCs r? is_runningzSAMPClient.is_runnings rEc|jS)z= Whether the client is currently registered. )rrCs r? is_registeredzSAMPClient.is_registereds ""rEcJ|jr|jdSdSN)rr/rDrCs r?rBzSAMPClient._run_clients0 > ! L    ! !rEcF|jr tj|jjgggdd}|r|jn4#t $r'}t jd|tYd}~nd}~wwxYw|j|j dS)Ng?rz%Call to select in SAMPClient failed: ) rselectrr'handle_requestr*warningswarnr server_close)r7 read_readyexcs r?r.zSAMPClient._serve_forevers 1 1#]DK,>+?RMMaP 1K..000     ACAA;  1   """""s(A A>A99A>cRtid}|j|||dS)N samp.status samp.result)rr+replyr7 private_key sender_idmsg_id msg_mtype msg_paramsmessager^s r?r"zSAMPClient._pings- .rBB {FE22222rEc|dtjvr#tdtj|did}ntddiddid}|j|||dS)Nr8valuer[rz samp.errortxtz!Environment variable not defined.)r\r]z samp.error)osenvironrrr+r^r_s r?r#zSAMPClient._client_env_gets| f  + +- 'Jv4F)GHEE 3 '}.0STE {FE22222rEc :||krd|vr~|d}|d=|d}|d=tj|}|D]Q}||jvrF|j|d}t |dkr||||||A|||d|||RdS)N samp.mtype samp.paramsrr)get_private_keyr get_mtype_subtypesr!r ) r7r`rarercrdmsubsmtype bound_funcs r?_handle_notificationzSAMPClient._handle_notifications $..00 0 0\W5L5L -I % /J &!4Y??E  D777!%! private_key, sender_id, msg_id, mtype, params, extra) where ``private_key`` is the client private-key, ``sender_id`` is the notification sender ID, ``msg_id`` is the Hub message-id (calls only, otherwise is `None`), ``mtype`` is the message MType, ``params`` is the message parameter set (content of ``"samp.params"``) and ``extra`` is a dictionary containing any extra message map entry. The client is automatically declared subscribed to the MType by default. Parameters ---------- mtype : str MType to be caught. function : callable Application function to be used when ``mtype`` is received. declare : bool, optional Specify whether the client must be automatically declared as subscribed to the MType (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). metadata : dict, optional Dictionary containing additional metadata to declare associated with the MType subscribed to (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). )declarer:N)bind_receive_callbind_receive_notificationr7rqfunctionrr:s r?bind_receive_messagezSAMPClient.bind_receive_message}sRF uh(SSS && 8Wx '     rEc|jr*|si}||g|j|<|r|dSdStd)a Bind a specific MType notification to a function or class method. The function must be of the form:: def my_function_or_method( private_key, sender_id, mtype, params, extra) where ``private_key`` is the client private-key, ``sender_id`` is the notification sender ID, ``mtype`` is the message MType, ``params`` is the notified message parameter set (content of ``"samp.params"``) and ``extra`` is a dictionary containing any extra message map entry. The client is automatically declared subscribed to the MType by default. Parameters ---------- mtype : str MType to be caught. function : callable Application function to be used when ``mtype`` is received. declare : bool, optional Specify whether the client must be automatically declared as subscribed to the MType (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). metadata : dict, optional Dictionary containing additional metadata to declare associated with the MType subscribed to (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). Client not callable.Nrr!_declare_subscriptionsrrs r?rz$SAMPClient.bind_receive_notificationsiB > : 2:H1ED ' . .++----- . .""899 9rEc|jr*|si}||g|j|<|r|dSdStd)a< Bind a specific MType call to a function or class method. The function must be of the form:: def my_function_or_method( private_key, sender_id, msg_id, mtype, params, extra) where ``private_key`` is the client private-key, ``sender_id`` is the notification sender ID, ``msg_id`` is the Hub message-id, ``mtype`` is the message MType, ``params`` is the message parameter set (content of ``"samp.params"``) and ``extra`` is a dictionary containing any extra message map entry. The client is automatically declared subscribed to the MType by default. Parameters ---------- mtype : str MType to be caught. function : callable Application function to be used when ``mtype`` is received. declare : bool, optional Specify whether the client must be automatically declared as subscribed to the MType (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). metadata : dict, optional Dictionary containing additional metadata to declare associated with the MType subscribed to (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). rNrr$rrrs r?rzSAMPClient.bind_receive_callsiD > : *2H)=D  & .++----- . .""899 9rEcF|jr ||j|<dStd)a Bind a specific msg-tag response to a function or class method. The function must be of the form:: def my_function_or_method( private_key, responder_id, msg_tag, response) where ``private_key`` is the client private-key, ``responder_id`` is the message responder ID, ``msg_tag`` is the message-tag provided at call time and ``response`` is the response received. Parameters ---------- msg_tag : str Message-tag to be caught. function : callable Application function to be used when ``msg_tag`` is received. rNrr%r)r7r{rs r?bind_receive_responsez SAMPClient.bind_receive_responses0* > :/7D #G , , ,!"899 9rEcr|jr"|j|=|r|dSdStd)a Remove from the notifications binding table the specified MType and unsubscribe the client from it (if required). Parameters ---------- mtype : str MType to be removed. declare : bool Specify whether the client must be automatically declared as unsubscribed from the MType (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). rNrr7rqrs r?unbind_receive_notificationz&SAMPClient.unbind_receive_notificationsT > :+E2 .++----- . .""899 9rEcr|jr"|j|=|r|dSdStd)a Remove from the calls binding table the specified MType and unsubscribe the client from it (if required). Parameters ---------- mtype : str MType to be removed. declare : bool Specify whether the client must be automatically declared as unsubscribed from the MType (see also :meth:`~astropy.samp.client.SAMPClient.declare_subscriptions`). rNrrs r?unbind_receive_callzSAMPClient.unbind_receive_call+sT > :#E* .++----- . .""899 9rEcB|jr |j|=dStd)z Remove from the responses binding table the specified message-tag. Parameters ---------- msg_tag : str Message-tag to be removed. rNr)r7r{s r?unbind_receive_responsez"SAMPClient.unbind_receive_responseAs. > :'000!"899 9rEc\|jr||dStd)a Declares the MTypes the client wishes to subscribe to, implicitly defined with the MType binding methods :meth:`~astropy.samp.client.SAMPClient.bind_receive_notification` and :meth:`~astropy.samp.client.SAMPClient.bind_receive_call`. An optional ``subscriptions`` map can be added to the final map passed to the :meth:`~astropy.samp.hub_proxy.SAMPHubProxy.declare_subscriptions` method. Parameters ---------- subscriptions : dict, optional Dictionary containing the list of MTypes to subscribe to, with the same format of the ``subscriptions`` map passed to the :meth:`~astropy.samp.hub_proxy.SAMPHubProxy.declare_subscriptions` method. rN)rrr)r7 subscriptionss r?declare_subscriptionsz SAMPClient.declare_subscriptionsOs7& > :  ' ' 6 6 6 6 6!"899 9rEc |jjr|jtd|j|jjd}|ddkrtd|ddkrtd|d|_|d|_|d |_|jr(| | |j ikr| d |_ dStd ) z6 Register the client to the SAMP Hub. NzClient already registeredz samp.secretz samp.self-idrz:Registration failed - samp.self-id was not set by the hub.zsamp.private-keyz>Registration failed - samp.private-key was not set by the hub.z samp.hub-idTz Declare the client application metadata supported. Parameters ---------- metadata : dict, optional Dictionary containing the client application metadata as defined in the SAMP definition document. If omitted, then no metadata are declared. NzVUnable to declare metadata. Hub unreachable or not connected or client not registered.)r+rrrrrr)r7r:s r?rzSAMPClient.declare_metadataso 8 T%6%B#%%h/// H % %d&7 H H H H H!" rEc|jS)z Return the client private key used for the Standard Profile communications obtained at registration time (``samp.private-key``). Returns ------- key : str Client private key. )rrCs r?rnzSAMPClient.get_private_keys   rEc|jS)z Return public client ID obtained at registration time (``samp.self-id``). Returns ------- id : str Client public ID. )rrCs r? get_public_idzSAMPClient.get_public_ids rE)NNNNrT)rF)TN)TrQ)#__name__ __module__ __qualname____doc__r@rDrKpropertyrMrOrBr.r"r#rsr3rvr4r}r5rrrrrrrrrrrrrrnrrEr?r r sW  N  WWWWr   *  X ##X# !!! # # #333 333",JJJ@"!J!J!JF!S!S!SF' ' ' ' R(:(:(:(:T):):):):V:::4::::,::::, : : :::::0$$$L   NNN4, ! ! !     rE)rrhrSr'r,rU urllib.parser constantsrrerrorsrrr+r standard_profiler utilsr r __all__r rrEr?rs ######::::::::00000000333333,,,,,,,, .Q Q Q Q Q Q Q Q Q Q rE