Skip to content

gh-133390: Extend completion for .commands in sqlite3 #135432

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

StanFromIreland
Copy link
Contributor

@StanFromIreland StanFromIreland commented Jun 12, 2025

Copy link
Contributor

@tanloong tanloong left a comment

Choose a reason for hiding this comment

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

Only commands with a dot at the line beginning is considered dot commands. text is the non-whitespace chars under wherever the cursor is at. This means using text.startswith() enables dot command completion for not only actual dot commands but also any inline word that starts with dot:

sqlite> SELECT .<tab>
.help 
.quit 
.version 
sqlite> SELECT .

Using readline.get_line_buffer() instead is more reasonable. This returns the whole current line and can be used to avoid completion for dot-started inline word:

origline = readline.get_line_buffer()
if origline.startswith("."):
    ...

@StanFromIreland
Copy link
Contributor Author

sqlite3 identifiers cannot start with . (OperationalError (SQLITE_ERROR): near ".": syntax error). Calling readline would complicate our imports a bit more, I'm not sure it is worth it. Not much changes, it is invalid just like it was before.

@tanloong
Copy link
Contributor

tanloong commented Jun 12, 2025

I actually also made a local change to add dot commands completion. This is the idea on my local branch, just sharing it for discussion:

  1. Complete without dot if there is any number of whitespaces between the dot and the cursor.
sqlite> . |
help
version
quit
  1. Complete with the dot if cursor is immediately at the right handside of the dot.
sqlite> .|
.help
.version
.quit
  1. Complete nothing if there is any non-whitespace chars between the dot and the cursor (as we currently don't have dot commands that receive arguments).
sqlite> . help |
# no candidates
COMMANDS = ("quit", "help", "version")


def _complete(text, state):
    global _completion_matches

    if state == 0:
        import readline

        origline = readline.get_line_buffer()
        if origline.startswith("."):
            if origline == text:
                text_lstrip = text.lstrip(".")
                _completion_matches = [f".{cmd}" for cmd in COMMANDS
                                       if cmd.startswith(text_lstrip)]
            elif origline.removeprefix(".").lstrip(" ") == text:
                _completion_matches = [cmd for cmd in COMMANDS
                                       if cmd.startswith(text)]
            else:
                _completion_matches.clear()
        else:
            text_upper = text.upper()
            _completion_matches = [c for c in SQLITE_KEYWORDS if c.startswith(text_upper)]
    try:
        return _completion_matches[state] + " "
    except IndexError:
        return None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants