mycli 2.14.0__tar.gz → 2.16.0__tar.gz

{mycli-2.14.0 → mycli-2.16.0}/.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           version: "latest"
 
@@ -66,7 +66,7 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           version: "latest"
 
@@ -116,7 +116,7 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           version: 'latest'
 
@@ -165,7 +165,7 @@ jobs:
         run: |
           mkdir -p /root/mycli
 
-      - uses: ubuntu/wsl/.github/actions/wsl-checkout@f861f1083e518354e4c3637b08c0edfcf8bc3d51
+      - uses: ubuntu/wsl/.github/actions/wsl-checkout@e2114d0a5ebea62e6b2e1565f175871ed7558d20
         with:
           distro: Ubuntu-24.04
           working-dir: /root/mycli
@@ -219,7 +219,7 @@ jobs:
     steps:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           version: "latest"
 

{mycli-2.14.0 → mycli-2.16.0}/.github/workflows/publish.yml

@@ -29,7 +29,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
       with:
         version: "latest"
 
@@ -74,7 +74,7 @@ jobs:
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
       with:
         version: "latest"
 
@@ -124,7 +124,7 @@ jobs:
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
       with:
         version: 'latest'
 
@@ -173,7 +173,7 @@ jobs:
       run: |
         mkdir -p /root/mycli
 
-    - uses: ubuntu/wsl/.github/actions/wsl-checkout@f861f1083e518354e4c3637b08c0edfcf8bc3d51
+    - uses: ubuntu/wsl/.github/actions/wsl-checkout@e2114d0a5ebea62e6b2e1565f175871ed7558d20
       with:
         distro: Ubuntu-24.04
         working-dir: /root/mycli
@@ -226,7 +226,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-    - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
       with:
         version: "latest"
 

{mycli-2.14.0 → mycli-2.16.0}/.github/workflows/typecheck.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           python-version: '3.14'
 
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with:
           version: 'latest'
 

{mycli-2.14.0/mycli.egg-info → mycli-2.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.14.0
+Version: 2.16.0
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause

{mycli-2.14.0 → mycli-2.16.0}/changelog.md

@@ -1,3 +1,39 @@
+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)
+==============
+
+Features
+---------
+* Add alternative interface `/favorite` for favorite queries.
+* Add `/dsn edit` subcommand to edit an existing DSN.
+
+
+Bug Fixes
+---------
+* Lower Boundary tunnel stabilization pause to 0.15 sec.
+
+
+Documentation
+---------
+* TIPS: `/favorite run` composes with the `\G` and `\x` terminators.
+
+
 2.14.0 (2026/08/15)
 ==============
 

{mycli-2.14.0 → mycli-2.16.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!
 
@@ -64,9 +64,11 @@ edit a query in an external editor using /edit <filename>!
 
 Favorite queries support Jinja templates and named arguments!
 
+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!
 
@@ -146,6 +148,8 @@ display output vertically using \G at the end of a query!
 
 display output in an interactive explorer \x at the end of a query!
 
+"/favorite run" can be combined with the \G or \x terminators!
+
 run SQL scripts in batch mode using the standard input!
 
 indexed columns are tagged with a "*" in completion menus!
@@ -302,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.14.0 → mycli-2.16.0}/mycli/boundary_tunnel.py

@@ -15,7 +15,10 @@ from typing import IO
 
 from mycli.compat import WIN
 
-TUNNEL_STABILIZATION_PAUSE = 0.25
+# This should be as small as possible and yet still
+# ward off SSL errors at connection time.  We know
+# that 0.1 is too small on at least one Mac.
+TUNNEL_STABILIZATION_PAUSE = 0.15
 
 
 class BoundaryTunnelError(RuntimeError):
@@ -148,8 +151,6 @@ class BoundaryTunnel:
             self._raise_if_failed()
             if self._is_listening():
                 self._ready.set()
-                # todo: if this works to ward off SSL errors at connection time,
-                # try making the pause as small as possible
                 time.sleep(TUNNEL_STABILIZATION_PAUSE)
                 return
             time.sleep(0.05)

{mycli-2.14.0 → mycli-2.16.0}/mycli/clibuffer.py

@@ -29,7 +29,7 @@ def _multiline_exception(text: str) -> bool:
     # Multi-statement favorite query is a special case. Because there will
     # be a semicolon separating statements, we can't consider semicolon an
     # EOL. Let's consider an empty line an EOL instead.
-    if first_word.startswith(("\\fs", "/fs")):
+    if iocommands.is_favorite_save_command(text):
         return orig.endswith("\n")
 
     return (

{mycli-2.14.0 → mycli-2.16.0}/mycli/client.py

@@ -122,6 +122,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
             self.config,
             myclirc,
             c['main'].get('shared_favorites_file'),
+            system_config_files=self.system_config_files,
         )
         DsnAliases.instance = DsnAliases.from_config(
             self.config,

{mycli-2.14.0 → mycli-2.16.0}/mycli/client_commands.py

@@ -4,16 +4,21 @@ 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.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 +35,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 +66,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 = '',
@@ -143,7 +271,7 @@ class ClientCommandsMixin:
         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)],
         )
@@ -266,12 +394,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 +424,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.14.0 → mycli-2.16.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
@@ -80,6 +84,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 +96,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.14.0 → mycli-2.16.0}/mycli/config.py

@@ -48,6 +48,7 @@ def read_config_file(
     f: str | IO[str],
     list_values: bool = True,
     preserve_quotes: bool = False,
+    raise_errors: bool = False,
 ) -> ConfigObj | LimiitedQuotePreservingConfigObj | None:
     """Read a config file.
 
@@ -57,6 +58,9 @@ def read_config_file(
     not unquoted. We are disabling list_values when reading MySQL config files
     so we can correctly interpret commas in passwords.
 
+    Set *raise_errors* to propagate parsing and I/O errors instead of logging
+    them and returning a partial config or ``None``.
+
     """
 
     if isinstance(f, str):
@@ -68,10 +72,14 @@ def read_config_file(
         else:
             config = ConfigObj(f, interpolation=False, encoding="utf8", list_values=list_values)
     except ConfigObjError as e:
+        if raise_errors:
+            raise
         log(logger, logging.WARNING, "Unable to parse line {0} of config file '{1}'.".format(e.line_number, f))
         log(logger, logging.WARNING, "Using successfully parsed config values.")
         return e.config
     except (IOError, OSError) as e:
+        if raise_errors:
+            raise
         log(logger, logging.WARNING, "You don't have permission to read config file '{0}'.".format(e.filename))
         return None
 

{mycli-2.14.0 → mycli-2.16.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.14.0 → mycli-2.16.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