mycli 2.6.1__tar.gz → 2.7.0__tar.gz

{mycli-2.6.1/mycli.egg-info → mycli-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.6.1
+Version: 2.7.0
 Summary: CLI for MySQL Database. With auto-completion and syntax highlighting.
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -13,18 +13,18 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 License-File: AUTHORS.rst
-Requires-Dist: click~=8.3.1
+Requires-Dist: click~=8.4.2
 Requires-Dist: clickdc~=0.1.1
-Requires-Dist: cryptography~=46.0.5
-Requires-Dist: Pygments~=2.19.2
+Requires-Dist: cryptography~=49.0.0
+Requires-Dist: Pygments~=2.20.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
-Requires-Dist: sqlglot~=30.8.0
-Requires-Dist: sqlglotc~=30.8.0
+Requires-Dist: sqlglot~=30.12.0
+Requires-Dist: sqlglotc~=30.12.0
 Requires-Dist: configobj~=5.0.9
-Requires-Dist: cli_helpers[styles]~=2.15.0
-Requires-Dist: wcwidth~=0.6.0
+Requires-Dist: cli_helpers[styles]~=2.15.1
+Requires-Dist: wcwidth~=0.8.2
 Requires-Dist: pyperclip~=1.11.0
 Requires-Dist: pycryptodomex~=3.23.0
 Requires-Dist: pyfzf~=0.3.1
@@ -32,10 +32,9 @@ Requires-Dist: rapidfuzz~=3.14.3
 Requires-Dist: keyring~=25.7.0
 Requires-Dist: yaspin~=3.4.0
 Provides-Extra: llm
-Requires-Dist: llm~=0.30.0; extra == "llm"
-Requires-Dist: pydantic_core~=2.41.5; extra == "llm"
-Requires-Dist: setuptools==82.*; extra == "llm"
-Requires-Dist: pip==26.*; extra == "llm"
+Requires-Dist: llm~=0.31.1; extra == "llm"
+Requires-Dist: setuptools==83.*; extra == "llm"
+Requires-Dist: pip~=26.1.2; extra == "llm"
 Provides-Extra: dataframe
 Requires-Dist: polars~=1.42.1; extra == "dataframe"
 Requires-Dist: altair~=6.2.2; extra == "dataframe"
@@ -45,21 +44,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~=1.19.1; extra == "dev"
+Requires-Dist: mypy~=2.3.0; extra == "dev"
 Requires-Dist: pexpect~=4.9.0; extra == "dev"
-Requires-Dist: pytest~=9.0.2; 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: llm~=0.30.0; extra == "dev"
-Requires-Dist: pydantic_core~=2.41.5; extra == "dev"
-Requires-Dist: setuptools==82.*; extra == "dev"
-Requires-Dist: pip==26.*; extra == "dev"
 Requires-Dist: ruff~=0.15.0; extra == "dev"
-Requires-Dist: polars~=1.42.1; extra == "dev"
-Requires-Dist: altair~=6.2.2; extra == "dev"
-Requires-Dist: vl-convert-python~=1.9.0; extra == "dev"
 Dynamic: license-file
 
 # mycli

{mycli-2.6.1 → mycli-2.7.0}/changelog.md

@@ -1,3 +1,42 @@
+2.7.0 (2026/07/25)
+==============
+
+Features
+---------
+* Show purpose in tabular `--checkup` output.
+* Add optional dependencies to `--checkup`.
+* Improve completions for `/command`s.
+* Highlight indexed columns in completions with a suffix and/or a text style.
+
+
+Bugfixes
+---------
+* Ignoring `min_completion_trigger` only applies to first token after `/`.
+
+
+Documentation
+---------
+* Add `.|` and `.>` to TIPS.
+
+
+Internal
+---------
+* Update `cli_helpers` dependency to v2.15.1
+* Update `click` to v8.4.2
+* Update `cryptography` to v49.0.0
+* Update `pygments` to v2.20.0
+* Update `llm` to v0.31.1
+* Update `setuptools` to v83.x
+* Update `pip` to v26.1.2
+* Update `pytest` to v9.1.1
+* Add dependency cooldown period
+* Exclude `cli_helpers` and `openai` from cooldown
+* Update `sqlglot`/`sqlglotc` to v30.12.0
+* Update `wcwidth` to v0.8.2
+* Remove duplication in dev dependencies.
+* Update `mypy` to v2.3.0.
+
+
 2.6.1 (2026/07/24)
 ==============
 

{mycli-2.6.1 → mycli-2.7.0}/mycli/TIPS

@@ -144,6 +144,8 @@ display output in an interactive explorer \x at the end of a query!
 
 run SQL scripts in batch mode using the standard input!
 
+indexed columns are tagged with a "*" in completion menus!
+
 ###
 ### keystrokes
 ###
@@ -301,3 +303,11 @@ redirect query output to a CSV file with "$> <filename>"!
 append query output to a CSV file with "$>> <filename>"!
 
 run a command after shell redirects with "post_redirect_command" in ~/.myclirc!
+
+###
+### transforms
+###
+
+transform or plot query output with a dataframe using ".| df"!
+
+save query output to a Parquet file with ".> output.parquet"!

{mycli-2.6.1 → mycli-2.7.0}/mycli/client.py

@@ -183,6 +183,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         self.initialize_logging()
 
         keyword_casing = c["main"].get("keyword_casing", "auto")
+        indexed_column_suffix = c['main'].get('indexed_column_suffix', '')
 
         self.highlight_preview = c['search'].as_bool('highlight_preview')
 
@@ -191,7 +192,10 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         # Initialize completer.
         self.smart_completion = c["main"].as_bool("smart_completion")
         self.completer = SQLCompleter(
-            self.smart_completion, supported_formats=self.main_formatter.supported_formats, keyword_casing=keyword_casing
+            self.smart_completion,
+            supported_formats=self.main_formatter.supported_formats,
+            keyword_casing=keyword_casing,
+            indexed_column_suffix=indexed_column_suffix,
         )
         self._completer_lock = threading.Lock()
 

{mycli-2.6.1 → mycli-2.7.0}/mycli/client_commands.py

@@ -52,7 +52,7 @@ class ClientCommandsMixin:
             "rehash",
             "/rehash",
             "Refresh auto-completions.",
-            arg_type=ArgType.NO_QUERY,
+            arg_type=ArgType.NO_ARGUMENT,
             aliases=[SpecialCommandAlias("\\#", case_sensitive=False)],
         )
         special.register_special_command(

{mycli-2.6.1 → mycli-2.7.0}/mycli/client_query.py

@@ -52,6 +52,7 @@ class ClientQueryMixin:
                 "smart_completion": self.smart_completion,
                 "supported_formats": self.main_formatter.supported_formats,
                 "keyword_casing": self.completer.keyword_casing,
+                "indexed_column_suffix": self.completer.indexed_column_suffix,
             },
         )
 

{mycli-2.6.1 → mycli-2.7.0}/mycli/clistyle.py

@@ -15,6 +15,7 @@ logger = logging.getLogger(__name__)
 TOKEN_TO_PROMPT_STYLE: dict[Token, str] = {
     Token.Menu.Completions.Completion.Current: "completion-menu.completion.current",
     Token.Menu.Completions.Completion: "completion-menu.completion",
+    Token.Menu.Completions.Completion.Indexed: "completion-menu.completion.indexed",
     Token.Menu.Completions.Meta.Current: "completion-menu.meta.completion.current",
     Token.Menu.Completions.Meta: "completion-menu.meta.completion",
     Token.Menu.Completions.MultiColumnMeta: "completion-menu.multi-column-meta",

{mycli-2.6.1 → mycli-2.7.0}/mycli/completion_refresher.py

@@ -167,6 +167,11 @@ def refresh_tables(completer: SQLCompleter, executor: SQLExecute) -> None:
     completer.extend_columns(table_columns_dbresult, kind="tables")
 
 
+@refresher("indexed_columns")
+def refresh_indexed_columns(completer: SQLCompleter, executor: SQLExecute) -> None:
+    completer.extend_indexed_columns(executor.indexed_columns())
+
+
 @refresher("foreign_keys")
 def refresh_foreign_keys(completer: SQLCompleter, executor: SQLExecute) -> None:
     completer.extend_foreign_keys(executor.foreign_keys())

{mycli-2.6.1 → mycli-2.7.0}/mycli/main_modes/checkup.py

@@ -6,6 +6,8 @@ import sys
 import urllib.error
 import urllib.request
 
+from tabulate import tabulate
+
 from mycli.constants import REPO_URL
 
 PYPI_API_BASE = 'https://pypi.org/pypi'
@@ -24,15 +26,20 @@ def pypi_api_fetch(fragment: str) -> dict:
 
 def _dependencies_checkup() -> None:
     print('\n### Key Python dependencies:\n')
-    for dependency in [
-        'cli_helpers',
-        'click',
-        'prompt_toolkit',
-        'pygments',
-        'pymysql',
-        'sqlglot',
-        'sqlglotc',
-        'tabulate',
+    table = []
+    for dependency, purpose in [
+        ('cli_helpers', 'required'),
+        ('click', 'required'),
+        ('prompt_toolkit', 'required'),
+        ('pygments', 'required'),
+        ('pymysql', 'required'),
+        ('sqlglot', 'required'),
+        ('sqlglotc', 'required'),
+        ('tabulate', 'required'),
+        ('llm', 'optional for /llm command'),
+        ('polars', 'optional for .| operator'),
+        ('altair', 'optional for .| operator'),
+        ('vl-convert-python', 'optional for .| operator'),
     ]:
         try:
             installed_version = importlib.metadata.version(dependency)
@@ -40,32 +47,38 @@ def _dependencies_checkup() -> None:
             installed_version = None
         pypi_profile = pypi_api_fetch(f'/{dependency}/json')
         latest_version = pypi_profile.get('info', {}).get('version', None)
-        print(f'{dependency} version {installed_version} (latest {latest_version})')
+        table.append([dependency, installed_version, latest_version, purpose])
+    print(tabulate(table, headers=['library', 'version', 'latest', 'purpose']))
 
 
 def _executables_checkup() -> None:
     print('\n### External executables:\n')
-    for executable in [
-        'less',
-        'fzf',
-        'pygmentize',
+    table = []
+    for executable, purpose in [
+        ('less', 'required for paging'),
+        ('fzf', r'optional for history search and \x'),
+        ('pygmentize', 'optional for history search'),
     ]:
+        # executable, purpose = external
         if shutil.which(executable):
-            print(f'The "{executable}" executable was found — good!')
+            table.append([executable, 'found', purpose])
         else:
-            print(f'The recommended "{executable}" executable was not found — some functionality will suffer.')
+            table.append([executable, 'MISSING', purpose])
+    print(tabulate(table, headers=['executable', 'status', 'purpose']))
 
 
 def _environment_checkup() -> None:
     print('\n### Environment variables:\n')
-    for variable in [
-        'EDITOR',
-        'VISUAL',
+    table = []
+    for variable, purpose in [
+        ('EDITOR', r'optional for \edit and C-x C-e'),
+        ('VISUAL', r'optional for \edit and C-x C-e'),
     ]:
         if value := os.environ.get(variable):
-            print(f'The ${variable} environment variable was set to "{value}" — good!')
+            table.append([f'${variable}', value, purpose])
         else:
-            print(f'The ${variable} environment variable was not set — some functionality will suffer.')
+            table.append([f'${variable}', 'UNSET', purpose])
+    print(tabulate(table, headers=['variable', 'setting', 'purpose']))
 
 
 def _configuration_checkup(mycli) -> None:

{mycli-2.6.1 → mycli-2.7.0}/mycli/main_modes/repl.py

@@ -112,7 +112,7 @@ def complete_while_typing_filter() -> bool:
         return True
     app = get_app()
     text = app.current_buffer.text.lstrip()
-    if text.startswith('/') and not text.startswith('/*'):
+    if text.startswith('/') and not text.startswith('/*') and ' ' not in text:
         return True
     text_len = len(text)
     if text_len < MIN_COMPLETION_TRIGGER:

{mycli-2.6.1 → mycli-2.7.0}/mycli/myclirc

@@ -9,6 +9,12 @@ show_warnings = False
 # possible completions will be listed.
 smart_completion = True
 
+# Text appended to indexed column names in the completion menu.  This text is
+# not inserted into the query. Leave empty to disable the marker.  Quote values
+# containing spaces, commas, or comment characters.
+# Alternative: ' [indexed]'
+indexed_column_suffix = *
+
 # Minimum characters typed before offering completion suggestions.  Forward
 # slash for a command is an exception which always offers completions.
 # Suggestion: 3.
@@ -411,6 +417,7 @@ default_username_field = username
 # Completion menus
 completion-menu.completion.current = 'bg:#ffffff #000000'
 completion-menu.completion = 'bg:#008888 #ffffff'
+completion-menu.completion.indexed = 'bg:#008888 #ffffff'
 completion-menu.meta.completion.current = 'bg:#44aaaa #000000'
 completion-menu.meta.completion = 'bg:#448888 #ffffff'
 completion-menu.multi-column-meta = 'bg:#aaffff #000000'

{mycli-2.6.1 → mycli-2.7.0}/mycli/packages/completion_engine.py

@@ -71,6 +71,10 @@ def _keyword_suggestions() -> list[Suggestion]:
     return [{'type': 'keyword'}]
 
 
+def _special_suggestions() -> list[Suggestion]:
+    return [{'type': 'special'}]
+
+
 def _keyword_and_special_suggestions() -> list[Suggestion]:
     return [{'type': 'keyword'}, {'type': 'special'}]
 
@@ -144,8 +148,11 @@ def _emit_none_token(_ctx: SuggestContext) -> list[Suggestion]:
     return _keyword_suggestions()
 
 
-def _emit_blank_token(_ctx: SuggestContext) -> list[Suggestion]:
-    return _keyword_and_special_suggestions()
+def _emit_blank_token(ctx: SuggestContext) -> list[Suggestion]:
+    if ctx.text_before_cursor.startswith('/'):
+        return _special_suggestions()
+    else:
+        return _keyword_and_special_suggestions()
 
 
 def _emit_star(_ctx: SuggestContext) -> list[Suggestion]:
@@ -793,7 +800,8 @@ def suggest_special(text: str) -> list[dict[str, Any]]:
             {"type": "view", "schema": []},
             {"type": "schema"},
         ]
-    elif cmd.lower() in [
+
+    if cmd.lower() in [
         r'\.',
         r'/.',
         'source',
@@ -806,14 +814,16 @@ def suggest_special(text: str) -> list[dict[str, Any]]:
         '/tee',
     ]:
         return [{"type": "file_name"}]
+
     # todo: why is \edit case-sensitive?
-    elif cmd in [
+    if cmd in [
         r'\e',
         '/e',
         r'\edit',
         '/edit',
     ]:
         return [{"type": "file_name"}]
+
     if cmd in ["\\llm", "/llm", "\\ai", "/ai"]:
         return [{"type": "llm"}]
 
@@ -828,7 +838,17 @@ def suggest_special(text: str) -> list[dict[str, Any]]:
             return []
         return [{'type': 'special_subcommand', 'subcommands': list(DSN_SUBCOMMANDS)}]
 
-    return [{"type": "keyword"}, {"type": "special"}]
+    if cmd.lower() in [
+        'help',
+        '/help',
+        r'\help',
+        '?',
+        '/?',
+        r'\?',
+    ]:
+        return [{"type": "keyword"}, {"type": "special"}]
+
+    return []
 
 
 def suggest_based_on_last_token(

{mycli-2.6.1 → mycli-2.7.0}/mycli/packages/special/iocommands.py

@@ -98,7 +98,7 @@ def is_show_warnings_enabled() -> bool:
     'warnings',
     '/warnings',
     'Enable automatic warnings display.',
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     aliases=[SpecialCommandAlias('\\W', case_sensitive=True)],
 )
@@ -113,7 +113,7 @@ def enable_show_warnings() -> Generator[SQLResult, None, None]:
     'nowarnings',
     '/nowarnings',
     'Disable automatic warnings display.',
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     aliases=[SpecialCommandAlias('\\w', case_sensitive=True)],
 )
@@ -152,7 +152,7 @@ def set_pager(arg: str, **_) -> list[SQLResult]:
     "nopager",
     "/nopager",
     "Disable pager; print to stdout.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     aliases=[SpecialCommandAlias("\\n", case_sensitive=True)],
 )
@@ -165,7 +165,7 @@ def disable_pager() -> list[SQLResult]:
     "\\timing",
     "/timing",
     "Toggle timing of queries.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     aliases=[SpecialCommandAlias("\\t", case_sensitive=True)],
 )

{mycli-2.6.1 → mycli-2.7.0}/mycli/packages/special/main.py

@@ -27,7 +27,7 @@ CASE_INSENSITIVE_COMMANDS: set[str] = set()
 
 
 class ArgType(Enum):
-    NO_QUERY = 0
+    NO_ARGUMENT = 0
     PARSED_QUERY = 1
     RAW_QUERY = 2
 
@@ -205,7 +205,7 @@ def execute(cur: Cursor, sql: str) -> list[SQLResult]:
     if command.lower().startswith(("help", "/help", "\\?", "/?", "?")) and arg:
         return show_keyword_help(cur=cur, arg=arg)
 
-    if special_cmd.arg_type == ArgType.NO_QUERY:
+    if special_cmd.arg_type == ArgType.NO_ARGUMENT:
         return special_cmd.handler()
     elif special_cmd.arg_type == ArgType.PARSED_QUERY:
         return special_cmd.handler(cur=cur, arg=arg, command_verbosity=(command_verbosity == CommandVerbosity.VERBOSE))
@@ -219,7 +219,7 @@ def execute(cur: Cursor, sql: str) -> list[SQLResult]:
     "help",
     "/help [term]",
     "Show this table, or search for help on a term.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     aliases=[SpecialCommandAlias("\\?", case_sensitive=False), SpecialCommandAlias("?", case_sensitive=False)],
 )
 def show_help(*_args) -> list[SQLResult]:
@@ -283,7 +283,7 @@ def show_keyword_help(cur: Cursor, arg: str) -> list[SQLResult]:
     return _show_mysql_help(cur, keyword)
 
 
-@special_command('\\bug', '/bug', 'File a bug on GitHub.', arg_type=ArgType.NO_QUERY)
+@special_command('\\bug', '/bug', 'File a bug on GitHub.', arg_type=ArgType.NO_ARGUMENT)
 def file_bug(*_args) -> list[SQLResult]:
     webbrowser.open_new_tab(ISSUES_URL)
     return [SQLResult(status=f'{ISSUES_URL} — press "New Issue"')]
@@ -293,14 +293,14 @@ def file_bug(*_args) -> list[SQLResult]:
     "exit",
     "/exit",
     "Exit.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     aliases=[SpecialCommandAlias("\\q", case_sensitive=False)],
 )
 @special_command(
     "quit",
     "/quit",
     "Quit.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     aliases=[SpecialCommandAlias("\\q", case_sensitive=False)],
 )
 def quit_(*_args):
@@ -311,7 +311,7 @@ def quit_(*_args):
     "\\edit",
     "/edit <filename> | <query>\\edit",
     "Edit query with editor (uses $VISUAL or $EDITOR).",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     aliases=[SpecialCommandAlias("\\e", case_sensitive=True)],
 )
@@ -319,14 +319,14 @@ def quit_(*_args):
     "\\clip",
     "/clip | <query>\\clip",
     "Copy query to the system clipboard.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
 )
 @special_command(
     "\\G",
     "<query>\\G",
     "Display query results vertically.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     backslash_only=True,
 )
@@ -334,7 +334,7 @@ def quit_(*_args):
     "\\g",
     "<query>\\g",
     "Display query results (mnemonic: go).",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     backslash_only=True,
 )
@@ -342,7 +342,7 @@ def quit_(*_args):
     "\\x",
     "<query>\\x",
     "Display query results in an explorer rather than a pager.",
-    arg_type=ArgType.NO_QUERY,
+    arg_type=ArgType.NO_ARGUMENT,
     case_sensitive=True,
     backslash_only=True,
 )

{mycli-2.6.1 → mycli-2.7.0}/mycli/schema_prefetcher.py

@@ -174,6 +174,7 @@ class SchemaPrefetcher:
     def _prefetch_one(self, executor: SQLExecute, schema: str) -> None:
         _logger.debug('prefetching schema %r', schema)
         table_rows = list(executor.table_columns(schema=schema))
+        indexed_rows = list(executor.indexed_columns(schema=schema))
         fk_rows = list(executor.foreign_keys(schema=schema))
         enum_rows = list(executor.enum_values(schema=schema))
         func_rows = list(executor.functions(schema=schema))
@@ -189,6 +190,12 @@ class SchemaPrefetcher:
             cols = table_columns.setdefault(esc_table, ['*'])
             cols.append(esc_col)
 
+        indexed_columns: dict[str, set[str]] = {}
+        for table, column in indexed_rows:
+            esc_table = completer.escape_name(table)
+            esc_col = completer.escape_name(column)
+            indexed_columns.setdefault(esc_table, set()).add(esc_col)
+
         fk_tables: dict[str, set[str]] = {}
         fk_relations: list[tuple[str, str, str, str]] = []
         for table, col, ref_table, ref_col in fk_rows:
@@ -224,6 +231,7 @@ class SchemaPrefetcher:
             live_completer.load_schema_metadata(
                 schema=schema,
                 table_columns=table_columns,
+                indexed_columns=indexed_columns,
                 foreign_keys=fk_payload,
                 enum_values=enum_values,
                 functions=functions,