Reference/API

pyvo.samp Package

This subpackage provides classes to communicate with other applications via the Simple Application Messaging Protocol (SAMP).

Before integration into Astropy it was known as SAMPy, and was developed by Luigi Paioro (INAF - Istituto Nazionale di Astrofisica).

Functions

accessible_table(table)

a context manager making astropy_table available under a (file) URL for the controlled section.

connection([client_name, description])

a context manager to give the controlled block a SAMP connection.

find_client_id(conn, name)

returns the SAMP id of the client with samp.name samp_name.

safe_xmlrpc_loads(data[, use_datetime, ...])

A secure replacement for xmlrpc.client.loads that prevents XXE.

send_image_to(conn, url[, client_name, name])

asks an image client to open a remote image via SAMP.

send_product_to(conn, url, mtype[, ...])

sends SAMP messages to load data.

send_spectrum_to(conn, url[, client_name, name])

asks a spectrum client to open a remote spectrum via SAMP.

send_table_to(conn, table[, client_name, name])

sends astropy_table via SAMP.

Classes

Conf()

Configuration parameters for pyvo.samp.

SAMPClient(hub[, name, description, ...])

Utility class which provides facilities to create and manage a SAMP compliant XML-RPC server that acts as SAMP callable client application.

SAMPClientError

SAMP Client exceptions.

SAMPHubError

SAMP Hub exception.

SAMPHubProxy()

Proxy class to simplify the client interaction with a SAMP hub (via the standard profile).

SAMPHubServer([secret, addr, port, ...])

SAMP Hub Server.

SAMPIntegratedClient([name, description, ...])

A Simple SAMP client.

SAMPMsgReplierWrapper(cli)

Function decorator that allows to automatically grab errors and returned maps (if any) from a function bound to a SAMP call (or notify).

SAMPProxyError(faultCode, faultString, **extra)

SAMP Proxy Hub exception.

SAMPWarning

SAMP-specific Astropy warning class.

SAMPXXEServerProxy(uri, *args, **kwargs)

An XML-RPC server proxy that uses a safe transport to prevent XXE.

WebProfileDialog()

A base class to make writing Web Profile GUI consent dialogs easier.

Class Inheritance Diagram

Inheritance diagram of pyvo.samp.Conf, pyvo.samp.client.SAMPClient, pyvo.samp.errors.SAMPClientError, pyvo.samp.errors.SAMPHubError, pyvo.samp.hub_proxy.SAMPHubProxy, pyvo.samp.hub.SAMPHubServer, pyvo.samp.integrated_client.SAMPIntegratedClient, pyvo.samp.utils.SAMPMsgReplierWrapper, pyvo.samp.errors.SAMPProxyError, pyvo.samp.errors.SAMPWarning, pyvo.samp.utils.SAMPXXEServerProxy, pyvo.samp.hub.WebProfileDialog