epivizfileserver.server package

Submodules

epivizfileserver.server.request module

class epivizfileserver.server.request.DataRequest(request)[source]

Bases: epivizfileserver.server.request.EpivizRequest

Data requests class

get_data(mMgr)[source]

Get Data for this request type

Returns:JSON response for this request error: HTTP ERROR CODE
Return type:result
validate_params(request)[source]

Validate parameters for requests

Parameters:request – dict of params from request
class epivizfileserver.server.request.EpivizRequest(request)[source]

Bases: object

Base class to process requests

get_data(mMgr)[source]

Get Data for this request type

Returns:JSON response for this request error: HTTP ERROR CODE
Return type:result
validate_params(request)[source]

Validate parameters for requests

Parameters:request – dict of params from request
class epivizfileserver.server.request.MeasurementRequest(request)[source]

Bases: epivizfileserver.server.request.EpivizRequest

Measurement requests class

get_data(mMgr)[source]

Get Data for this request type

Returns:JSON response for this request error: HTTP ERROR CODE
Return type:result
validate_params(request)[source]

Validate parameters for requests

Parameters:request – dict of params from request
class epivizfileserver.server.request.SearchRequest(request)[source]

Bases: epivizfileserver.server.request.EpivizRequest

Search requests class

get_data(mMgr)[source]

Get Data for this request type

Returns:JSON response for this request error: HTTP ERROR CODE
Return type:result
validate_params(request)[source]

Validate parameters for requests

Parameters:request – dict of params from request
class epivizfileserver.server.request.SeqInfoRequest(request)[source]

Bases: epivizfileserver.server.request.EpivizRequest

SeqInfo requests class

get_data(mMgr)[source]

Get Data for this request type

Returns:JSON response for this request error: HTTP ERROR CODE
Return type:result
validate_params(request)[source]

Validate parameters for requests

Parameters:request – dict of params from request
class epivizfileserver.server.request.StatusRequest(request, datasource)[source]

Bases: epivizfileserver.server.request.EpivizRequest

get_status(mMgr)[source]
epivizfileserver.server.request.create_request(action, request)[source]

Create appropriate request class based on action

Parameters:
  • action – Type of request
  • request – Other request parameters
Returns:

An instance of EpivizRequest class

epivizfileserver.server.utils module

epivizfileserver.server.utils.bin_rows(input, max_rows=2000)[source]

Helper function to bin rows to resolution

Parameters:
  • input – dataframe to bin
  • max_rows – resolution to scale rows
Returns:

data frame with scaled rows

epivizfileserver.server.utils.create_parser_object(format, source)[source]

Create appropriate File class based on file format

Parameters:
  • format – Type of file
  • request – Other request parameters
Returns:

An instance of parser class

epivizfileserver.server.utils.format_result(input, params, offset=True)[source]

Fromat result to a epiviz compatible format

Parameters:
  • input – input dataframe
  • params – request parameters
  • offset – defaults to True
Returns:

formatted JSON response

Module contents

epivizfileserver.server.MAXWORKER = 10

The server module allows users to instantly create a REST API from the list of measuremensts. The API can then be used to interactive exploration of data or build various applications.

epivizfileserver.server.clean_up(app, loop)[source]
epivizfileserver.server.create_fileHandler()[source]

create a dask file handler if one doesn’t exist

epivizfileserver.server.schedulePickle()[source]

Sanic task to regularly pickle file objects from memory

epivizfileserver.server.setup_after_connection(app, loop)[source]
epivizfileserver.server.setup_app(measurementsManager, dask_scheduler=None)[source]

Setup the Sanic Rest API

Parameters:measurementsManager – a measurements manager object
Returns:a sanic app object
epivizfileserver.server.setup_connection(app, loop)[source]

Sanic callback for app setup before the server starts