mycli 2.19.0__tar.gz → 2.20.0__tar.gz

{mycli-2.19.0/mycli.egg-info → mycli-2.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.19.0
+Version: 2.20.0
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -30,7 +30,7 @@ License-File: LICENSE.txt
 License-File: AUTHORS.rst
 Requires-Dist: click~=8.5.0
 Requires-Dist: clickdc~=0.1.1
-Requires-Dist: cryptography~=50.0.0
+Requires-Dist: cryptography~=50.0.1
 Requires-Dist: Pygments~=2.21.0
 Requires-Dist: prompt_toolkit<4.0.0,>=3.0.41
 Requires-Dist: PyMySQL~=1.1.2
@@ -39,11 +39,11 @@ Requires-Dist: sqlglot~=30.17.0
 Requires-Dist: sqlglotc~=30.17.0
 Requires-Dist: configobj~=5.0.9
 Requires-Dist: cli_helpers[styles]~=2.15.1
-Requires-Dist: wcwidth~=0.8.2
+Requires-Dist: wcwidth~=0.8.3
 Requires-Dist: pyperclip~=1.11.0
 Requires-Dist: pycryptodomex~=3.23.0
 Requires-Dist: pyfzf~=0.3.1
-Requires-Dist: rapidfuzz~=3.14.3
+Requires-Dist: rapidfuzz~=3.14.5
 Requires-Dist: keyring~=25.7.0
 Requires-Dist: jinja2~=3.1.6
 Requires-Dist: yaspin~=3.4.0
@@ -59,21 +59,21 @@ Provides-Extra: all
 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: coverage~=7.15.4; 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-cov~=7.1.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.16.3; extra == "dev"
+Requires-Dist: ruff~=0.16.5; extra == "dev"
 Dynamic: license-file
 
 # mycli
 
 [![Build Status](https://github.com/dbcli/mycli/workflows/mycli/badge.svg)](https://github.com/dbcli/mycli/actions?query=workflow%3Amycli)
-[![License](https://img.shields.io/github/license/dbcli/mycli.svg)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
+[![License](https://img.shields.io/github/license/dbcli/mycli.svg?color=2FC745)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
 
 Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes.
 

{mycli-2.19.0 → mycli-2.20.0}/README.md

@@ -1,7 +1,7 @@
 # mycli
 
 [![Build Status](https://github.com/dbcli/mycli/workflows/mycli/badge.svg)](https://github.com/dbcli/mycli/actions?query=workflow%3Amycli)
-[![License](https://img.shields.io/github/license/dbcli/mycli.svg)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
+[![License](https://img.shields.io/github/license/dbcli/mycli.svg?color=2FC745)](https://github.com/dbcli/mycli/blob/main/LICENSE.txt)
 
 Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes.
 

{mycli-2.19.0 → mycli-2.20.0}/changelog.md

@@ -1,3 +1,33 @@
+2.20.0 (2026/09/05)
+==============
+
+Features
+--------
+* Add a `/source --throttle` option to pause between sourced statements.
+
+
+Bug Fixes
+--------
+* Allow shell-style redirects with `/source` when the filename is unquoted.
+
+
+Documentation
+--------
+* Badge color nit in `README.md`.
+* Add a `/source --help` option.
+
+
+Internal
+---------
+* Upgrade `cryptography` dependency to v50.0.1.
+* Upgrade `rapidfuzz` dependency to v3.14.5.
+* Upgrade `ruff` dev dependency to v0.16.5.
+* Upgrade `coverage` dev dependency to v7.15.4.
+* Upgrade `pytest-cov` dev dependency to v7.1.0.
+* Upgrade `wcwidth` dependency to v0.8.3.
+* Use `argparse` to process arguments to `/source`.
+
+
 2.19.0 (2026/09/02)
 ==============
 

{mycli-2.19.0 → mycli-2.20.0}/mycli/client_commands.py

@@ -4,13 +4,11 @@ from collections.abc import Generator, Mapping
 import logging
 import os
 import re
-import shlex
+import time
 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
@@ -18,9 +16,12 @@ 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.special.source import (
+    SOURCE_HELP_ROWS,
+    parse_source_arguments,
+    source_special_command_is_safe,
+)
 from mycli.packages.sqlresult import SQLResult
 from mycli.sqlexecute import SQLExecute
 
@@ -36,30 +37,6 @@ 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',
-    'ping',
-    '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:
@@ -68,106 +45,6 @@ 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 = '',
@@ -279,7 +156,7 @@ class ClientCommandsMixin:
         special.register_special_command(
             self.execute_from_file,
             "source",
-            "/source [--special|--show|--page] <file>",
+            "/source [options] <file>",
             "Execute queries from a file.",
             aliases=[SpecialCommandAlias("\\.", case_sensitive=False)],
             completion_snippet='execute queries from file',
@@ -412,16 +289,19 @@ class ClientCommandsMixin:
         yield SQLResult(status=msg)
 
     def execute_from_file(self, arg: str, **_) -> Generator[SQLResult, None, None]:
-        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)
+            source_arguments = parse_source_arguments(arg)
         except ValueError as error:
             yield SQLResult(status=str(error), is_error=True)
             return
+        if source_arguments.show_help:
+            yield SQLResult(header=['Argument', 'Description'], rows=SOURCE_HELP_ROWS)
+            return
+        if source_arguments.page_output:
+            yield SQLResult(command={'name': 'source_page'})
+        filename = source_arguments.filename
         if not filename:
-            yield SQLResult(status="Missing required argument: filename.", is_error=True)
+            yield SQLResult(status="Missing required argument: filename.  See /source --help.", is_error=True)
             return
 
         try:
@@ -431,6 +311,7 @@ class ClientCommandsMixin:
             return
 
         assert isinstance(self.sqlexecute, SQLExecute)
+        executed_statement = False
         with file_h:
             statements = statements_from_filehandle(file_h)
             while True:
@@ -444,35 +325,41 @@ class ClientCommandsMixin:
 
                 special_query = query.rstrip(';')
                 if special.is_special_command(special_query):
-                    if not allow_special:
+                    if not source_arguments.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):
+                    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:
+                    if executed_statement and source_arguments.throttle > 0:
+                        time.sleep(source_arguments.throttle)
+                    if source_arguments.show_queries:
+                        if source_arguments.page_output:
                             yield SQLResult(command={'name': 'source_show', 'text': special_query})
                         else:
                             click.secho(f'> {special_query}')
                     yield from self.sqlexecute.run(special_query)
+                    executed_statement = True
                     continue
 
                 if self.destructive_warning and confirm_destructive_query(self.destructive_keywords, query) is False:
                     continue
-                if show_queries:
-                    if page_output:
+                if executed_statement and source_arguments.throttle > 0:
+                    time.sleep(source_arguments.throttle)
+                if source_arguments.show_queries:
+                    if source_arguments.page_output:
                         yield SQLResult(command={'name': 'source_show', 'text': query})
                     else:
                         click.secho(f'> {query}')
                 yield from self.sqlexecute.run(query)
+                executed_statement = True
 
     def change_prompt_format(self, arg: str, **_) -> list[SQLResult]:
         """

{mycli-2.19.0 → mycli-2.20.0}/mycli/packages/completion_engine.py

@@ -11,6 +11,7 @@ from mycli.packages.special.dsn_aliases import DSN_SUBCOMMANDS
 from mycli.packages.special.favoritequeries import FAVORITE_SUBCOMMANDS
 from mycli.packages.special.main import COMMANDS as SPECIAL_COMMANDS
 from mycli.packages.special.main import parse_special_command
+from mycli.packages.special.source import SOURCE_BOOLEAN_OPTIONS, SOURCE_OPTIONS
 from mycli.packages.sql_utils import extract_tables, find_prev_keyword, last_word
 
 sqlparse.engine.grouping.MAX_GROUPING_DEPTH = None  # type: ignore[assignment]
@@ -816,8 +817,24 @@ def suggest_special(text: str) -> list[dict[str, Any]]:
         'source',
         '/source',
     ]:
-        source_options = ['--special', '--show', '--page']
-        source_arguments = _arg.split()
+        source_options = list(SOURCE_OPTIONS)
+        try:
+            source_arguments = shlex.split(_arg, posix=False)
+        except ValueError:
+            source_filename = _arg
+            while leading_arguments := source_filename.split(maxsplit=1):
+                if leading_arguments[0] in SOURCE_BOOLEAN_OPTIONS:
+                    source_filename = leading_arguments[1] if len(leading_arguments) == 2 else ''
+                    continue
+                if leading_arguments[0] == '--throttle' and len(leading_arguments) == 2:
+                    throttle_arguments = leading_arguments[1].split(maxsplit=1)
+                    source_filename = throttle_arguments[1] if len(throttle_arguments) == 2 else ''
+                    continue
+                if leading_arguments[0].startswith('--throttle='):
+                    source_filename = leading_arguments[1] if len(leading_arguments) == 2 else ''
+                    continue
+                break
+            return [{'type': 'file_name', 'quote_spaces': True, 'source_filename': source_filename}]
         if not source_arguments:
             return [
                 {'type': 'special_subcommand', 'subcommands': source_options},
@@ -826,26 +843,55 @@ def suggest_special(text: str) -> list[dict[str, Any]]:
 
         used_options: set[str] = set()
         argument_index = 0
-        while argument_index < len(source_arguments) and source_arguments[argument_index] in source_options:
-            used_options.add(source_arguments[argument_index])
+        filename_index: int | None = None
+        options_ended = False
+        while argument_index < len(source_arguments):
+            argument = source_arguments[argument_index]
+            if not options_ended and argument == '--':
+                options_ended = True
+                used_options.update(source_options)
+                argument_index += 1
+                continue
+            if not options_ended and argument in SOURCE_BOOLEAN_OPTIONS:
+                used_options.add(argument)
+                argument_index += 1
+                continue
+            if not options_ended and argument == '--help':
+                return []
+            if not options_ended and argument == '--throttle':
+                used_options.add(argument)
+                argument_index += 1
+                if argument_index >= len(source_arguments):
+                    return []
+                if argument_index == len(source_arguments) - 1 and not text[-1].isspace():
+                    return []
+                argument_index += 1
+                continue
+            if not options_ended and argument.startswith('--throttle='):
+                used_options.add('--throttle')
+                if argument == '--throttle=' or not text[-1].isspace():
+                    return []
+                argument_index += 1
+                continue
+            if not options_ended and argument.startswith('-'):
+                break
+            if filename_index is not None:
+                return []
+            filename_index = argument_index
             argument_index += 1
         remaining_options = [option for option in source_options if option not in used_options]
-        source_filename = _arg
-        for _index in range(argument_index):
-            parsed_argument = source_filename.split(maxsplit=1)
-            source_filename = parsed_argument[1] if len(parsed_argument) == 2 else ''
+        source_filename = source_arguments[filename_index] if filename_index is not None else ''
         file_suggestion = {'type': 'file_name', 'quote_spaces': True, 'source_filename': source_filename}
 
         if argument_index < len(source_arguments):
-            if source_arguments[argument_index].startswith('-'):
-                return [{'type': 'special_subcommand', 'subcommands': remaining_options}]
-            return [file_suggestion]
+            return [{'type': 'special_subcommand', 'subcommands': remaining_options}]
         if not text[-1].isspace():
-            return []
+            return [file_suggestion] if filename_index == len(source_arguments) - 1 else []
         suggestions: list[dict[str, Any]] = []
         if remaining_options:
             suggestions.append({'type': 'special_subcommand', 'subcommands': remaining_options})
-        suggestions.append(file_suggestion)
+        if filename_index is None:
+            suggestions.append(file_suggestion)
         return suggestions
 
     if cmd.lower() in [

{mycli-2.19.0 → mycli-2.20.0}/mycli/packages/hybrid_redirection.py

@@ -1,14 +1,35 @@
 import functools
 import logging
+import re
 import shlex
 
 import sqlglot
 
 from mycli.compat import WIN
 from mycli.packages.special.delimitercommand import DelimiterCommand
+from mycli.packages.special.source import (
+    parse_source_arguments,
+)
 
 logger = logging.getLogger(__name__)
 delimiter_command = DelimiterCommand()
+SOURCE_COMMAND_PATTERN = re.compile(r'^([/]?source|[/\\]\.)\s+', re.IGNORECASE)
+SOURCE_OPTION_PATTERN = re.compile(r'(?<!\S)--(?:special|show|page|help|throttle)(?==|\s|$)', re.IGNORECASE)
+SOURCE_OPTION_TERMINATOR_PATTERN = re.compile(r'(?<!\S)--(?=\s|$)')
+HYBRID_OPERATOR_PATTERN = re.compile(r'\$(?:>>?|\|)')
+
+
+def tokenize_command(command: str) -> list[sqlglot.Token]:
+    """Tokenize a command without treating source options as SQL comments."""
+    if SOURCE_COMMAND_PATTERN.match(command):
+        operator_match = HYBRID_OPERATOR_PATTERN.search(command)
+        source_end = operator_match.start() if operator_match is not None else len(command)
+        source_part = command[:source_end]
+        terminator_match = SOURCE_OPTION_TERMINATOR_PATTERN.search(source_part)
+        options_end = terminator_match.start() if terminator_match is not None else len(source_part)
+        masked_options = SOURCE_OPTION_PATTERN.sub(lambda match: match.group().replace('-', '_'), source_part[:options_end])
+        command = masked_options + source_part[options_end:] + command[source_end:]
+    return sqlglot.tokenize(command)
 
 
 def find_token_indices(tokens: list[sqlglot.Token]) -> dict[str, list[int]]:
@@ -44,6 +65,15 @@ def find_sql_part(
 ):
     leftmost_dollar_pos = tokens[true_dollar_indices[0]].start
     sql_part = command[0:leftmost_dollar_pos].strip().removesuffix(delimiter_command.current).rstrip()
+    if SOURCE_COMMAND_PATTERN.match(sql_part):
+        source_arg_str = SOURCE_COMMAND_PATTERN.sub('', sql_part)
+        try:
+            filename = parse_source_arguments(source_arg_str).filename
+        except ValueError:
+            return ''
+        if not filename:
+            return ''
+        return sql_part
     try:
         statements = sqlglot.parse(sql_part, read='mysql')
     except sqlglot.errors.ParseError:
@@ -142,7 +172,7 @@ def get_redirect_components(command: str) -> tuple[str | None, str | None, str |
     """Get the parts of a hybrid shell-style redirect command."""
 
     try:
-        tokens = sqlglot.tokenize(command)
+        tokens = tokenize_command(command)
     except sqlglot.errors.TokenError:
         return None, None, None, None
 

{mycli-2.19.0 → mycli-2.20.0}/mycli/packages/special/__init__.py

@@ -3,6 +3,7 @@ __lazy_modules__ = [
     'mycli.packages.special.iocommands',
     'mycli.packages.special.llm',
     'mycli.packages.special.main',
+    'mycli.packages.special.source',
 ]
 
 import os
@@ -54,6 +55,7 @@ from mycli.packages.special.iocommands import (
     write_pipe_once,
     write_tee,
 )
+from mycli.packages.special.source import parse_source_arguments
 
 if not os.environ.get('MYCLI_LLM_OFF'):
     from mycli.packages.special.llm import (
@@ -112,12 +114,14 @@ __all__: list[str] = [
     'is_llm_command',
     'is_pager_enabled',
     'is_redirected',
-    'is_special_command',
+    'is_show_favorite_query',
     'is_show_warnings_enabled',
+    'is_special_command',
     'is_timing_enabled',
     'list_databases',
     'list_tables',
     'open_external_editor',
+    'parse_source_arguments',
     'parse_special_command',
     'ping',
     'register_special_command',
@@ -131,10 +135,9 @@ __all__: list[str] = [
     'set_pager',
     'set_pager_enabled',
     'set_redirect',
+    'set_show_favorite_query',
     'set_show_warnings_enabled',
     'set_timing_enabled',
-    'set_show_favorite_query',
-    'is_show_favorite_query',
     'special_command',
     'split_queries',
     'sql_using_llm',