qsrlib.qsrlib module

QSRlib module.

class qsrlib.qsrlib.QSRlib(help=False)[source]

Bases: object

The LIB

help()[source]

stdout help message about QSRlib

qsrs_registry

Getter.

Returns:self.__qsrs_registry
Return type:dict
request_qsrs(req_msg)[source]

Main function of the QSRlib that does all the magic; returns the computed requested QSRs.

Parameters:req_msg (QSRlib_Request_Message) – A request message containing the necessary data and other options.
Returns:Response message containing the computed requested QSRs and other information.
Return type:QSRlib_Response_Message
class qsrlib.qsrlib.QSRlib_Request_Message(which_qsr, input_data, dynamic_args={}, req_made_at=None)[source]

Bases: object

Input to QSRlib request calls containing all the necessary data.

dynamic_args = None

dict: User args passed dynamically during the request.

input_data = None

World_Trace: The input data.

made_at = None

datetime.datetime (datetime.datetime.now()): Time the request was made.

which_qsr = None

str or list: The name(s) of the wanted QSR(s) to be computed.

class qsrlib.qsrlib.QSRlib_Response_Message(qsrs, req_made_at, req_received_at, req_finished_at)[source]

Bases: object

The response message of QSRlib containing the QSRs and time processing information.

qsrs = None

World_QSR_Trace: Holds the QSRs.

req_finished_at = None

datetime.datetime : Time the QSRlib finished processing the request.

req_made_at = None

datetime.datetime : Time the request was made.

req_received_at = None

datetime.datetime : Time the request was received in QSRlib.