| 1 |
from code import InteractiveConsole |
| 2 |
from functools import partial |
| 3 |
from typing import Iterable |
| 4 |
from unittest.mock import MagicMock |
| 5 |
|
| 6 |
from _pyrepl.console import Console, Event |
| 7 |
from _pyrepl.readline import ReadlineAlikeReader, ReadlineConfig |
| 8 |
from _pyrepl.simple_interact import _strip_final_indent |
| 9 |
from _pyrepl.utils import unbracket, ANSI_ESCAPE_SEQUENCE |
| 10 |
|
| 11 |
|
| 12 |
class ScreenEqualMixin: |
| 13 |
def assert_screen_equal( |
| 14 |
self, reader: ReadlineAlikeReader, expected: str, clean: bool = False |
| 15 |
): |
| 16 |
actual = clean_screen(reader) if clean else reader.screen |
| 17 |
expected = expected.split("\n") |
| 18 |
self.assertListEqual(actual, expected) |
| 19 |
|
| 20 |
|
| 21 |
def multiline_input(reader: ReadlineAlikeReader, namespace: dict | None = None): |
| 22 |
saved = reader.more_lines |
| 23 |
try: |
| 24 |
reader.more_lines = partial(more_lines, namespace=namespace) |
| 25 |
reader.ps1 = reader.ps2 = ">>> " |
| 26 |
reader.ps3 = reader.ps4 = "... " |
| 27 |
return reader.readline() |
| 28 |
finally: |
| 29 |
reader.more_lines = saved |
| 30 |
reader.paste_mode = False |
| 31 |
|
| 32 |
|
| 33 |
def more_lines(text: str, namespace: dict | None = None): |
| 34 |
if namespace is None: |
| 35 |
namespace = {} |
| 36 |
src = _strip_final_indent(text) |
| 37 |
console = InteractiveConsole(namespace, filename="<stdin>") |
| 38 |
try: |
| 39 |
code = console.compile(src, "<stdin>", "single") |
| 40 |
except (OverflowError, SyntaxError, ValueError): |
| 41 |
return False |
| 42 |
else: |
| 43 |
return code is None |
| 44 |
|
| 45 |
|
| 46 |
def code_to_events(code: str): |
| 47 |
for c in code: |
| 48 |
yield Event(evt="key", data=c, raw=bytearray(c.encode("utf-8"))) |
| 49 |
|
| 50 |
|
| 51 |
def clean_screen(reader: ReadlineAlikeReader) -> list[str]: |
| 52 |
"""Cleans color and console characters out of a screen output. |
| 53 |
|
| 54 |
This is useful for screen testing, it increases the test readability since |
| 55 |
it strips out all the unreadable side of the screen. |
| 56 |
""" |
| 57 |
output = [] |
| 58 |
for line in reader.screen: |
| 59 |
line = unbracket(line, including_content=True) |
| 60 |
line = ANSI_ESCAPE_SEQUENCE.sub("", line) |
| 61 |
for prefix in (reader.ps1, reader.ps2, reader.ps3, reader.ps4): |
| 62 |
if line.startswith(prefix): |
| 63 |
line = line[len(prefix):] |
| 64 |
break |
| 65 |
output.append(line) |
| 66 |
return output |
| 67 |
|
| 68 |
|
| 69 |
def prepare_reader(console: Console, **kwargs): |
| 70 |
config = ReadlineConfig(readline_completer=kwargs.pop("readline_completer", None)) |
| 71 |
reader = ReadlineAlikeReader(console=console, config=config) |
| 72 |
reader.more_lines = partial(more_lines, namespace=None) |
| 73 |
reader.paste_mode = True # Avoid extra indents |
| 74 |
|
| 75 |
def get_prompt(lineno, cursor_on_line) -> str: |
| 76 |
return "" |
| 77 |
|
| 78 |
reader.get_prompt = get_prompt # Remove prompt for easier calculations of (x, y) |
| 79 |
|
| 80 |
for key, val in kwargs.items(): |
| 81 |
setattr(reader, key, val) |
| 82 |
|
| 83 |
return reader |
| 84 |
|
| 85 |
|
| 86 |
def prepare_console(events: Iterable[Event], **kwargs) -> MagicMock | Console: |
| 87 |
console = MagicMock() |
| 88 |
console.get_event.side_effect = events |
| 89 |
console.height = 100 |
| 90 |
console.width = 80 |
| 91 |
console.getheightwidth = MagicMock(side_effect=lambda: (console.height, console.width)) |
| 92 |
|
| 93 |
for key, val in kwargs.items(): |
| 94 |
setattr(console, key, val) |
| 95 |
return console |
| 96 |
|
| 97 |
|
| 98 |
def handle_all_events( |
| 99 |
events, prepare_console=prepare_console, prepare_reader=prepare_reader |
| 100 |
): |
| 101 |
console = prepare_console(events) |
| 102 |
reader = prepare_reader(console) |
| 103 |
try: |
| 104 |
while True: |
| 105 |
reader.handle1() |
| 106 |
except StopIteration: |
| 107 |
pass |
| 108 |
except KeyboardInterrupt: |
| 109 |
pass |
| 110 |
return reader, console |
| 111 |
|
| 112 |
|
| 113 |
handle_events_narrow_console = partial( |
| 114 |
handle_all_events, |
| 115 |
prepare_console=partial(prepare_console, width=10), |
| 116 |
) |
| 117 |
|
| 118 |
|
| 119 |
class FakeConsole(Console): |
| 120 |
def __init__(self, events, encoding="utf-8") -> None: |
| 121 |
self.events = iter(events) |
| 122 |
self.encoding = encoding |
| 123 |
self.screen = [] |
| 124 |
self.height = 100 |
| 125 |
self.width = 80 |
| 126 |
|
| 127 |
def get_event(self, block: bool = True) -> Event | None: |
| 128 |
return next(self.events) |
| 129 |
|
| 130 |
def getpending(self) -> Event: |
| 131 |
return self.get_event(block=False) |
| 132 |
|
| 133 |
def getheightwidth(self) -> tuple[int, int]: |
| 134 |
return self.height, self.width |
| 135 |
|
| 136 |
def refresh(self, screen: list[str], xy: tuple[int, int]) -> None: |
| 137 |
pass |
| 138 |
|
| 139 |
def prepare(self) -> None: |
| 140 |
pass |
| 141 |
|
| 142 |
def restore(self) -> None: |
| 143 |
pass |
| 144 |
|
| 145 |
def move_cursor(self, x: int, y: int) -> None: |
| 146 |
pass |
| 147 |
|
| 148 |
def set_cursor_vis(self, visible: bool) -> None: |
| 149 |
pass |
| 150 |
|
| 151 |
def push_char(self, char: int | bytes) -> None: |
| 152 |
pass |
| 153 |
|
| 154 |
def beep(self) -> None: |
| 155 |
pass |
| 156 |
|
| 157 |
def clear(self) -> None: |
| 158 |
pass |
| 159 |
|
| 160 |
def finish(self) -> None: |
| 161 |
pass |
| 162 |
|
| 163 |
def flushoutput(self) -> None: |
| 164 |
pass |
| 165 |
|
| 166 |
def forgetinput(self) -> None: |
| 167 |
pass |
| 168 |
|
| 169 |
def wait(self, timeout: float | None = None) -> bool: |
| 170 |
return True |
| 171 |
|
| 172 |
def repaint(self) -> None: |
| 173 |
pass |