mycli 2.28.0__tar.gz → 2.28.1__tar.gz

mycli-2.28.1/.git-blame-ignore-revs

@@ -0,0 +1,43 @@
+# rename "toolkit" to "ptoolkit"
+d891e5ae670c44b96ecd79fca36da91748d8c44a
+4c8b5bfb314ed8998b8652613f0669fe58537a62
+# gather pytest files in a subdirectory
+9dbad2c5be3786eacbb127362b9b37f41b4d4785
+eb4526c66f141734b806d4782968135772f39557
+# refactor moves 2026-10-03
+07df6f36996c7c7c8665ef58dbabf735eff12557
+95e378d136a5fd115469aa3931b551c50f8f93e1
+25951150261aa6d64d4ea2efc4aad77a25b39e83
+b7dc69e6aa254b89c3b9ad4284b01e8d00202d42
+9b287611156b7529769e739ce0aed455b216a5e3
+69c403e947feef0a9f974fe42fc79de5f7794eec
+e071c7d4384e3ef1c95c624de710fc3ebfdc5ef6
+6f4308c986319efaf29a4284746b0152dc1265bd
+e2b09f4084cb7a0c3558928ce97ef0a89748e577
+d0f950a112e2f151581fa8037d37ecf69e292530
+f551bc5f4a8bbf27464bb3136d32ae869de2ac0a
+4eae45347e6a118520be85892984afff2bda36aa
+b61da9f98ccfef415d3773ff7bfc20c2ab695d53
+88929f0f1dec04544328e468d0b7b95f646d2ee2
+b6e3034b5b72ef3db975bf3a039f1c8c1d023789
+a710112ae1670e76681200ad6475c56ee91e1725
+59be294e6a87378618064ef055520cbab7648c94
+ef787f1134d77b01a334d059d578ce2f56e34e5a
+861931b0e75cd1d54270b535f1773d80923a904f
+a5cf52b5610589ce56399da9d2c5886bd3a669c5
+abb4b583d8c81eb8d2f3d3123cfda23cb9e47953
+e7ead2dcd8fb1c6df089eb1b42a05fd50db69466
+37a2bb563edcb68b5a2e7e7ec6331bec7e9d8a76
+5ad8d7b7b5acc4abdc4050cae38a58782c48e56f
+9b311151154a36322369a321f3c11512f50539b5
+c093369d557e59fd212e99e01150ebbb3a2fc6ea
+5cbc7919445d6d7121cc231ea37c8ed1ca21365e
+de595f2618657b0decbcf9fe827168d0e1e8e38b
+cfc1080e75baf2a8086322420666be685d6886a8
+2c364de0bfd397132f7a2c5c751b8e8df829cfe1
+5ebb1cb7f2613c820b83dfae3f90591a17fcc930
+0b8d7677d3fd396f515dd5f46cdb47c3da3885bd
+bb6ba73a39bc166c6a9968476999a9c08b63ccc8
+5c6dfea7b2dd5219901141935f29577bbf1fef55
+9b3e5921d0b9d05fcd422202c5e3aef6db01e205
+4caa83e882a1bf32c2e8da89608ad57b4a5dc136

{mycli-2.28.0 → mycli-2.28.1}/.github/PULL_REQUEST_TEMPLATE.md

@@ -6,7 +6,7 @@
 ## Checklist
 <!--- We appreciate your help and want to give you credit. Place an `x` in the boxes below as you complete them. -->
 - [ ] I added this contribution to the `changelog.md` file.
-- [ ] I added my name to the `AUTHORS` file (or it's already there).
+- [ ] I added my name to the `mycli/AUTHORS.txt` file (or it's already there).
 - [ ] To lint and format the code, I ran
     ```bash
     uv run ruff check && uv run ruff format && uv run mypy --install-types .

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

@@ -7,9 +7,9 @@ on:
       - '**.rst'
       - 'LICENSE.txt'
       - 'doc/**/*.txt'
-      - '**/AUTHORS'
-      - '**/SPONSORS'
-      - '**/TIPS'
+      - '**/AUTHORS.txt'
+      - '**/SPONSORS.txt'
+      - '**/TIPS.txt'
 
 jobs:
   tests:

{mycli-2.28.0 → mycli-2.28.1}/.github/workflows/lint.yml

@@ -7,9 +7,9 @@ on:
       - '**.rst'
       - 'LICENSE.txt'
       - 'doc/**/*.txt'
-      - '**/AUTHORS'
-      - '**/SPONSORS'
-      - '**/TIPS'
+      - '**/AUTHORS.txt'
+      - '**/SPONSORS.txt'
+      - '**/TIPS.txt'
 
 jobs:
   linters:

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

@@ -7,9 +7,9 @@ on:
       - '**.rst'
       - 'LICENSE.txt'
       - 'doc/**/*.txt'
-      - '**/AUTHORS'
-      - '**/SPONSORS'
-      - '**/TIPS'
+      - '**/AUTHORS.txt'
+      - '**/SPONSORS.txt'
+      - '**/TIPS.txt'
 
 jobs:
   typecheck:

mycli-2.28.1/AGENTS.md

@@ -0,0 +1,149 @@
+# Mycli
+
+Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes.
+
+## Project Structure
+
+    /                                                     # repository root
+    ├── .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
+    ├── mycli/cli_runner.py                               # connects and dispatches main modes based on CLI arguments
+    ├── mycli/client_commands.py                          # special commands which must be registered separately
+    ├── mycli/client_connection.py                        # `ClientConnectionMixin` mixin for establishing the database connection
+    ├── mycli/client_query.py                             # `ClientQueryMixin` mixin for running queries and refreshing completions
+    ├── mycli/client.py                                   # the `MyCli` "god class"
+    ├── mycli/compat.py                                   # OS compatibility helpers
+    ├── mycli/config.py                                   # configuration file readers and utilities
+    ├── mycli/constants.py                                # shared constants
+    ├── mycli/main.py                                     # processes CLI arguments
+    ├── mycli/main_modes/                                 # main execution paths
+    ├── mycli/main_modes/batch.py                         # `--batch` mode
+    ├── mycli/main_modes/checkup.py                       # `--checkup` mode
+    ├── mycli/main_modes/completions.py                   # `--completions` mode
+    ├── mycli/main_modes/execute.py                       # `--execute` mode
+    ├── mycli/main_modes/list_dsn.py                      # `--list-dsn` mode
+    ├── mycli/main_modes/repl.py                          # interactive REPL mode
+    ├── mycli/myclirc                                     # project-level configuration file
+    ├── mycli/output.py                                   # `OutputMixin` mixin for feedback and output of query results
+    ├── mycli/packages/                                   # application packages
+    ├── mycli/packages/completion/completion_engine.py    # implementation of completion suggestions
+    ├── mycli/packages/completion/completion_refresher.py # populates a `SQLCompleter` object in a background thread
+    ├── mycli/packages/completion/schema_prefetcher.py    # background prefetcher for multi-schema auto-completion
+    ├── mycli/packages/completion/sql_completer.py        # finds SQL completion candidates
+    ├── mycli/packages/credentials/password_sources.py    # password sources and precedence
+    ├── mycli/packages/dataframes/completion.py           # completions for `.|` transforms
+    ├── mycli/packages/dataframes/transform.py            # implements `.|` transforms
+    ├── mycli/packages/execution/background_runner.py     # run queries in the background, with query state and timing updates
+    ├── mycli/packages/execution/sql_execute.py           # `SQLExecute` class and friends
+    ├── mycli/packages/integrations/                      # integrations with fzf, Boundary, Kubernetes, macOS, OpenSSH, and Vault
+    ├── mycli/packages/prompt_toolkit/fzf_history.py      # uses fzf integration to serach the prompt_toolkit history
+    ├── mycli/packages/prompt_toolkit/history.py          # extends the prompt_toolkit history class
+    ├── mycli/packages/prompt_toolkit/key_bindings.py     # prompt_toolkit key bindings
+    ├── mycli/packages/prompt_toolkit/multiline.py        # prompt_toolkit multiline input
+    ├── mycli/packages/prompt_toolkit/style.py            # prompt_toolkit (and Pygments) styles
+    ├── mycli/packages/prompt_toolkit/toolbar.py          # prompt_toolkit bottom toolbar
+    ├── mycli/packages/prompt_toolkit/utils.py            # general utility functions for prompt_toolkit
+    ├── mycli/packages/pygments/mycli_lexer.py            # extends `MySqlLexer` from Pygments
+    ├── mycli/packages/redirection/                       # implementation of shell-style redirects
+    ├── mycli/packages/special_commands/                  # implementation of mycli special commands
+    ├── mycli/packages/sql_result/sql_result.py           # the `SQLResult` dataclass for holding responses
+    ├── mycli/packages/tabular_output/                    # extends cli_helper with additional output formats
+    ├── mycli/packages/utils/batch_utils.py               # utilities for `--batch` mode
+    ├── mycli/packages/utils/cli_utils.py                 # utilities for parsing CLI arguments
+    ├── mycli/packages/utils/interactive_utils.py         # utilities for confirming on destructive statements
+    ├── mycli/packages/utils/key_binding_utils.py         # handlers for key bindings and related special commands
+    ├── mycli/packages/utils/keyring_utils.py             # saved credential utilities
+    ├── mycli/packages/utils/path_utils.py                # utilities for files, including completion suggestions
+    ├── mycli/packages/utils/sql_utils.py                 # utilities for parsing SQL statements
+    ├── mycli/packages/utils/string_utils.py              # generic string utilities
+    ├── mycli/resources/completions/                      # shell completions for CLI interface
+    ├── mycli/types.py                                    # shared types
+    ├── mycli_test/features/                              # behave tests
+    ├── mycli_test/myclirc                                # mycli configuration used for tests
+    ├── mycli_test/mylogin.cnf                            # `mylogin.cnf` example used for tests
+    ├── mycli_test/pytests/                               # pytest tests
+    ├── mycli_test/pytests/conftest.py                    # pytest configuration
+    └── mycli_test/utils.py                               # shared utilities for tests
+
+## Development
+
+### Python
+
+#### Python Dependency Management
+
+This repo uses `uv` for dependency management. **Always** prefix Python
+commands with `uv run`.  Example:
+
+```bash
+env -u PYTHONPATH uv run -- python script.py
+```
+
+#### Python Typing
+
+This repo uses type annotations which are checked by `mypy`.  **Always** add
+type annotations, and always check new code with `env -u PYTHONPATH uv run -- mypy --install-types --non-interactive script.py`.
+
+Use lower-case type annotations such as `tuple`, not upper-case type
+annotations such as `Tuple`.
+
+Use `Type | None` instead of `Optional[Type]`.
+
+#### Python Testing
+
+Tests are coordinated by `tox`, and include both `pytest` and `behave` tests.
+To run the full test suite, execute `env -u PYTHONPATH uv run -- tox`.
+
+#### Python Compatibility
+
+Use Python features available from Python 3.11 through Python 3.14.
+Compatibility with Python 3.9 is not needed.  Compatibility with Python
+3.10 is not needed.
+
+#### Python Style
+
+Import style: prefer `from package import name` over `import package.name as name`.
+
+Quoting style: prefer single quotes for new code, but do not remove double quotes
+from existing code.
+
+#### Python Environment
+
+ * Package manager: `uv` (not pip)
+ * Formatter: `env -u PYTHONPATH uv run -- ruff format`
+ * Linter: `env -u PYTHONPATH uv run -- ruff check`
+ * Type checker: `env -u PYTHONPATH uv run -- mypy --install-types --non-interactive`
+
+### Git Workflows
+
+#### Git Commit Messages
+
+ * Use the present tense.
+ * Keep the first line under 50 characters in length.
+ * Keep the second line blank.
+ * Keep all other lines under 72 characters in length.
+ * Reference issue numbers when available.
+
+#### Generating PRs
+
+When generating a PR, follow the instructions in `.github/PULL_REQUEST_TEMPLATE.md`:
+
+ * Add new author names to `mycli/AUTHORS.txt`.
+ * Add a new entry to `changelog.md`.
+
+### Code Comments
+
+Keep comments concise and direct.  Use full sentences, ending with a period.
+
+### See Also
+
+See also the file `CONTRIBUTING.md`.

mycli-2.28.1/AUTHORS.md

@@ -0,0 +1 @@
+See [AUTHORS.txt](mycli/AUTHORS.txt)

{mycli-2.28.0 → mycli-2.28.1}/CONTRIBUTING.md

@@ -126,7 +126,7 @@ readlink -f $(which ex)
 # GitHub PR checklist
 
  * add the contribution to `changelog.md`
- * add your name to the `AUTHORS` file (or make sure it is already there)
+ * add your name to the `mycli/AUTHORS.txt` file (or make sure it is already there)
  * run
 
     ```bash

mycli-2.28.1/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE.txt *.md *.rst doc/screenshots/*
+recursive-include mycli/resources/completions *
+recursive-include mycli_test *.cnf
+recursive-include mycli_test *.feature
+recursive-include mycli_test *.py
+recursive-include mycli_test *.txt

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mycli
-Version: 2.28.0
+Version: 2.28.1
 Summary: Rich MySQL terminal client with autocompletion, syntax highlighting, and dataframes
 Author: Mycli Core Team
 License-Expression: BSD-3-Clause
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: SQL
 Classifier: Topic :: Database
 Classifier: Topic :: Database :: Front-Ends

mycli-2.28.1/SPONSORS.md

@@ -0,0 +1 @@
+See [SPONSORS.txt](mycli/SPONSORS.txt)

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

@@ -1,3 +1,34 @@
+v2.28.1 (2026/10/03)
+==============
+
+Documentation
+--------
+* Align all uses of one-line app description with `README.md`.
+
+
+Internal
+--------
+* Add Python 3.15 trove classifier.
+* Move Polars files to `dataframes` package directory.
+* Move various utility files to a `utils` directory.
+* Move various completion files to a `completion` directory.
+* Move `fzf.py` inside a package directory.
+* Move `hybrid_redirection.py` inside a package directory.
+* Move `sql_result.py` inside a package directory.
+* Rename `special` package to `special_commands`.
+* Move various integrations to an `integrations` directory.
+* Move various `prompt_toolkit` extensions to the `ptoolkit` directory.
+* Rename the `ptoolkit` package to `prompt_toolkit`.
+* Move `mycli_lexer.py` to a `pygments` package directory.
+* Move `password_sources.py` to a `credentials` package directory.
+* Create an `execution` package directory for `sql_execute.py` and `background_runner.py`.
+* Add `.txt` to text files without file extensions.
+* Move `test` directory to `mycli_test`.
+* Ignore recent refactoring move commits in `git-blame`.
+* Recast `cli_is_multiline()` as `repl_is_multiline()`.
+* Align some imports and variable names to match filename moves.
+
+
 v2.28.0 (2026/10/02)
 ==============
 

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

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

{mycli-2.28.0 → mycli-2.28.1}/mycli/cli_runner.py

@@ -14,10 +14,10 @@ __lazy_modules__ = [
     'mycli.main_modes.completions',
     'mycli.main_modes.execute',
     'mycli.main_modes.list_dsn',
-    'mycli.packages.cli_utils',
-    'mycli.packages.special.dsn_aliases',
-    'mycli.password_sources',
-    'mycli.vault',
+    'mycli.packages.special_commands.dsn_aliases',
+    'mycli.packages.utils.cli_utils',
+    'mycli.packages.credentials.password_sources',
+    'mycli.packages.integrations.vault.vault_credentials',
 ]
 
 import os
@@ -35,16 +35,16 @@ from mycli.main_modes.checkup import main_checkup
 from mycli.main_modes.completions import main_completions
 from mycli.main_modes.execute import main_execute_from_cli
 from mycli.main_modes.list_dsn import main_list_dsn
-from mycli.packages.cli_utils import is_valid_connection_scheme
-from mycli.packages.special.dsn_aliases import INVALID_DSN_ALIAS_ERROR, is_valid_dsn_alias
-from mycli.password_sources import PasswordCandidates
-from mycli.vault import (
+from mycli.packages.credentials.password_sources import PasswordCandidates
+from mycli.packages.integrations.vault.vault_credentials import (
     DEFAULT_VAULT_EXECUTABLE,
     DEFAULT_VAULT_PASSWORD_FIELD,
     DEFAULT_VAULT_USERNAME_FIELD,
     VaultError,
     get_field_from_vault,
 )
+from mycli.packages.special_commands.dsn_aliases import INVALID_DSN_ALIAS_ERROR, is_valid_dsn_alias
+from mycli.packages.utils.cli_utils import is_valid_connection_scheme
 
 if TYPE_CHECKING:
     from mycli.main import CliArgs

{mycli-2.28.0 → mycli-2.28.1}/mycli/client.py

@@ -20,12 +20,9 @@ from mycli.app_state import (
     normalize_image_protocol,
     normalize_ssl_mode,
 )
-from mycli.boundary_tunnel import BoundaryTunnel
 from mycli.client_commands import ClientCommandsMixin, get_config_property_names
 from mycli.client_connection import ClientConnectionMixin
 from mycli.client_query import ClientQueryMixin
-from mycli.clistyle import style_factory_helpers, style_factory_ptoolkit
-from mycli.completion_refresher import CompletionRefresher
 from mycli.config import (
     get_mylogin_cnf_path,
     open_mylogin_cnf,
@@ -34,17 +31,20 @@ from mycli.config import (
     write_default_config,
 )
 from mycli.constants import DEFAULT_PROMPT
-from mycli.kubectl_tunnel import KubectlTunnel
 from mycli.main_modes import repl as repl_package
 from mycli.output import OutputMixin
-from mycli.packages import special
-from mycli.packages.special.dsn_aliases import DsnAliases
-from mycli.packages.special.favoritequeries import FavoriteQueries
+from mycli.packages import special_commands
+from mycli.packages.completion.completion_refresher import CompletionRefresher
+from mycli.packages.completion.schema_prefetcher import SchemaPrefetcher
+from mycli.packages.completion.sql_completer import SQLCompleter
+from mycli.packages.execution.sql_execute import SQLExecute
+from mycli.packages.integrations.boundary.boundary_tunnel import BoundaryTunnel
+from mycli.packages.integrations.kubernetes.kubectl_tunnel import KubectlTunnel
+from mycli.packages.integrations.openssh.ssh_tunnel import SshTunnel
+from mycli.packages.prompt_toolkit.style import style_factory_helpers, style_factory_prompt_toolkit
+from mycli.packages.special_commands.dsn_aliases import DsnAliases
+from mycli.packages.special_commands.favorite_queries import FavoriteQueries
 from mycli.packages.tabular_output import sql_format
-from mycli.schema_prefetcher import SchemaPrefetcher
-from mycli.sqlcompleter import SQLCompleter
-from mycli.sqlexecute import SQLExecute
-from mycli.ssh_tunnel import SshTunnel
 from mycli.types import Query
 
 sqlparse.engine.grouping.MAX_GROUPING_DEPTH = None  # type: ignore[assignment]
@@ -56,7 +56,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
     default_prompt_splitln = r'\u@\h\n(\t):\d>\_'
     max_len_prompt = 45
     prompt_lines: int
-    sqlexecute: SQLExecute | None
+    sql_execute: SQLExecute | None
     numeric_alignment: str
 
     # check XDG_CONFIG_HOME exists and not an empty string
@@ -68,7 +68,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
 
     def __init__(
         self,
-        sqlexecute: SQLExecute | None = None,
+        sql_execute: SQLExecute | None = None,
         prompt: str | None = None,
         toolbar_format: str | None = None,
         logfile: TextIOWrapper | Literal[False] | None = None,
@@ -79,7 +79,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         show_warnings: bool | None = None,
         cli_verbosity: int = 0,
     ) -> None:
-        self.sqlexecute = sqlexecute
+        self.sql_execute = sql_execute
         self.ssh_tunnel: SshTunnel | None = None
         self.kubectl_tunnel: KubectlTunnel | None = None
         self.boundary_tunnel: BoundaryTunnel | None = None
@@ -111,12 +111,12 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         self.key_bindings = c["main"]["key_bindings"]
         self.emacs_ttimeoutlen = c['keys'].as_float('emacs_ttimeoutlen')
         self.vi_ttimeoutlen = c['keys'].as_float('vi_ttimeoutlen')
-        special.set_timing_enabled(c["main"].as_bool("timing"))
-        special.set_show_favorite_query(c["main"].as_bool("show_favorite_query"))
+        special_commands.set_timing_enabled(c["main"].as_bool("timing"))
+        special_commands.set_show_favorite_query(c["main"].as_bool("show_favorite_query"))
         if show_warnings is not None:
-            special.set_show_warnings_enabled(show_warnings)
+            special_commands.set_show_warnings_enabled(show_warnings)
         else:
-            special.set_show_warnings_enabled(c['main'].as_bool('show_warnings'))
+            special_commands.set_show_warnings_enabled(c['main'].as_bool('show_warnings'))
         self.beep_after_seconds = float(c["main"]["beep_after_seconds"] or 0)
         self.default_keepalive_ticks = c['connection'].as_int('default_keepalive_ticks')
 
@@ -150,7 +150,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         if cli_verbosity:
             self.verbosity = cli_verbosity
         self.cli_style = c["colors"]
-        self.ptoolkit_style = style_factory_ptoolkit(self.syntax_style, self.cli_style)
+        self.prompt_toolkit_style = style_factory_prompt_toolkit(self.syntax_style, self.cli_style)
         self.helpers_style = style_factory_helpers(self.syntax_style, self.cli_style)
         self.helpers_warnings_style = style_factory_helpers(self.syntax_style, self.cli_style, warnings=True)
         self.wider_completion_menu = c["main"].as_bool("wider_completion_menu")
@@ -247,7 +247,7 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
         configure_prompt_state(self, c, prompt, toolbar_format)
         self.prompt_session = None
         self.destructive_keywords = destructive_keywords_from_config(c)
-        special.set_destructive_keywords(self.destructive_keywords)
+        special_commands.set_destructive_keywords(self.destructive_keywords)
 
     def _invalidate_prompt_session(self) -> None:
         if self.prompt_session:
@@ -262,9 +262,9 @@ class MyCli(AppStateMixin, OutputMixin, ClientCommandsMixin, ClientConnectionMix
             self.schema_prefetcher.stop()
         except Exception:
             pass
-        if self.sqlexecute is not None:
+        if self.sql_execute is not None:
             try:
-                self.sqlexecute.close()
+                self.sql_execute.close()
             except Exception:
                 pass
         if self.ssh_tunnel is not None:

{mycli-2.28.0 → mycli-2.28.1}/mycli/client_commands.py

@@ -11,19 +11,19 @@ import click
 
 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.main import ArgType, SpecialCommandAlias
-from mycli.packages.special.source import (
+from mycli.packages import special_commands
+from mycli.packages.execution.sql_execute import SQLExecute
+from mycli.packages.prompt_toolkit.history import FileHistoryWithTimestamp
+from mycli.packages.special_commands.main import ArgType, SpecialCommandAlias
+from mycli.packages.special_commands.source import (
     SOURCE_HELP_ROWS,
     parse_source_arguments,
     source_special_command_is_safe,
 )
-from mycli.packages.sqlresult import SQLResult
-from mycli.sqlexecute import SQLExecute
+from mycli.packages.sql_result.sql_result import SQLResult
+from mycli.packages.utils.batch_utils import statements_from_filehandle
+from mycli.packages.utils.interactive_utils import confirm_destructive_query
+from mycli.packages.utils.path_utils import dir_path_exists
 
 CONFIG_COMMAND_USAGE = '''Syntax:
   /config get <key>
@@ -96,7 +96,7 @@ class ClientCommandsMixin:
     if TYPE_CHECKING:
         main_formatter: Any
         redirect_formatter: Any
-        sqlexecute: Any
+        sql_execute: Any
         destructive_warning: bool
         destructive_keywords: Any
         config: Any
@@ -109,7 +109,7 @@ class ClientCommandsMixin:
         def echo(self, *args: Any, **kwargs: Any) -> None: ...
 
     def register_special_commands(self) -> None:
-        special.register_special_command(
+        special_commands.register_special_command(
             self.change_db,
             "use",
             "/use <database>",
@@ -117,7 +117,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\u", case_sensitive=False)],
             completion_snippet='change databases',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.manual_reconnect,
             "connect",
             "/connect [database]",
@@ -126,7 +126,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\r", case_sensitive=True)],
             completion_snippet='reconnect to server',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.rehash,
             "rehash",
             "/rehash",
@@ -135,7 +135,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\#", case_sensitive=False)],
             completion_snippet='refresh completions',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.change_table_format,
             "tableformat",
             "/tableformat <format>",
@@ -144,7 +144,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\T", case_sensitive=True)],
             completion_snippet='set interactive output format',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.change_redirect_format,
             "redirectformat",
             "/redirectformat <format>",
@@ -153,7 +153,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\Tr", case_sensitive=True)],
             completion_snippet='set redirected output format',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.execute_from_file,
             "source",
             "/source [options] <file>",
@@ -161,7 +161,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\.", case_sensitive=False)],
             completion_snippet='execute queries from file',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.change_prompt_format,
             "prompt",
             "/prompt [string]",
@@ -170,7 +170,7 @@ class ClientCommandsMixin:
             aliases=[SpecialCommandAlias("\\R", case_sensitive=True)],
             completion_snippet='set prompt format',
         )
-        special.register_special_command(
+        special_commands.register_special_command(
             self.config_command,
             r'\config',
             '/config <command> [key]',
@@ -274,13 +274,13 @@ class ClientCommandsMixin:
             click.secho("No database selected", err=True, fg="red")
             return
 
-        assert isinstance(self.sqlexecute, SQLExecute)
+        assert isinstance(self.sql_execute, SQLExecute)
 
-        if self.sqlexecute.dbname == arg:
-            msg = f'You are already connected to database "{self.sqlexecute.dbname}" as user "{self.sqlexecute.user}"'
+        if self.sql_execute.dbname == arg:
+            msg = f'You are already connected to database "{self.sql_execute.dbname}" as user "{self.sql_execute.user}"'
         else:
-            self.sqlexecute.change_db(arg)
-            msg = f'You are now connected to database "{self.sqlexecute.dbname}" as user "{self.sqlexecute.user}"'
+            self.sql_execute.change_db(arg)
+            msg = f'You are now connected to database "{self.sql_execute.dbname}" as user "{self.sql_execute.user}"'
 
         # todo: this jump back to repl.py is a sign that separation is incomplete.
         # also: it should not be needed.  Don't titles update on every new prompt?
@@ -310,7 +310,7 @@ class ClientCommandsMixin:
             yield SQLResult(status=str(error))
             return
 
-        assert isinstance(self.sqlexecute, SQLExecute)
+        assert isinstance(self.sql_execute, SQLExecute)
         executed_statement = False
         with file_h:
             statements = statements_from_filehandle(file_h)
@@ -324,7 +324,7 @@ class ClientCommandsMixin:
                     return
 
                 special_query = query.rstrip(';')
-                if special.is_special_command(special_query):
+                if special_commands.is_special_command(special_query):
                     if not source_arguments.allow_special:
                         yield SQLResult(
                             status='Special commands are not supported without /source --special.',
@@ -332,7 +332,7 @@ class ClientCommandsMixin:
                         )
                         return
                     if not source_special_command_is_safe(special_query):
-                        command, _verbosity, _arg = special.parse_special_command(special_query)
+                        command, _verbosity, _arg = special_commands.parse_special_command(special_query)
                         yield SQLResult(
                             status=f'Special command is never permitted in source files: {command}.',
                             is_error=True,
@@ -345,7 +345,7 @@ class ClientCommandsMixin:
                             yield SQLResult(command={'name': 'source_show', 'text': special_query})
                         else:
                             click.secho(f'> {special_query}')
-                    yield from self.sqlexecute.run(special_query)
+                    yield from self.sql_execute.run(special_query)
                     executed_statement = True
                     continue
 
@@ -358,7 +358,7 @@ class ClientCommandsMixin:
                         yield SQLResult(command={'name': 'source_show', 'text': query})
                     else:
                         click.secho(f'> {query}')
-                yield from self.sqlexecute.run(query)
+                yield from self.sql_execute.run(query)
                 executed_statement = True
 
     def change_prompt_format(self, arg: str, **_) -> list[SQLResult]: