Skip to content

gh-133447: Add basic color to sqlite3 CLI #133461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
May 10, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Highlight error messages
  • Loading branch information
StanFromIreland committed May 5, 2025
commit b4561334eb4a9dbcabed1d16bf302635ed2123e9
31 changes: 20 additions & 11 deletions Lib/sqlite3/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,16 @@
from textwrap import dedent
import _colorize as colorize

BOLD_MAGENTA = colorize.ANSIColors.BOLD_MAGENTA
MAGENTA =colorize.ANSIColors.MAGENTA
RESET = colorize.ANSIColors.RESET

def execute(c, sql, suppress_errors=True):
def color(color, use_color):
if use_color:
return color
return ''

def execute(c, sql, suppress_errors=True, use_color=False):
"""Helper that wraps execution of SQL code.

This is used both by the REPL and by direct execution from the CLI.
Expand All @@ -28,20 +36,24 @@ def execute(c, sql, suppress_errors=True):
except sqlite3.Error as e:
tp = type(e).__name__
try:
print(f"{tp} ({e.sqlite_errorname}): {e}", file=sys.stderr)
print(f"{color(BOLD_MAGENTA, use_color)}{tp} ({e.sqlite_errorname})"
f"{color(RESET, use_color)}: "
f"{color(MAGENTA, use_color)}{e}{color(RESET, use_color)}", file=sys.stderr)
except AttributeError:
print(f"{tp}: {e}", file=sys.stderr)
print(f"{color(BOLD_MAGENTA, use_color)}{tp}{color(RESET, use_color)}: "
f"{color(MAGENTA, use_color)}{e}{color(RESET, use_color)}", file=sys.stderr)
if not suppress_errors:
sys.exit(1)


class SqliteInteractiveConsole(InteractiveConsole):
"""A simple SQLite REPL."""

def __init__(self, connection):
def __init__(self, connection, use_color=False):
super().__init__()
self._con = connection
self._cur = connection.cursor()
self._use_color = use_color

def runsource(self, source, filename="<input>", symbol="single"):
"""Override runsource, the core of the InteractiveConsole REPL.
Expand All @@ -59,7 +71,7 @@ def runsource(self, source, filename="<input>", symbol="single"):
case _:
if not sqlite3.complete_statement(source):
return True
execute(self._cur, source)
execute(self._cur, source, use_color=self._use_color)
return False


Expand Down Expand Up @@ -109,11 +121,8 @@ def main(*args):

use_color = colorize.can_colorize()

bold_magenta = colorize.ANSIColors.BOLD_MAGENTA if use_color else ""
reset = colorize.ANSIColors.RESET if use_color else ""

sys.ps1 = f"{bold_magenta}sqlite> {reset}"
sys.ps2 = f"{bold_magenta} ... {reset}"
sys.ps1 = f"{color(BOLD_MAGENTA, use_color)}sqlite> {color(RESET, use_color)}"
sys.ps2 = f"{color(BOLD_MAGENTA, use_color)} ... {color(RESET, use_color)}"

con = sqlite3.connect(args.filename, isolation_level=None)
try:
Expand All @@ -122,7 +131,7 @@ def main(*args):
execute(con, args.sql, suppress_errors=False)
else:
# No SQL provided; start the REPL.
console = SqliteInteractiveConsole(con)
console = SqliteInteractiveConsole(con, use_color)
try:
import readline # noqa: F401
except ImportError:
Expand Down
3 changes: 3 additions & 0 deletions Lib/test/test_sqlite3/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,9 @@ def test_color(self):
out, err = self.run_cli(commands="\n")
self.assertIn("\x1b[1;35msqlite> \x1b[0m", out)
self.assertIn("\x1b[1;35m ... \x1b[0m\x1b", out)
out, err = self.run_cli(commands=("sel;",))
self.assertIn('\x1b[1;35mOperationalError (SQLITE_ERROR)\x1b[0m: '
'\x1b[35mnear "sel": syntax error\x1b[0m', err)

if __name__ == "__main__":
unittest.main()
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy