Files
napalm-linux/napalm_linux/_shell.py
T
Christian Manivong 448eeec0fa
driver / standard (pull_request) Successful in 14s
driver / lint (pull_request) Successful in 13s
driver / types (pull_request) Successful in 1m15s
driver / test (3.12) (pull_request) Successful in 1m19s
driver / test (3.13) (pull_request) Successful in 1m11s
driver / lowest (pull_request) Successful in 35s
driver / build (pull_request) Successful in 37s
driver / security (pull_request) Successful in 1m19s
CI / driver (pull_request) Successful in 3m5s
driver / publish (pull_request) Skipped
refactor: the interactive shell's end-of-output pattern lives in _shell (quality ratchet)
expect_for and STATUS_ECHO_RE say when netmiko's interactive shell has
finished printing a command's output, next to PROMPT_RE they build on.
Moving them out keeps linux.py within its line count now that it mixes in
the personal accounts; the baseline goes down to 2265.
2026-11-01 00:48:02 +01:00

79 lines
3.3 KiB
Python

"""The interactive shell netmiko opens, made fit to be read before the first command."""
from __future__ import annotations
import logging
import re
from typing import Any
logger = logging.getLogger(__name__)
#: The end of a command's output when nothing better is known: a line that looks
#: like a shell prompt.
PROMPT_RE = r"[#$\>]\s*$"
#: A command ending in ``echo __NAME=$?`` reports its exit status on a line of its
#: own: the driver's ``_RC_MARKER``, ``__APT_RC=`` and ``__SVC_RC=`` in
#: napalm-device-types.
STATUS_ECHO_RE = re.compile(r"echo\s+(__[A-Z_]+=)\$\?")
def expect_for(command: str) -> str:
"""The pattern that ends *command*'s output.
netmiko stops reading as soon as the pattern matches what it has read so far.
A line the command prints can end in ``#``, ``$`` or ``>`` -- apt's
``<ftpmaster@ubuntu.com>`` after a bad signature -- and was taken for the
prompt: half the output came back, and the rest started the next command's
(#615). A command that echoes its exit status is read until that marker, with
a number, and the prompt line after it. The echoed command line carries a
literal ``$?`` and cannot match.
"""
markers: list[str] = STATUS_ECHO_RE.findall(command)
if not markers:
return PROMPT_RE
return re.escape(markers[-1]) + r"\d+\s*\n.*" + PROMPT_RE
#: Sent before anything else in the interactive session (NetOrk/netork#1039):
#: the shell writes no history file and records nothing more. The leading space
#: keeps this line itself out of a history under ``HISTCONTROL=ignorespace``;
#: a shell without ``set -o history`` (dash) only complains, to /dev/null.
HISTORY_OFF = " unset HISTFILE; set +o history 2>/dev/null; true"
#: Sent right after ``HISTORY_OFF`` (#41): systemd 258's
#: ``/etc/profile.d/80-systemd-osc-context.sh`` wraps every command in OSC 3008
#: sequences from ``PS0`` and ``PROMPT_COMMAND``, each with a fresh UUID. It appends
#: to ``PROMPT_COMMAND`` as an array, so only ``unset`` removes its hook.
PROMPT_HOOKS_OFF = " unset PS0 PROMPT_COMMAND; true"
#: Keeps the PTY from wrapping long output lines (e.g. docker JSON).
NO_LINE_WRAP = "stty cols 10000 2>/dev/null || true"
def prepare_shell(device: Any, hostname: str) -> None:
"""Make netmiko's fresh shell *device* fit to read, one step at a time.
A step the shell refuses is logged and skipped: none of them is worth
failing the connection for.
"""
# No history before anything else is typed (NetOrk/netork#1039).
try:
device.send_command(HISTORY_OFF, expect_string=PROMPT_RE)
except Exception:
logger.debug("Could not switch the shell history off on %s", hostname, exc_info=True)
# No systemd OSC 3008 context around every command (#41). netmiko learned
# the prompt with those sequences in front, and a prompt carrying a fresh
# UUID never matches again, so it reads the prompt anew once they are gone.
try:
device.send_command(PROMPT_HOOKS_OFF, expect_string=PROMPT_RE)
device.set_base_prompt()
except Exception:
logger.debug("Could not switch the prompt hooks off on %s", hostname, exc_info=True)
try:
device.send_command(NO_LINE_WRAP, expect_string=PROMPT_RE)
except Exception:
logger.debug("%s: ignored", hostname, exc_info=True)