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.

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

gh-121245: Refactor site.register_readline() #121659

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
39 changes: 19 additions & 20 deletions Lib/_pyrepl/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,26 @@
else:
CAN_USE_PYREPL = sys.getwindowsversion().build >= 10586 # Windows 10 TH2

FAIL_MSG = ""
try:
import errno
if not os.isatty(sys.stdin.fileno()):
raise OSError(errno.ENOTTY, "tty required", "stdin")
from .simple_interact import check
if err := check():
raise RuntimeError(err)
except Exception as e:
FAIL_MSG = f"warning: can't use pyrepl: {e}"
CAN_USE_PYREPL = False


def interactive_console(mainmodule=None, quiet=False, pythonstartup=False):
global CAN_USE_PYREPL
global CAN_USE_PYREPL, FAIL_MSG
skirpichev marked this conversation as resolved.
Show resolved Hide resolved
if not CAN_USE_PYREPL:
if not os.environ.get('PYTHON_BASIC_REPL', None):
from .trace import trace
trace(FAIL_MSG)
print(FAIL_MSG, file=sys.stderr)
return sys._baserepl()

if mainmodule:
Expand All @@ -34,22 +50,5 @@ def interactive_console(mainmodule=None, quiet=False, pythonstartup=False):
if not hasattr(sys, "ps2"):
sys.ps2 = "... "

run_interactive = None
try:
import errno
if not os.isatty(sys.stdin.fileno()):
raise OSError(errno.ENOTTY, "tty required", "stdin")
from .simple_interact import check
if err := check():
raise RuntimeError(err)
from .simple_interact import run_multiline_interactive_console
run_interactive = run_multiline_interactive_console
except Exception as e:
from .trace import trace
msg = f"warning: can't use pyrepl: {e}"
trace(msg)
print(msg, file=sys.stderr)
CAN_USE_PYREPL = False
if run_interactive is None:
return sys._baserepl()
run_interactive(namespace)
from .simple_interact import run_multiline_interactive_console
run_multiline_interactive_console(namespace)
23 changes: 10 additions & 13 deletions Lib/site.py
Original file line number Diff line number Diff line change
Expand Up @@ -509,32 +509,29 @@ def register_readline():
pass

if readline.get_current_history_length() == 0:
try:
from _pyrepl.main import CAN_USE_PYREPL
except ImportError:
CAN_USE_PYREPL = False
# If no history was loaded, default to .python_history,
# or PYTHON_HISTORY.
# The guard is necessary to avoid doubling history size at
# each interpreter exit when readline was already configured
# through a PYTHONSTARTUP hook, see:
# http://bugs.python.org/issue5845#msg198636
history = gethistoryfile()
if os.getenv("PYTHON_BASIC_REPL") or not CAN_USE_PYREPL:
my_readline = readline
else:
my_readline = _pyrepl.readline
skirpichev marked this conversation as resolved.
Show resolved Hide resolved
try:
if os.getenv("PYTHON_BASIC_REPL"):
readline.read_history_file(history)
else:
_pyrepl.readline.read_history_file(history)
my_readline.read_history_file(history)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
my_readline.read_history_file(history)
target_readline.read_history_file(history)

except (OSError,* _pyrepl.unix_console._error):
pass

def write_history():
try:
from _pyrepl.main import CAN_USE_PYREPL
except ImportError:
CAN_USE_PYREPL = False

try:
if os.getenv("PYTHON_BASIC_REPL") or not CAN_USE_PYREPL:
readline.write_history_file(history)
else:
_pyrepl.readline.write_history_file(history)
my_readline.write_history_file(history)
skirpichev marked this conversation as resolved.
Show resolved Hide resolved
except (FileNotFoundError, PermissionError):
# home directory does not exist or is not writable
# https://bugs.python.org/issue19891
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Simplify handling of the history file in ``site.register_readline()``
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that I'm pretty sure this suggestion will break buildbots while site.register_readline is undocumented. Document that before adding this.

Suggested change
Simplify handling of the history file in ``site.register_readline()``
Simplify handling of the history file in :func:`site.register_readline`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this out of the scope for this pr.

helper. The ``CAN_USE_PYREPL`` variable now will be initialized, when
imported. Patch by Sergey B Kirpichev.
Loading