Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented asynchronous execute_request #393

Closed
wants to merge 1 commit into from
Closed

Implemented asynchronous execute_request #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/source/example/src/custom_interpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ namespace nl = nlohmann;
namespace custom
{

nl::json custom_interpreter::execute_request_impl(xrequest_context request_context, // data required by other functions
int execution_counter, // Typically the cell number
const std::string& /*code*/, // Code to execute
bool /*silent*/,
bool /*store_history*/,
nl::json /*user_expressions*/,
bool /*allow_stdin*/)
void custom_interpreter::execute_request_impl(xrequest_context request_context,
send_reply_callback cb,
int execution_counter,
const std::string& code,
execute_request_config config,
nl::json user_expressions)
{
// You can use the C-API of your target language for executing the code,
// e.g. `PyRun_String` for the Python C-API
Expand All @@ -45,7 +44,8 @@ namespace custom
// publish_execution_error(error_name, error_value, error_traceback);
publish_execution_error(request_context, "TypeError", "123", {"!@#$", "*(*"});

return xeus::create_successful_reply();
// Call the callback parameter to send the reply
cb(xeus::create_successful_reply());
}

void custom_interpreter::configure_impl()
Expand Down
13 changes: 6 additions & 7 deletions docs/source/example/src/custom_interpreter.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,12 @@ namespace custom

void configure_impl() override;

nl::json execute_request_impl(xrequest_context request_context,
int execution_counter,
const std::string& code,
bool silent,
bool store_history,
nl::json user_expressions,
bool allow_stdin) override;
void execute_request_impl(xrequest_context request_context,
send_reply_callback cb,
int execution_counter,
const std::string& code,
execute_request_config config,
nl::json user_expressions) override;

nl::json complete_request_impl(const std::string& code,
int cursor_pos) override;
Expand Down
2 changes: 1 addition & 1 deletion docs/source/kernel_implementation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ course the ``execute_request_impl`` which executes the code whenever the client
.. literalinclude:: ./example/src/custom_interpreter.cpp
:language: cpp
:dedent: 4
:lines: 22-48
:lines: 22-49

The result and arguments of the execution request are described in the execute_request_ documentation.

Expand Down
32 changes: 19 additions & 13 deletions include/xeus/xinterpreter.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ namespace xeus
XEUS_API bool register_interpreter(xinterpreter* interpreter);
XEUS_API xinterpreter& get_interpreter();

struct XEUS_API execute_request_config
{
bool silent;
bool store_history;
bool allow_stdin;
};

class XEUS_API xinterpreter
{
public:
Expand All @@ -42,12 +49,12 @@ namespace xeus

void configure();

nl::json execute_request(xrequest_context context,
const std::string& code,
bool silent,
bool store_history,
nl::json user_expressions,
bool allow_stdin);
using send_reply_callback = std::function<void(nl::json)>;
void execute_request(xrequest_context context,
send_reply_callback callback,
const std::string& code,
execute_request_config config,
nl::json user_expressions);

nl::json complete_request(const std::string& code, int cursor_pos);

Expand Down Expand Up @@ -101,13 +108,12 @@ namespace xeus

virtual void configure_impl() = 0;

virtual nl::json execute_request_impl(xrequest_context request_context,
int execution_counter,
const std::string& code,
bool silent,
bool store_history,
nl::json user_expressions,
bool allow_stdin) = 0;
virtual void execute_request_impl(xrequest_context request_context,
send_reply_callback cb,
int execution_counter,
const std::string& code,
execute_request_config config,
nl::json user_expressions) = 0;

virtual nl::json complete_request_impl(const std::string& code,
int cursor_pos) = 0;
Expand Down
27 changes: 13 additions & 14 deletions src/xinterpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,27 +29,26 @@ namespace xeus
configure_impl();
}

nl::json xinterpreter::execute_request(xrequest_context context,
const std::string& code,
bool silent,
bool store_history,
nl::json user_expressions,
bool allow_stdin)
{
if (!silent)
void xinterpreter::execute_request(xrequest_context context,
send_reply_callback callback,
const std::string& code,
execute_request_config config,
nl::json user_expressions)
{
if (!config.silent)
{
++m_execution_count;
publish_execution_input(context, code, m_execution_count);
}

nl::json reply = execute_request_impl(
execute_request_impl(
std::move(context),
m_execution_count, code, silent,
store_history, user_expressions, allow_stdin
std::move(callback),
m_execution_count,
code,
std::move(config),
user_expressions
);

reply["execution_count"] = m_execution_count;
return reply;
}

nl::json xinterpreter::complete_request(const std::string& code, int cursor_pos)
Expand Down
39 changes: 27 additions & 12 deletions src/xkernel_core.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,19 +236,34 @@ namespace xeus
bool allow_stdin = content.value("allow_stdin", true);
bool stop_on_error = content.value("stop_on_error", false);

nl::json metadata = get_metadata();
xrequest_context request_context(request.header(), c, request.identities());
nl::json reply = p_interpreter->execute_request(std::move(request_context),
code, silent, store_history, std::move(user_expression), allow_stdin);
int execution_count = reply.value("execution_count", 1);
std::string status = reply.value("status", "error");
send_reply(
request.identities(),
"execute_reply",
request.header(),
std::move(metadata),
std::move(reply),
c);
execute_request_config config { silent, store_history, allow_stdin };
int execution_count = 1;
std::string status;
auto reply_callback = [&](nl::json reply)
{
execution_count = reply.value("execution_count", 1);
status = reply.value("status", "error");
nl::json metadata = get_metadata();

send_reply(
request.identities(),
"execute_reply",
request.header(),
std::move(metadata),
std::move(reply),
c
);
};

p_interpreter->execute_request(
std::move(request_context),
std::move(reply_callback),
code,
config,
std::move(user_expression)
);


if (!silent && store_history)
{
Expand Down
15 changes: 7 additions & 8 deletions src/xmock_interpreter.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,14 @@ namespace xeus
{
}

nl::json execute_request_impl(xrequest_context /*request_context*/,
int /*execution_counter*/,
const std::string& /*code*/,
bool /*silent*/,
bool /*store_history*/,
nl::json /*user_expressions*/,
bool /*allow_stdin*/) override
void execute_request_impl(xrequest_context /*request_context*/,
send_reply_callback cb,
int /*execution_counter*/,
const std::string& /*code*/,
execute_request_config /*config*/,
nl::json /*user_expressions*/) override
{
return nl::json();
cb(nl::json());
}

nl::json complete_request_impl(const std::string& /*code*/, int /*cursor_pos*/) override
Expand Down
17 changes: 8 additions & 9 deletions test/xmock_interpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,12 @@ namespace xeus
using function_type = std::function<void(xeus::xcomm&&, const xeus::xmessage&)>;
}

nl::json xmock_interpreter::execute_request_impl(xrequest_context request_context,
int execution_counter,
const std::string& code,
bool /* silent */,
bool /* store_history */,
nl::json /* user_expressions */,
bool /* allow_stdin */)
void xmock_interpreter::execute_request_impl(xrequest_context request_context,
send_reply_callback cb,
int execution_counter,
const std::string& code,
execute_request_config /*config*/,
nl::json /*user_expressions*/)
{
if (code.compare("hello, world") == 0)
{
Expand All @@ -62,14 +61,14 @@ namespace xeus
{"start", 0}
});

return xeus::create_successful_reply(payload);
cb(xeus::create_successful_reply(payload));
}

nl::json pub_data;
pub_data["text/plain"] = code;
publish_execution_result(request_context, execution_counter, std::move(pub_data), nl::json::object());

return xeus::create_successful_reply();
cb(xeus::create_successful_reply());
}

nl::json xmock_interpreter::complete_request_impl(const std::string& /* code */,
Expand Down
13 changes: 6 additions & 7 deletions test/xmock_interpreter.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,12 @@ namespace xeus

void configure_impl() override;

nl::json execute_request_impl(xrequest_context request_context,
int execution_counter,
const std::string& code,
bool silent,
bool store_history,
nl::json user_expressions,
bool allow_stdin) override;
void execute_request_impl(xrequest_context request_context,
send_reply_callback cb,
int execution_counter,
const std::string& code,
execute_request_config config,
nl::json user_expressions) override;

nl::json complete_request_impl(const std::string& code,
int cursor_pos) override;
Expand Down