TapPlus

class astroquery.utils.tap.TapPlus(url=None, host=None, server_context=None, tap_context=None, port=80, sslport=443, default_protocol_is_https=False, connhandler=None, verbose=True)[source]

Bases: astroquery.utils.tap.Tap

TAP plus class Provides TAP and TAP+ capabilities

Constructor

Parameters:
url : str, mandatory if no host is specified, default None

TAP URL

host : str, optional, default None

host name

server_context : str, optional, default None

server context

tap_context : str, optional, default None

tap context

port : int, optional, default ‘80’

HTTP port

sslport : int, optional, default ‘443’

HTTPS port

default_protocol_is_https : bool, optional, default False

Specifies whether the default protocol to be used is HTTPS

connhandler connection handler object, optional, default None

HTTP(s) connection hander (creator). If no handler is provided, a new one is created.

verbose : bool, optional, default ‘True’

flag to display information about the process

Methods Summary

load_table(table[, verbose]) Loads the specified table
load_tables([only_names, …]) Loads all public tables
login([user, password, credentials_file, …]) Performs a login.
login_gui([verbose]) Performs a login using a GUI dialog
logout([verbose]) Performs a logout
remove_jobs(jobs_list[, verbose]) Removes the specified jobs
search_async_jobs([jobfilter, verbose]) Searches for jobs applying the specified filter

Methods Documentation

load_table(table, verbose=False)[source]

Loads the specified table

Parameters:
table : str, mandatory

full qualified table name (i.e. schema name + table name)

verbose : bool, optional, default ‘False’

flag to display information about the process

Returns:
A table object
load_tables(only_names=False, include_shared_tables=False, verbose=False)[source]

Loads all public tables

Parameters:
only_names : bool, TAP+ only, optional, default ‘False’

True to load table names only

include_shared_tables : bool, TAP+, optional, default ‘False’

True to include shared tables

verbose : bool, optional, default ‘False’

flag to display information about the process

Returns:
A list of table objects
login(user=None, password=None, credentials_file=None, verbose=False)[source]

Performs a login. User and password can be used or a file that contains user name and password (2 lines: one for user name and the following one for the password)

Parameters:
user : str, mandatory if ‘file’ is not provided, default None

login name

password : str, mandatory if ‘file’ is not provided, default None

user password

credentials_file : str, mandatory if no ‘user’ & ‘password’ are provided

file containing user and password in two lines

verbose : bool, optional, default ‘False’

flag to display information about the process

login_gui(verbose=False)[source]

Performs a login using a GUI dialog

Parameters:
verbose : bool, optional, default ‘False’

flag to display information about the process

logout(verbose=False)[source]

Performs a logout

Parameters:
verbose : bool, optional, default ‘False’

flag to display information about the process

remove_jobs(jobs_list, verbose=False)[source]

Removes the specified jobs

Parameters:
jobs_list : str, mandatory

jobs identifiers to be removed

verbose : bool, optional, default ‘False’

flag to display information about the process

search_async_jobs(jobfilter=None, verbose=False)[source]

Searches for jobs applying the specified filter

Parameters:
jobfilter : JobFilter, optional, default None

job filter

verbose : bool, optional, default ‘False’

flag to display information about the process

Returns:
A list of Job objects