pgcli 4.5.0__tar.gz → 4.6.0__tar.gz

{pgcli-4.5.0 → pgcli-4.6.0}/AUTHORS

@@ -144,10 +144,16 @@ Contributors:
     * Jay Knight (jay-knight)
     * fbdb
     * Charbel Jacquin (charbeljc)
+    * Jeronimo Garcia (bechampion)
     * Devadathan M B (devadathanmb)
     * Charalampos Stratakis
     * Laszlo Bimba (bimlas)
     * Anjanna
+    * Shayan Golshani (shgol)
+    * Tommi Kyntölä (kynde)
+    * Diego
+    * Chris (ChrisJr404)
+    * Pieter Ouwerkerk (pouwerkerk)
 
 Creator:
 --------

{pgcli-4.5.0 → pgcli-4.6.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pgcli
-Version: 4.5.0
+Version: 4.6.0
 Summary: CLI for Postgres Database. With auto-completion and syntax highlighting.
 Author-email: Pgcli Core Team <pgcli-dev@googlegroups.com>
-License: BSD
+License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://pgcli.com
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
@@ -29,7 +29,7 @@ Requires-Dist: Pygments>=2.0
 Requires-Dist: prompt_toolkit<4.0.0,>=2.0.6
 Requires-Dist: psycopg>=3.0.14; sys_platform != "win32"
 Requires-Dist: psycopg-binary>=3.0.14; sys_platform == "win32"
-Requires-Dist: sqlparse<0.6,>=0.3.0
+Requires-Dist: sqlparse<0.7,>=0.3.0
 Requires-Dist: configobj>=5.0.6
 Requires-Dist: cli_helpers[styles]>=2.4.0
 Requires-Dist: setproctitle>=1.1.9; sys_platform != "win32" and "CYGWIN" not in sys_platform

{pgcli-4.5.0 → pgcli-4.6.0}/changelog.rst

@@ -1,3 +1,31 @@
+4.6.0 (2026-08-26)
+==================
+
+Bug fixes:
+----------
+* Restore cursor shape behaviour for Emacs mode
+* Fix ``TypeError: cannot use a string pattern on a bytes-like object`` when
+  completion metadata comes back as bytes (e.g. ``SQL_ASCII`` client encoding).
+* Suggest columns, not datatypes, after a column literally named ``type`` in a ``SELECT`` list.
+* Allow ``sqlparse`` 0.6.x. sqlparse 0.6.0 fixes several denial-of-service
+  issues (CVE-2026-59893, CVE-2026-54284, CVE-2026-71491) and a string-escaping
+  bug (CVE-2026-59894); the previous ``<0.6`` cap prevented users from
+  installing the fixed release.
+
+Features:
+---------
+* Honor the ``PSQL_EDITOR`` environment variable when opening the external
+  editor (``\\e``, ``\\ev``, ``\\ef``, ``\\ne``), matching psql's precedence of
+  ``PSQL_EDITOR``, then ``EDITOR``, then ``VISUAL`` ([issue 1398](https://github.com/dbcli/pgcli/issues/1398)).
+* Add ``\\ne <name>`` to edit a named query in the external editor. Loads the
+  named query's SQL into ``$EDITOR``; on save it is written back to the
+  ``[named queries]`` section, creating it if it does not exist. Complements
+  ``\\ns`` (save) by making longer queries easier to edit ([issue 1430](https://github.com/dbcli/pgcli/issues/1430)).
+* Enable ``.pgpass`` support for SSH tunnel connections.
+    * Preserve original hostname for ``.pgpass`` lookup using PostgreSQL's ``hostaddr`` parameter
+    * SSH tunnel endpoint (``127.0.0.1``) is passed via ``hostaddr``, keeping ``host`` for ``.pgpass``
+    * Works with both DSN and host/port connection styles
+
 4.5.0 (2026-06-02)
 ==================
 
@@ -20,6 +48,8 @@ Bug fixes:
 * Fix trailing SQL comments preventing query submission and execution.
     * ``SELECT 1; -- note`` now submits correctly in multiline mode
     * ``rstrip(";")`` in ``pgexecute.py`` now handles comments after the semicolon
+* Fix completion crash when tables are created during refresh.
+* Suggest columns after `GROUP BY`, like `ORDER BY` already does.    
 
 4.4.0 (2025-12-24)
 ==================

pgcli-4.6.0/pgcli/__init__.py

@@ -0,0 +1 @@
+__version__ = "4.6.0"

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli/main.py

@@ -146,6 +146,17 @@ def notify_callback(notify: Notify):
     )
 
 
+def get_editor():
+    """Pick the external editor for ``\\e``/``\\ev``/``\\ef``/``\\ne``.
+
+    Mirrors psql, which checks ``PSQL_EDITOR`` first, then ``EDITOR``, then
+    ``VISUAL``. Returning ``None`` when none are set lets click fall back to
+    its platform default, so the behaviour is unchanged for anyone who wasn't
+    setting ``PSQL_EDITOR``.
+    """
+    return os.environ.get("PSQL_EDITOR") or os.environ.get("EDITOR") or os.environ.get("VISUAL") or None
+
+
 class PGCli:
     default_prompt = "\\u@\\h:\\d> "
     max_len_prompt = 30
@@ -319,6 +330,31 @@ class PGCli:
         message = f"Named query quiet mode: {status}"
         return [(None, None, None, message)]
 
+    def edit_named_query(self, pattern, **_):
+        r"""Edit (or create) a named query in the external editor (\ne name).
+
+        Loads the named query's SQL into ``$EDITOR``; on save, persists it back
+        to the ``[named queries]`` section. If the name does not exist, the
+        editor opens empty and saving creates it.
+        """
+        name = pattern.strip()
+        if not name:
+            return [(None, None, None, "Usage: \\ne <name>")]
+
+        existing = NamedQueries.instance.get(name)
+        sql, message = special.open_external_editor(sql=existing or "", editor=get_editor())
+        if message:
+            return [(None, None, None, message)]
+
+        sql = (sql or "").strip()
+        if not sql:
+            return [(None, None, None, f"{name}: empty query, not saved.")]
+        if existing is not None and sql == existing.strip():
+            return [(None, None, None, f"{name}: no changes.")]
+
+        NamedQueries.instance.save(name, sql)
+        return [(None, None, None, f"{name}: {'Created' if existing is None else 'Saved'}")]
+
     def _is_named_query_execution(self, text):
         """Check if the command is a named query execution (\n <name>)."""
         text = text.strip()
@@ -334,6 +370,13 @@ class PGCli:
             case_sensitive=True,
         )
 
+        self.pgspecial.register(
+            self.edit_named_query,
+            "\\ne",
+            "\\ne name",
+            "Edit a named query in the external editor.",
+        )
+
         self.pgspecial.register(
             self.change_db,
             "\\c",
@@ -652,7 +695,7 @@ class PGCli:
         if self.force_passwd_prompt and not passwd:
             passwd = click.prompt("Password for %s" % user, hide_input=True, show_default=False, type=str)
 
-        key = f"{user}@{host}"
+        key = f"{user}@{host}@{port}"
 
         if not passwd and auth.keyring:
             passwd = auth.keyring_get_password(key)
@@ -719,11 +762,15 @@ class PGCli:
             self.logger.handlers = logger_handlers
 
             atexit.register(self.ssh_tunnel.stop)
-            host = "127.0.0.1"
+            # Preserve original host for .pgpass lookup and SSL certificate verification.
+            # Use hostaddr to specify the actual connection endpoint (SSH tunnel).
+            hostaddr = "127.0.0.1"
             port = self.ssh_tunnel.local_bind_ports[0]
 
             if dsn:
-                dsn = make_conninfo(dsn, host=host, port=port)
+                dsn = make_conninfo(dsn, host=host, hostaddr=hostaddr, port=port)
+            else:
+                kwargs["hostaddr"] = hostaddr
 
         # Attempt to connect to the database.
         # Note that passwd may be empty on the first attempt. If connection
@@ -796,7 +843,7 @@ class PGCli:
                     query = self.pgexecute.view_definition(spec)
                 elif editor_command == "\\ef":
                     query = self.pgexecute.function_definition(spec)
-            sql, message = special.open_external_editor(filename, sql=query)
+            sql, message = special.open_external_editor(filename, sql=query, editor=get_editor())
             if message:
                 # Something went wrong. Raise an exception and bail.
                 raise RuntimeError(message)
@@ -1099,7 +1146,7 @@ class PGCli:
                 enable_suspend=True,
                 editing_mode=EditingMode.VI if self.vi_mode else EditingMode.EMACS,
                 search_ignore_case=True,
-                cursor=ModalCursorShapeConfig(),
+                cursor=ModalCursorShapeConfig() if self.vi_mode else None,
             )
 
             return prompt_app

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli/packages/sqlcompletion.py

@@ -278,6 +278,29 @@ def suggest_special(text):
     return (Keyword(), Special())
 
 
+def _is_datatype_keyword(token, stmt):
+    """Decide whether a `type` token is the SQL TYPE keyword or a column name.
+
+    `type` is a non-reserved word in postgres, so sqlparse tags a column
+    literally named "type" as a keyword. The TYPE keyword only introduces a
+    datatype in DDL contexts (`ALTER COLUMN bar TYPE`, `SET DATA TYPE`,
+    `CREATE TYPE`), never directly inside a DML select/insert/update list.
+    """
+    if isinstance(token, str):
+        # An explicit internal request for datatype suggestions, e.g. the
+        # parenthesized column list in `CREATE TABLE foo (bar <CURSOR>`.
+        return True
+
+    if not token.is_keyword:
+        return False
+
+    prev_keyword, _ = find_prev_keyword(stmt.text_before_cursor.rstrip(), n_skip=1)
+    if prev_keyword is None:
+        return False
+
+    return prev_keyword.ttype is not sqlparse.tokens.Keyword.DML
+
+
 def suggest_based_on_last_token(token, stmt):
     if isinstance(token, str):
         token_v = token.lower()
@@ -383,7 +406,7 @@ def suggest_based_on_last_token(token, stmt):
         # E.g. 'UPDATE foo SET'
         return (Column(table_refs=stmt.get_tables(), local_tables=stmt.local_tables),)
 
-    elif token_v in ("select", "where", "having", "order by", "distinct"):
+    elif token_v in ("select", "where", "having", "group by", "order by", "distinct"):
         return _suggest_expression(token_v, stmt)
     elif token_v == "as":
         # Don't suggest anything for aliases
@@ -492,7 +515,7 @@ def suggest_based_on_last_token(token, stmt):
             return suggest_based_on_last_token(prev_keyword, stmt)
         else:
             return ()
-    elif token_v in ("type", "::"):
+    elif token_v == "::" or (token_v == "type" and _is_datatype_keyword(token, stmt)):
         #   ALTER TABLE foo SET DATA TYPE bar
         #   SELECT foo::bar
         # Note that tables are a form of composite type in postgresql, so

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli/pgcompleter.py

@@ -141,6 +141,11 @@ class PGCompleter(Completer):
         self.all_completions = set(self.keywords + self.functions)
 
     def escape_name(self, name):
+        if isinstance(name, bytes):
+            # Identifiers come back as bytes when the client encoding is one
+            # psycopg cannot decode (e.g. SQL_ASCII), see issue #1405.
+            name = name.decode("utf-8", "replace")
+
         if name and ((not self.name_pattern.match(name)) or (name.upper() in self.reserved_words) or (name.upper() in self.functions)):
             name = '"%s"' % name
 
@@ -229,6 +234,8 @@ class PGCompleter(Completer):
                 has_default=has_default,
                 default=default,
             )
+            metadata.setdefault(schema, {})
+            metadata[schema].setdefault(relname, OrderedDict())
             metadata[schema][relname][colname] = column
             self.all_completions.add(colname)
 

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli/pgexecute.py

@@ -215,7 +215,8 @@ class PGExecute:
         new_params.update(kwargs)
 
         if new_params["dsn"]:
-            new_params = {"dsn": new_params["dsn"], "password": new_params["password"]}
+            # When using DSN, only keep dsn, password, and hostaddr (for SSH tunnels)
+            new_params = {k: v for k, v in new_params.items() if k in ("dsn", "password", "hostaddr")}
 
             if new_params["password"]:
                 new_params["dsn"] = make_conninfo(new_params["dsn"], password=new_params.pop("password"))

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pgcli
-Version: 4.5.0
+Version: 4.6.0
 Summary: CLI for Postgres Database. With auto-completion and syntax highlighting.
 Author-email: Pgcli Core Team <pgcli-dev@googlegroups.com>
-License: BSD
+License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://pgcli.com
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
@@ -29,7 +29,7 @@ Requires-Dist: Pygments>=2.0
 Requires-Dist: prompt_toolkit<4.0.0,>=2.0.6
 Requires-Dist: psycopg>=3.0.14; sys_platform != "win32"
 Requires-Dist: psycopg-binary>=3.0.14; sys_platform == "win32"
-Requires-Dist: sqlparse<0.6,>=0.3.0
+Requires-Dist: sqlparse<0.7,>=0.3.0
 Requires-Dist: configobj>=5.0.6
 Requires-Dist: cli_helpers[styles]>=2.4.0
 Requires-Dist: setproctitle>=1.1.9; sys_platform != "win32" and "CYGWIN" not in sys_platform

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli.egg-info/SOURCES.txt

@@ -47,6 +47,8 @@ pgcli.egg-info/SOURCES.txt
 pgcli.egg-info/dependency_links.txt
 pgcli.egg-info/entry_points.txt
 pgcli.egg-info/requires.txt
+pgcli.egg-info/scm_file_list.json
+pgcli.egg-info/scm_version.json
 pgcli.egg-info/top_level.txt
 pgcli/packages/__init__.py
 pgcli/packages/prioritization.py

{pgcli-4.5.0 → pgcli-4.6.0}/pgcli.egg-info/requires.txt

@@ -2,7 +2,7 @@ pgspecial>=2.0.0
 click!=8.1.8,!=8.2.*,!=8.3.0,<9,>=4.1
 Pygments>=2.0
 prompt_toolkit<4.0.0,>=2.0.6
-sqlparse<0.6,>=0.3.0
+sqlparse<0.7,>=0.3.0
 configobj>=5.0.6
 cli_helpers[styles]>=2.4.0
 tzlocal>=5.2

pgcli-4.6.0/pgcli.egg-info/scm_file_list.json

@@ -0,0 +1,122 @@
+{
+  "files": [
+    ".coveragerc",
+    ".editorconfig",
+    ".git-blame-ignore-revs",
+    ".github/ISSUE_TEMPLATE.md",
+    ".github/PULL_REQUEST_TEMPLATE.md",
+    ".github/workflows/ci.yml",
+    ".github/workflows/codeql.yml",
+    ".github/workflows/codex-review.yml",
+    ".github/workflows/publish.yml",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+    "AUTHORS",
+    "CONTRIBUTING.rst",
+    "Dockerfile",
+    "LICENSE.txt",
+    "MANIFEST.in",
+    "README.rst",
+    "RELEASES.md",
+    "TODO",
+    "changelog.rst",
+    "pgcli-completion.bash",
+    "pgcli/__init__.py",
+    "pgcli/__main__.py",
+    "pgcli/auth.py",
+    "pgcli/completion_refresher.py",
+    "pgcli/config.py",
+    "pgcli/explain_output_formatter.py",
+    "pgcli/key_bindings.py",
+    "pgcli/magic.py",
+    "pgcli/main.py",
+    "pgcli/packages/__init__.py",
+    "pgcli/packages/formatter/__init__.py",
+    "pgcli/packages/formatter/sqlformatter.py",
+    "pgcli/packages/parseutils/__init__.py",
+    "pgcli/packages/parseutils/ctes.py",
+    "pgcli/packages/parseutils/meta.py",
+    "pgcli/packages/parseutils/tables.py",
+    "pgcli/packages/parseutils/utils.py",
+    "pgcli/packages/pgliterals/__init__.py",
+    "pgcli/packages/pgliterals/main.py",
+    "pgcli/packages/pgliterals/pgliterals.json",
+    "pgcli/packages/prioritization.py",
+    "pgcli/packages/prompt_utils.py",
+    "pgcli/packages/sqlcompletion.py",
+    "pgcli/pgbuffer.py",
+    "pgcli/pgclirc",
+    "pgcli/pgcompleter.py",
+    "pgcli/pgexecute.py",
+    "pgcli/pgstyle.py",
+    "pgcli/pgtoolbar.py",
+    "pgcli/pyev.py",
+    "post-install",
+    "post-remove",
+    "pylintrc",
+    "pyproject.toml",
+    "release.py",
+    "sanity_checks.txt",
+    "screenshots/image01.png",
+    "screenshots/image02.png",
+    "screenshots/kharkiv-destroyed.jpg",
+    "screenshots/pgcli.gif",
+    "tests/conftest.py",
+    "tests/features/__init__.py",
+    "tests/features/auto_vertical.feature",
+    "tests/features/basic_commands.feature",
+    "tests/features/crud_database.feature",
+    "tests/features/crud_table.feature",
+    "tests/features/db_utils.py",
+    "tests/features/environment.py",
+    "tests/features/expanded.feature",
+    "tests/features/fixture_data/help.txt",
+    "tests/features/fixture_data/help_commands.txt",
+    "tests/features/fixture_data/mock_pg_service.conf",
+    "tests/features/fixture_utils.py",
+    "tests/features/iocommands.feature",
+    "tests/features/named_queries.feature",
+    "tests/features/pgbouncer.feature",
+    "tests/features/specials.feature",
+    "tests/features/steps/__init__.py",
+    "tests/features/steps/auto_vertical.py",
+    "tests/features/steps/basic_commands.py",
+    "tests/features/steps/crud_database.py",
+    "tests/features/steps/crud_table.py",
+    "tests/features/steps/expanded.py",
+    "tests/features/steps/iocommands.py",
+    "tests/features/steps/named_queries.py",
+    "tests/features/steps/pgbouncer.py",
+    "tests/features/steps/specials.py",
+    "tests/features/steps/wrappers.py",
+    "tests/features/wrappager.py",
+    "tests/formatter/__init__.py",
+    "tests/formatter/test_sqlformatter.py",
+    "tests/metadata.py",
+    "tests/parseutils/test_ctes.py",
+    "tests/parseutils/test_function_metadata.py",
+    "tests/parseutils/test_parseutils.py",
+    "tests/pytest.ini",
+    "tests/test_application_name.py",
+    "tests/test_auth.py",
+    "tests/test_completion_refresher.py",
+    "tests/test_config.py",
+    "tests/test_fuzzy_completion.py",
+    "tests/test_init_commands_simple.py",
+    "tests/test_main.py",
+    "tests/test_naive_completion.py",
+    "tests/test_pgcompleter.py",
+    "tests/test_pgexecute.py",
+    "tests/test_pgspecial.py",
+    "tests/test_prioritization.py",
+    "tests/test_prompt_utils.py",
+    "tests/test_rowlimit.py",
+    "tests/test_smart_completion_multiple_schemata.py",
+    "tests/test_smart_completion_public_schema_only.py",
+    "tests/test_sqlcompletion.py",
+    "tests/test_ssh_tunnel.py",
+    "tests/test_trailing_comments.py",
+    "tests/utils.py",
+    "tox.ini"
+  ]
+}

pgcli-4.6.0/pgcli.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "4.6.0",
+  "distance": 0,
+  "node": "g787a77a8c8fd15e241b463baa2c66068354a62e0",
+  "dirty": false,
+  "branch": "main",
+  "node_date": "2026-08-26"
+}

{pgcli-4.5.0 → pgcli-4.6.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "pgcli"
 authors = [{ name = "Pgcli Core Team", email = "pgcli-dev@googlegroups.com" }]
-license = { text = "BSD" }
+license = "BSD-3-Clause"
 description = "CLI for Postgres Database. With auto-completion and syntax highlighting."
 readme = "README.rst"
 classifiers = [
@@ -32,7 +32,7 @@ dependencies = [
     "prompt_toolkit>=2.0.6,<4.0.0",
     "psycopg >= 3.0.14; sys_platform != 'win32'",
     "psycopg-binary >= 3.0.14; sys_platform == 'win32'",
-    "sqlparse >=0.3.0,<0.6",
+    "sqlparse >=0.3.0,<0.7",
     "configobj >= 5.0.6",
     "cli_helpers[styles] >= 2.4.0",
     # setproctitle is used to mask the password when running `ps` in command line.
@@ -73,9 +73,6 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools]
 include-package-data = false
 
-[tool.setuptools.dynamic]
-version = { attr = "pgcli.__version__" }
-
 [tool.setuptools.packages]
 find = { namespaces = false }