iframe-proxy | Sunbelt Computer Software

814 lines (693 loc) · 24.1 KB
# The MIT License
# Copyright (c) 2009-2015 the bpython authors.
# Copyright (c) 2015-2020 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.
# To gradually migrate to mypy we aren't setting these globally yet
# mypy: disallow_untyped_defs=True
# mypy: disallow_untyped_calls=True
import __main__
import glob
import itertools
import keyword
import logging
import rlcompleter
import builtins
from enum import Enum
from typing import (
    Iterator,
    Optional,
    Sequence,
from . import inspection
from . import line as lineparts
from .line import LinePart
from .lazyre import LazyReCompile
from .simpleeval import safe_eval, evaluate_current_expression, EvaluationError
from .importcompletion import ModuleGatherer
logger = logging.getLogger(__name__)
# Autocomplete modes
class AutocompleteModes(Enum):
    NONE = "none"
    SIMPLE = "simple"
    SUBSTRING = "substring"
    FUZZY = "fuzzy"
    @classmethod
    def from_string(cls, value: str) -> Optional["AutocompleteModes"]:
        if value.upper() in cls.__members__:
            return cls.__members__[value.upper()]
        return None
MAGIC_METHODS = tuple(
    f"__{s}__"
    for s in (
        "new",
        "init",
        "del",
        "repr",
        "str",
        "bytes",
        "format",
        "lt",
        "le",
        "eq",
        "ne",
        "gt",
        "ge",
        "hash",
        "bool",
        "getattr",
        "getattribute",
        "setattr",
        "delattr",
        "dir",
        "get",
        "set",
        "delete",
        "set_name",
        "init_subclass",
        "instancecheck",
        "subclasscheck",
        "class_getitem",
        "call",
        "len",
        "length_hint",
        "getitem",
        "setitem",
        "delitem",
        "missing",
        "iter",
        "reversed",
        "contains",
        "add",
        "sub",
        "mul",
        "matmul",
        "truediv",
        "floordiv",
        "mod",
        "divmod",
        "pow",
        "lshift",
        "rshift",
        "and",
        "xor",
        "or",
        "radd",
        "rsub",
        "rmul",
        "rmatmul",
        "rtruediv",
        "rfloordiv",
        "rmod",
        "rdivmod",
        "rpow",
        "rlshift",
        "rrshift",
        "rand",
        "rxor",
        "ror",
        "iadd",
        "isub",
        "imul",
        "imatmul",
        "itruediv",
        "ifloordiv",
        "imod",
        "ipow",
        "ilshift",
        "irshift",
        "iand",
        "ixor",
        "ixor",
        "neg",
        "pos",
        "abs",
        "invert",
        "complex",
        "int",
        "float",
        "index",
        "round",
        "trunc",
        "floor",
        "ceil",
        "enter",
        "exit",
        "await",
        "aiter",
        "anext",
        "aenter",
        "aexit",
KEYWORDS = frozenset(keyword.kwlist)
def _after_last_dot(name: str) -> str:
    return name.rstrip(".").rsplit(".")[-1]
def _few_enough_underscores(current: str, match: str) -> bool:
    """Returns whether match should be shown based on current
    if current is _, True if match starts with 0 or 1 underscore
    if current is __, True regardless of match
    otherwise True if match does not start with any underscore
    if current.startswith("__"):
        return True
    elif current.startswith("_") and not match.startswith("__"):
        return True
    return not match.startswith("_")
def _method_match_none(word: str, size: int, text: str) -> bool:
    return False
def _method_match_simple(word: str, size: int, text: str) -> bool:
    return word[:size] == text
def _method_match_substring(word: str, size: int, text: str) -> bool:
    return text in word
def _method_match_fuzzy(word: str, size: int, text: str) -> bool:
    s = r".*{}.*".format(".*".join(c for c in text))
    return re.search(s, word) is not None
_MODES_MAP = {
    AutocompleteModes.NONE: _method_match_none,
    AutocompleteModes.SIMPLE: _method_match_simple,
    AutocompleteModes.SUBSTRING: _method_match_substring,
    AutocompleteModes.FUZZY: _method_match_fuzzy,
class BaseCompletionType:
    """Describes different completion types"""
    def __init__(
        self,
        shown_before_tab: bool = True,
        mode: AutocompleteModes = AutocompleteModes.SIMPLE,
    ) -> None:
        self._shown_before_tab = shown_before_tab
        self.method_match = _MODES_MAP[mode]
    @abc.abstractmethod
    def matches(
        self, cursor_offset: int, line: str, **kwargs: Any
    ) -> Optional[Set[str]]:
        """Returns a list of possible matches given a line and cursor, or None
        if this completion type isn't applicable.
        ie, import completion doesn't make sense if there cursor isn't after
        an import or from statement, so it ought to return None.
        Completion types are used to:
            * `locate(cur, line)` their initial target word to replace given a
              line and cursor
            * find `matches(cur, line)` that might replace that word
            * `format(match)` matches to be displayed to the user
            * determine whether suggestions should be `shown_before_tab`
            * `substitute(cur, line, match)` in a match for what's found with
              `target`
        """
        raise NotImplementedError
    @abc.abstractmethod
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        """Returns a Linepart namedtuple instance or None given cursor and line
        A Linepart namedtuple contains a start, stop, and word. None is
        returned if no target for this type of completion is found under
        the cursor."""
        raise NotImplementedError
    def format(self, word: str) -> str:
        return word
    def substitute(
        self, cursor_offset: int, line: str, match: str
    ) -> 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
    @property
    def shown_before_tab(self) -> bool:
        """Whether suggestions should be shown before the user hits tab, or only
        once that has happened."""
        return self._shown_before_tab
class CumulativeCompleter(BaseCompletionType):
    """Returns combined matches from several completers"""
    def __init__(
        self,
        completers: Sequence[BaseCompletionType],
        mode: AutocompleteModes = AutocompleteModes.SIMPLE,
    ) -> None:
        if not completers:
            raise ValueError(
                "CumulativeCompleter requires at least one completer"
        self._completers: Sequence[BaseCompletionType] = completers
        super().__init__(True, mode)
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        for completer in self._completers:
            return_value = completer.locate(cursor_offset, line)
            if return_value is not None:
                return return_value
        return None
    def format(self, word: str) -> str:
        return self._completers[0].format(word)
    def matches(
        self, cursor_offset: int, line: str, **kwargs: Any
    ) -> Optional[Set[str]]:
        return_value = None
        all_matches = set()
        for completer in self._completers:
            matches = completer.matches(
                cursor_offset=cursor_offset, line=line, **kwargs
            if matches is not None:
                all_matches.update(matches)
                return_value = all_matches
        return return_value
class ImportCompletion(BaseCompletionType):
    def __init__(
        self,
        module_gatherer: ModuleGatherer,
        mode: AutocompleteModes = AutocompleteModes.SIMPLE,
        super().__init__(False, mode)
        self.module_gatherer = module_gatherer
    def matches(
        self, cursor_offset: int, line: str, **kwargs: Any
    ) -> Optional[Set[str]]:
        return self.module_gatherer.complete(cursor_offset, line)
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_word(cursor_offset, line)
    def format(self, word: str) -> str:
        return _after_last_dot(word)
def _safe_glob(pathname: str) -> Iterator[str]:
    return glob.iglob(glob.escape(pathname) + "*")
class FilenameCompletion(BaseCompletionType):
    def __init__(self, mode: AutocompleteModes = AutocompleteModes.SIMPLE):
        super().__init__(False, mode)
    def matches(
        self, cursor_offset: int, line: str, **kwargs: Any
    ) -> Optional[Set[str]]:
        cs = lineparts.current_string(cursor_offset, line)
        if cs is None:
            return None
        matches = set()
        username = cs.word.split(os.path.sep, 1)[0]
        user_dir = os.path.expanduser(username)
        for filename in _safe_glob(os.path.expanduser(cs.word)):
            if os.path.isdir(filename):
                filename += os.path.sep
            if cs.word.startswith("~"):
                filename = username + filename[len(user_dir) :]
            matches.add(filename)
        return matches
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_string(cursor_offset, line)
    def format(self, filename: str) -> str:
        if os.sep in filename[:-1]:
            return filename[filename.rindex(os.sep, 0, -1) + 1 :]
        else:
            return filename
class AttrCompletion(BaseCompletionType):
    attr_matches_re = LazyReCompile(r"(\w+(\.\w+)*)\.(\w*)")
    def matches(
        self,
        cursor_offset: int,
        line: str,
        locals_: Optional[Dict[str, Any]] = None,
        **kwargs: Any,
    ) -> Optional[Set[str]]:
        r = self.locate(cursor_offset, line)
        if r is None:
            return None
        if locals_ is None:  # TODO add a note about why
            locals_ = __main__.__dict__
        assert "." in r.word
        i = r.word.rfind("[") + 1
        methodtext = r.word[i:]
        matches = {
            "".join([r.word[:i], m])
            for m in self.attr_matches(methodtext, locals_)
        return {
            for m in matches
            if _few_enough_underscores(r.word.split(".")[-1], m.split(".")[-1])
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_dotted_attribute(cursor_offset, line)
    def format(self, word: str) -> str:
        return _after_last_dot(word)
    def attr_matches(
        self, text: str, namespace: Dict[str, Any]
    ) -> Iterator[str]:
        """Taken from rlcompleter.py and bent to my will."""
        m = self.attr_matches_re.match(text)
        if not m:
            return (_ for _ in ())
        expr, attr = m.group(1, 3)
        if expr.isdigit():
            # Special case: float literal, using attrs here will result in
            # a SyntaxError
            return (_ for _ in ())
        try:
            obj = safe_eval(expr, namespace)
        except EvaluationError:
            return (_ for _ in ())
        return self.attr_lookup(obj, expr, attr)
    def attr_lookup(self, obj: Any, expr: str, attr: str) -> Iterator[str]:
        """Second half of attr_matches."""
        words = self.list_attributes(obj)
        if inspection.hasattr_safe(obj, "__class__"):
            words.append("__class__")
            klass = inspection.getattr_safe(obj, "__class__")
            words = words + rlcompleter.get_class_members(klass)
            if not isinstance(klass, abc.ABCMeta):
                    words.remove("__abstractmethods__")
                except ValueError:
        n = len(attr)
        return (
            f"{expr}.{word}"
            for word in words
            if self.method_match(word, n, attr) and word != "__builtins__"
    def list_attributes(self, obj: Any) -> List[str]:
        # TODO: re-implement dir without AttrCleaner here
        # Note: accessing `obj.__dir__` via `getattr_static` is not side-effect free.
        with inspection.AttrCleaner(obj):
            return dir(obj)
class DictKeyCompletion(BaseCompletionType):
    def matches(
        self,
        cursor_offset: int,
        line: str,
        locals_: Optional[Dict[str, Any]] = None,
        **kwargs: Any,
    ) -> Optional[Set[str]]:
        if locals_ is None:
            return None
        r = self.locate(cursor_offset, line)
        if r is None:
            return None
        current_dict_parts = lineparts.current_dict(cursor_offset, line)
        if current_dict_parts is None:
            return None
        dexpr = current_dict_parts.word
        try:
            obj = safe_eval(dexpr, locals_)
        except EvaluationError:
            return None
        if isinstance(obj, dict) and obj.keys():
            matches = {
                f"{k!r}]" for k in obj.keys() if repr(k).startswith(r.word)
            return matches if matches else None
        else:
            return None
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_dict_key(cursor_offset, line)
    def format(self, match: str) -> str:
        return match[:-1]
class MagicMethodCompletion(BaseCompletionType):
    def matches(
        self,
        cursor_offset: int,
        line: str,
        current_block: Optional[str] = None,
        complete_magic_methods: Optional[bool] = None,
        **kwargs: Any,
    ) -> Optional[Set[str]]:
        if (
            current_block is None
            or complete_magic_methods is None
            or not complete_magic_methods
            return None
        r = self.locate(cursor_offset, line)
        if r is None:
            return None
        if "class" not in current_block:
            return None
        return {name for name in MAGIC_METHODS if name.startswith(r.word)}
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_method_definition_name(cursor_offset, line)
class GlobalCompletion(BaseCompletionType):
    def matches(
        self,
        cursor_offset: int,
        line: str,
        locals_: Optional[Dict[str, Any]] = None,
        **kwargs: Any,
    ) -> Optional[Set[str]]:
        """Compute matches when text is a simple name.
        Return a list of all keywords, built-in functions and names currently
        defined in self.namespace that match.
        """
        if locals_ is None:
            return None
        r = self.locate(cursor_offset, line)
        if r is None:
            return None
        n = len(r.word)
        matches = {
            word for word in KEYWORDS if self.method_match(word, n, r.word)
        for nspace in (builtins.__dict__, locals_):
            for word, val in nspace.items():
                # if identifier isn't ascii, don't complete (syntax error)
                if word is None:
                    continue
                    self.method_match(word, n, r.word)
                    and word != "__builtins__"
                    matches.add(_callable_postfix(val, word))
        return matches if matches else None
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_single_word(cursor_offset, line)
class ParameterNameCompletion(BaseCompletionType):
    def matches(
        self,
        cursor_offset: int,
        line: str,
        funcprops: Optional[inspection.FuncProps] = None,
        **kwargs: Any,
    ) -> Optional[Set[str]]:
        if funcprops is None:
            return None
        r = self.locate(cursor_offset, line)
        if r is None:
            return None
        matches = {
            f"{name}="
            for name in funcprops.argspec.args
            if isinstance(name, str) and name.startswith(r.word)
        matches.update(
            f"{name}="
            for name in funcprops.argspec.kwonly
            if name.startswith(r.word)
        return matches if matches else None
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        r = lineparts.current_word(cursor_offset, line)
        if r and r.word[-1] == "(":
            # if the word ends with a (, it's the parent word with an empty
            # param. Return an empty word
            return lineparts.LinePart(r.stop, r.stop, "")
        return r
class ExpressionAttributeCompletion(AttrCompletion):
    # could replace attr completion as a more general case with some work
    def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
        return lineparts.current_expression_attribute(cursor_offset, line)
    def matches(
        self,
        cursor_offset: int,
        line: str,
        locals_: Optional[Dict[str, Any]] = None,
        **kwargs: Any,
    ) -> Optional[Set[str]]:
        if locals_ is 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_)
        except EvaluationError:
            return set()
        # strips leading dot
        matches = (m[1:] for m in self.attr_lookup(obj, "", attr.word))
        return {m for m in matches if _few_enough_underscores(attr.word, m)}
    import jedi
except ImportError:
    class MultilineJediCompletion(BaseCompletionType):  # type: ignore [no-redef]
        def matches(
            self, cursor_offset: int, line: str, **kwargs: Any
        ) -> Optional[Set[str]]:
            return None
        def locate(self, cursor_offset: int, line: str) -> Optional[LinePart]:
            return None
    class MultilineJediCompletion(BaseCompletionType):  # type: ignore [no-redef]
        _orig_start: Optional[int]
        def matches(
            self,
            cursor_offset: int,
            line: str,
            current_block: Optional[str] = None,
            history: Optional[List[str]] = None,
            **kwargs: Any,
        ) -> Optional[Set[str]]:
                current_block is None
                or history is None
                or "\n" not in current_block
                or not lineparts.current_word(cursor_offset, line)
                return None
            assert cursor_offset <= len(line), "{!r} {!r}".format(
                cursor_offset,
                line,
            combined_history = "\n".join(itertools.chain(history, (line,)))
            try:
                script = jedi.Script(combined_history, path="fake.py")
                completions = script.complete(
                    combined_history.count("\n") + 1, cursor_offset
            except (jedi.NotFoundError, IndexError, KeyError):
                # IndexError for #483
                # KeyError for #544
                self._orig_start = None
                return None
            if completions:
                diff = len(completions[0].name) - len(completions[0].complete)
                self._orig_start = cursor_offset - diff
            else:
                self._orig_start = None
                return None
            assert isinstance(self._orig_start, int)
            matches = [c.name for c in completions]
            if any(
                not m.lower().startswith(matches[0][0].lower()) for m in matches
                # Too general - giving completions starting with multiple
                # letters
                return None
            else:
                # case-sensitive matches only
                first_letter = line[self._orig_start]
                return {m for m in matches if m.startswith(first_letter)}
        def locate(self, cursor_offset: int, line: str) -> LinePart:
            assert self._orig_start is not None
            start = self._orig_start
            end = cursor_offset
            return LinePart(start, end, line[start:end])
def get_completer(
    completers: Sequence[BaseCompletionType],
    cursor_offset: int,
    line: str,
    locals_: Optional[Dict[str, Any]] = None,
    argspec: Optional[inspection.FuncProps] = None,
    history: Optional[List[str]] = None,
    current_block: Optional[str] = None,
    complete_magic_methods: Optional[bool] = None,
) -> Tuple[List[str], Optional[BaseCompletionType]]:
    """Returns a list of matches and an applicable completer
    If no matches available, returns a tuple of an empty list and None
    cursor_offset is the current cursor column
    line is a string of the current line
    kwargs (all optional):
        locals_ is a dictionary of the environment
        argspec is an inspection.FuncProps instance for the current function where
            the cursor is
        current_block is the possibly multiline not-yet-evaluated block of
            code which the current line is part of
        complete_magic_methods is a bool of whether we ought to complete
            double underscore methods like __len__ in method signatures
    def _cmpl_sort(x: str) -> Tuple[bool, str]:
        """
        Function used to sort the matches.
        """
        # put parameters above everything in completion
        return (
            x[-1] != "=",
    for completer in completers:
        try:
            matches = completer.matches(
                cursor_offset,
                line,
                locals_=locals_,
                funcprops=argspec,
                history=history,
                current_block=current_block,
                complete_magic_methods=complete_magic_methods,
        except Exception as e:
            # Instead of crashing the UI, log exceptions from autocompleters.
            logger.debug(
                "Completer %r failed with unhandled exception: %s", completer, e
            continue
        if matches is not None:
            return sorted(matches, key=_cmpl_sort), (
                completer if matches else None
    return [], None
def get_default_completer(
    mode: AutocompleteModes, module_gatherer: ModuleGatherer
) -> Tuple[BaseCompletionType, ...]:
    return (
            DictKeyCompletion(mode=mode),
            ImportCompletion(module_gatherer, mode=mode),
            FilenameCompletion(mode=mode),
            MagicMethodCompletion(mode=mode),
            MultilineJediCompletion(mode=mode),
            CumulativeCompleter(
                    GlobalCompletion(mode=mode),
                    ParameterNameCompletion(mode=mode),
                mode=mode,
            AttrCompletion(mode=mode),
            ExpressionAttributeCompletion(mode=mode),
        if mode != AutocompleteModes.NONE
        else tuple()
def _callable_postfix(value: Any, word: str) -> str:
    """rlcompleter's _callable_postfix done right."""
    if callable(value):
        word += "("
    return word
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

autocomplete.py

Latest commit

History

autocomplete.py

File metadata and controls
