Merge pull request #15 from jwodder/gh-10

Add themes

Author: jwodder

.github/workflows/test.yml

@@ -19,19 +19,17 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - '3.8'
           - '3.9'
           - '3.10'
           - '3.11'
           - '3.12'
-          - 'pypy-3.8'
           - 'pypy-3.9'
           - 'pypy-3.10'
         toxenv: [py]
         include:
-          - python-version: '3.8'
+          - python-version: '3.9'
             toxenv: lint
-          - python-version: '3.8'
+          - python-version: '3.9'
             toxenv: typing
     steps:
       - name: Check out repository

CHANGELOG.md

@@ -1,6 +1,8 @@
 v0.7.0 (in development)
 -----------------------
 - The branch name/`HEAD` description is now truncated if it gets too long.
+- Add `--theme` option for selecting between dark and light themes
+- Drop support for Python 3.8
 
 v0.6.0 (2024-05-12)
 -------------------

README.rst

@@ -44,7 +44,7 @@ Features:
 Installation & Setup
 ====================
 
-``jwodder-ps1`` requires Python 3.8 or higher.  You'll also need a Bash or zsh
+``jwodder-ps1`` requires Python 3.9 or higher.  You'll also need a Bash or zsh
 shell to set the program up in, and you'll need ``git`` v1.7.10+ installed in
 order to get status information about Git repositories.
 
@@ -102,15 +102,27 @@ Options
 -------
 
 --ansi          Format output for direct display
+
 --bash          Format output for use in Bash's ``PS1`` (default)
+
 -G, --git-only  Only output the Git status string (including leading
                 separator); output an empty line if not in a Git repository or
                 if "off" is given on the command line
+
 --git-timeout SECONDS
                 If running ``git status`` takes longer than the given number of
                 seconds (default: 3), disable the Git integration
+
+-T THEME, --theme THEME
+                Select the theme to use for coloring prompt elements.  The
+                available themes are ``dark`` (the default, for use with light
+                text on dark backgrounds) and ``light`` (for use with dark text
+                on light backgrounds).
+
 --zsh           Format output for use in zsh's ``PS1``
+
 -V, --version   Display version information and exit
+
 -h, --help      Display usage information and exit
 
 

pyproject.toml

@@ -7,7 +7,7 @@ name = "jwodder-ps1"
 dynamic = ["version"]
 description = "Yet another bash/zsh custom prompt script"
 readme = "README.rst"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = "MIT"
 license-files = { paths = ["LICENSE"] }
 authors = [
@@ -25,7 +25,6 @@ keywords = [
 classifiers = [
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",

src/jwodder_ps1/__main__.py

@@ -3,7 +3,7 @@
 from . import __url__, __version__
 from .git import git_status
 from .info import PromptInfo
-from .style import ANSIStyler, BashStyler, ZshStyler
+from .styles import THEMES, ANSIStyler, BashStyler, Painter, ZshStyler
 
 
 def main() -> None:
@@ -43,6 +43,13 @@ def main() -> None:
             "  [default: 3]"
         ),
     )
+    parser.add_argument(
+        "-T",
+        "--theme",
+        choices=list(THEMES.keys()),
+        default="dark",
+        help="Select the color theme to use  [default: dark]",
+    )
     parser.add_argument(
         "--zsh",
         action="store_const",
@@ -61,15 +68,15 @@ def main() -> None:
     )
     args = parser.parse_args()
     show_git = args.git_flag != "off"
-    # Stylizing & escaping callable:
-    style = (args.stylecls or BashStyler)()
+    styler = (args.stylecls or BashStyler)()
+    paint = Painter(styler=styler, theme=THEMES[args.theme])
     if args.git_only:
         if show_git and (gs := git_status(timeout=args.git_timeout)):
-            s = gs.display(style)
+            s = gs.display(paint)
         else:
             s = ""
     else:
-        s = PromptInfo.get(git=show_git, git_timeout=args.git_timeout).display(style)
+        s = PromptInfo.get(git=show_git, git_timeout=args.git_timeout).display(paint)
     print(s)
 
 

src/jwodder_ps1/git.py

@@ -4,7 +4,8 @@
 from pathlib import Path
 import re
 import subprocess
-from .style import Color, Styler
+from .styles import Painter
+from .styles import StyleClass as SC
 
 #: Default maximum display length of the repository HEAD
 MAX_HEAD_LEN = 15
@@ -32,42 +33,43 @@ class GitStatus:
     #: repository is not a bare repository
     wkt: WorkTreeStatus | None
 
-    def display(self, style: Styler) -> str:
+    def display(self, paint: Painter) -> str:
         # Start building the status string with the separator:
-        p = style("@")
+        p = "@"
         if self.wkt is not None and self.wkt.stashed:
             # We have stashed changes:
-            p += style("+", fg=Color.LIGHT_YELLOW, bold=True)
+            p += paint("+", SC.GIT_STASHED)
         # Show HEAD; color changes depending on whether it's detached:
-        head_color = Color.LIGHT_BLUE if self.detached else Color.LIGHT_GREEN
-        p += style(shorthead(self.head), fg=head_color)
+        p += paint(
+            shorthead(self.head), SC.GIT_DETACHED if self.detached else SC.GIT_HEAD
+        )
         if self.ahead:
             # Show commits ahead of upstream:
-            p += style(f"+{self.ahead}", fg=Color.GREEN)
+            p += paint(f"+{self.ahead}", SC.GIT_AHEAD)
             if self.behind:
                 # Ahead/behind separator:
-                p += style(",")
+                p += ","
         if self.behind:
             # Show commits behind upstream:
-            p += style(f"-{self.behind}", fg=Color.RED)
+            p += paint(f"-{self.behind}", SC.GIT_BEHIND)
         if (wkt := self.wkt) is not None:
             # Show staged/unstaged status:
             if wkt.staged and wkt.unstaged:
-                p += style("*", fg=Color.LIGHT_YELLOW, bold=True)
+                p += paint("*", SC.GIT_STAGED_UNSTAGED)
             elif wkt.staged:
-                p += style("*", fg=Color.GREEN)
+                p += paint("*", SC.GIT_STAGED)
             elif wkt.unstaged:
-                p += style("*", fg=Color.RED)
+                p += paint("*", SC.GIT_UNSTAGED)
             # else: Show nothing
             if wkt.untracked:
                 # There are untracked files:
-                p += style("+", fg=Color.RED, bold=True)
+                p += paint("+", SC.GIT_UNTRACKED)
             if wkt.state is not None:
                 # The repository is in the middle of something special:
-                p += style("[" + wkt.state.value + "]", fg=Color.MAGENTA)
+                p += paint("[" + wkt.state.value + "]", SC.GIT_STATE)
             if wkt.conflict:
                 # There are conflicted files:
-                p += style("!", fg=Color.RED, bold=True)
+                p += paint("!", SC.GIT_CONFLICT)
         return p
 
 

src/jwodder_ps1/info.py

@@ -6,7 +6,8 @@
 import re
 import socket
 from .git import GitStatus, git_status
-from .style import Color, Styler
+from .styles import Painter
+from .styles import StyleClass as SC
 
 #: Default maximum display length of the path to the current working directory
 MAX_CWD_LEN = 30
@@ -94,7 +95,7 @@ def get(cls, git: bool = True, git_timeout: float = 3) -> PromptInfo:
             git=gs,
         )
 
-    def display(self, style: Styler) -> str:
+    def display(self, paint: Painter) -> str:
         """
         Construct & return a complete prompt string for the current environment
         """
@@ -104,37 +105,37 @@ def display(self, style: Styler) -> str:
 
         # If the $MAIL file is nonempty, show the string "[MAIL]":
         if self.mail:
-            ps1 += style("[MAIL] ", fg=Color.CYAN, bold=True)
+            ps1 += paint("[MAIL] ", SC.MAIL)
 
         # Show the chroot we're working in (if any):
         if self.debian_chroot is not None:
-            ps1 += style(f"[{self.debian_chroot}] ", fg=Color.BLUE, bold=True)
+            ps1 += paint(f"[{self.debian_chroot}] ", SC.CHROOT)
 
         # If a Conda environment is active, show its prompt prefix:
         if self.conda_prompt_modifier is not None:
             # Green like a snake!
-            ps1 += style(self.conda_prompt_modifier, fg=Color.LIGHT_GREEN)
+            ps1 += paint(self.conda_prompt_modifier, SC.CONDA)
 
         # If we're inside a Python virtualenv, show the basename of the
         # virtualenv directory (or the custom prompt prefix, if set).
         if self.venv_prompt is not None:
-            ps1 += style(f"({self.venv_prompt}) ")
+            ps1 += paint(f"({self.venv_prompt}) ", SC.VENV)
 
         # Show the current hostname:
-        ps1 += style(self.hostname, fg=Color.LIGHT_RED)
+        ps1 += paint(self.hostname, SC.HOST)
 
         # Separator:
-        ps1 += style(":")
+        ps1 += ":"
 
         # Show the path to the current working directory:
-        ps1 += style(self.cwdstr, fg=Color.LIGHT_CYAN)
+        ps1 += paint(self.cwdstr, SC.CWD)
 
         # Show Git status information, if any:
         if self.git is not None:
-            ps1 += self.git.display(style)
+            ps1 += self.git.display(paint)
 
         # The actual prompt symbol at the end of the prompt:
-        ps1 += style.prompt_suffix + " "
+        ps1 += paint.styler.prompt_suffix + " "
 
         return ps1