Show More
@@ -1,158 +1,166 b'' | |||||
1 | """prompt-toolkit utilities |
|
1 | """prompt-toolkit utilities | |
2 |
|
2 | |||
3 | Everything in this module is a private API, |
|
3 | Everything in this module is a private API, | |
4 | not to be used outside IPython. |
|
4 | not to be used outside IPython. | |
5 | """ |
|
5 | """ | |
6 |
|
6 | |||
7 | # Copyright (c) IPython Development Team. |
|
7 | # Copyright (c) IPython Development Team. | |
8 | # Distributed under the terms of the Modified BSD License. |
|
8 | # Distributed under the terms of the Modified BSD License. | |
9 |
|
9 | |||
10 | import unicodedata |
|
10 | import unicodedata | |
11 | from wcwidth import wcwidth |
|
11 | from wcwidth import wcwidth | |
12 |
|
12 | |||
13 | from IPython.core.completer import ( |
|
13 | from IPython.core.completer import ( | |
14 | provisionalcompleter, cursor_to_position, |
|
14 | provisionalcompleter, cursor_to_position, | |
15 | _deduplicate_completions) |
|
15 | _deduplicate_completions) | |
16 | from prompt_toolkit.completion import Completer, Completion |
|
16 | from prompt_toolkit.completion import Completer, Completion | |
17 | from prompt_toolkit.lexers import Lexer |
|
17 | from prompt_toolkit.lexers import Lexer | |
18 | from prompt_toolkit.lexers import PygmentsLexer |
|
18 | from prompt_toolkit.lexers import PygmentsLexer | |
19 | from prompt_toolkit.patch_stdout import patch_stdout |
|
19 | from prompt_toolkit.patch_stdout import patch_stdout | |
20 |
|
20 | |||
21 | import pygments.lexers as pygments_lexers |
|
21 | import pygments.lexers as pygments_lexers | |
|
22 | import os | |||
22 |
|
23 | |||
23 | _completion_sentinel = object() |
|
24 | _completion_sentinel = object() | |
24 |
|
25 | |||
25 | def _elide(string, *, min_elide=30): |
|
26 | def _elide(string, *, min_elide=30): | |
26 | """ |
|
27 | """ | |
27 |
If a string is long enough, and has at least |
|
28 | If a string is long enough, and has at least 3 dots, | |
|
29 | replace the middle part with ellipses. | |||
|
30 | ||||
|
31 | If a string naming a file is long enough, and has at least 3 slashes, | |||
28 | replace the middle part with ellipses. |
|
32 | replace the middle part with ellipses. | |
29 |
|
33 | |||
30 | If three consecutive dots, or two consecutive dots are encountered these are |
|
34 | If three consecutive dots, or two consecutive dots are encountered these are | |
31 | replaced by the equivalents HORIZONTAL ELLIPSIS or TWO DOT LEADER unicode |
|
35 | replaced by the equivalents HORIZONTAL ELLIPSIS or TWO DOT LEADER unicode | |
32 | equivalents |
|
36 | equivalents | |
33 | """ |
|
37 | """ | |
34 | string = string.replace('...','\N{HORIZONTAL ELLIPSIS}') |
|
38 | string = string.replace('...','\N{HORIZONTAL ELLIPSIS}') | |
35 | string = string.replace('..','\N{TWO DOT LEADER}') |
|
39 | string = string.replace('..','\N{TWO DOT LEADER}') | |
36 | if len(string) < min_elide: |
|
40 | if len(string) < min_elide: | |
37 | return string |
|
41 | return string | |
38 |
|
42 | |||
39 | parts = string.split('.') |
|
43 | object_parts = string.split('.') | |
|
44 | file_parts = string.split(os.sep) | |||
40 |
|
45 | |||
41 |
if len(parts) |
|
46 | if len(object_parts) > 3: | |
42 | return string |
|
47 | return '{}.{}\N{HORIZONTAL ELLIPSIS}{}.{}'.format(object_parts[0], object_parts[1][0], object_parts[-2][-1], object_parts[-1]) | |
|
48 | ||||
|
49 | elif len(file_parts) > 3: | |||
|
50 | return ('{}' + os.sep + '{}\N{HORIZONTAL ELLIPSIS}{}' + os.sep + '{}').format(file_parts[0], file_parts[1][0], file_parts[-2][-1], file_parts[-1]) | |||
43 |
|
51 | |||
44 | return '{}.{}\N{HORIZONTAL ELLIPSIS}{}.{}'.format(parts[0], parts[1][0], parts[-2][-1], parts[-1]) |
|
52 | return string | |
45 |
|
53 | |||
46 |
|
54 | |||
47 | def _adjust_completion_text_based_on_context(text, body, offset): |
|
55 | def _adjust_completion_text_based_on_context(text, body, offset): | |
48 | if text.endswith('=') and len(body) > offset and body[offset] is '=': |
|
56 | if text.endswith('=') and len(body) > offset and body[offset] is '=': | |
49 | return text[:-1] |
|
57 | return text[:-1] | |
50 | else: |
|
58 | else: | |
51 | return text |
|
59 | return text | |
52 |
|
60 | |||
53 |
|
61 | |||
54 | class IPythonPTCompleter(Completer): |
|
62 | class IPythonPTCompleter(Completer): | |
55 | """Adaptor to provide IPython completions to prompt_toolkit""" |
|
63 | """Adaptor to provide IPython completions to prompt_toolkit""" | |
56 | def __init__(self, ipy_completer=None, shell=None): |
|
64 | def __init__(self, ipy_completer=None, shell=None): | |
57 | if shell is None and ipy_completer is None: |
|
65 | if shell is None and ipy_completer is None: | |
58 | raise TypeError("Please pass shell=an InteractiveShell instance.") |
|
66 | raise TypeError("Please pass shell=an InteractiveShell instance.") | |
59 | self._ipy_completer = ipy_completer |
|
67 | self._ipy_completer = ipy_completer | |
60 | self.shell = shell |
|
68 | self.shell = shell | |
61 |
|
69 | |||
62 | @property |
|
70 | @property | |
63 | def ipy_completer(self): |
|
71 | def ipy_completer(self): | |
64 | if self._ipy_completer: |
|
72 | if self._ipy_completer: | |
65 | return self._ipy_completer |
|
73 | return self._ipy_completer | |
66 | else: |
|
74 | else: | |
67 | return self.shell.Completer |
|
75 | return self.shell.Completer | |
68 |
|
76 | |||
69 | def get_completions(self, document, complete_event): |
|
77 | def get_completions(self, document, complete_event): | |
70 | if not document.current_line.strip(): |
|
78 | if not document.current_line.strip(): | |
71 | return |
|
79 | return | |
72 | # Some bits of our completion system may print stuff (e.g. if a module |
|
80 | # Some bits of our completion system may print stuff (e.g. if a module | |
73 | # is imported). This context manager ensures that doesn't interfere with |
|
81 | # is imported). This context manager ensures that doesn't interfere with | |
74 | # the prompt. |
|
82 | # the prompt. | |
75 |
|
83 | |||
76 | with patch_stdout(), provisionalcompleter(): |
|
84 | with patch_stdout(), provisionalcompleter(): | |
77 | body = document.text |
|
85 | body = document.text | |
78 | cursor_row = document.cursor_position_row |
|
86 | cursor_row = document.cursor_position_row | |
79 | cursor_col = document.cursor_position_col |
|
87 | cursor_col = document.cursor_position_col | |
80 | cursor_position = document.cursor_position |
|
88 | cursor_position = document.cursor_position | |
81 | offset = cursor_to_position(body, cursor_row, cursor_col) |
|
89 | offset = cursor_to_position(body, cursor_row, cursor_col) | |
82 | yield from self._get_completions(body, offset, cursor_position, self.ipy_completer) |
|
90 | yield from self._get_completions(body, offset, cursor_position, self.ipy_completer) | |
83 |
|
91 | |||
84 | @staticmethod |
|
92 | @staticmethod | |
85 | def _get_completions(body, offset, cursor_position, ipyc): |
|
93 | def _get_completions(body, offset, cursor_position, ipyc): | |
86 | """ |
|
94 | """ | |
87 | Private equivalent of get_completions() use only for unit_testing. |
|
95 | Private equivalent of get_completions() use only for unit_testing. | |
88 | """ |
|
96 | """ | |
89 | debug = getattr(ipyc, 'debug', False) |
|
97 | debug = getattr(ipyc, 'debug', False) | |
90 | completions = _deduplicate_completions( |
|
98 | completions = _deduplicate_completions( | |
91 | body, ipyc.completions(body, offset)) |
|
99 | body, ipyc.completions(body, offset)) | |
92 | for c in completions: |
|
100 | for c in completions: | |
93 | if not c.text: |
|
101 | if not c.text: | |
94 | # Guard against completion machinery giving us an empty string. |
|
102 | # Guard against completion machinery giving us an empty string. | |
95 | continue |
|
103 | continue | |
96 | text = unicodedata.normalize('NFC', c.text) |
|
104 | text = unicodedata.normalize('NFC', c.text) | |
97 | # When the first character of the completion has a zero length, |
|
105 | # When the first character of the completion has a zero length, | |
98 | # then it's probably a decomposed unicode character. E.g. caused by |
|
106 | # then it's probably a decomposed unicode character. E.g. caused by | |
99 | # the "\dot" completion. Try to compose again with the previous |
|
107 | # the "\dot" completion. Try to compose again with the previous | |
100 | # character. |
|
108 | # character. | |
101 | if wcwidth(text[0]) == 0: |
|
109 | if wcwidth(text[0]) == 0: | |
102 | if cursor_position + c.start > 0: |
|
110 | if cursor_position + c.start > 0: | |
103 | char_before = body[c.start - 1] |
|
111 | char_before = body[c.start - 1] | |
104 | fixed_text = unicodedata.normalize( |
|
112 | fixed_text = unicodedata.normalize( | |
105 | 'NFC', char_before + text) |
|
113 | 'NFC', char_before + text) | |
106 |
|
114 | |||
107 | # Yield the modified completion instead, if this worked. |
|
115 | # Yield the modified completion instead, if this worked. | |
108 | if wcwidth(text[0:1]) == 1: |
|
116 | if wcwidth(text[0:1]) == 1: | |
109 | yield Completion(fixed_text, start_position=c.start - offset - 1) |
|
117 | yield Completion(fixed_text, start_position=c.start - offset - 1) | |
110 | continue |
|
118 | continue | |
111 |
|
119 | |||
112 | # TODO: Use Jedi to determine meta_text |
|
120 | # TODO: Use Jedi to determine meta_text | |
113 | # (Jedi currently has a bug that results in incorrect information.) |
|
121 | # (Jedi currently has a bug that results in incorrect information.) | |
114 | # meta_text = '' |
|
122 | # meta_text = '' | |
115 | # yield Completion(m, start_position=start_pos, |
|
123 | # yield Completion(m, start_position=start_pos, | |
116 | # display_meta=meta_text) |
|
124 | # display_meta=meta_text) | |
117 | display_text = c.text |
|
125 | display_text = c.text | |
118 |
|
126 | |||
119 | adjusted_text = _adjust_completion_text_based_on_context(c.text, body, offset) |
|
127 | adjusted_text = _adjust_completion_text_based_on_context(c.text, body, offset) | |
120 | if c.type == 'function': |
|
128 | if c.type == 'function': | |
121 | yield Completion(adjusted_text, start_position=c.start - offset, display=_elide(display_text+'()'), display_meta=c.type+c.signature) |
|
129 | yield Completion(adjusted_text, start_position=c.start - offset, display=_elide(display_text+'()'), display_meta=c.type+c.signature) | |
122 | else: |
|
130 | else: | |
123 | yield Completion(adjusted_text, start_position=c.start - offset, display=_elide(display_text), display_meta=c.type) |
|
131 | yield Completion(adjusted_text, start_position=c.start - offset, display=_elide(display_text), display_meta=c.type) | |
124 |
|
132 | |||
125 | class IPythonPTLexer(Lexer): |
|
133 | class IPythonPTLexer(Lexer): | |
126 | """ |
|
134 | """ | |
127 | Wrapper around PythonLexer and BashLexer. |
|
135 | Wrapper around PythonLexer and BashLexer. | |
128 | """ |
|
136 | """ | |
129 | def __init__(self): |
|
137 | def __init__(self): | |
130 | l = pygments_lexers |
|
138 | l = pygments_lexers | |
131 | self.python_lexer = PygmentsLexer(l.Python3Lexer) |
|
139 | self.python_lexer = PygmentsLexer(l.Python3Lexer) | |
132 | self.shell_lexer = PygmentsLexer(l.BashLexer) |
|
140 | self.shell_lexer = PygmentsLexer(l.BashLexer) | |
133 |
|
141 | |||
134 | self.magic_lexers = { |
|
142 | self.magic_lexers = { | |
135 | 'HTML': PygmentsLexer(l.HtmlLexer), |
|
143 | 'HTML': PygmentsLexer(l.HtmlLexer), | |
136 | 'html': PygmentsLexer(l.HtmlLexer), |
|
144 | 'html': PygmentsLexer(l.HtmlLexer), | |
137 | 'javascript': PygmentsLexer(l.JavascriptLexer), |
|
145 | 'javascript': PygmentsLexer(l.JavascriptLexer), | |
138 | 'js': PygmentsLexer(l.JavascriptLexer), |
|
146 | 'js': PygmentsLexer(l.JavascriptLexer), | |
139 | 'perl': PygmentsLexer(l.PerlLexer), |
|
147 | 'perl': PygmentsLexer(l.PerlLexer), | |
140 | 'ruby': PygmentsLexer(l.RubyLexer), |
|
148 | 'ruby': PygmentsLexer(l.RubyLexer), | |
141 | 'latex': PygmentsLexer(l.TexLexer), |
|
149 | 'latex': PygmentsLexer(l.TexLexer), | |
142 | } |
|
150 | } | |
143 |
|
151 | |||
144 | def lex_document(self, document): |
|
152 | def lex_document(self, document): | |
145 | text = document.text.lstrip() |
|
153 | text = document.text.lstrip() | |
146 |
|
154 | |||
147 | lexer = self.python_lexer |
|
155 | lexer = self.python_lexer | |
148 |
|
156 | |||
149 | if text.startswith('!') or text.startswith('%%bash'): |
|
157 | if text.startswith('!') or text.startswith('%%bash'): | |
150 | lexer = self.shell_lexer |
|
158 | lexer = self.shell_lexer | |
151 |
|
159 | |||
152 | elif text.startswith('%%'): |
|
160 | elif text.startswith('%%'): | |
153 | for magic, l in self.magic_lexers.items(): |
|
161 | for magic, l in self.magic_lexers.items(): | |
154 | if text.startswith('%%' + magic): |
|
162 | if text.startswith('%%' + magic): | |
155 | lexer = l |
|
163 | lexer = l | |
156 | break |
|
164 | break | |
157 |
|
165 | |||
158 | return lexer.lex_document(document) |
|
166 | return lexer.lex_document(document) |
General Comments 0
You need to be logged in to leave comments.
Login now