harlequin 2.1.3__tar.gz → 2.2.0__tar.gz

harlequin-2.2.0/.gitignore

@@ -0,0 +1,181 @@
+*.db*
+*.db.wal
+*.csv
+*.json
+*.parquet
+*.sql
+*.sqlite
+!tests/data/**/*.db
+!tests/data/**/*.csv
+!tests/data/**/*.json
+!tests/data/**/*.parquet
+!tests/data/**/*.sql
+Pipfile
+snapshot_report.html
+.harlequin.toml
+.profiles
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+!tests/data/**/*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

{harlequin-2.1.3 → harlequin-2.2.0}/PKG-INFO

@@ -1,56 +1,53 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: harlequin
-Version: 2.1.3
+Version: 2.2.0
 Summary: The SQL IDE for Your Terminal.
-Home-page: https://harlequin.sh
-License: MIT
-Author: Ted Conbeer
-Author-email: tconbeer@users.noreply.github.com
-Requires-Python: >=3.9,<3.14.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
+Project-URL: Homepage, https://harlequin.sh
+Project-URL: Documentation, https://harlequin.sh/docs/getting-started/index
+Project-URL: Repository, https://github.com/tconbeer/harlequin
+Project-URL: Bug Tracker, https://github.com/tconbeer/harlequin/issues
+Project-URL: Changelog, https://github.com/tconbeer/harlequin/blob/main/CHANGELOG.md
+Author-email: Ted Conbeer <tconbeer@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: harlequin,ide,sql,tui
+Requires-Python: <3.14,>=3.9
+Requires-Dist: click==8.1.8
+Requires-Dist: duckdb>=0.8.0
+Requires-Dist: importlib-metadata>=8.0; python_version < '3.10'
+Requires-Dist: numpy<2.1.0,>=2.0.0; python_version < '3.10'
+Requires-Dist: numpy<2.3.0,>=2.1.0; python_version >= '3.10'
+Requires-Dist: platformdirs<5.0,>=3.10
+Requires-Dist: pyarrow>=18.1.0; python_version >= '3.12'
+Requires-Dist: questionary==2.0.1
+Requires-Dist: rich-click==1.8.5
+Requires-Dist: shandy-sqlfmt>=0.19.0
+Requires-Dist: textual-fastdatatable==0.12.0
+Requires-Dist: textual-textarea==0.15.0
+Requires-Dist: textual==0.89.1
+Requires-Dist: tomlkit<0.14.0,>=0.12.5
+Requires-Dist: tree-sitter-sql==0.3.7
+Requires-Dist: tree-sitter<0.25.0,>=0.23.0
 Provides-Extra: adbc
+Requires-Dist: harlequin-adbc; extra == 'adbc'
 Provides-Extra: bigquery
+Requires-Dist: harlequin-bigquery; extra == 'bigquery'
 Provides-Extra: cassandra
+Requires-Dist: harlequin-cassandra; extra == 'cassandra'
 Provides-Extra: databricks
+Requires-Dist: harlequin-databricks; extra == 'databricks'
 Provides-Extra: mysql
+Requires-Dist: harlequin-mysql; extra == 'mysql'
 Provides-Extra: nebulagraph
+Requires-Dist: harlequin-nebulagraph; extra == 'nebulagraph'
 Provides-Extra: odbc
+Requires-Dist: harlequin-odbc; extra == 'odbc'
 Provides-Extra: postgres
+Requires-Dist: harlequin-postgres; extra == 'postgres'
 Provides-Extra: s3
+Requires-Dist: boto3==1.34.22; extra == 's3'
 Provides-Extra: trino
-Requires-Dist: boto3 (>=1.34.22,<2.0.0) ; extra == "s3"
-Requires-Dist: click (==8.1.8)
-Requires-Dist: duckdb (>=0.8.0)
-Requires-Dist: harlequin-adbc (>=0.1) ; extra == "adbc"
-Requires-Dist: harlequin-bigquery (>=1.0.3) ; extra == "bigquery"
-Requires-Dist: harlequin-cassandra (>=0.1.2) ; extra == "cassandra"
-Requires-Dist: harlequin-databricks (>=0.5.2) ; extra == "databricks"
-Requires-Dist: harlequin-mysql (>=1.0) ; extra == "mysql"
-Requires-Dist: harlequin-nebulagraph (>=0.4.1) ; extra == "nebulagraph"
-Requires-Dist: harlequin-odbc (>=0.2) ; extra == "odbc"
-Requires-Dist: harlequin-postgres (>=1.0) ; extra == "postgres"
-Requires-Dist: harlequin-trino (>=0.1) ; extra == "trino"
-Requires-Dist: importlib_metadata (>=8.0) ; python_full_version < "3.10.0"
-Requires-Dist: numpy (>=2.0.0,<2.1.0) ; python_full_version < "3.10.0"
-Requires-Dist: numpy (>=2.1.0,<2.3.0) ; python_full_version >= "3.10.0"
-Requires-Dist: platformdirs (>=3.10,<5.0)
-Requires-Dist: pyarrow (>=18.1.0) ; python_full_version >= "3.12.0"
-Requires-Dist: questionary (>=2.0.1,<3.0.0)
-Requires-Dist: rich-click (==1.8.5)
-Requires-Dist: shandy-sqlfmt (>=0.19.0)
-Requires-Dist: textual (==0.89.1)
-Requires-Dist: textual-fastdatatable (==0.12.0)
-Requires-Dist: textual-textarea (==0.15.0)
-Requires-Dist: tomlkit (>=0.12.5,<0.14.0)
-Requires-Dist: tree-sitter (>=0.23.0,<0.25.0)
-Requires-Dist: tree-sitter-sql (==0.3.7)
-Project-URL: Repository, https://github.com/tconbeer/harlequin
+Requires-Dist: harlequin-trino; extra == 'trino'
 Description-Content-Type: text/markdown
 
 # Harlequin
@@ -100,7 +97,7 @@ Alternatively, if you know what you're doing, after installing Python 3.9 or abo
 pip install harlequin
 ```
 
-There is also a [Homebrew formula](https://formulae.brew.sh/formula/harlequin) for Harlequin, although this is maintained by the community and is not as rigorously tested as the Python installations. Note that the formula includes several Harlequin adapter packages (Postgres, MySQL, and ODBC) and their dependencies, which is convenient but increases the application size.
+There is also a [Homebrew formula](https://formulae.brew.sh/formula/harlequin) for Harlequin, although this is maintained by the community and is not as rigorously tested as the Python installations. Note that the formula includes several Harlequin adapter packages (Postgres, MySQL/MariaDB, and ODBC) and their dependencies, which is convenient but increases the application size.
 
 ```bash
 brew install harlequin
@@ -213,4 +210,3 @@ Please consider [sponsoring Harlequin's author](https://github.com/sponsors/tcon
 Thanks for your interest in Harlequin! Harlequin is primarily maintained by [Ted Conbeer](https://github.com/tconbeer), but he welcomes all contributions!
 
 Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for more information.
-

{harlequin-2.1.3 → harlequin-2.2.0}/README.md

@@ -45,7 +45,7 @@ Alternatively, if you know what you're doing, after installing Python 3.9 or abo
 pip install harlequin
 ```
 
-There is also a [Homebrew formula](https://formulae.brew.sh/formula/harlequin) for Harlequin, although this is maintained by the community and is not as rigorously tested as the Python installations. Note that the formula includes several Harlequin adapter packages (Postgres, MySQL, and ODBC) and their dependencies, which is convenient but increases the application size.
+There is also a [Homebrew formula](https://formulae.brew.sh/formula/harlequin) for Harlequin, although this is maintained by the community and is not as rigorously tested as the Python installations. Note that the formula includes several Harlequin adapter packages (Postgres, MySQL/MariaDB, and ODBC) and their dependencies, which is convenient but increases the application size.
 
 ```bash
 brew install harlequin

{harlequin-2.1.3/src → harlequin-2.2.0}/harlequin/actions.py

@@ -68,6 +68,11 @@ HARLEQUIN_ACTIONS = {
         target=None,
         action="toggle_full_screen",
     ),
+    "show_debug_info": Action(
+        target=None,
+        action="show_debug_info",
+        description="Debug Info",
+    ),
     "show_query_history": Action(
         target=None,
         action="show_query_history",

{harlequin-2.1.3/src → harlequin-2.2.0}/harlequin/adapter.py

@@ -207,12 +207,21 @@ class HarlequinAdapter(ABC):
     disregard any extra (unexpected) kwargs. They should not rely on the
     option's default values, as those will not be passed by the CLI when
     initializing the adapter.
+
+    Adapters can provide client-side (Harlequin adapter) details using the
+    ADAPTER_DETAILS class variable. It is expected to be formatted as markdown.
+
+    Adapters can also provide server-side (DB driver) details using the
+    ADAPTER_DRIVER_DETAILS class variable. It is expected to be formatted
+    as markdown.
     """
 
     ADAPTER_OPTIONS: list[HarlequinAdapterOption] | None = None
     COPY_FORMATS: list[HarlequinCopyFormat] | None = None
     """DEPRECATED. Adapter Copy formats are now ignored by Harlequin."""
     IMPLEMENTS_CANCEL = False
+    ADAPTER_DETAILS: str | None = None
+    ADAPTER_DRIVER_DETAILS: str | None = None
 
     @abstractmethod
     def __init__(self, conn_str: Sequence[str], **options: Any) -> None:
@@ -267,3 +276,20 @@ class HarlequinAdapter(ABC):
         also provide options for customizing the Export dialog GUI.
         """
         return self.COPY_FORMATS is not None
+
+    @property
+    def provides_details(self) -> bool:
+        """
+        True if the adapter provides an optional description of itself, visible
+        on Harlequin's debugging info screen, NOT including
+        driver or connection details, which should be ADAPTER_DRIVER_DETAILS.
+        """
+        return self.ADAPTER_DETAILS is not None
+
+    @property
+    def provides_driver_details(self) -> bool:
+        """
+        True if the adapter provides an optional description of its driver
+        or connection.
+        """
+        return self.ADAPTER_DRIVER_DETAILS is not None

{harlequin-2.1.3/src → harlequin-2.2.0}/harlequin/app.py

@@ -57,6 +57,7 @@ from harlequin.catalog_cache import (
 from harlequin.components import (
     CodeEditor,
     DataCatalog,
+    DebugInfoScreen,
     EditorCollection,
     ErrorModal,
     ExportScreen,
@@ -69,6 +70,12 @@ from harlequin.components import (
 from harlequin.components.confirm_modal import ConfirmModal
 from harlequin.components.data_catalog import ContextMenu
 from harlequin.components.data_catalog.tree import HarlequinTree
+from harlequin.components.debug_info import AdapterDebugInfo, HarlequinDebugInfo
+from harlequin.config import (
+    get_config_for_profile,
+    get_highest_priority_existing_config_file,
+    load_config,
+)
 from harlequin.copy_formats import HARLEQUIN_COPY_FORMATS, WINDOWS_COPY_FORMATS
 from harlequin.driver import HarlequinDriver
 from harlequin.editor_cache import BufferState, Cache
@@ -182,6 +189,7 @@ class Harlequin(AppBase):
     def __init__(
         self,
         adapter: HarlequinAdapter,
+        profile_name: str | None = None,
         *,
         keymap_names: Sequence[str] | None = None,
         user_defined_keymaps: Sequence[HarlequinKeyMap] | None = None,
@@ -201,6 +209,7 @@ class Harlequin(AppBase):
             watch_css=watch_css,
         )
         self.adapter = adapter
+        self.profile_name = profile_name
         self.connection_hash = connection_hash
         self.history: History | None = None
         self.show_files = show_files
@@ -279,6 +288,8 @@ class Harlequin(AppBase):
             and self.editor._has_focus_within
         ):
             self.editor.text_input._pause_blink(visible=True)
+
+        ## TODO: PREVENT DUPLICATE SCREENS HERE.
         return super().push_screen(  # type: ignore[no-any-return,call-overload]
             screen,
             callback=callback,
@@ -951,6 +962,47 @@ class Harlequin(AppBase):
     def action_show_help_screen(self) -> None:
         self.push_screen(HelpScreen(id="help_screen"))
 
+    def action_show_debug_info(self) -> None:
+        SCREEN_ID = "debug_info_screen"
+        if self.screen.id == SCREEN_ID:
+            # already showing this screen.
+            return
+
+        config_path = get_highest_priority_existing_config_file()
+        config = load_config(config_path)
+        profile_name = self.profile_name
+        active_profile_config, _ = get_config_for_profile(config_path, profile_name)
+        active_profile_name = profile_name or config.get("default_profile")
+        adapter_options = getattr(self.adapter, "ADAPTER_OPTIONS", None)
+        adapter_type = type(self.adapter).__name__
+
+        harlequin_info = HarlequinDebugInfo(
+            active_profile_config=active_profile_config,
+            active_profile_name=active_profile_name,
+            all_keymaps=list(self.all_keymaps.keys()),
+            config=config,
+            config_path=config_path,
+            keymap_names=self.keymap_names,
+            theme=self.theme,
+        )
+        adapter_info = AdapterDebugInfo(
+            adapter_options=adapter_options,
+            adapter_type=adapter_type,
+            adapter_details=self.adapter.ADAPTER_DETAILS
+            if self.adapter.provides_details
+            else "No details were provided by adapter.",
+            adapter_driver_details=self.adapter.ADAPTER_DRIVER_DETAILS
+            if self.adapter.provides_driver_details
+            else "No details were provided by the database driver.",
+        )
+        self.push_screen(
+            DebugInfoScreen(
+                harlequin_details=harlequin_info.parse_info(),
+                adapter_details=adapter_info.parse_info(),
+                id=SCREEN_ID,
+            )
+        )
+
     def action_toggle_full_screen(self) -> None:
         self.full_screen = not self.full_screen
 

{harlequin-2.1.3/src → harlequin-2.2.0}/harlequin/app.tcss

@@ -418,7 +418,9 @@ HelpScreen {
     padding: 0;
 }
 
-#help_outer {
+/* Shared Components */
+
+#modal_outer {
     border: round $border-color-focus;
     background: $background;
     margin: 2 4;
@@ -426,22 +428,22 @@ HelpScreen {
     max-width: 88;
 }
 
-#help_header {
+#modal_header {
     dock: top;
     margin: 0 0 1 0;
     padding: 0 1;
 }
 
-#help_inner {
+#modal_inner {
     border: round $border-color-nofocus;
     padding: 0 0 0 0;
 }
 
-#help_info {
+#modal_info {
     padding: 0 0 0 0;
 }
 
-#help_footer {
+#modal_footer {
     dock: bottom;
     color: $text-muted;
     margin: 1 0 0 0;
@@ -618,6 +620,12 @@ HistoryScreen .history-screen--error-label {
     text-style: bold italic;
 }
 
+/* DEBUG INFO SCREEN */
+
+DebugInfoScreen {
+    align: center middle;
+    padding: 0;
+}
 
 /* ConfirmModal */
 

{harlequin-2.1.3/src → harlequin-2.2.0}/harlequin/cli.py

@@ -367,6 +367,7 @@ def build_cli() -> click.Command:
 
         tui = Harlequin(
             adapter=adapter_instance,
+            profile_name=profile,
             keymap_names=keymap_names,
             user_defined_keymaps=user_defined_keymaps,
             connection_hash=connection_id,

{harlequin-2.1.3/src → harlequin-2.2.0}/harlequin/components/__init__.py

@@ -1,5 +1,6 @@
 from harlequin.components.code_editor import CodeEditor, EditorCollection
 from harlequin.components.data_catalog import DataCatalog, HarlequinTree
+from harlequin.components.debug_info import DebugInfoScreen
 from harlequin.components.error_modal import ErrorModal
 from harlequin.components.export_screen import ExportScreen, export_callback
 from harlequin.components.help_screen import HelpScreen
@@ -15,6 +16,7 @@ __all__ = [
     "export_callback",
     "HelpScreen",
     "ResultsTable",
+    "DebugInfoScreen",
     "ResultsViewer",
     "RunQueryBar",
     "DataCatalog",