Synced from main

Author: scottnemes

changelog.md

@@ -1,9 +1,19 @@
-Upcoming (TBD)
+TBD
 ==============
 
 Features
 --------
-* Make password options also function as flags. Reworked password logic to prompt user as early as possible. (#341):
+* Make password options also function as flags. Reworked password logic to prompt user as early as possible (#341).
+* More complete and up-to-date set of MySQL reserved words for completions.
+* Place exact-leading completions first.
+* Allow history file location to be configured.
+
+
+Bug Fixes
+--------
+* Respect `--logfile` when using `--execute` or standard input at the shell CLI.
+* Gracefully catch Paramiko parsing errors on `--list-ssh-config`.
+* Downgrade to Paramiko 3.5.1 to avoid crashing on DSA SSH keys.
 
 
 1.44.2 (2026/01/13)

mycli/main.py

@@ -732,7 +732,7 @@ def run_cli(self) -> None:
         if self.smart_completion:
             self.refresh_completions()
 
-        history_file = os.path.expanduser(os.environ.get("MYCLI_HISTFILE", "~/.mycli-history"))
+        history_file = os.path.expanduser(os.environ.get("MYCLI_HISTFILE", self.config.get("history_file", "~/.mycli-history")))
         if dir_path_exists(history_file):
             history = FileHistoryWithTimestamp(history_file)
         else:
@@ -952,10 +952,7 @@ def one_iteration(text: str | None = None) -> None:
                 logger.debug("sql: %r", text)
 
                 special.write_tee(self.get_prompt(self.prompt_format) + text)
-                if self.logfile:
-                    self.logfile.write(f"\n# {datetime.now()}\n")
-                    self.logfile.write(text)
-                    self.logfile.write("\n")
+                self.log_query(text)
 
                 successful = False
                 start = time()
@@ -1136,6 +1133,12 @@ def reconnect(self, database: str = "") -> bool:
             self.echo(str(e), err=True, fg="red")
             return False
 
+    def log_query(self, query: str) -> None:
+        if isinstance(self.logfile, TextIOWrapper):
+            self.logfile.write(f"\n# {datetime.now()}\n")
+            self.logfile.write(query)
+            self.logfile.write("\n")
+
     def log_output(self, output: str) -> None:
         """Log the output in the audit log, if it's enabled."""
         if isinstance(self.logfile, TextIOWrapper):
@@ -1315,6 +1318,7 @@ def get_prompt(self, string: str) -> str:
     def run_query(self, query: str, new_line: bool = True) -> None:
         """Runs *query*."""
         assert self.sqlexecute is not None
+        self.log_query(query)
         results = self.sqlexecute.run(query)
         for result in results:
             title = result.title
@@ -1331,6 +1335,7 @@ def run_query(self, query: str, new_line: bool = True) -> None:
                 self.null_string,
             )
             for line in output:
+                self.log_output(line)
                 click.echo(line, nl=new_line)
 
             # get and display warnings if enabled
@@ -1623,12 +1628,17 @@ def cli(
         sys.exit(0)
     if list_ssh_config:
         ssh_config = read_ssh_config(ssh_config_path)
-        for host in ssh_config.get_hostnames():
+        try:
+            host_entries = ssh_config.get_hostnames()
+        except KeyError:
+            click.secho('Error reading ssh config', err=True, fg="red")
+            sys.exit(1)
+        for host_entry in host_entries:
             if verbose:
-                host_config = ssh_config.lookup(host)
-                click.secho(f"{host} : {host_config.get('hostname')}")
+                host_config = ssh_config.lookup(host_entry)
+                click.secho(f"{host_entry} : {host_config.get('hostname')}")
             else:
-                click.secho(host)
+                click.secho(host_entry)
         sys.exit(0)
     # Choose which ever one has a valid value.
     database = dbname or database

mycli/myclirc

@@ -27,6 +27,9 @@ multi_line = False
 # or "shutdown".
 destructive_warning = True
 
+# interactive query history location.
+history_file = ~/.mycli-history
+
 # log_file location.
 log_file = ~/.mycli.log
 

mycli/sqlcompleter.py

@@ -7,6 +7,7 @@
 
 from prompt_toolkit.completion import CompleteEvent, Completer, Completion
 from prompt_toolkit.completion.base import Document
+from pygments.lexers._mysql_builtins import MYSQL_DATATYPES, MYSQL_FUNCTIONS, MYSQL_KEYWORDS
 
 from mycli.packages.completion_engine import suggest_type
 from mycli.packages.filepaths import complete_path, parse_path, suggest_path
@@ -18,141 +19,27 @@
 
 
 class SQLCompleter(Completer):
+    favorite_keywords = [
+        'SELECT',
+        'FROM',
+        'WHERE',
+        'UPDATE',
+        'DELETE FROM',
+        'GROUP BY',
+        'ORDER BY',
+        'JOIN',
+        'INSERT INTO',
+        'LIKE',
+        'LIMIT',
+    ]
     keywords = [
-        "SELECT",
-        "FROM",
-        "WHERE",
-        "UPDATE",
-        "DELETE FROM",
-        "GROUP BY",
-        "JOIN",
-        "INSERT INTO",
-        "LIKE",
-        "LIMIT",
-        "ACCESS",
-        "ADD",
-        "ALL",
-        "ALTER TABLE",
-        "AND",
-        "ANY",
-        "AS",
-        "ASC",
-        "AUTO_INCREMENT",
-        "BEFORE",
-        "BEGIN",
-        "BETWEEN",
-        "BIGINT",
-        "BINARY",
-        "BY",
-        "CASE",
-        "CHANGE MASTER TO",
-        "CHAR",
-        "CHARACTER SET",
-        "CHECK",
-        "COLLATE",
-        "COLUMN",
-        "COMMENT",
-        "COMMIT",
-        "CONSTRAINT",
-        "CREATE",
-        "CURRENT",
-        "CURRENT_TIMESTAMP",
-        "DATABASE",
-        "DATE",
-        "DECIMAL",
-        "DEFAULT",
-        "DESC",
-        "DESCRIBE",
-        "DROP",
-        "ELSE",
-        "END",
-        "ENGINE",
-        "ESCAPE",
-        "EXISTS",
-        "FILE",
-        "FLOAT",
-        "FOR",
-        "FOREIGN KEY",
-        "FORMAT",
-        "FULL",
-        "FUNCTION",
-        "GRANT",
-        "HAVING",
-        "HOST",
-        "IDENTIFIED",
-        "IN",
-        "INCREMENT",
-        "INDEX",
-        "INT",
-        "INTEGER",
-        "INTERVAL",
-        "INTO",
-        "IS",
-        "KEY",
-        "LEFT",
-        "LEVEL",
-        "LOCK",
-        "LOGS",
-        "LONG",
-        "MASTER",
-        "MEDIUMINT",
-        "MODE",
-        "MODIFY",
-        "NOT",
-        "NULL",
-        "NUMBER",
-        "OFFSET",
-        "ON",
-        "OPTION",
-        "OR",
-        "ORDER BY",
-        "OUTER",
-        "OWNER",
-        "PASSWORD",
-        "PORT",
-        "PRIMARY",
-        "PRIVILEGES",
-        "PROCESSLIST",
-        "PURGE",
-        "REFERENCES",
-        "REGEXP",
-        "RENAME",
-        "REPAIR",
-        "RESET",
-        "REVOKE",
-        "RIGHT",
-        "ROLLBACK",
-        "ROW",
-        "ROWS",
-        "ROW_FORMAT",
-        "SAVEPOINT",
-        "SESSION",
-        "SET",
-        "SHARE",
-        "SHOW",
-        "SLAVE",
-        "SMALLINT",
-        "START",
-        "STOP",
-        "TABLE",
-        "THEN",
-        "TINYINT",
-        "TO",
-        "TRANSACTION",
-        "TRIGGER",
-        "TRUNCATE",
-        "UNION",
-        "UNIQUE",
-        "UNSIGNED",
-        "USE",
-        "USER",
-        "USING",
-        "VALUES",
-        "VARCHAR",
-        "VIEW",
-        "WHEN",
-        "WITH",
+        x.upper()
+        for x in favorite_keywords
+        + list(MYSQL_DATATYPES)
+        + list(MYSQL_KEYWORDS)
+        + ['ALTER TABLE', 'CHANGE MASTER TO', 'CHARACTER SET', 'FOREIGN KEY']
     ]
+    keywords = list(dict.fromkeys(keywords))
 
     tidb_keywords = [
         "SELECT",
@@ -838,27 +725,7 @@ class SQLCompleter(Completer):
         "ZEROFILL",
     ]
 
-    functions = [
-        "AVG",
-        "CONCAT",
-        "COUNT",
-        "DISTINCT",
-        "FIRST",
-        "FORMAT",
-        "FROM_UNIXTIME",
-        "LAST",
-        "LCASE",
-        "LEN",
-        "MAX",
-        "MID",
-        "MIN",
-        "NOW",
-        "ROUND",
-        "SUM",
-        "TOP",
-        "UCASE",
-        "UNIX_TIMESTAMP",
-    ]
+    functions = [x.upper() for x in MYSQL_FUNCTIONS]
 
     # https://docs.pingcap.com/tidb/dev/tidb-functions
     tidb_functions = [
@@ -1110,6 +977,13 @@ def apply_case(kw: str) -> str:
                 return kw.upper()
             return kw.lower()
 
+        def exact_leading_key(item: tuple[int, int, str], text):
+            if text and item[2].lower().startswith(text):
+                return -1000 + len(item[2])
+            return 0
+
+        completions = sorted(completions, key=lambda item: exact_leading_key(item, text))
+
         return (Completion(z if casing is None else apply_case(z), -len(text)) for x, y, z in completions)
 
     def get_completions(

pyproject.toml

@@ -11,7 +11,7 @@ urls = { homepage = "http://mycli.net" }
 dependencies = [
     "click >= 8.3.1",
     "cryptography >= 1.0.0",
-    "Pygments>=1.6",
+    "Pygments ~= 2.19.2",
     "prompt_toolkit>=3.0.6,<4.0.0",
     "PyMySQL >= 0.9.2",
     "sqlparse>=0.3.0,<0.6.0",
@@ -31,7 +31,10 @@ build-backend = "setuptools.build_meta"
 
 
 [project.optional-dependencies]
-ssh = ["paramiko", "sshtunnel"]
+ssh = [
+    "paramiko~=3.5.1",
+    "sshtunnel",
+]
 llm = [
     "llm>=0.19.0",
     "setuptools",                   # Required by llm commands to install models
@@ -50,7 +53,7 @@ dev = [
     "pytest-cov>=4.1.0",
     "tox>=4.8.0",
     "pdbpp>=0.10.3",
-    "paramiko",
+    "paramiko~=3.5.1",
     "sshtunnel",
     "llm>=0.19.0",
     "setuptools",                   # Required by llm commands to install models

test/myclirc

@@ -27,6 +27,9 @@ multi_line = False
 # or "shutdown".
 destructive_warning = True
 
+# interactive query history location.
+history_file = ~/.mycli-history
+
 # log_file location.
 log_file = ~/.mycli.test.log
 

test/test_main.py

@@ -878,3 +878,22 @@ def test_global_init_commands(executor):
     expected = "sql_select_limit\t9999\n"
     assert result.exit_code == 0
     assert expected in result.output
+
+
+@dbtest
+def test_execute_with_logfile(executor):
+    """Test that --execute combines with --logfile"""
+    sql = 'select 1'
+    runner = CliRunner()
+
+    with NamedTemporaryFile(mode="w", delete=False) as logfile:
+        result = runner.invoke(mycli.main.cli, args=CLI_ARGS + ["--logfile", logfile.name, "--execute", sql])
+        assert result.exit_code == 0
+
+    assert os.path.getsize(logfile.name) > 0
+
+    try:
+        if os.path.exists(logfile.name):
+            os.remove(logfile.name)
+    except Exception as e:
+        print(f"An error occurred while attempting to delete the file: {e}")