๓ š฿ศ[c@`sddlmZmZmZmZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl mZddlmZmZddlmZdd lmZmZdd lmZmZdd lmZd gZd efd„ƒYZdS(i(tabsolute_importtdivisiontprint_functiontunicode_literalsNi(tlog(t urlunparsei(tSAMP_STATUS_OKtSAMP_STATUS_WARNING(t SAMPHubServer(tSAMPClientErrort SAMPWarning(t internet_ont get_num_args(tThreadingXMLRPCServeru SAMPClientt SAMPClientcB`s^eZdZd!d!d!d!ded„Zd„Zdd„Zed„ƒZ ed„ƒZ d„Z d „Z d „Z d „Zd „Zd „Zd„Zd„Zd„Zd„Zed!d„Zed!d„Zed!d„Zd„Zed„Zed„Zd„Zd!d„Zd„Zd„Zd„Zd!d„Z d!d„Z!d„Z"d „Z#RS("uฎ 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. ic C`s{t|_t|_|dkr'i}n|dk r@||d||jkr>|j|||||ƒndS(Nu(RXR#(R7RPt responder_idtmsg_tagtresponse((s2lib/python2.7/site-packages/astropy/samp/client.pyt_handle_responseCs  cC`s|j||||ƒS(u— Standard callable client ``receive_response`` method. This method is automatically handled when the :meth:`~astropy.samp.client.SAMPClient.bind_receive_response` method is used to bind distinct operations to MTypes. In case of a customized callable client implementation that inherits from the :class:`~astropy.samp.SAMPClient` class this method should be overwritten. .. note:: When overwritten, this method must always return a string result (even empty). Parameters ---------- private_key : str Client private key. responder_id : str Responder public ID. msg_tag : str Response message tag. response : dict Received response. Returns ------- confirmation : str Any confirmation string. (Rb(R7RPR_R`Ra((s2lib/python2.7/site-packages/astropy/samp/client.pyR4Js!cC`s<|j||d|d|ƒ|j||d|d|ƒdS(u Bind a specific MType to a function or class method, being intended for a call or a notification. 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 (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 catched. 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`). tdeclareR:N(tbind_receive_calltbind_receive_notification(R7R[tfunctionRcR:((s2lib/python2.7/site-packages/astropy/samp/client.pytbind_receive_messagens%cC`sQ|jrA|si}n||g|j|<|rM|jƒqMn tdƒ‚dS(u 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`). uClient not callable.N(RRt_declare_subscriptionsR (R7R[RfRcR:((s2lib/python2.7/site-packages/astropy/samp/client.pyRe™s!  cC`sQ|jrA|si}n||g|j|<|rM|jƒqMn tdƒ‚dS(u< 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`). uClient not callable.N(RR"RhR (R7R[RfRcR:((s2lib/python2.7/site-packages/astropy/samp/client.pyRdรs"  cC`s)|jr||j| 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. uClient not callable.N(RR#R (R7R`Rf((s2lib/python2.7/site-packages/astropy/samp/client.pytbind_receive_response๎s cC`s9|jr)|j|=|r5|jƒq5n tdƒ‚dS(uฦ 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`). uClient not callable.N(RRRhR (R7R[Rc((s2lib/python2.7/site-packages/astropy/samp/client.pytunbind_receive_notifications   cC`s9|jr)|j|=|r5|jƒq5n tdƒ‚dS(uพ 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`). uClient not callable.N(RR"RhR (R7R[Rc((s2lib/python2.7/site-packages/astropy/samp/client.pytunbind_receive_calls   cC`s&|jr|j|=n tdƒ‚dS(uธ Remove from the responses binding table the specified message-tag. Parameters ---------- msg_tag : str Message-tag to be removed. uClient not callable.N(RR#R (R7R`((s2lib/python2.7/site-packages/astropy/samp/client.pytunbind_receive_response4s  cC`s)|jr|j|ƒn tdƒ‚dS(u 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. uClient not callable.N(RRhR (R7t subscriptions((s2lib/python2.7/site-packages/astropy/samp/client.pytdeclare_subscriptionsBs cC`s|jjr๓|jd k r*tdƒ‚n|jj|jjdƒ}|ddkretdƒ‚n|ddkr„tdƒ‚n|d|_|d|_|d|_|j rห|j ƒ|j ƒn|j ikr็|j ƒnt|_n td ƒ‚d S( u6 Register the client to the SAMP Hub. uClient already registeredu samp.secretu samp.self-iduu:Registration failed - samp.self-id was not set by the hub.usamp.private-keyu>Registration failed - samp.private-key was not set by the hub.u samp.hub-idu<Unable to register to the SAMP Hub. Hub proxy not connected.N(R)t is_connectedRRR tregistertlockfileRRRt_set_xmlrpc_callbackRhRtdeclare_metadataR.R(R7tresult((s2lib/python2.7/site-packages/astropy/samp/client.pyRpZs$         cC`sV|jjrFt|_|jj|jƒd|_d|_d|_n t dƒ‚dS(u: Unregister the client from the SAMP Hub. u@Unable to unregister from the SAMP Hub. Hub proxy not connected.N( R)RoRRt unregisterRRRRR (R7((s2lib/python2.7/site-packages/astropy/samp/client.pyRu~s     cC`s;|jjr7|jdk r7|jj|j|jƒndS(N(R)RoRRtset_xmlrpc_callbackR(R7((s2lib/python2.7/site-packages/astropy/samp/client.pyRrŒscC`sู|jjrษ|jdk rษi}x5|jjƒD]$}tj|j|dƒ|| 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. uVUnable to declare metadata. Hub unreachable or not connected or client not registered.N(R)RoRRRRzRsR (R7R:((s2lib/python2.7/site-packages/astropy/samp/client.pyRsจs  cC`s|jS(uํ Return the client private key used for the Standard Profile communications obtained at registration time (``samp.private-key``). Returns ------- key : str Client private key. (R(R7((s2lib/python2.7/site-packages/astropy/samp/client.pyRXผs cC`s|jS(uณ Return public client ID obtained at registration time (``samp.self-id``). Returns ------- id : str Client public ID. (R(R7((s2lib/python2.7/site-packages/astropy/samp/client.pyt get_public_idศs N($t__name__t __module__t__doc__RR.R?RAREtpropertyRFRGR@R,R R!R]R2R^R3RbR4RgReRdRiRjRkRlRnRpRuRrRhRsRXR|(((s2lib/python2.7/site-packages/astropy/samp/client.pyRsB! C       #  $ **+      $     (t __future__RRRRRxRVRHR%R*RItRtextern.six.moves.urllib.parseRt constantsRRR)RterrorsR R tutilsR R tstandard_profileR t__all__tobjectR(((s2lib/python2.7/site-packages/astropy/samp/client.pyts"