Repository navigation
Expand file tree
/
Copy pathrepl.py
More file actions
1307 lines (1117 loc) · 45.6 KB
/
Copy pathrepl.py
File metadata and controls
1307 lines (1117 loc) · 45.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# The MIT License
#
# Copyright (c) 2009-2011 the bpython authors.
# Copyright (c) 2012-2013,2015 Sebastian Ramacher
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import abc
import code
import inspect
import os
import pkgutil
import pydoc
import shlex
import subprocess
import sys
import tempfile
import textwrap
import time
import traceback
from abc import abstractmethod
from dataclasses import dataclass
from itertools import takewhile
from pathlib import Path
from types import ModuleType, TracebackType
from typing import (
Any,
Dict,
List,
Literal,
Optional,
TYPE_CHECKING,
Tuple,
Type,
Union,
cast,
)
from collections.abc import Callable, Iterable
from pygments.lexers import Python3Lexer
from pygments.token import Token, _TokenType
have_pyperclip = True
try:
import pyperclip
except ImportError:
have_pyperclip = False
from . import autocomplete, inspection, simpleeval
from .config import getpreferredencoding, Config
from .formatter import Parenthesis
from .history import History
from .lazyre import LazyReCompile
from .paste import PasteHelper, PastePinnwand, PasteFailed
from .patch_linecache import filename_for_console_input
from .translations import _, ngettext
from .importcompletion import ModuleGatherer
class RuntimeTimer:
"""Calculate running time"""
def __init__(self) -> None:
self.reset_timer()
def __enter__(self) -> None:
self.start = time.monotonic()
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_val: BaseException | None,
exc_tb: TracebackType | None,
) -> Literal[False]:
self.last_command = time.monotonic() - self.start
self.running_time += self.last_command
return False
def reset_timer(self) -> None:
self.running_time = 0.0
self.last_command = 0.0
def estimate(self) -> float:
return self.running_time - self.last_command
class Interpreter(code.InteractiveInterpreter):
"""Source code interpreter for use in bpython."""
bpython_input_re = LazyReCompile(r"<bpython-input-\d+>")
def __init__(
self,
locals: dict[str, Any] | None = None,
) -> None:
"""Constructor.
The optional 'locals' argument specifies the dictionary in which code
will be executed; it defaults to a newly created dictionary with key
"__name__" set to "__main__".
The syntaxerror callback can be set at any time and will be called
on a caught syntax error. The purpose for this in bpython is so that
the repl can be instantiated after the interpreter (which it
necessarily must be with the current factoring) and then an exception
callback can be added to the Interpreter instance afterwards - more
specifically, this is so that autoindentation does not occur after a
traceback.
"""
self.syntaxerror_callback: Callable | None = None
if locals is None:
# instead of messing with sys.modules, we should modify sys.modules
# in the interpreter instance
sys.modules["__main__"] = main_mod = ModuleType("__main__")
locals = main_mod.__dict__
super().__init__(locals)
self.timer = RuntimeTimer()
def runsource(
self,
source: str,
filename: str | None = None,
symbol: str = "single",
) -> bool:
"""Execute Python code.
source, filename and symbol are passed on to
code.InteractiveInterpreter.runsource."""
if filename is None:
filename = filename_for_console_input(source)
with self.timer:
return super().runsource(source, filename, symbol)
def showsyntaxerror(self, filename: str | None = None, **kwargs) -> None:
"""Override the regular handler, the code's copied and pasted from
code.py, as per showtraceback, but with the syntaxerror callback called
and the text in a pretty colour."""
if self.syntaxerror_callback is not None:
self.syntaxerror_callback()
exc_type, value, sys.last_traceback = sys.exc_info()
sys.last_type = exc_type
sys.last_value = value
if filename and exc_type is SyntaxError and value is not None:
msg = value.args[0]
args = list(value.args[1])
# strip linechache line number
if self.bpython_input_re.match(filename):
args[0] = "<input>"
value = SyntaxError(msg, tuple(args))
sys.last_value = value
exc_formatted = traceback.format_exception_only(exc_type, value)
self.writetb(exc_formatted)
def showtraceback(self) -> None:
"""This needs to override the default traceback thing
so it can put it into a pretty colour and maybe other
stuff, I don't know"""
try:
t, v, tb = sys.exc_info()
sys.last_type = t
sys.last_value = v
sys.last_traceback = tb
tblist = traceback.extract_tb(tb)
del tblist[:1]
for frame in tblist:
if self.bpython_input_re.match(frame.filename):
# strip linecache line number
frame.filename = "<input>"
l = traceback.format_list(tblist)
if l:
l.insert(0, "Traceback (most recent call last):\n")
l[len(l) :] = traceback.format_exception_only(t, v)
finally:
pass
self.writetb(l)
def writetb(self, lines: Iterable[str]) -> None:
"""This outputs the traceback and should be overridden for anything
fancy."""
for line in lines:
self.write(line)
class MatchesIterator:
"""Stores a list of matches and which one is currently selected if any.
Also responsible for doing the actual replacement of the original line with
the selected match.
A MatchesIterator can be `clear`ed to reset match iteration, and
`update`ed to set what matches will be iterated over."""
def __init__(self) -> None:
# word being replaced in the original line of text
self.current_word = ""
# possible replacements for current_word
self.matches: list[str] = []
# which word is currently replacing the current word
self.index = -1
# cursor position in the original line
self.orig_cursor_offset = -1
# original line (before match replacements)
self.orig_line = ""
# class describing the current type of completion
self.completer: autocomplete.BaseCompletionType | None = None
self.start: int | None = None
self.end: int | None = None
def __nonzero__(self) -> bool:
"""MatchesIterator is False when word hasn't been replaced yet"""
return self.index != -1
def __bool__(self) -> bool:
return self.index != -1
@property
def candidate_selected(self) -> bool:
"""True when word selected/replaced, False when word hasn't been
replaced yet"""
return bool(self)
def __iter__(self) -> "MatchesIterator":
return self
def current(self) -> str:
if self.index == -1:
raise ValueError("No current match.")
return self.matches[self.index]
def __next__(self) -> str:
self.index = (self.index + 1) % len(self.matches)
return self.matches[self.index]
def previous(self) -> str:
if self.index <= 0:
self.index = len(self.matches)
self.index -= 1
return self.matches[self.index]
def cur_line(self) -> tuple[int, str]:
"""Returns a cursor offset and line with the current substitution
made"""
return self.substitute(self.current())
def substitute(self, match: str) -> tuple[int, str]:
"""Returns a cursor offset and line with match substituted in"""
assert self.completer is not None
lp = self.completer.locate(self.orig_cursor_offset, self.orig_line)
assert lp is not None
return (
lp.start + len(match),
self.orig_line[: lp.start] + match + self.orig_line[lp.stop :],
)
def is_cseq(self) -> bool:
return bool(
os.path.commonprefix(self.matches)[len(self.current_word) :]
)
def substitute_cseq(self) -> tuple[int, str]:
"""Returns a new line by substituting a common sequence in, and update
matches"""
assert self.completer is not None
cseq = os.path.commonprefix(self.matches)
new_cursor_offset, new_line = self.substitute(cseq)
if len(self.matches) == 1:
self.clear()
else:
self.update(
new_cursor_offset, new_line, self.matches, self.completer
)
if len(self.matches) == 1:
self.clear()
return new_cursor_offset, new_line
def update(
self,
cursor_offset: int,
current_line: str,
matches: list[str],
completer: autocomplete.BaseCompletionType,
) -> None:
"""Called to reset the match index and update the word being replaced
Should only be called if there's a target to update - otherwise, call
clear"""
if matches is None:
raise ValueError("Matches may not be None.")
self.orig_cursor_offset = cursor_offset
self.orig_line = current_line
self.matches = matches
self.completer = completer
self.index = -1
lp = self.completer.locate(self.orig_cursor_offset, self.orig_line)
assert lp is not None
self.start = lp.start
self.end = lp.stop
self.current_word = lp.word
def clear(self) -> None:
self.matches = []
self.orig_cursor_offset = -1
self.orig_line = ""
self.current_word = ""
self.start = None
self.end = None
self.index = -1
class Interaction(metaclass=abc.ABCMeta):
def __init__(self, config: Config):
self.config = config
@abc.abstractmethod
def confirm(self, s: str) -> bool:
pass
@abc.abstractmethod
def notify(
self, s: str, n: float = 10.0, wait_for_keypress: bool = False
) -> None:
pass
@abc.abstractmethod
def file_prompt(self, s: str) -> str | None:
pass
class NoInteraction(Interaction):
def __init__(self, config: Config):
super().__init__(config)
def confirm(self, s: str) -> bool:
return False
def notify(
self, s: str, n: float = 10.0, wait_for_keypress: bool = False
) -> None:
pass
def file_prompt(self, s: str) -> str | None:
return None
class SourceNotFound(Exception):
"""Exception raised when the requested source could not be found."""
@dataclass
class _FuncExpr:
"""Stack element in Repl._funcname_and_argnum"""
full_expr: str
function_expr: str
arg_number: int
opening: str
keyword: str | None = None
class Repl(metaclass=abc.ABCMeta):
"""Implements the necessary guff for a Python-repl-alike interface
The execution of the code entered and all that stuff was taken from the
Python code module, I had to copy it instead of inheriting it, I can't
remember why. The rest of the stuff is basically what makes it fancy.
It reads what you type, passes it to a lexer and highlighter which
returns a formatted string. This then gets passed to echo() which
parses that string and prints to the curses screen in appropriate
colours and/or bold attribute.
The Repl class also keeps two stacks of lines that the user has typed in:
One to be used for the undo feature. I am not happy with the way this
works. The only way I have been able to think of is to keep the code
that's been typed in in memory and re-evaluate it in its entirety for each
"undo" operation. Obviously this means some operations could be extremely
slow. I'm not even by any means certain that this truly represents a
genuine "undo" implementation, but it does seem to be generally pretty
effective.
If anyone has any suggestions for how this could be improved, I'd be happy
to hear them and implement it/accept a patch. I researched a bit into the
idea of keeping the entire Python state in memory, but this really seems
very difficult (I believe it may actually be impossible to work) and has
its own problems too.
The other stack is for keeping a history for pressing the up/down keys
to go back and forth between lines.
XXX Subclasses should implement echo, current_line, cw
"""
@abc.abstractmethod
def reevaluate(self):
pass
@abc.abstractmethod
def reprint_line(
self, lineno: int, tokens: list[tuple[_TokenType, str]]
) -> None:
pass
@abc.abstractmethod
def _get_current_line(self) -> str:
pass
@abc.abstractmethod
def _set_current_line(self, val: str) -> None:
pass
@property
def current_line(self) -> str:
"""The current line"""
return self._get_current_line()
@current_line.setter
def current_line(self, value: str) -> None:
self._set_current_line(value)
@abc.abstractmethod
def _get_cursor_offset(self) -> int:
pass
@abc.abstractmethod
def _set_cursor_offset(self, val: int) -> None:
pass
@property
def cursor_offset(self) -> int:
"""The current cursor offset from the front of the "line"."""
return self._get_cursor_offset()
@cursor_offset.setter
def cursor_offset(self, value: int) -> None:
self._set_cursor_offset(value)
if TYPE_CHECKING:
# not actually defined, subclasses must define
cpos: int
def __init__(self, interp: Interpreter, config: Config):
"""Initialise the repl.
interp is a Python code.InteractiveInterpreter instance
config is a populated bpython.config.Struct.
"""
self.config = config
self.cut_buffer = ""
self.buffer: list[str] = []
self.interp = interp
self.interp.syntaxerror_callback = self.clear_current_line
self.match = False
self.rl_history = History(
duplicates=config.hist_duplicates, hist_size=config.hist_length
)
# all input and output, stored as old style format strings
# (\x01, \x02, ...) for cli.py
self.screen_hist: list[str] = []
# commands executed since beginning of session
self.history: list[str] = []
self.redo_stack: list[str] = []
self.evaluating = False
self.matches_iter = MatchesIterator()
self.funcprops = None
self.arg_pos: str | int | None = None
self.current_func = None
self.highlighted_paren: None | (
tuple[Any, list[tuple[_TokenType, str]]]
) = None
self._C: dict[str, int] = {}
self.prev_block_finished: int = 0
self.interact: Interaction = NoInteraction(self.config)
# previous pastebin content to prevent duplicate pastes, filled on call
# to repl.pastebin
self.prev_pastebin_content = ""
self.prev_pastebin_url = ""
self.prev_removal_url = ""
# Necessary to fix mercurial.ui.ui expecting sys.stderr to have this
# attribute
self.closed = False
self.paster: PasteHelper | PastePinnwand
if self.config.hist_file.exists():
try:
self.rl_history.load(
self.config.hist_file,
getpreferredencoding() or "ascii",
)
except OSError:
pass
self.module_gatherer = ModuleGatherer(
skiplist=self.config.import_completion_skiplist
)
self.completers = autocomplete.get_default_completer(
config.autocomplete_mode, self.module_gatherer
)
if self.config.pastebin_helper:
self.paster = PasteHelper(self.config.pastebin_helper)
else:
self.paster = PastePinnwand(
self.config.pastebin_url,
self.config.pastebin_expiry,
)
@property
def ps1(self) -> str:
return cast(str, getattr(sys, "ps1", ">>> "))
@property
def ps2(self) -> str:
return cast(str, getattr(sys, "ps2", "... "))
def startup(self) -> None:
"""
Execute PYTHONSTARTUP file if it exits. Call this after front
end-specific initialisation.
"""
filename = os.environ.get("PYTHONSTARTUP")
if filename:
encoding = inspection.get_encoding_file(filename)
with open(filename, encoding=encoding) as f:
source = f.read()
self.interp.runsource(source, filename, "exec")
def current_string(self, concatenate=False):
"""If the line ends in a string get it, otherwise return ''"""
tokens = self.tokenize(self.current_line)
string_tokens = list(
takewhile(
token_is_any_of([Token.String, Token.Text]), reversed(tokens)
)
)
if not string_tokens:
return ""
opening = string_tokens.pop()[1]
string = list()
for token, value in reversed(string_tokens):
if token is Token.Text:
continue
elif opening is None:
opening = value
elif token is Token.String.Doc:
string.append(value[3:-3])
opening = None
elif value == opening:
opening = None
if not concatenate:
string = list()
else:
string.append(value)
if opening is None:
return ""
return "".join(string)
def get_object(self, name: str) -> Any:
attributes = name.split(".")
obj = eval(attributes.pop(0), cast(dict[str, Any], self.interp.locals))
while attributes:
obj = inspection.getattr_safe(obj, attributes.pop(0))
return obj
@classmethod
def _funcname_and_argnum(
cls, line: str
) -> tuple[str | None, str | int | None]:
"""Parse out the current function name and arg from a line of code."""
# each element in stack is a _FuncExpr instance
# if keyword is not None, we've encountered a keyword and so we're done counting
stack = [_FuncExpr("", "", 0, "")]
try:
for token, value in Python3Lexer().get_tokens(line):
if token is Token.Punctuation:
if value in "([{":
stack.append(_FuncExpr("", "", 0, value))
elif value in ")]}":
element = stack.pop()
expr = element.opening + element.full_expr + value
stack[-1].function_expr += expr
stack[-1].full_expr += expr
elif value == ",":
if stack[-1].keyword is None:
stack[-1].arg_number += 1
else:
stack[-1].keyword = ""
stack[-1].function_expr = ""
stack[-1].full_expr += value
elif value == ":" and stack[-1].opening == "lambda":
expr = stack.pop().full_expr + ":"
stack[-1].function_expr += expr
stack[-1].full_expr += expr
else:
stack[-1].function_expr = ""
stack[-1].full_expr += value
elif (
token is Token.Number
or token in Token.Number.subtypes
or token is Token.Name
or token in Token.Name.subtypes
or token is Token.Operator
and value == "."
):
stack[-1].function_expr += value
stack[-1].full_expr += value
elif token is Token.Operator and value == "=":
stack[-1].keyword = stack[-1].function_expr
stack[-1].function_expr = ""
stack[-1].full_expr += value
elif token is Token.Number or token in Token.Number.subtypes:
stack[-1].function_expr = value
stack[-1].full_expr += value
elif token is Token.Keyword and value == "lambda":
stack.append(_FuncExpr(value, "", 0, value))
else:
stack[-1].function_expr = ""
stack[-1].full_expr += value
while stack[-1].opening in "[{":
stack.pop()
elem1 = stack.pop()
elem2 = stack.pop()
return elem2.function_expr, elem1.keyword or elem1.arg_number
except IndexError:
return None, None
def get_args(self):
"""Check if an unclosed parenthesis exists, then attempt to get the
argspec() for it. On success, update self.funcprops,self.arg_pos and
return True, otherwise set self.funcprops to None and return False"""
self.current_func = None
if not self.config.arg_spec:
return False
func, arg_number = self._funcname_and_argnum(self.current_line)
if not func:
return False
try:
if inspection.is_eval_safe_name(func):
f = self.get_object(func)
else:
try:
fake_cursor = self.current_line.index(func) + len(func)
f = simpleeval.evaluate_current_attribute(
fake_cursor, self.current_line, self.interp.locals
)
except simpleeval.EvaluationError:
return False
if inspect.isclass(f):
class_f = None
if (
(not class_f or not inspection.getfuncprops(func, class_f))
and hasattr(f, "__new__")
and f.__new__ is not object.__new__
and
# py3
f.__new__.__class__ is not object.__new__.__class__
):
class_f = f.__new__
if class_f:
f = class_f
except Exception:
# another case of needing to catch every kind of error
# since user code is run in the case of descriptors
# XXX: Make sure you raise here if you're debugging the completion
# stuff !
return False
self.current_func = f
self.funcprops = inspection.getfuncprops(func, f)
if self.funcprops:
self.arg_pos = arg_number
return True
self.arg_pos = None
return False
def get_source_of_current_name(self) -> str:
"""Return the unicode source code of the object which is bound to the
current name in the current input line. Throw `SourceNotFound` if the
source cannot be found."""
obj: Callable | None = self.current_func
try:
if obj is None:
line = self.current_line
if not line.strip():
raise SourceNotFound(_("Nothing to get source of"))
if inspection.is_eval_safe_name(line):
obj = self.get_object(line)
# Ignoring the next mypy error because we want this to fail if obj is None
return inspect.getsource(obj) # type:ignore[arg-type]
except (AttributeError, NameError) as e:
msg = _("Cannot get source: %s") % (e,)
except OSError as e:
msg = f"{e}"
except TypeError as e:
if "built-in" in f"{e}":
msg = _("Cannot access source of %r") % (obj,)
else:
msg = _("No source code found for %s") % (self.current_line,)
raise SourceNotFound(msg)
def set_docstring(self) -> None:
self.docstring = None
if not self.get_args():
self.funcprops = None
if self.current_func is not None:
try:
self.docstring = pydoc.getdoc(self.current_func)
except IndexError:
self.docstring = None
else:
# pydoc.getdoc() returns an empty string if no
# docstring was found
if not self.docstring:
self.docstring = None
# What complete() does:
# Should we show the completion box? (are there matches, or is there a
# docstring to show?)
# Some completions should always be shown, other only if tab=True
# set the current docstring to the "current function's" docstring
# Populate the matches_iter object with new matches from the current state
# if none, clear the matches iterator
# If exactly one match that is equal to current line, clear matches
# If example one match and tab=True, then choose that and clear matches
def complete(self, tab: bool = False) -> bool | None:
"""Construct a full list of possible completions and
display them in a window. Also check if there's an available argspec
(via the inspect module) and bang that on top of the completions too.
The return value is whether the list_win is visible or not.
If no matches are found, just return whether there's an argspec to show
If any matches are found, save them and select the first one.
If tab is True exactly one match found, make the replacement and return
the result of running complete() again on the new line.
"""
self.set_docstring()
matches, completer = autocomplete.get_completer(
self.completers,
cursor_offset=self.cursor_offset,
line=self.current_line,
locals_=cast(dict[str, Any], self.interp.locals),
argspec=self.funcprops,
current_block="\n".join(self.buffer + [self.current_line]),
complete_magic_methods=self.config.complete_magic_methods,
history=self.history,
)
if len(matches) == 0:
self.matches_iter.clear()
return bool(self.funcprops)
if completer:
self.matches_iter.update(
self.cursor_offset, self.current_line, matches, completer
)
if len(matches) == 1:
if tab:
# if this complete is being run for a tab key press, substitute
# common sequence
(
self._cursor_offset,
self._current_line,
) = self.matches_iter.substitute_cseq()
return Repl.complete(self) # again for
elif self.matches_iter.current_word == matches[0]:
self.matches_iter.clear()
return False
return completer.shown_before_tab
else:
return tab or completer.shown_before_tab
else:
return False
def format_docstring(
self, docstring: str, width: int, height: int
) -> list[str]:
"""Take a string and try to format it into a sane list of strings to be
put into the suggestion box."""
lines = docstring.split("\n")
out = []
i = 0
for line in lines:
i += 1
if not line.strip():
out.append("\n")
for block in textwrap.wrap(line, width):
out.append(" " + block + "\n")
if i >= height:
return out
i += 1
# Drop the last newline
out[-1] = out[-1].rstrip()
return out
def next_indentation(self) -> int:
"""Return the indentation of the next line based on the current
input buffer."""
if self.buffer:
indentation = next_indentation(
self.buffer[-1], self.config.tab_length
)
if indentation and self.config.dedent_after > 0:
def line_is_empty(line):
return not line.strip()
empty_lines = takewhile(line_is_empty, reversed(self.buffer))
if sum(1 for _ in empty_lines) >= self.config.dedent_after:
indentation -= 1
else:
indentation = 0
return indentation
@abstractmethod
def getstdout(self) -> str:
raise NotImplementedError()
def get_session_formatted_for_file(self) -> str:
"""Format the stdout buffer to something suitable for writing to disk,
i.e. without >>> and ... at input lines and with "# OUT: " prepended to
output lines and "### " prepended to current line"""
session_output = self.getstdout()
def process():
for line in session_output.split("\n"):
if line.startswith(self.ps1):
yield line[len(self.ps1) :]
elif line.startswith(self.ps2):
yield line[len(self.ps2) :]
elif line.rstrip():
yield f"# OUT: {line}"
return "\n".join(process())
def write2file(self) -> None:
"""Prompt for a filename and write the current contents of the stdout
buffer to disk."""
try:
fn = self.interact.file_prompt(_("Save to file (Esc to cancel): "))
if not fn:
self.interact.notify(_("Save cancelled."))
return
except ValueError:
self.interact.notify(_("Save cancelled."))
return
path = Path(fn).expanduser()
if path.suffix != ".py" and self.config.save_append_py:
# fn.with_suffix(".py") does not append if fn has a non-empty suffix
path = Path(f"{path}.py")
mode = "w"
if path.exists():
new_mode = self.interact.file_prompt(
_(
"%s already exists. Do you want to (c)ancel, (o)verwrite or (a)ppend? "
)
% (path,)
)
if new_mode in ("o", "overwrite", _("overwrite")):
mode = "w"
elif new_mode in ("a", "append", _("append")):
mode = "a"
else:
self.interact.notify(_("Save cancelled."))
return
stdout_text = self.get_session_formatted_for_file()
try:
with open(path, mode) as f:
f.write(stdout_text)
except OSError as e:
self.interact.notify(_("Error writing file '%s': %s") % (path, e))
else:
self.interact.notify(_("Saved to %s.") % (path,))
def copy2clipboard(self) -> None:
"""Copy current content to clipboard."""
if not have_pyperclip:
self.interact.notify(_("No clipboard available."))
return
content = self.get_session_formatted_for_file()
try:
pyperclip.copy(content)
except pyperclip.PyperclipException:
self.interact.notify(_("Could not copy to clipboard."))
else:
self.interact.notify(_("Copied content to clipboard."))
def pastebin(self, s=None) -> str | None:
"""Upload to a pastebin and display the URL in the status bar."""
if s is None:
s = self.getstdout()
if self.config.pastebin_confirm and not self.interact.confirm(
_("Pastebin buffer? (y/N) ")
):
self.interact.notify(_("Pastebin aborted."))
return None
else:
return self.do_pastebin(s)
def do_pastebin(self, s) -> str | None:
"""Actually perform the upload."""
paste_url: str
if s == self.prev_pastebin_content:
self.interact.notify(
_("Duplicate pastebin. Previous URL: %s. " "Removal URL: %s")
% (self.prev_pastebin_url, self.prev_removal_url),
10,
)
return self.prev_pastebin_url
self.interact.notify(_("Posting data to pastebin..."))
try:
paste_url, removal_url = self.paster.paste(s)
except PasteFailed as e:
self.interact.notify(_("Upload failed: %s") % e)
return None
self.prev_pastebin_content = s
self.prev_pastebin_url = paste_url
self.prev_removal_url = removal_url if removal_url is not None else ""
if removal_url is not None:
self.interact.notify(
_("Pastebin URL: %s - Removal URL: %s")
% (paste_url, removal_url),
10,
)
else:
self.interact.notify(_("Pastebin URL: %s") % (paste_url,), 10)
return paste_url
def push(self, s, insert_into_history=True) -> bool:
"""Push a line of code onto the buffer so it can process it all
at once when a code block ends"""
# This push method is used by cli and urwid, but not curtsies
s = s.rstrip("\n")
self.buffer.append(s)
if insert_into_history:
self.insert_into_history(s)
more: bool = self.interp.runsource("\n".join(self.buffer))
if not more:
self.buffer = []