mycli 2.27.0__tar.gz → 2.28.0__tar.gz

{mycli-2.27.0 → mycli-2.28.0}/.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
           sudo /etc/init.d/mysql start
 
       - name: Install dependencies
-        run: uv sync --all-extras -p ${{ matrix.python-version }}
+        run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
       - name: Wait for MySQL connection
         run: |
@@ -52,7 +52,7 @@ jobs:
           PYTEST_HOST: 127.0.0.1
           TERM: xterm
         run: |
-          uv run tox -e py${{ matrix.python-version }}
+          ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-macos:
     name: Tests macOS
@@ -84,7 +84,7 @@ jobs:
           brew services start mysql
 
       - name: Install dependencies
-        run: uv sync --all-extras -p ${{ matrix.python-version }}
+        run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
       - name: Wait for MySQL connection
         run: |
@@ -102,7 +102,7 @@ jobs:
           PYTEST_HOST: 127.0.0.1
           TERM: xterm
         run: |
-          uv run tox -e py${{ matrix.python-version }}
+          ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-windows:
     name: Tests Windows
@@ -127,7 +127,7 @@ jobs:
 
       - name: Install dependencies
         shell: cmd
-        run: uv sync --all-extras -p ${{ matrix.python-version }}
+        run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
       - name: Set up MySQL
         uses: shogo82148/actions-setup-mysql@083ec148d28e62f2b24b8f4541693dfe1d50488d # v1.54.0
@@ -182,7 +182,7 @@ jobs:
         run: |
           export PATH="$HOME/.local/bin:$PATH"
           cd /root/mycli
-          uv sync --all-extras --python 3.14
+          uv sync --extra dev,llm,dataframe --python 3.14
 
       - name: Start MySQL in WSL
         shell: wsl-bash {0}
@@ -248,7 +248,7 @@ jobs:
           PYTEST_HOST: 127.0.0.1
           TERM: xterm
         run: |
-          uv run tox -e py3.14
+          ./.venv/bin/tox -e py3.14
 
   docker-x86-build:
     name: Build x86 Docker Image

{mycli-2.27.0 → mycli-2.28.0}/.github/workflows/publish.yml

@@ -46,7 +46,7 @@ jobs:
         sudo /etc/init.d/mysql start
 
     - name: Install dependencies
-      run: uv sync --all-extras -p ${{ matrix.python-version }}
+      run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
     - name: Wait for MySQL connection
       run: |
@@ -54,16 +54,22 @@ jobs:
           sleep 5
         done
 
+      # arguably this should be made identical to CI for PRs
+      # better would be a composite GH action
+    - name: Run Style Checks
+      run: ./.venv/bin/tox -e style
+
+      # arguably this should be made identical to CI for PRs
+      # better would be a composite GH action
+    - name: Run Typechecker
+      run: ./.venv/bin/tox -e typecheck
+
     - name: Pytest / behave
       env:
         PYTEST_PASSWORD: root
         PYTEST_HOST: 127.0.0.1
       run: |
-        uv run tox -e py${{ matrix.python-version }}
-
-      # arguably this should be made identical to CI for PRs
-    - name: Run Style Checks
-      run: uv run tox -e style
+        ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-macos:
     name: Tests macOS
@@ -95,7 +101,7 @@ jobs:
         brew services start mysql
 
     - name: Install dependencies
-      run: uv sync --all-extras -p ${{ matrix.python-version }}
+      run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
     - name: Wait for MySQL connection
       run: |
@@ -113,7 +119,7 @@ jobs:
         PYTEST_HOST: 127.0.0.1
         TERM: xterm
       run: |
-        uv run tox -e py${{ matrix.python-version }}
+        ./.venv/bin/tox -e py${{ matrix.python-version }}
 
   tests-windows:
     name: Tests Windows
@@ -138,7 +144,7 @@ jobs:
 
     - name: Install dependencies
       shell: cmd
-      run: uv sync --all-extras -p ${{ matrix.python-version }}
+      run: uv sync --extra dev,llm,dataframe -p ${{ matrix.python-version }}
 
     - name: Set up MySQL
       uses: shogo82148/actions-setup-mysql@083ec148d28e62f2b24b8f4541693dfe1d50488d # v1.54.0
@@ -193,7 +199,7 @@ jobs:
       run: |
         export PATH="$HOME/.local/bin:$PATH"
         cd /root/mycli
-        uv sync --all-extras --python 3.14
+        uv sync --extra dev,llm,dataframe --python 3.14
 
     - name: Start MySQL in WSL
       shell: wsl-bash {0}
@@ -240,7 +246,7 @@ jobs:
         python-version: '3.14'
 
     - name: Install dependencies
-      run: uv sync --all-extras -p 3.14
+      run: uv sync --extra llm,dataframe -p 3.14
 
     - name: Build
       run: uv build

{mycli-2.27.0 → mycli-2.28.0}/.github/workflows/typecheck.yml

@@ -30,7 +30,7 @@ jobs:
           version: 'latest'
 
       - name: Install dependencies
-        run: uv sync --all-extras
+        run: uv sync --extra dev,llm,dataframe
 
       - name: Run mypy
         run: |

{mycli-2.27.0 → mycli-2.28.0}/AGENTS.md

@@ -8,6 +8,12 @@ A command line client for MySQL with auto-completion and syntax highlighting.
     ├── .github/                              # GitHub Actions and configuration
     ├── pyproject.toml                        # project configuration
     ├── doc/                                  # documentation
+    ├── doc/cookbook.md                       # recipes for how to configure and use mycli
+    ├── doc/key_bindings.md                   # documentation of key binding behaviors
+    ├── doc/known_bugs.md                     # documentation of known bugs and limitations
+    ├── doc/llm.md                            # documentation on how to use LLM features
+    ├── doc/transforms.md                     # documentation on how to use dataframe transform/plot features
+    ├── doc/screenshots/                      # screenshots for documentation
     ├── mycli/                                # application source
     ├── mycli/__init__.py                     # provides version number
     ├── mycli/app_state.py                    # `AppStateMixin` application state mixin and related functions
@@ -44,6 +50,7 @@ A command line client for MySQL with auto-completion and syntax highlighting.
     ├── mycli/packages/cli_utils.py           # utilities for parsing CLI arguments
     ├── mycli/packages/completion_engine.py   # implementation of completion suggestions
     ├── mycli/packages/filepaths.py           # utilities for files, including completion suggestions
+    ├── mycli/packages/fzf.py                 # general interface to fzf chooser
     ├── mycli/packages/hybrid_redirection.py  # implementation of shell-style redirects
     ├── mycli/packages/interactive_utils.py   # utilities for confirming on destructive statements
     ├── mycli/packages/key_binding_utils.py   # handlers for key bindings and related special commands

{mycli-2.27.0/mycli.egg-info → mycli-2.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.27.0
+Version: 2.28.0
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -41,7 +41,6 @@ Requires-Dist: cli_helpers[styles]~=2.15.1
 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.5
 Requires-Dist: keyring~=25.7.0
 Requires-Dist: jinja2~=3.1.6

{mycli-2.27.0 → mycli-2.28.0}/changelog.md

@@ -1,3 +1,36 @@
+v2.28.0 (2026/10/02)
+==============
+
+Features
+--------
+* Add "streaming" query state when `--unbuffered` is in effect.
+
+
+Bug Fixes
+--------
+* Correct row counts when `--unbuffered` is in effect.
+* Don't let `--unbuffered` override the state-update interval.
+* Fix a brief blankout of query state feedback on large results.
+* Note that `sqlglotc` is optional for performance in `--checkup`.
+* Make imports less lazy, to load special commands under Python 3.15.
+
+
+Documentation
+--------
+* Add `doc/known_bugs.md` for known bugs and limitations.
+* Add `doc/cookbook.md` for recipes on how to use mycli.
+
+
+Internal
+--------
+* Replace `pyfzf` dependency with internal implementation.
+* Use the `uv` outside of the `tox` environment when testing.
+* Use forward-slash forms of special commands in the behave test suite.
+* Use forward-slash forms of special commands in the pytest test suite.
+* Add a `tox` typecheck command.
+* Add a typecheck step to the `publish.yml` workflow.
+
+
 v2.27.0 (2026/09/29)
 ==============
 

mycli-2.28.0/doc/cookbook.md

@@ -0,0 +1,71 @@
+# Cookbook
+
+Recipes for configuring and using mycli.
+
+## faster table rendering
+
+A substantial amount of time is spent rendering tables in `tabulate` when
+the number of rows returned is say 100K or more.  The reason is that
+`tabulate` scans every row in pure Python to determine cell width.
+
+One workaround for faster viewing of large results is to configure the output
+format to CSV in `~/.myclirc`:
+
+```ini
+[main]
+table_format = csv
+```
+
+and to configure the pager to a fast CSV viewer such as [csvlens](https://github.com/ys-l/csvlens):
+
+```ini
+[main]
+pager = csvlens
+```
+
+which has the effect of moving cell-width calculations from Python to Rust.
+
+## keyring
+
+Use of the system keyring was left disabled in the default `~/.myclirc` to avoid
+silently changing default behaviors.  But it is recommended to enable it!
+
+```ini
+[main]
+use_keyring = auto
+```
+
+Sources eligible for the keyring can also be configured with
+
+```ini
+[main]
+keyring_sources = prompt, literal, file, environment, dsn, login_path, fallback
+```
+
+## completions trigger
+
+Mycli's default completions trigger the display of candidates at the first
+character, which might be distracting for some.
+
+For more of an industry-standard experience, in which completions are deferred
+until more information is typed, set `min_completion_trigger` to a small value
+in `~/.myclirc`:
+
+```ini
+[main]
+min_completion_trigger = 3
+```
+
+## DSN environment variables
+
+If using a tool such as [mise](https://github.com/jdx/mise) or [direnv](https://github.com/direnv/direnv) to manage
+environment variables, it may be convenient to enable this setting in
+`~/.myclirc`:
+
+```ini
+[main]
+expand_dsn_alias_env_vars = True
+```
+
+which allows environment variables in the form `${VAR}` to be substituted
+in DSNs.

mycli-2.28.0/doc/known_bugs.md

@@ -0,0 +1,61 @@
+# Known Bugs
+
+These are known bugs or limitations in mycli which it would be welcome to
+fix.
+
+## custom delimiters
+
+A custom delimiter (query terminator) string may be set with the `/delimiter`
+special command, but the custom delimiter is not respected in all parts of
+mycli's code.
+
+## completions after backtick
+
+Completions after a backtick character are too exuberant.  Example:
+
+```sql
+SELECT `<tab>
+```
+
+will offer more completions than
+
+```sql
+SELECT <tab>
+```
+
+## Windows limitations
+
+Mycli is only partially tested on Windows, and several features such as
+filename completion after `/source` may not work as expected.
+
+## double-dash with shell redirections
+
+The interpretation of `--` may not be consistent with `$|`.  The double-dahs
+is inherently ambiguous, being either a SQL comment initiator, or a common
+part of a shell command.  The rules for resolving the ambiguity should be
+simple, and better documented.
+
+## enum completions
+
+Completions on enum values may fail if the values contain spaces.
+
+## keyring support
+
+If "Always Allow" is chosen on Mac, then all Python applications will have
+access to the credential.
+
+When making connections via a kubectl tunnel, the keyring is disabled, because
+the Kubernetes context is not known.
+
+## explorer
+
+There is a trailing blank line in the explorer choices.
+
+## prompt efficiency
+
+The prompt and toolbar are updated more often than needed, even with caching.
+
+## history search preview highlighting
+
+When syntax highlighting with `pygmentize` is enabled for history search previews,
+the colors do not match the user's preferences in `~/.myclirc`.

{mycli-2.27.0 → mycli-2.28.0}/docker/resources/test_db-1.0.7.tar.gz

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
-name: mycli-2.27.0/docker/resources/test_db-1.0.7.tar.gz
+name: mycli-2.28.0/docker/resources/test_db-1.0.7.tar.gz
 size: 35607473 bytes
 sha256: c44c140f352f35d47fdb65df60f52b779ef552822fad6c4efcfa7b134c3faf84

{mycli-2.27.0 → mycli-2.28.0}/mycli/constants.py

@@ -59,6 +59,7 @@ TTY_ERASE_LINE = '\r\x1b[2K'
 
 class QueryState(enum.StrEnum):
     RENDERING = 'rendering'
+    STREAMING = 'streaming'
     TRANSFORMING = 'transforming'
     UNKNOWN = 'unknown'
     INITIAL = 'finding state'

{mycli-2.27.0 → mycli-2.28.0}/mycli/key_bindings.py

@@ -19,7 +19,7 @@ from prompt_toolkit.selection import SelectionType
 
 from mycli.constants import DOCS_URL
 from mycli.packages import key_binding_utils
-from mycli.packages.ptoolkit.fzf import search_history
+from mycli.packages.ptoolkit.fzf_history import search_history
 from mycli.packages.ptoolkit.utils import safe_invalidate_display
 
 _logger = logging.getLogger(__name__)
@@ -43,9 +43,9 @@ def print_f1_help():
     app.print_text('\n')
     app.print_text([
         ('', 'Inline help — type "'),
-        ('bold', 'help'),
+        ('bold', '/help'),
         ('', '" or "'),
-        ('bold', r'\?'),
+        ('bold', r'/?'),
         ('', '"\n'),
     ])
     app.print_text([

{mycli-2.27.0 → mycli-2.28.0}/mycli/main_modes/checkup.py

@@ -34,8 +34,8 @@ def _dependencies_checkup() -> None:
         ('pygments', 'required'),
         ('pymysql', 'required'),
         ('sqlglot', 'required'),
-        ('sqlglotc', 'required'),
         ('tabulate', 'required'),
+        ('sqlglotc', 'optional for performance'),
         ('llm', 'optional for /llm command'),
         ('polars', 'optional for .| operator'),
         ('altair', 'optional for .| operator'),
@@ -71,8 +71,8 @@ def _environment_checkup() -> None:
     print('\n### Environment variables:\n')
     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'),
+        ('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):
             table.append([f'${variable}', value, purpose])

{mycli-2.27.0 → mycli-2.28.0}/mycli/main_modes/repl.py

@@ -530,33 +530,40 @@ def _output_results(
         else:
             max_width = None
 
-        formatted = mycli.format_sqlresult(
-            result,
-            is_expanded=special.is_expanded_output(),
-            is_redirected=special.is_redirected(),
-            null_string=mycli.null_string,
-            numeric_alignment=mycli.numeric_alignment,
-            binary_display=mycli.binary_display,
-            max_width=max_width,
-        )
+        runner = runner_for(mycli)
+        with runner.rendering() if runner else nullcontext():
+            formatted = mycli.format_sqlresult(
+                result,
+                is_expanded=special.is_expanded_output(),
+                is_redirected=special.is_redirected(),
+                null_string=mycli.null_string,
+                numeric_alignment=mycli.numeric_alignment,
+                binary_display=mycli.binary_display,
+                max_width=max_width,
+            )
 
-        duration = time.time() - start
-        try:
-            if result_count > 0:
-                mycli.echo('')
+            duration = time.time() - start
             try:
-                mycli.output(formatted, result)
+                if result_count > 0:
+                    if runner:
+                        runner.stop_rendering()
+                    mycli.echo('')
+                try:
+                    mycli.output(formatted, result)
+                except KeyboardInterrupt:
+                    if raise_interrupts:
+                        raise
+                finally:
+                    if runner:
+                        runner.stop_rendering()
+                if mycli.beep_after_seconds > 0 and duration >= mycli.beep_after_seconds:
+                    assert mycli.prompt_session is not None
+                    mycli.prompt_session.output.bell()
+                if special.is_timing_enabled():
+                    mycli.output_timing(f'Time: {duration:0.03f}s')
             except KeyboardInterrupt:
                 if raise_interrupts:
                     raise
-            if mycli.beep_after_seconds > 0 and duration >= mycli.beep_after_seconds:
-                assert mycli.prompt_session is not None
-                mycli.prompt_session.output.bell()
-            if special.is_timing_enabled():
-                mycli.output_timing(f'Time: {duration:0.03f}s')
-        except KeyboardInterrupt:
-            if raise_interrupts:
-                raise
 
         start = time.time()
         result_count += 1
@@ -1137,7 +1144,7 @@ def _tips_picker() -> str:
     except FileNotFoundError:
         pass
 
-    return random.choice(tips) if tips else r'\? or "help" for help!'
+    return random.choice(tips) if tips else r'/? or /help for help!'
 
 
 def _configure_editor(mycli: 'MyCli') -> None:

{mycli-2.27.0 → mycli-2.28.0}/mycli/output.py

@@ -344,7 +344,11 @@ class OutputMixin(MyCliState):
         if result.postamble:
             output = itertools.chain(output, [result.postamble])
 
-        return output
+        def finalized_output() -> Generator[str, None, None]:
+            yield from output
+            result.finalize_status()
+
+        return itertools.chain(finalized_output())
 
     def get_reserved_space(self) -> int:
         """Get the number of lines to reserve for the completion menu."""

mycli-2.28.0/mycli/packages/fzf.py

@@ -0,0 +1,78 @@
+"""Inspired by
+https://github.com/nk412/pyfzf
+and the fork
+https://github.com/purarue/pyfzf
+
+This code is trivially short and very far from the originals, but the MIT license
+header from pyfzf is included anyway.
+"""
+
+# Portions Copyright (c) 2022 Nagarjuna Kumarappan
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+from shutil import which
+import subprocess
+from typing import Any, Iterable
+
+DELIMITER = '\x00'
+
+
+class Fzf:
+    def __init__(
+        self,
+        executable: str = 'fzf',
+    ):
+        self.executable: str | None = executable
+
+        if not which(executable):
+            self.executable = None
+
+    def is_available(self) -> bool:
+        return self.executable is not None
+
+    def prompt(
+        self,
+        items: Iterable[Any],
+        options: list[str] | None = None,
+    ) -> str | None:
+        options_final = ['--read0', '--print0'] + (options or [])
+
+        fzf_process = subprocess.Popen(
+            [self.executable or 'fzf', *options_final],
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            encoding='utf-8',
+        )
+
+        assert fzf_process.stdin is not None, 'Error creating fzf input stream'
+        try:
+            for item in items:
+                fzf_process.stdin.write(str(item) + DELIMITER)
+        except BrokenPipeError:
+            pass
+
+        stdout_str, _stderr_str = fzf_process.communicate()
+
+        if stdout_str:
+            # in mycli there is no meaning for multiple selection, so
+            # just return the first item
+            return stdout_str.split(DELIMITER)[0]
+
+        return None

mycli-2.27.0/mycli/packages/ptoolkit/fzf.py → mycli-2.28.0/mycli/packages/ptoolkit/fzf_history.py

@@ -4,22 +4,12 @@ from shutil import which
 
 from prompt_toolkit import search
 from prompt_toolkit.key_binding.key_processor import KeyPressEvent
-from pyfzf import FzfPrompt
 
+from mycli.packages.fzf import Fzf
 from mycli.packages.ptoolkit.history import FileHistoryWithTimestamp
 from mycli.packages.ptoolkit.utils import safe_invalidate_display
 
 
-class Fzf(FzfPrompt):
-    def __init__(self):
-        self.executable = which("fzf")
-        if self.executable:
-            super().__init__()
-
-    def is_available(self) -> bool:
-        return self.executable is not None
-
-
 def search_history(
     event: KeyPressEvent,
     highlight_preview: bool = False,
@@ -60,17 +50,17 @@ def search_history(
     ]
 
     if highlight_preview and which('pygmentize'):
-        options.append(f'--preview="printf \'%s\' {{}} | pygmentize -l mysql -P style={shlex.quote(highlight_style)}"')
+        options.append(f'--preview=printf \'%s\' {{}} | pygmentize -l mysql -P style={shlex.quote(highlight_style)}')
     else:
-        options.append('--preview="printf \'%s\' {}"')
+        options.append('--preview=printf \'%s\' {}')
 
     result = fzf.prompt(
         formatted_history_items,
-        fzf_options=' '.join(options),
+        options=options,
     )
     safe_invalidate_display(event.app)
 
     if result:
-        selected_index = formatted_history_items.index(result[0])
+        selected_index = formatted_history_items.index(result)
         buffer.text = original_history_items[selected_index]
         buffer.cursor_position = len(buffer.text)

{mycli-2.27.0 → mycli-2.28.0}/mycli/packages/special/__init__.py

@@ -1,11 +1,3 @@
-__lazy_modules__ = [
-    'mycli.packages.special.dbcommands',
-    'mycli.packages.special.iocommands',
-    'mycli.packages.special.llm',
-    'mycli.packages.special.main',
-    'mycli.packages.special.source',
-]
-
 import os
 
 from mycli.packages.special.dbcommands import (