Skip to content

Mypy types for completion #928

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 7, 2021
Merged

Mypy types for completion #928

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8da0381
Mypy types for completion
thomasballinger Oct 7, 2021
f756d8f
types for Python 3.6
thomasballinger Oct 7, 2021
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
47 changes: 31 additions & 16 deletions bpython/autocomplete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
import builtins

from enum import Enum
from typing import Any, Dict, Iterator, List, Match, NoReturn, Set, Union
from typing import Any, Dict, Iterator, List, Match, NoReturn, Set, Union, Tuple
from . import inspection
from . import line as lineparts
from .line import LinePart
Expand Down Expand Up @@ -180,7 +180,7 @@ def few_enough_underscores(current, match) -> bool:
return not match.startswith("_")


def method_match_none(word, size, text) -> False:
def method_match_none(word, size, text) -> bool:
return False


Expand Down Expand Up @@ -214,7 +214,10 @@ def __init__(
self._shown_before_tab = shown_before_tab
self.method_match = MODES_MAP[mode]

def matches(self, cursor_offset, line, **kwargs) -> NoReturn:
@abc.abstractmethod
def matches(
self, cursor_offset: int, line: str, **kwargs
) -> Union[Set[str], None]:
"""Returns a list of possible matches given a line and cursor, or None
if this completion type isn't applicable.

Expand All @@ -232,7 +235,8 @@ def matches(self, cursor_offset, line, **kwargs) -> NoReturn:
"""
raise NotImplementedError

def locate(self, cursor_offset, line) -> NoReturn:
@abc.abstractmethod
def locate(self, cursor_offset: int, line: str) -> Union[LinePart, None]:
"""Returns a Linepart namedtuple instance or None given cursor and line

A Linepart namedtuple contains a start, stop, and word. None is
Expand All @@ -243,9 +247,10 @@ def locate(self, cursor_offset, line) -> NoReturn:
def format(self, word):
return word

def substitute(self, cursor_offset, line, match) -> NoReturn:
def substitute(self, cursor_offset, line, match) -> Tuple[int, str]:
"""Returns a cursor offset and line with match swapped in"""
lpart = self.locate(cursor_offset, line)
assert lpart
offset = lpart.start + len(match)
changed_line = line[: lpart.start] + match + line[lpart.stop :]
return offset, changed_line
Expand All @@ -269,16 +274,19 @@ def __init__(self, completers, mode=AutocompleteModes.SIMPLE) -> None:

super().__init__(True, mode)

def locate(self, current_offset, line) -> Union[None, NoReturn]:
def locate(self, current_offset: int, line: str) -> Union[None, NoReturn]:
for completer in self._completers:
return_value = completer.locate(current_offset, line)
if return_value is not None:
return return_value
return None

def format(self, word):
return self._completers[0].format(word)

def matches(self, cursor_offset, line, **kwargs) -> Union[None, Set]:
def matches(
self, cursor_offset: int, line: str, **kwargs
) -> Union[None, Set]:
return_value = None
all_matches = set()
for completer in self._completers:
Expand Down Expand Up @@ -344,7 +352,7 @@ class AttrCompletion(BaseCompletionType):

attr_matches_re = LazyReCompile(r"(\w+(\.\w+)*)\.(\w*)")

def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Set]:
if "locals_" not in kwargs:
return None
locals_ = kwargs["locals_"]
Expand Down Expand Up @@ -427,15 +435,17 @@ def list_attributes(self, obj) -> List[str]:


class DictKeyCompletion(BaseCompletionType):
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Set]:
if "locals_" not in kwargs:
return None
locals_ = kwargs["locals_"]

r = self.locate(cursor_offset, line)
if r is None:
return None
_, _, dexpr = lineparts.current_dict(cursor_offset, line)
curDictParts = lineparts.current_dict(cursor_offset, line)
assert curDictParts, "current_dict when .locate() truthy"
_, _, dexpr = curDictParts
try:
obj = safe_eval(dexpr, locals_)
except EvaluationError:
Expand All @@ -456,7 +466,7 @@ def format(self, match):


class MagicMethodCompletion(BaseCompletionType):
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Set]:
if "current_block" not in kwargs:
return None
current_block = kwargs["current_block"]
Expand Down Expand Up @@ -508,7 +518,7 @@ def locate(self, current_offset, line) -> Union[LinePart, None]:


class ParameterNameCompletion(BaseCompletionType):
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Set]:
if "argspec" not in kwargs:
return None
argspec = kwargs["argspec"]
Expand Down Expand Up @@ -538,7 +548,7 @@ class ExpressionAttributeCompletion(AttrCompletion):
def locate(self, current_offset, line) -> Union[LinePart, None]:
return lineparts.current_expression_attribute(current_offset, line)

def matches(self, cursor_offset, line, **kwargs) -> Union[Set, Dict, None]:
def matches(self, cursor_offset, line, **kwargs) -> Union[Set, None]:
if "locals_" not in kwargs:
return None
locals_ = kwargs["locals_"]
Expand All @@ -547,6 +557,7 @@ def matches(self, cursor_offset, line, **kwargs) -> Union[Set, Dict, None]:
locals_ = __main__.__dict__

attr = self.locate(cursor_offset, line)
assert attr, "locate was already truthy for the same call"

try:
obj = evaluate_current_expression(cursor_offset, line, locals_)
Expand All @@ -570,7 +581,9 @@ def matches(self, cursor_offset, line, **kwargs) -> None:
else:

class JediCompletion(BaseCompletionType):
def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
_orig_start: Union[int, None]

def matches(self, cursor_offset, line, **kwargs) -> Union[None, Set]:
if "history" not in kwargs:
return None
history = kwargs["history"]
Expand All @@ -596,6 +609,7 @@ def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
else:
self._orig_start = None
return None
assert isinstance(self._orig_start, int)

first_letter = line[self._orig_start : self._orig_start + 1]

Expand All @@ -610,13 +624,14 @@ def matches(self, cursor_offset, line, **kwargs) -> Union[None, Dict]:
# case-sensitive matches only
return {m for m in matches if m.startswith(first_letter)}

def locate(self, cursor_offset, line) -> LinePart:
def locate(self, cursor_offset: int, line: str) -> LinePart:
assert isinstance(self._orig_start, int)
start = self._orig_start
end = cursor_offset
return LinePart(start, end, line[start:end])

class MultilineJediCompletion(JediCompletion):
def matches(self, cursor_offset, line, **kwargs) -> Union[Dict, None]:
def matches(self, cursor_offset, line, **kwargs) -> Union[Set, None]:
if "current_block" not in kwargs or "history" not in kwargs:
return None
current_block = kwargs["current_block"]
Expand Down