pyvoa.kwargs_options

The catalogue of keyword arguments pyvoa accepts.

InputOption holds the data-selection arguments (where, which, what, when, option, input, output) and the drawing ones (vis, typeofplot, typeofhist, typeofmap, tile and the rest), each mapped to the values it accepts, the first of which is the default. front validates every user call against these two dictionaries.

Project : pyvoa Authors : Tristan Beau, Julien Browaeys, Olivier Dadoun Copyright ©pyvoa_org License : see the joint LICENSE file https://pyvoa.org/

class pyvoa.kwargs_options.InputOption

Bases: object

The catalogue of keyword arguments, and the values each one accepts.

front validates every user call against the two dictionaries built here.

__init__()

Build the catalogue of every keyword argument pyvoa accepts.

Fills two dictionaries that the front class validates user input against: d_batchinput_args, the data selection (‘where’, ‘which’, ‘what’, ‘when’, ‘option’, ‘input’, ‘output’), and d_graphicsinput_args, the drawing options (‘vis’, ‘typeofplot’, ‘typeofhist’, ‘typeofmap’, ‘tile’, …). Each entry maps a keyword to its accepted values, the first of which is the default. pdcharts records which backend supports which chart type, and dictpop the population scales used by the ‘normalize:’ options.

test_add_graphics_libraries(libraries)

Report which of the given graphical libraries are installed.

Parameters:

libraries (list of str) – The module names to try to import.

Returns:

One entry per name given, True if importing it succeeded.

Return type:

dict

setkwargsfront(kw)

Store the drawing options to apply to the following charts.

Parameters:

kw (dict) – the options to keep, checked against d_graphicsinput_args. An unknown key raises PyvoaError.

getkwargsfront()

Return the drawing options set by setkwargsfront().

Returns:

the stored options, empty until setkwargsfront() is called.

Return type:

dict