startup crashes on `TypeError: replace() argument 2 must be str, not bytes`, followed by `TypeError: cannot use a string pattern on a bytes-like object`

[mwbmcc]

Installed pgcli 4.3.0 using pip install pgcli in a Python 3.13 venv (MacOS 15.x, recent Sequoia).

pgcli crashes on startup due to a string-handling error (or byte string-handling error). Superficial patches lead to deeper problems during startup.

First I tried to start pgcli with the command pgcli my_database_name

Got a stacktrace ending with this error, related to handling string versus bytes:

  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 1051, in get_message
    prompt = self.get_prompt(prompt_format)
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 1323, in get_prompt
    string = string.replace("\\H", self.pgexecute.host or "(none)")
TypeError: replace() argument 2 must be str, not bytes

I modified line 1323 like this, and this initial error went away...

        string = string.replace("\\H", str(self.pgexecute.host) or "(none)")  # HACK added str() 20250802

...however then I got the same error from the subsequent line 1324:

  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 1324, in get_prompt
    string = string.replace("\\h", self.pgexecute.short_host or "(none)")
TypeError: replace() argument 2 must be str, not bytes

So I modified line 1324 the same way to bypass the error:

        string = string.replace("\\h", str(self.pgexecute.short_host) or "(none)")  # HACK added str() 20250802

These two hacks permitted pgcli to get farther in start up, however then I received another TypeError, seemingly related to the same issues. At this point I gave up debugging it. It should be an easy fix for someone who knows the pgcli codebase.

$ pgcli my_database_name

Using local time zone MyCountry/MyCity (server uses b'MyCountry/MyCity')
Use `set time zone <TZ>` to override, or set `use_local_timezone = False` in the config

Exception in thread completion_refresh:
Traceback (most recent call last):
  File "/opt/homebrew/Cellar/python@3.13/3.13.5/Frameworks/Python.framework/Versions/3.13/lib/python3.13/threading.py", line 1043, in _bootstrap_inner
    self.run()
    ~~~~~~~~^^
  File "/opt/homebrew/Cellar/python@3.13/3.13.5/Frameworks/Python.framework/Versions/3.13/lib/python3.13/threading.py", line 994, in run
    self._target(*self._args, **self._kwargs)
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/completion_refresher.py", line 67, in _bg_refresh
    refresher(completer, executor)
    ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^
Server: PostgreSQL 17.5 (Homebrew)
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/completion_refresher.py", line 108, in refresh_schemata
    completer.set_search_path(executor.search_path())
    ~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/pgcompleter.py", line 335, in set_search_path
    self.search_path = self.escaped_names(search_path)
                       ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^

Version: 4.3.0
Home: http://pgcli.com

  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/pgcompleter.py", line 183, in escaped_names
    return [self.escape_name(name) for name in names]
            ~~~~~~~~~~~~~~~~^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/pgcompleter.py", line 164, in escape_name
    (not self.name_pattern.match(name))
         ~~~~~~~~~~~~~~~~~~~~~~~^^^^^^

TypeError: cannot use a string pattern on a bytes-like object

Traceback (most recent call last):
  File "/path/to/my/venv/bin/pgcli", line 8, in <module>
    sys.exit(cli())
             ~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/click/core.py", line 1442, in __call__
    return self.main(*args, **kwargs)
           ~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/click/core.py", line 1363, in main
    rv = self.invoke(ctx)
  File "/path/to/my/venv/lib/python3.13/site-packages/click/core.py", line 1226, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/click/core.py", line 794, in invoke
    return callback(*args, **kwargs)
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 1720, in cli
    pgcli.run_cli()
    ~~~~~~~~~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 979, in run_cli
    text = self.prompt_app.prompt()
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/shortcuts/prompt.py", line 1035, in prompt
    return self.app.run(
           ~~~~~~~~~~~~^
        set_exception_handler=set_exception_handler,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    ...<2 lines>...
        inputhook=inputhook,
        ^^^^^^^^^^^^^^^^^^^^
    )
    ^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/application/application.py", line 1002, in run
    return asyncio.run(coro)
           ~~~~~~~~~~~^^^^^^
  File "/opt/homebrew/Cellar/python@3.13/3.13.5/Frameworks/Python.framework/Versions/3.13/lib/python3.13/asyncio/runners.py", line 195, in run
    return runner.run(main)
           ~~~~~~~~~~^^^^^^
  File "/opt/homebrew/Cellar/python@3.13/3.13.5/Frameworks/Python.framework/Versions/3.13/lib/python3.13/asyncio/runners.py", line 118, in run
    return self._loop.run_until_complete(task)
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/opt/homebrew/Cellar/python@3.13/3.13.5/Frameworks/Python.framework/Versions/3.13/lib/python3.13/asyncio/base_events.py", line 725, in run_until_complete
    return future.result()
           ~~~~~~~~~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/application/application.py", line 886, in run_async
    return await _run_async(f)
           ^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/application/application.py", line 739, in _run_async
    self._redraw()
    ~~~~~~~~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/application/application.py", line 543, in _redraw
    self.context.copy().run(run_in_context)
    ~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/application/application.py", line 526, in run_in_context
    self.renderer.render(self, self.layout)
    ~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/renderer.py", line 647, in render
    layout.container.preferred_height(size.columns, size.rows).preferred,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/layout/containers.py", line 319, in preferred_height
    c.preferred_height(width, max_available_height) for c in self._all_children
    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/layout/containers.py", line 786, in preferred_height
    return self.content.preferred_height(width, max_available_height)
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/layout/containers.py", line 319, in preferred_height
    c.preferred_height(width, max_available_height) for c in self._all_children
    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/layout/containers.py", line 2623, in preferred_height
    if self.filter():
       ~~~~~~~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/filters/base.py", line 253, in __call__
    return self.func()
           ~~~~~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/shortcuts/prompt.py", line 161, in has_before_fragments
    for fragment, char, *_ in get_prompt_text():
                              ~~~~~~~~~~~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/shortcuts/prompt.py", line 1280, in _get_prompt
    return to_formatted_text(self.message, style="class:prompt")
  File "/path/to/my/venv/lib/python3.13/site-packages/prompt_toolkit/formatted_text/base.py", line 82, in to_formatted_text
    return to_formatted_text(value(), style=style)
                             ~~~~~^^
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 1051, in get_message
    prompt = self.get_prompt(prompt_format)
  File "/path/to/my/venv/lib/python3.13/site-packages/pgcli/main.py", line 1324, in get_prompt
    string = string.replace("\\h", self.pgexecute.short_host or "(none)")

TypeError: replace() argument 2 must be str, not bytes

[dbaty]

I cannot reproduce the error. It's certainly linked to the name of the database host. Could you add some debugging statements before the problematic line, like this?

print(self.pgexecute.host)
string = string.replace("\\H", self.pgexecute.host or "(none)")

As you have noticed, the host name seems to be bytes while we expect it to be a string. I am not sure where that comes from. If you're willing to help, you could also try to add debugging statements in PGExecute.connect() (in pgexecute.py) to see what sets the host attribute. It would help us determine the cause of the bug.

[tekpriest]

I am experiencing same issue, installed via homebrew, I was able to get it working like this

pgcli -U root -h localhost -p 5432

but it showed this errors before opening

Server: PostgreSQL 18.2 (Homebrew)
Version: 4.4.0
Home: http://pgcli.com
root@localhost:root> Exception in thread completion_refresh:
Traceback (most recent call last):
  File "/opt/homebrew/Cellar/python@3.14/3.14.3_1/Frameworks/Python.framework/Versions/3.14/lib/python3.14/threading.py", line 1082, in _bootstrap_inner
    self._context.run(self.run)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^] Multiline: OFF  [F4] Emacs-mode  [F5] Explain: OFF      Refreshing completions...
  File "/opt/homebrew/Cellar/python@3.14/3.14.3_1/Frameworks/Python.framework/Versions/3.14/lib/python3.14/threading.py", line 1024, in run
    self._target(*self._args, **self._kwargs)
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/completion_refresher.py", line 63, in _bg_refresh
    refresher(completer, executor)
    ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/completion_refresher.py", line 104, in refresh_schemata
    completer.set_search_path(executor.search_path())
    ~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgcompleter.py", line 308, in set_search_path
    self.search_path = self.escaped_names(search_path)
                       ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgcompleter.py", line 160, in escaped_names
    return [self.escape_name(name) for name in names]
            ~~~~~~~~~~~~~~~~^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgcompleter.py", line 144, in escape_name
    if name and ((not self.name_pattern.match(name)) or (name.upper() in self.reserved_words) or (name.upper() in self.functions)):
                      ~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
TypeError: cannot use a string pattern on a bytes-like object

checking the $XDG_CONFIG/pgcli/log file, I got this

2026-02-19 10:31:17,572 (5398/MainThread) pgcli.main INFO - Default pager found in PAGER environment variable: "less"
2026-02-19 10:31:17,573 (5398/MainThread) pgcli.main WARNING - import keyring failed: ModuleNotFoundError("No module named 'keyring'").
2026-02-19 10:35:27,704 (8411/MainThread) pgcli.main INFO - Default pager found in PAGER environment variable: "less"
2026-02-19 10:35:27,704 (8411/MainThread) pgcli.main WARNING - import keyring failed: ModuleNotFoundError("No module named 'keyring'").
2026-02-19 10:35:27,714 (8411/MainThread) pgcli.main ERROR - traceback: 'Traceback (most recent call last):\n  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/main.py", line 731, in connect\n    raise e\n  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/main.py", line 702, in connect\n    pgexecute = PGExecute(\n        database,\n    ...<6 lines>...\n        **kwargs,\n    )\n  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgexecute.py", line 180, in __init__\n    self.connect(database, user, password, host, port, dsn, **kwargs)\n    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgexecute.py", line 227, in connect\n    conn = psycopg.connect(conn_info)\n  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/psycopg/connection.py", line 122, in connect\n    raise last_ex.with_traceback(None)\npsycopg.OperationalError: connection failed: connection to server on socket "/tmp/.s.PGSQL.5432" failed: FATAL:  database "version" does not exist\n'
2026-02-19 10:35:49,212 (8998/MainThread) pgcli.main INFO - Default pager found in PAGER environment variable: "less"
2026-02-19 10:35:49,212 (8998/MainThread) pgcli.main WARNING - import keyring failed: ModuleNotFoundError("No module named 'keyring'").
2026-02-19 10:36:10,610 (9600/MainThread) pgcli.main INFO - Default pager found in PAGER environment variable: "less"
2026-02-19 10:36:10,610 (9600/MainThread) pgcli.main WARNING - import keyring failed: ModuleNotFoundError("No module named 'keyring'").

so I thought, could the error be linked to the missing module keyring? So I installed that with pip using pip3 install -U keyring and brew brew install keyring but same error still shows in the log file

2026-02-19 10:43:31,289 (16256/MainThread) pgcli.main INFO - Default pager found in PAGER environment variable: "less"
2026-02-19 10:43:31,290 (16256/MainThread) pgcli.main WARNING - import keyring failed: ModuleNotFoundError("No module named 'keyring'").

and this in the terminal

Exception in thread completion_refresh:
Traceback (most recent call last):
  File "/opt/homebrew/Cellar/python@3.14/3.14.3_1/Frameworks/Python.framework/Versions/3.14/lib/python3.14/threading.py", line 1082, in _bootstrap_inner
    self._context.run(self.run)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/opt/homebrew/Cellar/python@3.14/3.14.3_1/Frameworks/Python.framework/Versions/3.14/lib/python3.14/threading.py", line 1024, in run
    self._target(*self._args, **self._kwargs)
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/completion_refresher.py", line 63, in _bg_refresh
    refresher(completer, executor)
    ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/completion_refresher.py", line 104, in refresh_schemata
    completer.set_search_path(executor.search_path())
    ~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgcompleter.py", line 308, in set_search_path
    self.search_path = self.escaped_names(search_path)Emacs-mode  [F5] Explain: OFF      Refreshing completions...
                       ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgcompleter.py", line 160, in escaped_names
    return [self.escape_name(name) for name in names]
            ~~~~~~~~~~~~~~~~^^^^^^
  File "/opt/homebrew/Cellar/pgcli/4.4.0/libexec/lib/python3.14/site-packages/pgcli/pgcompleter.py", line 144, in escape_name
    if name and ((not self.name_pattern.match(name)) or (name.upper() in self.reserved_words) or (name.upper() in self.functions)):
                      ~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
TypeError: cannot use a string pattern on a bytes-like object

using the alias dsn section does seem to work without any errors.

Maybe this can help anyone