MHO_PythonSubprocessContract.hh

Go to the documentation of this file.

#ifndef MHO_PythonSubprocessContract_HH__
#define MHO_PythonSubprocessContract_HH__
 
#include <string>
 
namespace hops
{
namespace python_subprocess
{
 
//bump when the request/response field layout OR the invocation convention
//changes incompatibly. v2: the child is invoked as
//`python -m <module> <request_file> <response_file>` and writes its JSON
//response into <response_file> (rather than to stdout) so that stray output
//from user control/plot code cannot corrupt the contract.
static const int kSchemaVersion = 2;
 
//common field names
static const char* const kSchemaVersionKey = "schema_version";
static const char* const kOkKey = "ok";
static const char* const kErrorKey = "error";
 
//control request/response
namespace control
{
static const char* const kModule = "hops_control"; // python -m hops_control
static const char* const kPassInfoKey = "pass_info";
static const char* const kConfigKey = "config";
static const char* const kScriptPathKey = "script_path";
static const char* const kStatementsKey = "statements";
} // namespace control
 
//plot request/response
namespace plot
{
static const char* const kModule = "hops_visualization.fourfit_plot";
static const char* const kPlotDictKey = "plot_dict";
static const char* const kShowPlotKey = "show_plot";
static const char* const kDiskFileKey = "disk_file";
static const char* const kOutputFileKey = "output_file";
} // namespace plot
 
} // namespace python_subprocess
 
} // namespace hops
 
#endif