mycli 2.15.0__tar.gz → 2.17.0__tar.gz

{mycli-2.15.0/mycli.egg-info → mycli-2.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.15.0
+Version: 2.17.0
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -31,7 +31,7 @@ License-File: AUTHORS.rst
 Requires-Dist: click~=8.3.3
 Requires-Dist: clickdc~=0.1.1
 Requires-Dist: cryptography~=50.0.0
-Requires-Dist: Pygments~=2.20.0
+Requires-Dist: Pygments~=2.21.0
 Requires-Dist: prompt_toolkit<4.0.0,>=3.0.41
 Requires-Dist: PyMySQL~=1.1.2
 Requires-Dist: sqlparse<0.6.0,>=0.3.0
@@ -48,10 +48,9 @@ Requires-Dist: keyring~=25.7.0
 Requires-Dist: jinja2~=3.1.6
 Requires-Dist: yaspin~=3.4.0
 Provides-Extra: llm
-Requires-Dist: llm~=0.31.1; extra == "llm"
+Requires-Dist: llm~=0.33; extra == "llm"
 Requires-Dist: setuptools==83.*; extra == "llm"
 Requires-Dist: pip~=26.1.2; extra == "llm"
-Requires-Dist: openai~=2.48.0; extra == "llm"
 Provides-Extra: dataframe
 Requires-Dist: polars~=1.42.1; extra == "dataframe"
 Requires-Dist: altair~=6.2.2; extra == "dataframe"
@@ -61,14 +60,14 @@ Requires-Dist: mycli[dataframe,llm]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: behave~=1.3.3; extra == "dev"
 Requires-Dist: coverage~=7.13.4; extra == "dev"
-Requires-Dist: mypy~=2.3.0; extra == "dev"
+Requires-Dist: mypy~=2.3.1; extra == "dev"
 Requires-Dist: pexpect~=4.9.0; extra == "dev"
 Requires-Dist: pytest~=9.1.1; extra == "dev"
 Requires-Dist: pytest-cov~=7.0.0; extra == "dev"
 Requires-Dist: pytest-random-order~=1.2.0; extra == "dev"
 Requires-Dist: tox~=4.35.0; extra == "dev"
 Requires-Dist: pdbpp~=0.11.7; extra == "dev"
-Requires-Dist: ruff~=0.15.0; extra == "dev"
+Requires-Dist: ruff~=0.16.3; extra == "dev"
 Dynamic: license-file
 
 # mycli

{mycli-2.15.0 → mycli-2.17.0}/changelog.md

@@ -1,3 +1,39 @@
+2.17.0 (2026/08/25)
+==============
+
+Features
+--------
+* Sort completion candidates by frecency from history.
+* Add help snippets in special /command completions.
+* Add completions on Polars methods in dataframe transforms.
+
+
+Internal
+---------
+* Upgrade `pygments` to v2.21.0, removing hacks for `set*` identifiers.
+* Upgrade `llm` dependency to v3.33, removing pin for `openai`.
+* Remove `pygments` cooldown exception as no longer needed.
+* Upgrade `mypy` dev dependency to v2.3.1.
+* Upgrade `ruff` dev dependency to v0.16.3.
+
+
+2.16.0 (2026/08/22)
+==============
+
+Features
+---------
+* Advertise beta `--boundary-id` option in helpdoc and completions.
+* Add `/source --special` to allow executing some special commands.
+* Add `/source --show` to display each query before executing it.
+* Add `/source --page` to display all output in one pager session.
+
+
+Bug Fixes
+---------
+* Show CLI error on invalid `--execute` containing `/source`.
+* Require `/source` filenames containing spaces to be quoted.
+
+
 2.15.0 (2026/08/20)
 ==============
 

{mycli-2.15.0 → mycli-2.17.0}/mycli/TIPS

@@ -54,7 +54,7 @@ copy the previous query to the clipboard with /clip!
 
 edit a query in an external editor using <query>\edit!
 
-edit a query in an external editor using /edit <filename>!
+edit a query in an external editor using /edit <file>!
 
 /f lists favorite queries; /f <name> executes a favorite!
 
@@ -68,7 +68,7 @@ Manage favorite queries with /favorite!
 
 /l lists databases!
 
-/once <filename> appends the next result to <filename>!
+/once <file> appends the next result to <file>!
 
 /| <command> sends the next result to a subprocess!
 
@@ -306,9 +306,9 @@ customize password sources/precedence with "password_sources" in ~/.myclirc!
 
 redirect query output to a shell command with "$| <command>"!
 
-redirect query output to a CSV file with "$> <filename>"!
+redirect query output to a CSV file with "$> <file>"!
 
-append query output to a CSV file with "$>> <filename>"!
+append query output to a CSV file with "$>> <file>"!
 
 run a command after shell redirects with "post_redirect_command" in ~/.myclirc!
 

{mycli-2.15.0 → mycli-2.17.0}/mycli/client_commands.py

@@ -4,16 +4,22 @@ from collections.abc import Generator, Mapping
 import logging
 import os
 import re
+import shlex
 from typing import TYPE_CHECKING, Any, cast
 
 import click
+import sqlparse
 
+from mycli.compat import WIN
 from mycli.config import write_default_config
 from mycli.main_modes.repl import set_all_external_titles
 from mycli.packages import special
 from mycli.packages.batch_utils import statements_from_filehandle
 from mycli.packages.filepaths import dir_path_exists
 from mycli.packages.interactive_utils import confirm_destructive_query
+from mycli.packages.ptoolkit.history import FileHistoryWithTimestamp
+from mycli.packages.special import main as special_main
+from mycli.packages.special.iocommands import expand_favorite_query
 from mycli.packages.special.main import ArgType, SpecialCommandAlias
 from mycli.packages.sqlresult import SQLResult
 from mycli.sqlexecute import SQLExecute
@@ -30,6 +36,29 @@ MISSING_CONFIG_VALUE = object()
 DSN_CONFIG_VALUE = object()
 FAVORITES_CONFIG_VALUE = object()
 HIDDEN_CONFIG_SECTIONS = frozenset({'alias_dsn', 'favorite_queries'})
+INVALID_SOURCE_FILENAME = 'Source accepts exactly one filename; filenames containing spaces must be quoted.'
+SOURCE_SAFE_SPECIAL_COMMANDS = frozenset({
+    'connect',
+    'fd',
+    'fs',
+    'help',
+    'l',
+    'nowarnings',
+    'prompt',
+    'redirectformat',
+    'rehash',
+    'status',
+    'tableformat',
+    'timing',
+    'use',
+    'warnings',
+    'dt',
+})
+SOURCE_SAFE_SUBCOMMANDS = {
+    'config': frozenset({'help', 'get', 'search'}),
+    'dsn': frozenset({'help', 'list', 'show', 'save', 'delete'}),
+    'favorite': frozenset({'help', 'list', 'reload', 'run', 'save', 'delete'}),
+}
 
 
 def _render_config_value(value: Any) -> str:
@@ -38,6 +67,106 @@ def _render_config_value(value: Any) -> str:
     return str(value)
 
 
+def _parse_source_arguments(arg: str) -> tuple[str, bool, bool, bool]:
+    allow_special = False
+    show_queries = False
+    page_output = False
+    filename = arg
+    while arguments := filename.split(maxsplit=1):
+        if arguments[0] == '--special':
+            allow_special = True
+        elif arguments[0] == '--show':
+            show_queries = True
+        elif arguments[0] == '--page':
+            page_output = True
+        else:
+            break
+        filename = arguments[1] if len(arguments) == 2 else ''
+    return filename, allow_special, show_queries, page_output
+
+
+def _has_unquoted_whitespace(value: str) -> bool:
+    quote: str | None = None
+    escaped = False
+    for character in value:
+        if escaped:
+            if quote is None and character.isspace():
+                return True
+            escaped = False
+            continue
+        if not WIN and character == '\\' and quote != "'":
+            escaped = True
+            continue
+        if character in ("'", '"'):
+            if quote is None:
+                quote = character
+            elif quote == character:
+                quote = None
+        elif quote is None and character.isspace():
+            return True
+    return False
+
+
+def _parse_source_filename(filename: str) -> str:
+    if not filename:
+        return ''
+    if _has_unquoted_whitespace(filename):
+        raise ValueError(INVALID_SOURCE_FILENAME)
+    try:
+        arguments = shlex.split(filename, posix=not WIN)
+    except ValueError as error:
+        raise ValueError(f'Invalid source filename: {error}.') from None
+    if len(arguments) != 1:
+        raise ValueError(INVALID_SOURCE_FILENAME)
+    parsed_filename = arguments[0]
+    if WIN and len(parsed_filename) >= 2 and parsed_filename[0] == parsed_filename[-1] and parsed_filename[0] in ("'", '"'):
+        parsed_filename = parsed_filename[1:-1]
+    return parsed_filename
+
+
+def _registered_special_command(query: str) -> tuple[str, str] | None:
+    command, _verbosity, arg = special.parse_special_command(query)
+    registered = special_main.COMMANDS.get(command)
+    if registered is None:
+        registered = special_main.COMMANDS.get(command.lower())
+    if registered is None:
+        return None
+    return registered.command.removeprefix('\\').removeprefix('/').lower(), arg
+
+
+def _favorite_source_command_is_safe(arg: str) -> bool:
+    query, _error = expand_favorite_query(arg)
+    if query is None:
+        return True
+    return not any(special.is_special_command(statement.rstrip(';')) for statement in sqlparse.split(query))
+
+
+def _source_special_command_is_safe(query: str) -> bool:
+    parsed = _registered_special_command(query)
+    if parsed is None:
+        return False
+
+    command, arg = parsed
+    if command == 'f':
+        return not arg or _favorite_source_command_is_safe(arg)
+    if command in ('fd', 'fs'):
+        return True
+    if command in SOURCE_SAFE_SPECIAL_COMMANDS:
+        return True
+
+    subcommands = SOURCE_SAFE_SUBCOMMANDS.get(command)
+    if subcommands is None:
+        return False
+    arguments = arg.split(maxsplit=1)
+    subcommand = arguments[0].lower() if arguments else 'help'
+    if subcommand not in subcommands:
+        return False
+    if command == 'favorite' and subcommand == 'run':
+        run_arg = arguments[1] if len(arguments) == 2 else ''
+        return not run_arg or _favorite_source_command_is_safe(run_arg)
+    return True
+
+
 def _iter_config_values(
     config: Mapping[str, Any],
     prefix: str = '',
@@ -94,6 +223,7 @@ class ClientCommandsMixin:
         destructive_keywords: Any
         config: Any
         myclirc_path: str
+        prompt_session: Any
         prompt_format: str
 
         def refresh_completions(self, reset: bool = False) -> list[SQLResult]: ...
@@ -107,6 +237,7 @@ class ClientCommandsMixin:
             "/use <database>",
             "Change to a new database.",
             aliases=[SpecialCommandAlias("\\u", case_sensitive=False)],
+            completion_snippet='change databases',
         )
         special.register_special_command(
             self.manual_reconnect,
@@ -115,14 +246,16 @@ class ClientCommandsMixin:
             "Reconnect to the server, optionally switching databases.",
             case_sensitive=True,
             aliases=[SpecialCommandAlias("\\r", case_sensitive=True)],
+            completion_snippet='reconnect to server',
         )
         special.register_special_command(
-            self.refresh_completions,
+            self.rehash,
             "rehash",
             "/rehash",
             "Refresh auto-completions.",
             arg_type=ArgType.NO_ARGUMENT,
             aliases=[SpecialCommandAlias("\\#", case_sensitive=False)],
+            completion_snippet='refresh completions',
         )
         special.register_special_command(
             self.change_table_format,
@@ -131,6 +264,7 @@ class ClientCommandsMixin:
             "Change the table format used to output interactive results.",
             case_sensitive=True,
             aliases=[SpecialCommandAlias("\\T", case_sensitive=True)],
+            completion_snippet='change interactive output format',
         )
         special.register_special_command(
             self.change_redirect_format,
@@ -139,13 +273,15 @@ class ClientCommandsMixin:
             "Change the table format used to output redirected results.",
             case_sensitive=True,
             aliases=[SpecialCommandAlias("\\Tr", case_sensitive=True)],
+            completion_snippet='change redirected output format',
         )
         special.register_special_command(
             self.execute_from_file,
             "source",
-            "/source <filename>",
+            "/source [--special|--show|--page] <file>",
             "Execute queries from a file.",
             aliases=[SpecialCommandAlias("\\.", case_sensitive=False)],
+            completion_snippet='execute queries from file',
         )
         special.register_special_command(
             self.change_prompt_format,
@@ -154,12 +290,14 @@ class ClientCommandsMixin:
             "Show or change prompt format.",
             case_sensitive=True,
             aliases=[SpecialCommandAlias("\\R", case_sensitive=True)],
+            completion_snippet='show or change prompt format',
         )
         special.register_special_command(
             self.config_command,
             r'\config',
             '/config <help|get|search|edit> [key]',
             'Inspect settings from config files.',
+            completion_snippet='inspect config file settings',
         )
 
     def manual_reconnect(self, arg: str = "", **_) -> Generator[SQLResult, None, None]:
@@ -174,6 +312,13 @@ class ClientCommandsMixin:
         else:
             yield self.change_db(arg).send(None)
 
+    def rehash(self) -> list[SQLResult]:
+        prompt_session = getattr(self, 'prompt_session', None)
+        history = getattr(prompt_session, 'history', None)
+        if isinstance(history, FileHistoryWithTimestamp):
+            history.refresh_frecency()
+        return self.refresh_completions()
+
     def change_table_format(self, arg: str, **_) -> Generator[SQLResult, None, None]:
         try:
             self.main_formatter.format_name = arg
@@ -266,12 +411,20 @@ class ClientCommandsMixin:
         yield SQLResult(status=msg)
 
     def execute_from_file(self, arg: str, **_) -> Generator[SQLResult, None, None]:
-        if not arg:
-            yield SQLResult(status="Missing required argument: filename.")
+        filename, allow_special, show_queries, page_output = _parse_source_arguments(arg)
+        if page_output:
+            yield SQLResult(command={'name': 'source_page'})
+        try:
+            filename = _parse_source_filename(filename)
+        except ValueError as error:
+            yield SQLResult(status=str(error), is_error=True)
+            return
+        if not filename:
+            yield SQLResult(status="Missing required argument: filename.", is_error=True)
             return
 
         try:
-            file_h = open(os.path.expanduser(arg))
+            file_h = open(os.path.expanduser(filename))
         except OSError as error:
             yield SQLResult(status=str(error))
             return
@@ -288,12 +441,36 @@ class ClientCommandsMixin:
                     yield SQLResult(status=str(error))
                     return
 
-                if special.is_special_command(query.rstrip(';')):
-                    yield SQLResult(status='Special commands are not supported in source files.')
-                    return
+                special_query = query.rstrip(';')
+                if special.is_special_command(special_query):
+                    if not allow_special:
+                        yield SQLResult(
+                            status='Special commands are not supported without /source --special.',
+                            is_error=True,
+                        )
+                        return
+                    if not _source_special_command_is_safe(special_query):
+                        command, _verbosity, _arg = special.parse_special_command(special_query)
+                        yield SQLResult(
+                            status=f'Special command is never permitted in source files: {command}.',
+                            is_error=True,
+                        )
+                        return
+                    if show_queries:
+                        if page_output:
+                            yield SQLResult(command={'name': 'source_show', 'text': special_query})
+                        else:
+                            click.secho(f'> {special_query}')
+                    yield from self.sqlexecute.run(special_query)
+                    continue
 
                 if self.destructive_warning and confirm_destructive_query(self.destructive_keywords, query) is False:
                     continue
+                if show_queries:
+                    if page_output:
+                        yield SQLResult(command={'name': 'source_show', 'text': query})
+                    else:
+                        click.secho(f'> {query}')
                 yield from self.sqlexecute.run(query)
 
     def change_prompt_format(self, arg: str, **_) -> list[SQLResult]:

{mycli-2.15.0 → mycli-2.17.0}/mycli/client_query.py

@@ -10,6 +10,10 @@ from mycli.packages.sqlresult import SQLResult
 from mycli.sqlcompleter import SQLCompleter
 
 
+class QueryError(Exception):
+    """An error reported while consuming query results."""
+
+
 class ClientQueryMixin:
     if TYPE_CHECKING:
         schema_prefetcher: Any
@@ -55,6 +59,7 @@ class ClientQueryMixin:
                 "keyword_casing": self.completer.keyword_casing,
                 "indexed_column_suffix": self.completer.indexed_column_suffix,
                 "config_property_names": self.completer.config_property_names,
+                'frecency_provider': self.completer.frecency_provider,
             },
         )
 
@@ -80,6 +85,7 @@ class ClientQueryMixin:
         query: str,
         checkpoint: str | None = None,
         new_line: bool = True,
+        raise_on_error: bool = False,
     ) -> None:
         """Runs *query*."""
         assert self.sqlexecute is not None
@@ -91,6 +97,10 @@ class ClientQueryMixin:
             self.main_formatter.query = query
             self.redirect_formatter.query = query
             self.explorer_formatter.query = query
+            if result.is_error and raise_on_error:
+                message = result.status_plain or 'Query failed.'
+                self.log_output(message)
+                raise QueryError(message)
             output = self.format_sqlresult(
                 result,
                 is_expanded=special.is_expanded_output(),

{mycli-2.15.0 → mycli-2.17.0}/mycli/completion_refresher.py

@@ -267,7 +267,7 @@ def refresh_collations(completer: SQLCompleter, executor: SQLExecute) -> None:
 
 @refresher("special_commands")
 def refresh_special(completer: SQLCompleter, executor: SQLExecute) -> None:
-    completer.extend_special_commands(list(COMMANDS.keys()))
+    completer.extend_special_commands({command: details.completion_snippet or details.description for command, details in COMMANDS.items()})
 
 
 @refresher("show_commands")

{mycli-2.15.0 → mycli-2.17.0}/mycli/lexer.py

@@ -1,6 +1,6 @@
 from pygments.lexer import inherit
 from pygments.lexers.sql import MySqlLexer
-from pygments.token import Keyword, Name
+from pygments.token import Keyword
 
 
 class MyCliLexer(MySqlLexer):
@@ -8,8 +8,6 @@ class MyCliLexer(MySqlLexer):
 
     tokens = {
         "root": [
-            # TODO: Remove once Pygments is upgraded above v2.20.0.
-            (r"\bset[\w$]+\b", Name),
             (r"\brepair\b", Keyword),
             (r"\boffset\b", Keyword),
             inherit,

{mycli-2.15.0 → mycli-2.17.0}/mycli/main.py

@@ -324,7 +324,6 @@ class CliArgs:
     boundary_id: str | None = clickdc.option(
         type=str,
         help='BETA: open a HashiCorp Boundary tunnel to TARGET_ID and connect through it.',
-        hidden=True,
     )
     checkup: bool = clickdc.option(
         is_flag=True,

{mycli-2.15.0 → mycli-2.17.0}/mycli/main_modes/execute.py

@@ -46,7 +46,7 @@ def main_execute_from_cli(mycli: 'MyCli', cli_args: 'CliArgs') -> int:
                 mycli.logger.warning('Unable to open TTY as stdin.')
                 raise e
         if execution_confirmed:
-            mycli.run_query(execute_sql, checkpoint=cli_args.checkpoint)
+            mycli.run_query(execute_sql, checkpoint=cli_args.checkpoint, raise_on_error=True)
             return 0
         else:
             return 1