-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-133390: Support SQL keyword completion for sqlite3 CLI #133393
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
Conversation
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs a whatsnew entry, (maybe a note in the docs?), a NEWS entry and tests.
This is quite limited completion so I guess it could work.
I think we need a separate nodule for this because if we want to have a smarter completion later the code is better to be isolated, so something like sqlite3._completer. If possible, can we have an autogenerated list of keywords? and those keywords could also be stored in a (private) module-level list. |
Misc/NEWS.d/next/Library/2025-05-05-03-14-08.gh-issue-133390.AuTggn.rst
Outdated
Show resolved
Hide resolved
Please add tests |
Yes, tests is coming. I will try to find a way to autogenerate list of keywords. |
You can mark the pr as a draft. |
782a599
to
5005d85
Compare
Added tests and moved keyword list to module level. Keywords seems not easy to auto-generate, the SQLite document says they can be accessed by |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With #133447 in mind the keywords list would be quite handy (I think hardcoding is fine, it doesn't change often anyway). Maybe it could be moved elsewhere, what do you think Benedikt?
15019ea
to
22652ae
Compare
Hi @picnixz, as Stan mentioned, beta freeze is around the corner, but I really hope this can be shipped in 3.14, do you think there is a chance to merge it before beta freeze? |
sources added which might be available for even old SQLite.
for (int i = 0; i < count; i++) { | ||
const char *keyword; | ||
int size; | ||
int result = sqlite3_keyword_name(i, &keyword, &size); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the record:
We could just assert
that the result is SQLITE_OK
. This is just an out-of-bounds check, and we know that we are within bounds here. OTOH, we don't know how the SQLite internals may change, so let's keep it like it is.
FTR, I've tested this with new SQLite variants, as well as SQLite 3.23.0 and 3.24.0. Everything works as expected for all versions. I should really get to setting up a build-bot with a SQLite library matrix. |
I only get the "Display all 147 possibilities? (y or n)" prompt with editline, and never on readline. Probably a bug in readline? Or are we missing a configuration option in order to get this to work? |
Readline has a completion-query-items (default value 100) option to determine whether or when this prompt should be shown. https://www.gnu.org/software/bash/manual/html_node/Readline-Init-File-Syntax.html#index-completion_002dquery_002ditems With a default readline config the prompt should have be shown, I suspect there is a config that sets the option to 0 on the testing machine? |
Nope. I was a little bit vague in my previous comment: I see the text "Display all 147 possibilities? (y or n)", but it is not shown as a prompt after the first tab. It is only displayed together with the resulting completion list, after the second tab. IOW: For editline, I get the prompt on the first tab; for readline, I get no prompt, but I see the prompt text after the second tab. FTR, I already experimented with the |
Try |
Thank you very much for the careful review and thorough test! There are so many corners and difficulties that I would have never considered let alone solved, thanks for everyone's help! |
This adds tab-completion for the 147 SQLite Keywords. A whitespace is appended to completion candidates for users' convenience and to mimic the behavior of sqlite3 tool.