color/themes/zt_dark: Enable marking common background color in styles.

This allows easily updating the background color to a theme by updating the color in only one location, as well as making it clear upon reading, if a background to a style is distinct from the background. To apply this to a theme with some common background color `Color.BG`: - import `Background` from `zulipterminal.config.color` - replace `Color.BG` values with `Background.COLOR` in styles (STYLES) - add a "background" entry to the META dictionary, with value `Color.BG` This commit applies this to only the 'zt_dark' theme. Note that in the absence of a globally reasonable fallback value, if the "background" entry is not specified in META, the background will be transparent or the terminal default background color. Tests updated.

Author: neiljp

tests/config/test_themes.py

@@ -9,6 +9,7 @@
 from pytest import param as case
 from pytest_mock import MockerFixture
 
+from zulipterminal.config.color import Background
 from zulipterminal.config.regexes import REGEX_COLOR_VALID_FORMATS
 from zulipterminal.config.themes import (
  REQUIRED_STYLES,
@@ -86,7 +87,8 @@ def test_builtin_theme_completeness(theme_name: str) -> None:
  # Check if color used in STYLE exists in Color.
  for style_name, style_conf in theme_styles.items():
  fg, bg = style_conf
- assert fg in theme_colors and bg in theme_colors
+ assert fg in theme_colors
+ assert bg in theme_colors or bg in Background
  # Check completeness of META
  expected_META = {"pygments": ["styles", "background", "overrides"]}
  for metadata, config in expected_META.items():
@@ -303,7 +305,10 @@ class Color(Enum):
 
  req_styles = {"s1": "", "s2": "bold"}
  mocker.patch.dict("zulipterminal.config.themes.REQUIRED_STYLES", req_styles)
- assert parse_themefile(theme_styles, color_depth) == expected_urwid_theme
+ assert (
+ parse_themefile(theme_styles, color_depth, Color.DARK_MAGENTA)
+ == expected_urwid_theme
+ )
 
 
 @pytest.mark.parametrize(

zulipterminal/config/color.py

@@ -25,6 +25,12 @@
 
 
 # fmt: off
+# Background is treated as transparent by default
+# This avoids the need for a dummy default color
+class Background(Enum):
+ COLOR = 'default default default'
+
+
 # NOTE: The 24bit color codes use 256 color which can be
 # enhanced to be truly 24bit.
 # NOTE: The 256code format can be moved to h0-255 to

zulipterminal/config/themes.py

@@ -5,7 +5,7 @@
 
 from pygments.token import STANDARD_TYPES, _TokenType
 
-from zulipterminal.config.color import term16
+from zulipterminal.config.color import Background, term16
 from zulipterminal.themes import gruvbox_dark, gruvbox_light, zt_blue, zt_dark, zt_light
 
 
@@ -186,11 +186,14 @@ def generate_theme(theme_name: str, color_depth: int) -> ThemeSpec:
  theme_styles = theme_module.STYLES
  except AttributeError:
  raise MissingThemeAttributeError("STYLES") from None
- urwid_theme = parse_themefile(theme_styles, color_depth)
 
  # META is not required, but if present should contain pygments data
  theme_meta = getattr(theme_module, "META", None)
  if theme_meta is not None:
+ # FIXME: Is META now required? Or only if Background.COLOR present?
+ # If used in styles and background is not specified, transparent by default!
+ background_color = theme_meta.get("background", Background.COLOR)
+
  pygments_data = theme_meta.get("pygments", None)
  if pygments_data is None:
  raise MissingThemeAttributeError('META["pygments"]') from None
@@ -199,8 +202,10 @@ def generate_theme(theme_name: str, color_depth: int) -> ThemeSpec:
  raise MissingThemeAttributeError(f'META["pygments"]["{key}"]') from None
  pygments_styles = generate_pygments_styles(pygments_data)
  else:
+ background_color = Background.COLOR
  pygments_styles = []
 
+ urwid_theme = parse_themefile(theme_styles, color_depth, background_color)
  urwid_theme.extend(pygments_styles)
 
  return urwid_theme
@@ -232,11 +237,18 @@ def validate_colors(color_enum: Any, color_depth: int) -> None:
 
 
 def parse_themefile(
- theme_styles: Dict[Optional[str], Tuple[Any, Any]], color_depth: int
+ theme_styles: Dict[Optional[str], Tuple[Any, Any]],
+ color_depth: int,
+ background_color: Any,
 ) -> ThemeSpec:
  urwid_theme = []
  for style_name, (fg_name, bg_name) in theme_styles.items():
  fg_code16, fg_code256, fg_code24, *fg_props = fg_name.value.split()
+
+ # If background (bg) is specific enum, use specified background_color instead
+ if bg_name == Background.COLOR:
+ bg_name = background_color # noqa: PLW2901 # overwrite loop variable
+
  bg_code16, bg_code256, bg_code24, *bg_props = bg_name.value.split()
 
  new_style: StyleSpec

zulipterminal/themes/zt_dark.py

@@ -6,71 +6,73 @@
 """
 from pygments.styles.material import MaterialStyle
 
+from zulipterminal.config.color import Background
 from zulipterminal.config.color import DefaultBoldColor as Color
 
 
 # fmt: off
 STYLES = {
  # style_name : foreground background
- None : (Color.WHITE, Color.BLACK),
+ None : (Color.WHITE, Background.COLOR),
  'selected' : (Color.WHITE, Color.DARK_BLUE),
  'msg_selected' : (Color.WHITE, Color.DARK_BLUE),
  'header' : (Color.DARK_CYAN, Color.DARK_BLUE),
  'general_narrow' : (Color.WHITE, Color.DARK_BLUE),
- 'general_bar' : (Color.WHITE, Color.BLACK),
- 'msg_sender' : (Color.YELLOW__BOLD, Color.BLACK),
- 'unread' : (Color.DARK_BLUE, Color.BLACK),
- 'user_active' : (Color.LIGHT_GREEN, Color.BLACK),
- 'user_idle' : (Color.YELLOW, Color.BLACK),
- 'user_offline' : (Color.WHITE, Color.BLACK),
- 'user_inactive' : (Color.WHITE, Color.BLACK),
- 'user_bot' : (Color.WHITE, Color.BLACK),
- 'title' : (Color.WHITE__BOLD, Color.BLACK),
- 'column_title' : (Color.WHITE__BOLD, Color.BLACK),
- 'time' : (Color.LIGHT_BLUE, Color.BLACK),
+ 'general_bar' : (Color.WHITE, Background.COLOR),
+ 'msg_sender' : (Color.YELLOW__BOLD, Background.COLOR),
+ 'unread' : (Color.DARK_BLUE, Background.COLOR),
+ 'user_active' : (Color.LIGHT_GREEN, Background.COLOR),
+ 'user_idle' : (Color.YELLOW, Background.COLOR),
+ 'user_offline' : (Color.WHITE, Background.COLOR),
+ 'user_inactive' : (Color.WHITE, Background.COLOR),
+ 'user_bot' : (Color.WHITE, Background.COLOR),
+ 'title' : (Color.WHITE__BOLD, Background.COLOR),
+ 'column_title' : (Color.WHITE__BOLD, Background.COLOR),
+ 'time' : (Color.LIGHT_BLUE, Background.COLOR),
  'bar' : (Color.WHITE, Color.DARK_GRAY),
- 'msg_emoji' : (Color.LIGHT_MAGENTA, Color.BLACK),
- 'reaction' : (Color.LIGHT_MAGENTA__BOLD, Color.BLACK),
+ 'msg_emoji' : (Color.LIGHT_MAGENTA, Background.COLOR),
+ 'reaction' : (Color.LIGHT_MAGENTA__BOLD, Background.COLOR),
  'reaction_mine' : (Color.BLACK, Color.LIGHT_MAGENTA),
  'msg_heading' : (Color.LIGHT_CYAN__BOLD, Color.DARK_MAGENTA),
  'msg_math' : (Color.LIGHT_GRAY, Color.DARK_GRAY),
- 'msg_mention' : (Color.LIGHT_RED__BOLD, Color.BLACK),
- 'msg_link' : (Color.LIGHT_BLUE, Color.BLACK),
- 'msg_link_index' : (Color.LIGHT_BLUE__BOLD, Color.BLACK),
- 'msg_quote' : (Color.BROWN, Color.BLACK),
- 'msg_bold' : (Color.WHITE__BOLD, Color.BLACK),
+ 'msg_mention' : (Color.LIGHT_RED__BOLD, Background.COLOR),
+ 'msg_link' : (Color.LIGHT_BLUE, Background.COLOR),
+ 'msg_link_index' : (Color.LIGHT_BLUE__BOLD, Background.COLOR),
+ 'msg_quote' : (Color.BROWN, Background.COLOR),
+ 'msg_bold' : (Color.WHITE__BOLD, Background.COLOR),
  'msg_time' : (Color.BLACK, Color.WHITE),
  'footer' : (Color.BLACK, Color.LIGHT_GRAY),
- 'footer_contrast' : (Color.WHITE, Color.BLACK),
- 'starred' : (Color.LIGHT_RED__BOLD, Color.BLACK),
- 'unread_count' : (Color.YELLOW, Color.BLACK),
- 'starred_count' : (Color.LIGHT_GRAY, Color.BLACK),
- 'table_head' : (Color.WHITE__BOLD, Color.BLACK),
+ 'footer_contrast' : (Color.WHITE, Background.COLOR),
+ 'starred' : (Color.LIGHT_RED__BOLD, Background.COLOR),
+ 'unread_count' : (Color.YELLOW, Background.COLOR),
+ 'starred_count' : (Color.LIGHT_GRAY, Background.COLOR),
+ 'table_head' : (Color.WHITE__BOLD, Background.COLOR),
  'filter_results' : (Color.WHITE, Color.DARK_GREEN),
  'edit_topic' : (Color.WHITE, Color.DARK_GRAY),
  'edit_tag' : (Color.WHITE, Color.DARK_GRAY),
- 'edit_author' : (Color.YELLOW, Color.BLACK),
- 'edit_time' : (Color.LIGHT_BLUE, Color.BLACK),
- 'current_user' : (Color.WHITE, Color.BLACK),
- 'muted' : (Color.LIGHT_BLUE, Color.BLACK),
- 'popup_border' : (Color.WHITE, Color.BLACK),
- 'popup_category' : (Color.LIGHT_BLUE__BOLD, Color.BLACK),
+ 'edit_author' : (Color.YELLOW, Background.COLOR),
+ 'edit_time' : (Color.LIGHT_BLUE, Background.COLOR),
+ 'current_user' : (Color.WHITE, Background.COLOR),
+ 'muted' : (Color.LIGHT_BLUE, Background.COLOR),
+ 'popup_border' : (Color.WHITE, Background.COLOR),
+ 'popup_category' : (Color.LIGHT_BLUE__BOLD, Background.COLOR),
  'popup_contrast' : (Color.WHITE, Color.DARK_GRAY),
- 'popup_important' : (Color.LIGHT_RED__BOLD, Color.BLACK),
- 'widget_disabled' : (Color.DARK_GRAY, Color.BLACK),
+ 'popup_important' : (Color.LIGHT_RED__BOLD, Background.COLOR),
+ 'widget_disabled' : (Color.DARK_GRAY, Background.COLOR),
  'area:help' : (Color.WHITE, Color.DARK_GREEN),
  'area:msg' : (Color.WHITE, Color.BROWN),
  'area:stream' : (Color.WHITE, Color.DARK_CYAN),
  'area:error' : (Color.WHITE, Color.DARK_RED),
  'area:user' : (Color.WHITE, Color.DARK_BLUE),
- 'search_error' : (Color.LIGHT_RED, Color.BLACK),
+ 'search_error' : (Color.LIGHT_RED, Background.COLOR),
  'task:success' : (Color.WHITE, Color.DARK_GREEN),
  'task:error' : (Color.WHITE, Color.DARK_RED),
  'task:warning' : (Color.WHITE, Color.BROWN),
  'ui_code' : (Color.BLACK, Color.WHITE),
 }
 
 META = {
+ 'background': Color.BLACK,
  'pygments': {
  'styles' : MaterialStyle().styles,
  'background': 'h235',