ganeti.rapi.baserlib

module documentation

Remote API base resources library.

Class	`OpcodeAttributes`	Acts as a structure containing the per-method attribute names.
Class	`OpcodeResource`	Base class for opcode-based RAPI resources.
Class	`ResourceBase`	Generic class for resources.
Function	`BuildUriList`	Builds a URI list as used by index resources.
Function	`CheckParameter`	Check and return the value for a given parameter.
Function	`CheckType`	Abort request if value type doesn't match expected type.
Function	`FeedbackFn`	Feedback logging function for jobs.
Function	`FillOpcode`	Fills an opcode with body parameters.
Function	`GetHandler`	Undocumented
Function	`GetHandlerAccess`	Returns the access rights for a method on a handler.
Function	`GetResourceOpcodes`	Returns all opcodes used by a resource.
Function	`HandleItemQueryErrors`	Converts errors when querying a single item.
Function	`InspectParams`	Inspects a dictionary of params, looking for forbidden values.
Function	`MapBulkFields`	Map value to field name in to one dictionary.
Function	`MapFields`	Maps two lists into one dictionary.
Function	`ProduceForbiddenParamDict`	Turns a list of parameter names and possibly values into a dictionary.
Constant	`ALL_VALUES_FORBIDDEN`	Undocumented
Constant	`OPCODE_ATTRS`	Undocumented
Class	`_MetaOpcodeResource`	Meta class for RAPI resources.
Function	`_BuildOpcodeAttributes`	Builds list of attributes used for per-handler opcodes.
Constant	`_DEFAULT`	Undocumented
Constant	`_SUPPORTED_METHODS`	Undocumented

def BuildUriList(ids, uri_format, uri_fields=('name', 'uri')): ¶

Builds a URI list as used by index resources.

Parameters
ids	list of ids as strings
uri_format	format to be applied for URI
uri_fields	optional parameter for field IDs

def CheckParameter(data, name, default=_DEFAULT, exptype=_DEFAULT): ¶

Check and return the value for a given parameter.

If no default value was given and the parameter doesn't exist in the input data, an error is raise.

Parameters
data:dict	Dictionary containing input data
name:string	Parameter name
default	Default value (can be None)
exptype	Expected type (can be None)

def CheckType(value, exptype, descr): ¶

Abort request if value type doesn't match expected type.

Parameters
value	Value
exptype:type	Expected type
descr:string	Description of value
Returns
Value (allows inline usage)

def FeedbackFn(msg): ¶

Feedback logging function for jobs.

We don't have a stdout for printing log messages, so log them to the http log at least.

Parameters
msg	the message

def FillOpcode(opcls, body, static, rename=None): ¶

Fills an opcode with body parameters.

Parameter types are checked.

Parameters
opcls:`opcodes.OpCode`	Opcode class
body:dict	Body parameters as received from client
static:dict	Static parameters which can't be modified by client
rename:dict	Renamed parameters, key as old name, value as new name
Returns
Opcode object

def GetHandler(get_fn, aliases): ¶

Undocumented

def GetHandlerAccess(handler, method): ¶

Returns the access rights for a method on a handler.

Parameters
handler:`ResourceBase`	Undocumented
method:string	Undocumented
Returns
string or None	Undocumented

def GetResourceOpcodes(cls): ¶

Returns all opcodes used by a resource.

def HandleItemQueryErrors(fn, *args, **kwargs): ¶

Converts errors when querying a single item.

def InspectParams(params_dict, forbidden_params, rename_dict): ¶

Inspects a dictionary of params, looking for forbidden values.

Parameters
params_dict:dict of string to anything	A dictionary of supplied parameters
forbidden_params:dict of string to string or list of any	The forbidden parameters, with a list of forbidden values or the constant ALL_VALUES_FORBIDDEN signifying that all values are forbidden
rename_dict:None or dict of string to string	The list of parameter renamings used by the method
Raises
`http.HttpForbidden`	If a forbidden param has been set

def MapBulkFields(itemslist, fields): ¶

Map value to field name in to one dictionary.

Parameters
itemslist	a list of items values
fields	a list of items names
Returns
a list of mapped dictionaries

def MapFields(names, data): ¶

Maps two lists into one dictionary.

Example:

    >>> MapFields(["a", "b"], ["foo", 123])
    {'a': 'foo', 'b': 123}

Parameters
names	field names (list of strings)
data	field data (list)

def ProduceForbiddenParamDict(class_name, method_name, param_list): ¶

Turns a list of parameter names and possibly values into a dictionary.

Parameters
class_name:string	The name of the handler class
method_name:string	The name of the HTTP method
param_list:list of string or tuple of (string, list of any)	A list of forbidden parameters, specified in the RAPI handler class
Returns
The dictionary of forbidden param names to values or ALL_VALUES_FORBIDDEN

ALL_VALUES_FORBIDDEN: str = ¶

Undocumented

Value

'all_values_forbidden'

OPCODE_ATTRS = ¶

Undocumented

Value

_BuildOpcodeAttributes()

def _BuildOpcodeAttributes(): ¶

Builds list of attributes used for per-handler opcodes.

_DEFAULT = ¶

Undocumented

Value

object()

_SUPPORTED_METHODS = ¶

Undocumented

Value

compat.UniqueFrozenset([http.HTTP_DELETE,
                        http.HTTP_GET,
                        http.HTTP_POST,
                        http.HTTP_PUT])