Merge pull request #221 from dbcli/amjith/sqlean-optional

amjith · web-flow · commit 76fb4c5211e7 · 2025-04-21T13:52:43.000-07:00
Amjith/sqlean optional
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,11 +2,11 @@
 
 ### Features
 
-*
+* Replace sqlite3 library with [sqlean](https://antonz.org/sqlean/). It's a drop-in replacement for sqlite3.
 
 ### Bug Fixes
 
-*
+* Fix missing sqlite extensions using sqlean. Note. support only limited set of extensions. [(#119)](https://github.com/dbcli/litecli/issues/119)
 
 
 ## 1.15.0 - 2025-03-15
diff --git a/README.md b/README.md
@@ -16,19 +16,7 @@ If you already know how to install python packages, then you can install it via
 You might need sudo on linux.
 
 ```
-$ pip install -U litecli
-```
-
-The package is also available on Arch Linux through AUR in two versions: [litecli](https://aur.archlinux.org/packages/litecli/) is based the latest release (git tag) and [litecli-git](https://aur.archlinux.org/packages/litecli-git/) is based on the master branch of the git repo. You can install them manually or with an AUR helper such as `yay`:
-
-```
-$ yay -S litecli
-```
-
-or
-
-```
-$ yay -S litecli-git
+$ pip install -U litecli[sqlean]
 ```
 
 For MacOS users, you can also use Homebrew to install it:
diff --git a/litecli/main.py b/litecli/main.py
@@ -11,7 +11,11 @@
 from collections import namedtuple
 from datetime import datetime
 from io import open
-from sqlite3 import OperationalError, sqlite_version
+
+try:
+    from sqlean import OperationalError, sqlite_version
+except ImportError:
+    from sqlite3 import OperationalError, sqlite_version
 from time import time
 
 import click
@@ -260,7 +264,7 @@ def initialize_logging(self):
             )
             return
 
-        formatter = logging.Formatter("%(asctime)s (%(process)d/%(threadName)s) " "%(name)s %(levelname)s - %(message)s")
+        formatter = logging.Formatter("%(asctime)s (%(process)d/%(threadName)s) %(name)s %(levelname)s - %(message)s")
 
         handler.setFormatter(formatter)
 
@@ -361,7 +365,7 @@ def run_cli(self):
         else:
             history = None
             self.echo(
-                'Error: Unable to open the history file "{}". ' "Your query history will not be saved.".format(history_file),
+                'Error: Unable to open the history file "{}". Your query history will not be saved.'.format(history_file),
                 err=True,
                 fg="red",
             )
@@ -452,7 +456,7 @@ def one_iteration(text=None):
                         if context:
                             click.echo("LLM Reponse:")
                             click.echo(context)
-                            click.echo('---')
+                            click.echo("---")
                         click.echo(f"Time: {duration:.2f} seconds")
                         text = self.prompt_app.prompt(default=sql)
                     except KeyboardInterrupt:
@@ -927,7 +931,7 @@ def cli(
 
     litecli.connect(database)
 
-    litecli.logger.debug("Launch Params: \n" "\tdatabase: %r", database)
+    litecli.logger.debug("Launch Params: \n\tdatabase: %r", database)
 
     #  --execute argument
     if execute:
diff --git a/litecli/packages/prompt_utils.py b/litecli/packages/prompt_utils.py
@@ -16,7 +16,7 @@ def confirm_destructive_query(queries):
     * False if the query is destructive and the user doesn't want to proceed.
 
     """
-    prompt_text = "You're about to run a destructive command.\n" "Do you want to proceed? (y/n)"
+    prompt_text = "You're about to run a destructive command.\nDo you want to proceed? (y/n)"
     if is_destructive(queries) and sys.stdin.isatty():
         return prompt(prompt_text, type=bool)
 
diff --git a/litecli/packages/special/dbcommands.py b/litecli/packages/special/dbcommands.py
@@ -27,14 +27,14 @@ def list_tables(cur, arg=None, arg_type=PARSED_QUERY, verbose=False):
         args = ("{0}%".format(arg),)
         query = """
             SELECT name FROM sqlite_master
-            WHERE type IN ('table','view') AND name LIKE ? AND name NOT LIKE 'sqlite_%'
+            WHERE type IN ('table','view') AND name LIKE ? AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'sqlean_%'
             ORDER BY 1
         """
     else:
         args = tuple()
         query = """
             SELECT name FROM sqlite_master
-            WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%'
+            WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'sqlean_%'
             ORDER BY 1
         """
 
@@ -69,14 +69,14 @@ def list_views(cur, arg=None, arg_type=PARSED_QUERY, verbose=False):
         args = ("{0}%".format(arg),)
         query = """
             SELECT name FROM sqlite_master
-            WHERE type = 'view' AND name LIKE ? AND name NOT LIKE 'sqlite_%'
+            WHERE type = 'view' AND name LIKE ? AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'sqlean_%'
             ORDER BY 1
         """
     else:
         args = tuple()
         query = """
             SELECT name FROM sqlite_master
-            WHERE type = 'view' AND name NOT LIKE 'sqlite_%'
+            WHERE type = 'view' AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'sqlean_%'
             ORDER BY 1
         """
     log.debug(query)
@@ -124,6 +124,7 @@ def show_schema(cur, arg=None, **_):
 
     return [(None, tables, headers, status)]
 
+
 @special_command(
     ".databases",
     ".databases",
@@ -142,6 +143,7 @@ def list_databases(cur, **_):
     else:
         return [(None, None, None, "")]
 
+
 @special_command(
     ".indexes",
     ".indexes [tablename]",
diff --git a/litecli/packages/special/llm.py b/litecli/packages/special/llm.py
@@ -194,6 +194,7 @@ def ensure_litecli_template(replace=False):
     run_external_cmd("llm", PROMPT, "--save", "litecli")
     return
 
+
 @export
 def handle_llm(text, cur) -> Tuple[str, Optional[str], float]:
     """This function handles the special command `\\llm`.
@@ -307,7 +308,7 @@ def sql_using_llm(cur, question=None, verbose=False) -> Tuple[str, Optional[str]
     """
     tables_query = """
             SELECT name FROM sqlite_master
-            WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%'
+            WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'sqlean_%'
             ORDER BY 1
     """
     click.echo("Preparing schema information to feed the llm")
diff --git a/litecli/sqlexecute.py b/litecli/sqlexecute.py
@@ -1,7 +1,15 @@
 import logging
-import sqlite3
+
 from contextlib import closing
-from sqlite3 import OperationalError
+
+try:
+    import sqlean as sqlite3
+    from sqlean import OperationalError
+
+    sqlite3.extensions.enable_all()
+except ImportError:
+    import sqlite3
+    from sqlite3 import OperationalError
 from litecli.packages.special.utils import check_if_sqlitedotcommand
 
 import sqlparse
@@ -25,15 +33,15 @@ class SQLExecute(object):
     tables_query = """
         SELECT name
         FROM sqlite_master
-        WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%'
+        WHERE type IN ('table','view') AND name NOT LIKE 'sqlite_%' AND name NOT LIKE 'sqlean_%'
         ORDER BY 1
     """
 
     table_columns_query = """
         SELECT m.name as tableName, p.name as columnName
         FROM sqlite_master m
         JOIN pragma_table_info((m.name)) p
-        WHERE m.type IN ('table','view') AND m.name NOT LIKE 'sqlite_%'
+        WHERE m.type IN ('table','view') AND m.name NOT LIKE 'sqlite_%' AND m.name NOT LIKE 'sqlean_%'
         ORDER BY tableName, columnName
     """
 
@@ -58,7 +66,7 @@ def __init__(self, database):
 
     def connect(self, database=None):
         db = database or self.dbname
-        _logger.debug("Connection DB Params: \n" "\tdatabase: %r", db)
+        _logger.debug("Connection DB Params: \n\tdatabase: %r", db)
 
         db_name = os.path.expanduser(db)
         db_dir_name = os.path.dirname(os.path.abspath(db_name))
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,6 +33,7 @@ litecli = "litecli.main:cli"
 
 [project.optional-dependencies]
 ai = ["llm"]
+sqlean = ["sqlean-py>=3.47.0"]
 
 dev = [
     "behave>=1.2.6",
diff --git a/release.py b/release.py
@@ -100,7 +100,7 @@ def checklist(questions):
         action="store_true",
         dest="confirm_steps",
         default=False,
-        help=("Confirm every step. If the step is not " "confirmed, it will be skipped."),
+        help=("Confirm every step. If the step is not confirmed, it will be skipped."),
     )
     parser.add_option(
         "-d",
diff --git a/tests/test_dbspecial.py b/tests/test_dbspecial.py
@@ -1,8 +1,8 @@
-from litecli.packages.completion_engine import suggest_type
 from test_completion_engine import sorted_dicts
-from litecli.packages.special.utils import format_uptime
-from litecli.packages.special.utils import check_if_sqlitedotcommand
-from utils import run, dbtest, assert_result_equal
+from utils import assert_result_equal, dbtest, run
+
+from litecli.packages.completion_engine import suggest_type
+from litecli.packages.special.utils import check_if_sqlitedotcommand, format_uptime
 
 
 def test_import_first_argument():
diff --git a/tests/test_llm_special.py b/tests/test_llm_special.py
@@ -54,7 +54,7 @@ def test_llm_command_with_c_flag(mock_run_cmd, mock_llm, executor):
 @patch("litecli.packages.special.llm.run_external_cmd")
 def test_llm_command_with_c_flag_and_fenced_sql(mock_run_cmd, mock_llm, executor):
     # The luscious SQL is inside triple backticks
-    return_text = "Here is your query:\n" "```sql\nSELECT * FROM table;\n```"
+    return_text = "Here is your query:\n```sql\nSELECT * FROM table;\n```"
     mock_run_cmd.return_value = (0, return_text)
 
     test_text = r"\llm -c 'Rewrite the SQL without CTE'"
@@ -88,6 +88,7 @@ def test_llm_command_known_subcommand(mock_run_cmd, mock_llm, executor):
     # And the function should raise FinishIteration(None)
     assert exc_info.value.args[0] is None
 
+
 @patch("litecli.packages.special.llm.llm")
 @patch("litecli.packages.special.llm.run_external_cmd")
 def test_llm_command_with_help_flag(mock_run_cmd, mock_llm, executor):
@@ -106,6 +107,7 @@ def test_llm_command_with_help_flag(mock_run_cmd, mock_llm, executor):
     # And the function should raise FinishIteration(None)
     assert exc_info.value.args[0] is None
 
+
 @patch("litecli.packages.special.llm.llm")
 @patch("litecli.packages.special.llm.run_external_cmd")
 def test_llm_command_with_install_flag(mock_run_cmd, mock_llm, executor):
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -74,7 +74,7 @@ def test_batch_mode(executor):
     run(executor, """create table test(a text)""")
     run(executor, """insert into test values('abc'), ('def'), ('ghi')""")
 
-    sql = "select count(*) from test;\n" "select * from test limit 1;"
+    sql = "select count(*) from test;\nselect * from test limit 1;"
 
     runner = CliRunner()
     result = runner.invoke(cli, args=CLI_ARGS, input=sql)
@@ -88,7 +88,7 @@ def test_batch_mode_table(executor):
     run(executor, """create table test(a text)""")
     run(executor, """insert into test values('abc'), ('def'), ('ghi')""")
 
-    sql = "select count(*) from test;\n" "select * from test limit 1;"
+    sql = "select count(*) from test;\nselect * from test limit 1;"
 
     runner = CliRunner()
     result = runner.invoke(cli, args=CLI_ARGS + ["-t"], input=sql)
diff --git a/tests/test_parseutils.py b/tests/test_parseutils.py
@@ -120,12 +120,12 @@ def test_query_starts_with_comment():
 
 
 def test_queries_start_with():
-    sql = "# comment\n" "show databases;" "use foo;"
+    sql = "# comment\nshow databases;use foo;"
     assert queries_start_with(sql, ("show", "select")) is True
     assert queries_start_with(sql, ("use", "drop")) is True
     assert queries_start_with(sql, ("delete", "update")) is False
 
 
 def test_is_destructive():
-    sql = "use test;\n" "show databases;\n" "drop database foo;"
+    sql = "use test;\nshow databases;\ndrop database foo;"
     assert is_destructive(sql) is True
diff --git a/tests/test_smart_completion_public_schema_only.py b/tests/test_smart_completion_public_schema_only.py
@@ -41,17 +41,18 @@ def complete_event():
 
 
 def test_escape_name(completer):
-
-    for name, expected_name in [# Upper case name shouldn't be escaped
+    for name, expected_name in [  # Upper case name shouldn't be escaped
         ("BAR", "BAR"),
         # This name is escaped and should start with back tick
         ("2025todos", "`2025todos`"),
         # normal case
         ("people", "people"),
         # table name with _underscore should not be escaped
-        ("django_users", "django_users")]:
+        ("django_users", "django_users"),
+    ]:
         assert completer.escape_name(name) == expected_name
 
+
 def test_empty_string_completion(completer, complete_event):
     text = ""
     position = 0
diff --git a/tests/test_sqlexecute.py b/tests/test_sqlexecute.py
@@ -5,7 +5,11 @@
 import pytest
 
 from utils import run, dbtest, set_expanded_output, is_expanded_output, assert_result_equal
-from sqlite3 import OperationalError, ProgrammingError
+
+try:
+    from sqlean import OperationalError, ProgrammingError
+except ImportError:
+    from sqlite3 import OperationalError, ProgrammingError
 
 
 @dbtest
@@ -37,7 +41,6 @@ def test_binary(executor):
     assert_result_equal(results, headers=["blb"], rows=[(expected,)])
 
 
-## Failing in Travis for some unknown reason.
 @dbtest
 def test_table_and_columns_query(executor):
     run(executor, "create table a(x text, y text)")
@@ -252,7 +255,7 @@ def test_favorite_query_multiple_statement(executor):
 
     results = run(
         executor,
-        "\\fs test-ad select * from test where a like 'a%'; " "select * from test where a like 'd%'",
+        "\\fs test-ad select * from test where a like 'a%'; select * from test where a like 'd%'",
     )
     assert_result_equal(results, status="Saved.")
 
diff --git a/tests/utils.py b/tests/utils.py
@@ -6,10 +6,13 @@
 import platform
 import multiprocessing
 from contextlib import closing
-
-import sqlite3
 import pytest
 
+try:
+    import sqlean as sqlite3
+except ImportError:
+    import sqlite3
+
 from litecli.main import special
 
 DATABASE = "test.sqlite3"
diff --git a/tox.ini b/tox.ini
@@ -1,12 +1,18 @@
 [tox]
-envlist = py,style
+envlist = py,style,sqlean
 
 [testenv]
 deps = uv
 commands = uv pip install -e .[dev]
         coverage run -m pytest -v tests
         coverage report -m
 
+[testenv:sqlean]
+deps = uv
+commands = uv pip install -e .[dev,sqlean]
+        coverage run -m pytest -v tests
+        coverage report -m
+
 [testenv:style]
 skip_install = true
 deps = ruff

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ def checklist(questions):`
`100`	`100`	`action="store_true",`
`101`	`101`	`dest="confirm_steps",`
`102`	`102`	`default=False,`
`103`		`- help=("Confirm every step. If the step is not " "confirmed, it will be skipped."),`
	`103`	`+ help=("Confirm every step. If the step is not confirmed, it will be skipped."),`
`104`	`104`	`)`
`105`	`105`	`parser.add_option(`
`106`	`106`	`"-d",`