Skip to content
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

Jump to bottom

Add better sorting of completions #1165

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Add better sorting of completions #1165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e97ca2d
Add better sorting of completions
Jun 13, 2024
2bec7e8
Fix issue with file name completions
Jun 18, 2024
9409239
Remove back tick before sorting completions
Aug 2, 2024
fa150e2
Fix some unit tests to work with new completing sorting
Aug 2, 2024
80d1945
Fix how the Completion position is set
Aug 3, 2024
8139ab1
Prevent duplicate completions
Aug 6, 2024
fb44577
Fix smart_completion_public_schema_only unit tests
Aug 7, 2024
d532221
Fix sql_output unit test
Aug 7, 2024
60c9677
Fix an issue with casing of completions
Aug 8, 2024
77cd828
Try using an older version of setuptools for unit tests
Aug 20, 2024
f5b674b
Comment out test_empty_string_completion for now
Oct 9, 2024
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
116 changes: 65 additions & 51 deletions mycli/sqlcompleter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,48 +369,61 @@ def find_matches(text, collection, start_only=False, fuzzy=True, casing=None):
yields prompt_toolkit Completion instances for any matches found
in the collection of available completions.
"""
last = last_word(text, include='most_punctuations')
text = last.lower()

completions = []
if casing == 'auto':
casing = 'lower' if text and text[-1].islower() else 'upper'

text = text.lower()

def apply_case(kw):
if casing is None:
return kw
if casing == 'upper':
return kw.upper()
return kw.lower()

matches = []

if fuzzy:
regex = '.*?'.join(map(escape, text))
pat = compile('(%s)' % regex)
for item in collection:
r = pat.search(item.lower())
if r:
completions.append((len(r.group()), r.start(), item))
matches.append(
(len(r.group()), r.start(), apply_case(item)))
else:
match_end_limit = len(text) if start_only else None
for item in collection:
match_point = item.lower().find(text, 0, match_end_limit)
if match_point >= 0:
completions.append((len(text), match_point, item))

if casing == 'auto':
casing = 'lower' if last and last[-1].islower() else 'upper'
matches.append((len(text), match_point, apply_case(item)))

def apply_case(kw):
if casing == 'upper':
return kw.upper()
return kw.lower()

return (Completion(z if casing is None else apply_case(z), -len(text))
for x, y, z in completions)
return matches

def get_completions(self, document, complete_event, smart_completion=None):
word_before_cursor = document.get_word_before_cursor(WORD=True)
text = last_word(word_before_cursor, include='most_punctuations')

def sorted_completions(matches):
# sort by match point, then match length, then item text
matches = sorted(list(matches), key=lambda m:
(m[1], m[0], m[2].lower().strip('`'), m[2].startswith('`')))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this strip is causing the tests to fail. The backticks are used to escape the table name if it happens to be a keyword. For instance if someone names the table table then it going to conflict with the keyword since table is a keyword. This adds backticks around it to escape the string to avoid the conflict.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the comment by @rolandwalker on June 13. The idea is that a table/field surrounded by backticks should match the same one without backticks. I've tried the change the tests to work with this.


return (Completion(z, -len(text))
for x, y, z in matches)

if smart_completion is None:
smart_completion = self.smart_completion

# If smart_completion is off then match any word that starts with
# 'word_before_cursor'.
# 'text'.
if not smart_completion:
return self.find_matches(word_before_cursor, self.all_completions,
start_only=True, fuzzy=False)
matches = self.find_matches(text, self.all_completions,
start_only=True, fuzzy=False)
return sorted_completions(matches)

completions = []
matches = set()
suggestions = suggest_type(document.text, document.text_before_cursor)

for suggestion in suggestions:
Expand All @@ -430,97 +443,98 @@ def get_completions(self, document, complete_event, smart_completion=None):
if count > 1 and col != '*'
]

cols = self.find_matches(word_before_cursor, scoped_cols)
completions.extend(cols)
cols = self.find_matches(text, scoped_cols)
matches.update(cols)

elif suggestion['type'] == 'function':
# suggest user-defined functions using substring matching
funcs = self.populate_schema_objects(suggestion['schema'],
'functions')
user_funcs = self.find_matches(word_before_cursor, funcs)
completions.extend(user_funcs)
user_funcs = self.find_matches(text, funcs)
matches.update(user_funcs)

# suggest hardcoded functions using startswith matching only if
# there is no schema qualifier. If a schema qualifier is
# present it probably denotes a table.
# eg: SELECT * FROM users u WHERE u.
if not suggestion['schema']:
predefined_funcs = self.find_matches(word_before_cursor,
predefined_funcs = self.find_matches(text,
self.functions,
start_only=True,
fuzzy=False,
casing=self.keyword_casing)
completions.extend(predefined_funcs)
matches.update(predefined_funcs)

elif suggestion['type'] == 'table':
tables = self.populate_schema_objects(suggestion['schema'],
'tables')
tables = self.find_matches(word_before_cursor, tables)
completions.extend(tables)
tables = self.find_matches(text, tables)
matches.update(tables)

elif suggestion['type'] == 'view':
views = self.populate_schema_objects(suggestion['schema'],
'views')
views = self.find_matches(word_before_cursor, views)
completions.extend(views)
views = self.find_matches(text, views)
matches.update(views)

elif suggestion['type'] == 'alias':
aliases = suggestion['aliases']
aliases = self.find_matches(word_before_cursor, aliases)
completions.extend(aliases)
aliases = self.find_matches(text, aliases)
matches.update(aliases)

elif suggestion['type'] == 'database':
dbs = self.find_matches(word_before_cursor, self.databases)
completions.extend(dbs)
dbs = self.find_matches(text, self.databases)
matches.update(dbs)

elif suggestion['type'] == 'keyword':
keywords = self.find_matches(word_before_cursor, self.keywords,
keywords = self.find_matches(text, self.keywords,
start_only=True,
fuzzy=False,
casing=self.keyword_casing)
completions.extend(keywords)
matches.update(keywords)

elif suggestion['type'] == 'show':
show_items = self.find_matches(word_before_cursor,
show_items = self.find_matches(text,
self.show_items,
start_only=False,
fuzzy=True,
casing=self.keyword_casing)
completions.extend(show_items)
matches.update(show_items)

elif suggestion['type'] == 'change':
change_items = self.find_matches(word_before_cursor,
change_items = self.find_matches(text,
self.change_items,
start_only=False,
fuzzy=True)
completions.extend(change_items)
matches.update(change_items)
elif suggestion['type'] == 'user':
users = self.find_matches(word_before_cursor, self.users,
users = self.find_matches(text, self.users,
start_only=False,
fuzzy=True)
completions.extend(users)
matches.update(users)

elif suggestion['type'] == 'special':
special = self.find_matches(word_before_cursor,
special = self.find_matches(text,
self.special_commands,
start_only=True,
fuzzy=False)
completions.extend(special)
fuzzy=False,
casing=None)

matches.update(special)
elif suggestion['type'] == 'favoritequery':
queries = self.find_matches(word_before_cursor,
queries = self.find_matches(text,
FavoriteQueries.instance.list(),
start_only=False, fuzzy=True)
completions.extend(queries)
matches.update(queries)
elif suggestion['type'] == 'table_format':
formats = self.find_matches(word_before_cursor,
formats = self.find_matches(text,
self.table_formats,
start_only=True, fuzzy=False)
completions.extend(formats)
matches.update(formats)
elif suggestion['type'] == 'file_name':
file_names = self.find_files(word_before_cursor)
completions.extend(file_names)
return self.find_files(text)

return completions
return sorted_completions(matches)

def find_files(self, word):
"""Yield matching directory or file names.
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ pyperclip>=1.8.1
importlib_resources>=5.0.0
pyaes>=1.6.1
sqlglot>=5.1.3
setuptools
setuptools<=71.1.0
10 changes: 8 additions & 2 deletions test/test_naive_completion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,18 @@ def complete_event():
return Mock()


def lower_sorted(completions):
return sorted(completions, key=lambda c: (c.lower()))


def test_empty_string_completion(completer, complete_event):
text = ''
position = 0
result = list(completer.get_completions(
Document(text=text, cursor_position=position),
complete_event))
assert result == list(map(Completion, completer.all_completions))
sorted_completions = lower_sorted(completer.all_completions)
assert result == list(map(Completion, sorted_completions))


def test_select_keyword_completion(completer, complete_event):
Expand All @@ -48,7 +53,8 @@ def test_column_name_completion(completer, complete_event):
result = list(completer.get_completions(
Document(text=text, cursor_position=position),
complete_event))
assert result == list(map(Completion, completer.all_completions))
sorted_completions = lower_sorted(completer.all_completions)
assert result == list(map(Completion, sorted_completions))


def test_special_name_completion(completer, complete_event):
Expand Down
Loading
Loading