3bcfb151c1
Replace plain-text type information with the type syntax used for Python's type annotations as it's more concise, especially for callbacks which often didn't include useful type information. Note that this change only applies to inline doc-strings, generated doc-strings from RNA need to be updated separately. Details: - Many minor corrections were made when "list" was incorrectly used instead of "sequence". - Some type information wasn't defined in the doc-strings and has been added. - Verbose type info would benefit from support for type aliases.
139 lines
4.5 KiB
Python
139 lines
4.5 KiB
Python
# SPDX-FileCopyrightText: 2009-2023 Blender Authors
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
# Copyright (c) 2009 https://www.stani.be
|
|
|
|
"""This module provides intellisense features such as:
|
|
|
|
* autocompletion
|
|
* calltips
|
|
|
|
It unifies all completion plugins and only loads them on demand.
|
|
"""
|
|
|
|
# TODO: file complete if startswith quotes
|
|
import os
|
|
import re
|
|
|
|
# regular expressions to find out which completer we need
|
|
|
|
# line which starts with an import statement
|
|
RE_MODULE = re.compile(r'''^import(\s|$)|from.+''')
|
|
|
|
# The following regular expression means an 'unquoted' word
|
|
RE_UNQUOTED_WORD = re.compile(
|
|
# don't start with a quote
|
|
r'''(?:^|[^"'a-zA-Z0-9_])'''
|
|
# start with a \w = [a-zA-Z0-9_]
|
|
r'''((?:\w+'''
|
|
# allow also dots and closed bracket pairs []
|
|
r'''(?:\w|[.]|\[.+?\])*'''
|
|
# allow empty string
|
|
r'''|)'''
|
|
# allow an unfinished index at the end (including quotes)
|
|
r'''(?:\[[^\]]*$)?)$''',
|
|
# allow unicode as theoretically this is possible
|
|
re.UNICODE)
|
|
|
|
|
|
def complete(line, cursor, namespace, private):
|
|
"""Returns a list of possible completions:
|
|
|
|
* name completion
|
|
* attribute completion (obj.attr)
|
|
* index completion for lists and dictionaries
|
|
* module completion (from/import)
|
|
|
|
:arg line: incomplete text line
|
|
:type line: str
|
|
:arg cursor: current character position
|
|
:type cursor: int
|
|
:arg namespace: namespace
|
|
:type namespace: dict
|
|
:arg private: whether private variables should be listed
|
|
:type private: bool
|
|
:returns: list of completions, word
|
|
:rtype: tuple[list[str], str]
|
|
|
|
>>> complete('re.sr', 5, {'re': re})
|
|
(['re.sre_compile', 're.sre_parse'], 're.sr')
|
|
"""
|
|
re_unquoted_word = RE_UNQUOTED_WORD.search(line[:cursor])
|
|
if re_unquoted_word:
|
|
# unquoted word -> module or attribute completion
|
|
word = re_unquoted_word.group(1)
|
|
if RE_MODULE.match(line):
|
|
from . import complete_import
|
|
matches = complete_import.complete(line)
|
|
if not private:
|
|
matches[:] = [m for m in matches if m[:1] != "_"]
|
|
matches.sort()
|
|
else:
|
|
from . import complete_namespace
|
|
matches = complete_namespace.complete(word, namespace, private=private)
|
|
else:
|
|
# for now we don't have completers for strings
|
|
# TODO: add file auto completer for strings
|
|
word = ''
|
|
matches = []
|
|
return matches, word
|
|
|
|
|
|
def expand(line, cursor, namespace, *, private=True):
|
|
"""This method is invoked when the user asks auto-completion,
|
|
e.g. when Ctrl+Space is clicked.
|
|
|
|
:arg line: incomplete text line
|
|
:type line: str
|
|
:arg cursor: current character position
|
|
:type cursor: int
|
|
:arg namespace: namespace
|
|
:type namespace: dict[str, Any]
|
|
:arg private: whether private variables should be listed
|
|
:type private: bool
|
|
:returns:
|
|
|
|
current expanded line, updated cursor position and scrollback
|
|
|
|
:rtype: str, int, str
|
|
|
|
>>> expand('os.path.isdir(', 14, {'os': os})[-1]
|
|
'isdir(s)\\nReturn true if the pathname refers to an existing directory.'
|
|
>>> expand('abs(', 4, {})[-1]
|
|
'abs(number) -> number\\nReturn the absolute value of the argument.'
|
|
"""
|
|
if line[:cursor].strip().endswith('('):
|
|
from . import complete_calltip
|
|
matches, word, scrollback = complete_calltip.complete(
|
|
line, cursor, namespace)
|
|
prefix = os.path.commonprefix(matches)[len(word):]
|
|
no_calltip = False
|
|
else:
|
|
matches, word = complete(line, cursor, namespace, private)
|
|
prefix = os.path.commonprefix(matches)[len(word):]
|
|
if len(matches) == 1:
|
|
scrollback = ''
|
|
else:
|
|
# causes blender bug #27495 since string keys may contain '.'
|
|
# scrollback = ' '.join([m.split('.')[-1] for m in matches])
|
|
|
|
# add white space to align with the cursor
|
|
white_space = " " + (" " * (cursor + len(prefix)))
|
|
word_prefix = word + prefix
|
|
scrollback = '\n'.join(
|
|
[white_space + m[len(word_prefix):]
|
|
if (word_prefix and m.startswith(word_prefix))
|
|
else
|
|
white_space + m.rsplit('.', 1)[-1]
|
|
for m in matches])
|
|
|
|
no_calltip = True
|
|
|
|
if prefix:
|
|
line = line[:cursor] + prefix + line[cursor:]
|
|
cursor += len(prefix.encode('utf-8'))
|
|
if no_calltip and prefix.endswith('('):
|
|
return expand(line, cursor, namespace, private=private)
|
|
return line, cursor, scrollback
|