Skip to content

Use xeus's routines for creating the replies #675

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

Merged
martinRenou merged 24 commits into from
Oct 28, 2025
Merged

Use xeus's routines for creating the replies #675

Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
c4a5245
Use `xeus::create_successful_reply` routine in debugger modules request
arjxn-py Oct 21, 2025
a22063d
use xeus's routines in `execute_request_impl`
arjxn-py Oct 22, 2025
8afa212
use xeus's routines in `complete_request_impl`
arjxn-py Oct 22, 2025
af1779a
use xeus's routines in `inspect_request_impl`
arjxn-py Oct 22, 2025
d3b7b77
use xeus's routines in `is_complete_request_impl`
arjxn-py Oct 22, 2025
5398530
use xeus's routines in `kernel_info_request_impl`
arjxn-py Oct 22, 2025
92441ba
use xeus's routines in `internal_request_impl`
arjxn-py Oct 22, 2025
d6d0f25
bring back comment and add version
arjxn-py Oct 22, 2025
7982793
typo
arjxn-py Oct 22, 2025
4c6311c
fill empty fields
arjxn-py Oct 22, 2025
3295f10
json as string
arjxn-py Oct 22, 2025
1839f2b
Update src/xinterpreter_raw.cpp
arjxn-py Oct 27, 2025
8011b40
Avoid changing kernel behaviour
arjxn-py Oct 27, 2025
c6972c5
fix
arjxn-py Oct 27, 2025
77903c0
try return
arjxn-py Oct 27, 2025
9bfdfe2
without callback
arjxn-py Oct 27, 2025
111da6f
just use the callback
arjxn-py Oct 27, 2025
9cdfe18
return
arjxn-py Oct 27, 2025
6a1c01c
fix
arjxn-py Oct 27, 2025
8ce058b
try fix
arjxn-py Oct 27, 2025
fab405b
fix
arjxn-py Oct 27, 2025
64d8045
fix
arjxn-py Oct 27, 2025
dc22c61
remove `kernel_res` variable
arjxn-py Oct 27, 2025
c7e02d2
remove kernel_res
arjxn-py Oct 28, 2025
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
91 changes: 39 additions & 52 deletions src/xinterpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

#include "xeus/xinterpreter.hpp"
#include "xeus/xsystem.hpp"
#include "xeus/xhelper.hpp"

#include "pybind11/functional.h"

Expand Down Expand Up @@ -176,16 +177,17 @@ namespace xpyt

if(exception_occurred)
{
kernel_res["status"] = "error";
kernel_res["traceback"] = std::vector<std::string>();
cb(kernel_res);
nl::json tb = kernel_res.value("traceback", nl::json::array());
cb(xeus::create_error_reply(kernel_res.value("ename", std::string()),
kernel_res.value("evalue", std::string()),
tb));
return;
}

if (m_ipython_shell.attr("last_error").is_none())
{
kernel_res["status"] = "ok";
kernel_res["user_expressions"] = m_ipython_shell.attr("user_expressions")(user_expressions);
nl::json user_exprs = m_ipython_shell.attr("user_expressions")(user_expressions);
cb(xeus::create_successful_reply(kernel_res["payload"], user_exprs));
}
else
{
Expand All @@ -198,38 +200,30 @@ namespace xpyt
publish_execution_error(error.m_ename, error.m_evalue, error.m_traceback);
}

kernel_res["status"] = "error";
kernel_res["ename"] = error.m_ename;
kernel_res["evalue"] = error.m_evalue;
kernel_res["traceback"] = error.m_traceback;
cb(xeus::create_error_reply(error.m_ename, error.m_evalue, error.m_traceback));
}
cb(kernel_res);
}

nl::json interpreter::complete_request_impl(
const std::string& code,
int cursor_pos)
{
py::gil_scoped_acquire acquire;
nl::json kernel_res;

py::list completion = m_ipython_shell.attr("complete_code")(code, cursor_pos);

kernel_res["matches"] = completion[0];
kernel_res["cursor_start"] = completion[1];
kernel_res["cursor_end"] = completion[2];
kernel_res["metadata"] = nl::json::object();
kernel_res["status"] = "ok";
nl::json matches = completion[0];
int cursor_start = completion[1].cast<int>();
int cursor_end = completion[2].cast<int>();

return kernel_res;
return xeus::create_complete_reply(matches, cursor_start, cursor_end, nl::json::object());
}

nl::json interpreter::inspect_request_impl(const std::string& code,
int cursor_pos,
int detail_level)
{
py::gil_scoped_acquire acquire;
nl::json kernel_res;
nl::json data = nl::json::object();
bool found = false;

Expand All @@ -249,17 +243,12 @@ namespace xpyt
// pass
}

kernel_res["data"] = data;
kernel_res["metadata"] = nl::json::object();
kernel_res["found"] = found;
kernel_res["status"] = "ok";
return kernel_res;
return xeus::create_inspect_reply(found, data, nl::json::object());
}

nl::json interpreter::is_complete_request_impl(const std::string& code)
{
py::gil_scoped_acquire acquire;
nl::json kernel_res;

py::object transformer_manager = py::getattr(m_ipython_shell, "input_transformer_manager", py::none());
if (transformer_manager.is_none())
Expand All @@ -268,29 +257,27 @@ namespace xpyt
}

py::list result = transformer_manager.attr("check_complete")(code);
auto status = result[0].cast<std::string>();
std::string status = result[0].cast<std::string>();
std::string indent;

kernel_res["status"] = status;
if (status.compare("incomplete") == 0)
if (status == "incomplete")
{
kernel_res["indent"] = std::string(result[1].cast<std::size_t>(), ' ');
indent = std::string(result[1].cast<std::size_t>(), ' ');
}
return kernel_res;

return xeus::create_is_complete_reply(status, indent);
}

nl::json interpreter::kernel_info_request_impl()
{
nl::json result;
result["implementation"] = "xeus-python";
result["implementation_version"] = XPYT_VERSION;

/* The jupyter-console banner for xeus-python is the following:
__ _____ _ _ ___
\ \/ / _ \ | | / __|
> < __/ |_| \__ \
/_/\_\___|\__,_|___/

xeus-python: a Jupyter lernel for Python
xeus-python: a Jupyter kernel for Python
*/

std::string banner = ""
Expand All @@ -309,22 +296,28 @@ namespace xpyt
"We recommend using a general-purpose package manager instead, such as Conda/Mamba."
"\n");
#endif
result["banner"] = banner;
result["debugger"] = (PY_MAJOR_VERSION != 3) || (PY_MAJOR_VERSION != 13);

result["language_info"]["name"] = "python";
result["language_info"]["version"] = PY_VERSION;
result["language_info"]["mimetype"] = "text/x-python";
result["language_info"]["file_extension"] = ".py";

result["help_links"] = nl::json::array();
result["help_links"][0] = nl::json::object({
nl::json help_links = nl::json::array();
help_links.push_back({
{"text", "Xeus-Python Reference"},
{"url", "https://xeus-python.readthedocs.io"}
});

result["status"] = "ok";
return result;
return xeus::create_info_reply(
"5.3", // protocol_version
"xeus-python", // implementation
XPYT_VERSION, // implementation_version
"python", // language_name
PY_VERSION, // language_version
"text/x-python", // language_mimetype
".py", // language_file_extension
"ipython" + std::to_string(PY_MAJOR_VERSION), // pygments_lexer
R"({"name": "ipython", "version": )" + std::to_string(PY_MAJOR_VERSION) + "}", // language_codemirror_mode
"python", // language_nbconvert_exporter
banner, // banner
(PY_MAJOR_VERSION != 3) || (PY_MINOR_VERSION != 13), // debugger
help_links // help_links
);
}

void interpreter::shutdown_request_impl()
Expand All @@ -335,15 +328,14 @@ namespace xpyt
{
py::gil_scoped_acquire acquire;
std::string code = content.value("code", "");
nl::json reply;

// Reset traceback
m_ipython_shell.attr("last_error") = py::none();

try
{
exec(py::str(code));
reply["status"] = "ok";
return xeus::create_successful_reply();
}
catch (py::error_already_set& e)
{
Expand All @@ -358,13 +350,8 @@ namespace xpyt
error.m_traceback.resize(1);
error.m_traceback[0] = code;

reply["status"] = "error";
reply["ename"] = error.m_ename;
reply["evalue"] = error.m_evalue;
reply["traceback"] = error.m_traceback;
return xeus::create_error_reply(error.m_ename, error.m_evalue, error.m_traceback);
}

return reply;
}

void interpreter::set_request_context(xeus::xrequest_context context)
Expand Down
71 changes: 27 additions & 44 deletions src/xinterpreter_raw.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

#include "xeus/xinterpreter.hpp"
#include "xeus/xsystem.hpp"
#include "xeus/xhelper.hpp"

#include "pybind11/functional.h"

Expand Down Expand Up @@ -146,7 +147,6 @@ namespace xpyt
nl::json /*user_expressions*/)
{
py::gil_scoped_acquire acquire;
nl::json kernel_res;
py::str code_copy;
// Scope guard performing the temporary monkey patching of input and
// getpass with a function sending input_request messages.
Expand Down Expand Up @@ -197,10 +197,6 @@ namespace xpyt
exec(compiled_code);
}

kernel_res["status"] = "ok";
kernel_res["user_expressions"] = nl::json::object();
kernel_res["payload"] = nl::json::array();

}
catch (py::error_already_set& e)
{
Expand All @@ -219,26 +215,23 @@ namespace xpyt
publish_execution_error(error.m_ename, error.m_evalue, error.m_traceback);
}

kernel_res["status"] = "error";
kernel_res["ename"] = error.m_ename;
kernel_res["evalue"] = error.m_evalue;
kernel_res["traceback"] = error.m_traceback;
cb(xeus::create_error_reply(error.m_ename, error.m_evalue, error.m_traceback));
return;
}

// Cache inputs
py::globals()["_iii"] = py::globals()["_ii"];
py::globals()["_ii"] = py::globals()["_i"];
py::globals()["_i"] = code;

cb(kernel_res);
cb(xeus::create_successful_reply(nl::json::array(), nl::json::object()));
}

nl::json raw_interpreter::complete_request_impl(
const std::string& code,
int cursor_pos)
{
py::gil_scoped_acquire acquire;
nl::json kernel_res;
std::vector<std::string> matches;
int cursor_start = cursor_pos;

Expand All @@ -253,12 +246,7 @@ namespace xpyt
}
}

kernel_res["cursor_start"] = cursor_start;
kernel_res["cursor_end"] = cursor_pos;
kernel_res["matches"] = matches;
kernel_res["metadata"] = nl::json::object();
kernel_res["status"] = "ok";
return kernel_res;
return xeus::create_complete_reply(matches, cursor_start, cursor_pos, nl::json::object());
}

nl::json raw_interpreter::inspect_request_impl(const std::string& code,
Expand All @@ -279,33 +267,24 @@ namespace xpyt
pub_data["text/plain"] = docstring;
}

kernel_res["data"] = pub_data;
kernel_res["metadata"] = nl::json::object();
kernel_res["found"] = found;
kernel_res["status"] = "ok";
return kernel_res;
return xeus::create_inspect_reply(found, pub_data, nl::json::object());
}

nl::json raw_interpreter::is_complete_request_impl(const std::string&)
{
nl::json result;
result["status"] = "complete";
return result;
return xeus::create_is_complete_reply("complete", "");
}

nl::json raw_interpreter::kernel_info_request_impl()
{
nl::json result;
result["implementation"] = "xeus-python";
result["implementation_version"] = XPYT_VERSION;

/* The jupyter-console banner for xeus-python is the following:
__ _____ _ _ ___
\ \/ / _ \ | | / __|
> < __/ |_| \__ \
/_/\_\___|\__,_|___/

xeus-python: a Jupyter lernel for Python
xeus-python: a Jupyter kernel for Python
*/

std::string banner = ""
Expand All @@ -324,24 +303,28 @@ namespace xpyt
"We recommend using a general-purpose package manager instead, such as Conda/Mamba."
"\n");
#endif
result["banner"] = banner;
result["debugger"] = false;

result["language_info"]["name"] = "python";
result["language_info"]["version"] = PY_VERSION;
result["language_info"]["mimetype"] = "text/x-python";
result["language_info"]["file_extension"] = ".py";
nl::json help_links = nl::json::array();
help_links.push_back({
{"text", "Xeus-Python Reference"},
{"url", "https://xeus-python.readthedocs.io"}
});

result["help_links"] = nl::json::array();
result["help_links"][0] = nl::json::object(
{
{"text", "Xeus-Python Reference"},
{"url", "https://xeus-python.readthedocs.io"}
}
return xeus::create_info_reply(
"5.3", // protocol_version
"xeus-python", // implementation
XPYT_VERSION, // implementation_version
"python", // language_name
PY_VERSION, // language_version
"text/x-python", // language_mimetype
".py", // language_file_extension
"ipython" + std::to_string(PY_MAJOR_VERSION), // pygments_lexer
R"({"name": "ipython", "version": )" + std::to_string(PY_MAJOR_VERSION) + "}", // language_codemirror_mode
"python", // language_nbconvert_exporter
banner, // banner
false, // debugger
help_links // help_links
);

result["status"] = "ok";
return result;
}

void raw_interpreter::shutdown_request_impl()
Expand Down