Merge pull request #1812 from dbcli/RW/rename-parseutils-sql-utils

rolandwalker · web-flow · commit 7eef51d34018 · 2026-04-04T08:57:13.000-04:00
Move SQL utilities to `sql_utils.py`
diff --git a/AGENTS.md b/AGENTS.md
@@ -27,11 +27,12 @@ A command line client for MySQL with auto-completion and syntax highlighting.
 ├── mycli/packages/                       # application packages
 ├── mycli/packages/batch_utils.py         # utilities for `--batch` mode
 ├── mycli/packages/checkup.py             # implementation of `--checkup` mode
+├── mycli/packages/cli_utils.py           # utilities for parsing CLI arguments
 ├── mycli/packages/completion_engine.py   # implementation of completion suggestions
 ├── mycli/packages/filepaths.py           # utilities for files, including completion suggestions
 ├── mycli/packages/hybrid_redirection.py  # implementation of shell-style redirects
 ├── mycli/packages/paramiko_stub/         # stub in case the Paramiko library is not installed
-├── mycli/packages/parseutils.py          # utilities for parsing SQL statements
+├── mycli/packages/sql_utils.py           # utilities for parsing SQL statements
 ├── mycli/packages/prompt_utils.py        # utilities for confirming on destructive statements
 ├── mycli/packages/ptoolkit/              # extends prompt_toolkit
 ├── mycli/packages/shortcuts.py           # utilities for keyboard shortcuts
diff --git a/changelog.md b/changelog.md
@@ -41,6 +41,8 @@ Internal
 * Move `--list-ssh-config` logic to the new `main_modes` with `--batch`.
 * Sort coverage report in tox suite.
 * Skip more tests when a database connection is not present.
+* Move SQL utilities to a new `sql_utils.py`.
+* Move CLI utilities to a new `cli_utils.py`.
 
 
 1.67.1 (2026/03/28)
diff --git a/mycli/main.py b/mycli/main.py
@@ -90,14 +90,21 @@
 from mycli.main_modes.list_dsn import main_list_dsn
 from mycli.main_modes.list_ssh_config import main_list_ssh_config
 from mycli.packages import special
+from mycli.packages.cli_utils import is_valid_connection_scheme
 from mycli.packages.filepaths import dir_path_exists, guess_socket_location
 from mycli.packages.hybrid_redirection import get_redirect_components, is_redirect_command
-from mycli.packages.parseutils import is_dropping_database, is_valid_connection_scheme
 from mycli.packages.prompt_utils import confirm, confirm_destructive_query
 from mycli.packages.ptoolkit.history import FileHistoryWithTimestamp
 from mycli.packages.special.favoritequeries import FavoriteQueries
 from mycli.packages.special.main import ArgType
 from mycli.packages.special.utils import format_uptime, get_ssl_version, get_uptime, get_warning_count
+from mycli.packages.sql_utils import (
+    is_dropping_database,
+    is_mutating,
+    is_select,
+    need_completion_refresh,
+    need_completion_reset,
+)
 from mycli.packages.sqlresult import SQLResult
 from mycli.packages.ssh_utils import read_ssh_config
 from mycli.packages.string_utils import sanitize_terminal_title
@@ -2650,53 +2657,6 @@ def get_password_from_file(password_file: str | None) -> str | None:
     mycli.close()
 
 
-def need_completion_refresh(queries: str) -> bool:
-    """Determines if the completion needs a refresh by checking if the sql
-    statement is an alter, create, drop or change db."""
-    for query in sqlparse.split(queries):
-        try:
-            first_token = query.split()[0]
-            if first_token.lower() in ("alter", "create", "use", "\\r", "\\u", "connect", "drop", "rename"):
-                return True
-        except Exception:
-            continue
-    return False
-
-
-def need_completion_reset(queries: str) -> bool:
-    """Determines if the statement is a database switch such as 'use' or '\\u'.
-    When a database is changed the existing completions must be reset before we
-    start the completion refresh for the new database.
-    """
-    for query in sqlparse.split(queries):
-        try:
-            tokens = query.split()
-            first_token = tokens[0]
-            if first_token.lower() in ("use", "\\u"):
-                return True
-            if first_token.lower() in ("\\r", "connect") and len(tokens) > 1:
-                return True
-        except Exception:
-            continue
-    return False
-
-
-def is_mutating(status_plain: str | None) -> bool:
-    """Determines if the statement is mutating based on the status."""
-    if not status_plain:
-        return False
-
-    mutating = {"insert", "update", "delete", "alter", "create", "drop", "replace", "truncate", "load", "rename"}
-    return status_plain.split(None, 1)[0].lower() in mutating
-
-
-def is_select(status_plain: str | None) -> bool:
-    """Returns true if the first word in status is 'select'."""
-    if not status_plain:
-        return False
-    return status_plain.split(None, 1)[0].lower() == "select"
-
-
 def thanks_picker() -> str:
     import mycli
 
diff --git a/mycli/main_modes/batch.py b/mycli/main_modes/batch.py
@@ -12,8 +12,8 @@
 import pymysql
 
 from mycli.packages.batch_utils import statements_from_filehandle
-from mycli.packages.parseutils import is_destructive
 from mycli.packages.prompt_utils import confirm_destructive_query
+from mycli.packages.sql_utils import is_destructive
 
 if TYPE_CHECKING:
     from mycli.main import CliArgs, MyCli
diff --git a/mycli/packages/cli_utils.py b/mycli/packages/cli_utils.py
@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+
+def is_valid_connection_scheme(text: str) -> tuple[bool, str | None]:
+    # exit early if the text does not resemble a DSN URI
+    if "://" not in text:
+        return False, None
+    scheme = text.split("://")[0]
+    if scheme not in ("mysql", "mysqlx", "tcp", "socket", "ssh"):
+        return False, scheme
+    else:
+        return True, None
diff --git a/mycli/packages/completion_engine.py b/mycli/packages/completion_engine.py
@@ -6,9 +6,9 @@
 import sqlparse
 from sqlparse.sql import Comparison, Identifier, Token, Where
 
-from mycli.packages.parseutils import extract_tables, find_prev_keyword, last_word
 from mycli.packages.special.main import COMMANDS as SPECIAL_COMMANDS
 from mycli.packages.special.main import parse_special_command
+from mycli.packages.sql_utils import extract_tables, find_prev_keyword, last_word
 
 sqlparse.engine.grouping.MAX_GROUPING_DEPTH = None  # type: ignore[assignment]
 sqlparse.engine.grouping.MAX_GROUPING_TOKENS = None  # type: ignore[assignment]
diff --git a/mycli/packages/prompt_utils.py b/mycli/packages/prompt_utils.py
@@ -2,7 +2,7 @@
 
 import click
 
-from mycli.packages.parseutils import is_destructive
+from mycli.packages.sql_utils import is_destructive
 
 
 class ConfirmBoolParamType(click.ParamType):
diff --git a/mycli/packages/sql_utils.py b/mycli/packages/sql_utils.py
@@ -23,17 +23,6 @@
 }
 
 
-def is_valid_connection_scheme(text: str) -> tuple[bool, str | None]:
-    # exit early if the text does not resemble a DSN URI
-    if "://" not in text:
-        return False, None
-    scheme = text.split("://")[0]
-    if scheme not in ("mysql", "mysqlx", "tcp", "socket", "ssh"):
-        return False, scheme
-    else:
-        return True, None
-
-
 def last_word(
     text: str,
     include: Literal[
@@ -433,3 +422,50 @@ def normalize_db_name(db: str) -> str:
             if database_token is not None and normalize_db_name(database_token.get_name()) == dbname:
                 result = keywords[0].normalized == "DROP"
     return result
+
+
+def need_completion_refresh(queries: str) -> bool:
+    """Determines if the completion needs a refresh by checking if the sql
+    statement is an alter, create, drop or change db."""
+    for query in sqlparse.split(queries):
+        try:
+            first_token = query.split()[0]
+            if first_token.lower() in ("alter", "create", "use", "\\r", "\\u", "connect", "drop", "rename"):
+                return True
+        except Exception:
+            continue
+    return False
+
+
+def need_completion_reset(queries: str) -> bool:
+    """Determines if the statement is a database switch such as 'use' or '\\u'.
+    When a database is changed the existing completions must be reset before we
+    start the completion refresh for the new database.
+    """
+    for query in sqlparse.split(queries):
+        try:
+            tokens = query.split()
+            first_token = tokens[0]
+            if first_token.lower() in ("use", "\\u"):
+                return True
+            if first_token.lower() in ("\\r", "connect") and len(tokens) > 1:
+                return True
+        except Exception:
+            continue
+    return False
+
+
+def is_mutating(status_plain: str | None) -> bool:
+    """Determines if the statement is mutating based on the status."""
+    if not status_plain:
+        return False
+
+    mutating = {"insert", "update", "delete", "alter", "create", "drop", "replace", "truncate", "load", "rename"}
+    return status_plain.split(None, 1)[0].lower() in mutating
+
+
+def is_select(status_plain: str | None) -> bool:
+    """Returns true if the first word in status is 'select'."""
+    if not status_plain:
+        return False
+    return status_plain.split(None, 1)[0].lower() == "select"
diff --git a/mycli/packages/tabular_output/sql_format.py b/mycli/packages/tabular_output/sql_format.py
@@ -6,7 +6,7 @@
 
 from cli_helpers.tabular_output import TabularOutputFormatter
 
-from mycli.packages.parseutils import extract_tables_from_complete_statements
+from mycli.packages.sql_utils import extract_tables_from_complete_statements
 
 supported_formats = (
     "sql-insert",
diff --git a/mycli/sqlcompleter.py b/mycli/sqlcompleter.py
@@ -13,10 +13,10 @@
 
 from mycli.packages.completion_engine import is_inside_quotes, suggest_type
 from mycli.packages.filepaths import complete_path, parse_path, suggest_path
-from mycli.packages.parseutils import extract_columns_from_select, extract_tables, last_word
 from mycli.packages.special import llm
 from mycli.packages.special.favoritequeries import FavoriteQueries
 from mycli.packages.special.main import COMMANDS as SPECIAL_COMMANDS
+from mycli.packages.sql_utils import extract_columns_from_select, extract_tables, last_word
 
 _logger = logging.getLogger(__name__)
 _CASE_CHANGE_PAT = re.compile('(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])')
diff --git a/test/pytests/test_cli_utils.py b/test/pytests/test_cli_utils.py
@@ -0,0 +1,24 @@
+# type: ignore
+
+import pytest
+
+from mycli.packages.cli_utils import (
+    is_valid_connection_scheme,
+)
+
+
+@pytest.mark.parametrize(
+    ('text', 'is_valid', 'invalid_scheme'),
+    [
+        ('localhost', False, None),
+        ('mysql://user@localhost/db', True, None),
+        ('mysqlx://user@localhost/db', True, None),
+        ('tcp://localhost:3306', True, None),
+        ('socket:///tmp/mysql.sock', True, None),
+        ('ssh://user@example.com', True, None),
+        ('postgres://user@localhost/db', False, 'postgres'),
+        ('http://example.com', False, 'http'),
+    ],
+)
+def test_is_valid_connection_scheme(text, is_valid, invalid_scheme):
+    assert is_valid_connection_scheme(text) == (is_valid, invalid_scheme)
diff --git a/test/pytests/test_main.py b/test/pytests/test_main.py
@@ -21,7 +21,6 @@
     TEST_DATABASE,
 )
 from mycli.main import EMPTY_PASSWORD_FLAG_SENTINEL, MyCli, click_entrypoint, thanks_picker
-from mycli.packages.parseutils import is_valid_connection_scheme
 import mycli.packages.special
 from mycli.packages.special.main import COMMANDS as SPECIAL_COMMANDS
 from mycli.packages.sqlresult import SQLResult
@@ -143,18 +142,6 @@ def test_select_from_empty_table(executor):
     assert expected in result.output
 
 
-@dbtest
-def test_is_valid_connection_scheme_valid(executor, capsys):
-    is_valid, scheme = is_valid_connection_scheme(f"mysql://test@{DEFAULT_HOST}:{DEFAULT_PORT}/dev")
-    assert is_valid
-
-
-@dbtest
-def test_is_valid_connection_scheme_invalid(executor, capsys):
-    is_valid, scheme = is_valid_connection_scheme(f"nope://test@{DEFAULT_HOST}:{DEFAULT_PORT}/dev")
-    assert not is_valid
-
-
 def test_filtered_sys_argv_maps_single_dash_h_to_help(monkeypatch):
     import mycli.main
 
diff --git a/test/pytests/test_main_regression.py b/test/pytests/test_main_regression.py
@@ -1326,10 +1326,6 @@ def cursor(self) -> PromptCursor:
     prompt = main.MyCli.get_prompt(cli, r'\H|\y|\Y|\T|\w|\W', 1)
     assert prompt == '127.0.0.1|123|uptime:123|TLSv1.3|7|7'
 
-    monkeypatch.setattr(main.sqlparse, 'split', lambda text: [None])
-    assert main.need_completion_refresh('sql') is False
-    assert main.need_completion_reset('sql') is False
-
 
 def test_format_sqlresult_string_paths_and_close_and_title_early_returns(monkeypatch: pytest.MonkeyPatch) -> None:
     cli = make_bare_mycli()
@@ -1481,7 +1477,6 @@ def test_filtered_sys_argv_covers_help_and_passthrough(monkeypatch: pytest.Monke
     assert main.filtered_sys_argv() == ['--help']
     monkeypatch.setattr(main.sys, 'argv', ['mycli', '-h', 'db.example'])
     assert main.filtered_sys_argv() == ['-h', 'db.example']
-    assert main.need_completion_refresh('') is False
 
 
 def test_completion_helpers_title_helpers_thanks_tips(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
@@ -1523,21 +1518,6 @@ def test_completion_helpers_title_helpers_thanks_tips(monkeypatch: pytest.Monkey
     assert list(main.MyCli.get_completions(cli, 'select', 6)) == ['done']
     assert entered_lock['count'] >= 2
 
-    monkeypatch.setattr(main.sqlparse, 'split', lambda text: ['alter table t', 'broken'])
-    assert main.need_completion_refresh('sql') is True
-    monkeypatch.setattr(main.sqlparse, 'split', lambda text: [''])
-    assert main.need_completion_refresh('sql') is False
-    monkeypatch.setattr(main.sqlparse, 'split', lambda text: ['use db'])
-    assert main.need_completion_reset('use db') is True
-    monkeypatch.setattr(main.sqlparse, 'split', lambda text: ['connect db'])
-    assert main.need_completion_reset('connect db') is True
-    monkeypatch.setattr(main.sqlparse, 'split', lambda text: ['select 1'])
-    assert main.need_completion_reset('select 1') is False
-    assert main.is_mutating('INSERT 1') is True
-    assert main.is_mutating(None) is False
-    assert main.is_select('SELECT 1') is True
-    assert main.is_select(None) is False
-
     class FakeResource:
         def __init__(self, text: str | None) -> None:
             self.text = text
@@ -2614,6 +2594,7 @@ def run(self, text: str) -> Iterator[SQLResult]:
     monkeypatch.setattr(main, 'need_completion_refresh', lambda text: text == 'dropdb')
     monkeypatch.setattr(main, 'need_completion_reset', lambda text: True)
     monkeypatch.setattr(main, 'is_dropping_database', lambda text, dbname: text == 'dropdb')
+
     main.MyCli.run_cli(cli)
     assert reconnect_calls == ['', '']
     assert any('bad op' in line for line in echoes)
diff --git a/test/pytests/test_sql_utils.py b/test/pytests/test_sql_utils.py
