Skip to content

gh-112510: Add readline.backend for the backend readline uses #112511

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.

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
merged 7 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
13 changes: 8 additions & 5 deletions Doc/library/readline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,26 @@ Readline library in general.
.. note::

The underlying Readline library API may be implemented by
the ``libedit`` library instead of GNU readline.
the ``editline`` (``libedit``) library instead of GNU readline.
On macOS the :mod:`readline` module detects which library is being used
at run time.

The configuration file for ``libedit`` is different from that
The configuration file for ``editline`` is different from that
of GNU readline. If you programmatically load configuration strings
you can check for the text "libedit" in :const:`readline.__doc__`
to differentiate between GNU readline and libedit.
you can use :data:`backend` to determine which library is being used.

If you use *editline*/``libedit`` readline emulation on macOS, the
If you use ``editline``/``libedit`` readline emulation on macOS, the
initialization file located in your home directory is named
``.editrc``. For example, the following content in ``~/.editrc`` will
turn ON *vi* keybindings and TAB completion::

python:bind -v
python:bind ^I rl_complete

.. data:: backend

The name of the underlying Readline library being used, either
``"readline"`` or ``"editline"``.

Init file
---------
Expand Down
2 changes: 1 addition & 1 deletion Lib/test/test_pdb.py
Original file line number Diff line number Diff line change
Expand Up @@ -3293,7 +3293,7 @@ def setUpClass():
# Ensure that the readline module is loaded
# If this fails, the test is skipped because SkipTest will be raised
readline = import_module('readline')
if readline.__doc__ and "libedit" in readline.__doc__:
if readline.backend == "editline":
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For just internal usage, why not just use readline._backend?

raise unittest.SkipTest("libedit readline is not supported for pdb")

def test_basic_completion(self):
Expand Down
4 changes: 2 additions & 2 deletions Lib/test/test_readline.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
if hasattr(readline, "_READLINE_LIBRARY_VERSION"):
is_editline = ("EditLine wrapper" in readline._READLINE_LIBRARY_VERSION)
else:
is_editline = (readline.__doc__ and "libedit" in readline.__doc__)
is_editline = readline.backend == "editline"


def setUpModule():
Expand Down Expand Up @@ -198,7 +198,7 @@ def test_nonascii(self):

script = r"""import readline

is_editline = readline.__doc__ and "libedit" in readline.__doc__
is_editline = readline.backend == "editline"
inserted = "[\xEFnserted]"
macro = "|t\xEB[after]"
set_pre_input_hook = getattr(readline, "set_pre_input_hook", None)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add :data:`readline.backend` for the backend readline uses (``editline`` or ``readline``)
10 changes: 9 additions & 1 deletion Modules/readline.c
Original file line number Diff line number Diff line change
Expand Up @@ -1538,15 +1538,18 @@ static struct PyModuleDef readlinemodule = {
PyMODINIT_FUNC
PyInit_readline(void)
{
const char *backend = "readline";
PyObject *m;
readlinestate *mod_state;

if (strncmp(rl_library_version, libedit_version_tag, strlen(libedit_version_tag)) == 0) {
using_libedit_emulation = 1;
}

if (using_libedit_emulation)
if (using_libedit_emulation) {
readlinemodule.m_doc = doc_module_le;
backend = "editline";
}


m = PyModule_Create(&readlinemodule);
Expand All @@ -1568,6 +1571,11 @@ PyInit_readline(void)
goto error;
}

if (PyModule_AddStringConstant(m, "backend", backend) < 0)
{
goto error;
}

mod_state = (readlinestate *) PyModule_GetState(m);
if (mod_state == NULL){
goto error;
Expand Down