Skip to content

Support upper-case theme color spec & Clarify 16-color names #1160

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.

Sign up for GitHub

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 2 commits into from
Mar 9, 2022
Merged

Support upper-case theme color spec & Clarify 16-color names #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d0c8cc
themes: Explicitly allow color specifications to use upper case.
neiljp Mar 5, 2022
f15f77a
tests/THEME_CONTRIBUTING: Add underscores to valid 16-color names.
neiljp Mar 5, 2022
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
32 changes: 17 additions & 15 deletions tests/config/test_themes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,25 @@
"zt_light",
"zt_blue",
}
aliases_16_color = [

# These are urwid color names with underscores instead of spaces
valid_16_color_codes = [
"default",
"black",
"dark red",
"dark green",
"dark_red",
"dark_green",
"brown",
"dark blue",
"dark magenta",
"dark cyan",
"dark gray",
"light red",
"light green",
"dark_blue",
"dark_magenta",
"dark_cyan",
"dark_gray",
"light_red",
"light_green",
"yellow",
"light blue",
"light magenta",
"light cyan",
"light gray",
"light_blue",
"light_magenta",
"light_cyan",
"light_gray",
"white",
]

Expand Down Expand Up @@ -78,10 +80,10 @@ def test_builtin_theme_completeness(theme_name: str) -> None:
if "__" in color.name:
continue

codes = color.value.split()
codes = color.value.lower().split()
assert len(codes) == 3
# Check if 16-color alias is correct
assert codes[0].replace("_", " ") in aliases_16_color
assert codes[0] in valid_16_color_codes
# Check if 24-bit and 256 color is any of the valid color codes
pattern = re.compile(REGEX_COLOR_VALID_FORMATS)
for code in [codes[1], codes[2]]:
Expand Down
8 changes: 4 additions & 4 deletions zulipterminal/config/themes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,13 @@ def parse_themefile(
new_style = (style_name, fg, bg)

elif color_depth == 256:
fg = " ".join([fg_code256] + fg_props)
bg = " ".join([bg_code256] + bg_props)
fg = " ".join([fg_code256] + fg_props).lower()
bg = " ".join([bg_code256] + bg_props).lower()
new_style = (style_name, "", "", "", fg, bg)

elif color_depth == 2**24:
fg = " ".join([fg_code24] + fg_props)
bg = " ".join([bg_code24] + bg_props)
fg = " ".join([fg_code24] + fg_props).lower()
bg = " ".join([bg_code24] + bg_props).lower()
new_style = (style_name, "", "", "", fg, bg)

urwid_theme.append(new_style)
Expand Down
31 changes: 17 additions & 14 deletions zulipterminal/themes/THEME_CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,18 @@ color codes:

* **16code**: Terminal's default 16 color aliases.
* Only those used in DefaultColor are acceptable.
* Acceptable names: `default`, `black`, `dark red`, `dark green`, `brown`, `dark blue`, `dark magenta`, `dark cyan`, `dark gray`, `light red`, `light green`, `yellow`, `light blue`, `light magenta`, `light cyan`, `light gray`, `white`
* Reference link to urwid documentation: https://urwid.org/manual/displayattributes.html#standard-foreground
* Acceptable names: `default`, `black`, `dark_red`, `dark_green`, `brown`, `dark_blue`, `dark_magenta`, `dark_cyan`, `dark_gray`, `light_red`, `light_green`, `yellow`, `light_blue`, `light_magenta`, `light_cyan`, `light_gray`, `white`
* Reference link to urwid documentation: https://urwid.org/manual/displayattributes.html#standard-foreground (**note our use of underscores**)
* **256code**: High color, 256 color code.
* Acceptable formats: `#000-#fff`, `h0-h255`, `g0-g100`, `g#00-g#ff`
* Eg: `#rgb or h255 or g19`
* **24code**: True color, 24 bit color code.
* Similar to HTML colors.
* Eg: `#rrggbb`

> Note that `urwid` documentation suggests colors should be lower case, but we
> explicitly support upper case in color specifications, eg. #FF5

`'default'` is a special alias which uses the default
foreground or background.

Expand All @@ -62,20 +65,20 @@ The following table consists of the 16code equivalents of 256 color codes-
| 256 color codes | Corresponding 16 color codes |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- |
| `h0`, `h16`, `h232`, `h233`, `h234`, `h235`, `h236`, `h237` | `black` |
| `h1`, `h52`, `h88`, `h124` | `dark red` |
| `h2`, `h22`, `h28`, `h34`, `h72` | `dark green` |
| `h1`, `h52`, `h88`, `h124` | `dark_red` |
| `h2`, `h22`, `h28`, `h34`, `h72` | `dark_green` |
| `h3`, `h58`, `h64`, `h70`, `h94`, `h100`, `h106`, `h130`, `h136`, `h142` | `brown` |
| `h4`, `h17`, `h18`, `h19`, `h60`, `h61`, `h67`, `h97` | `dark blue` |
| `h5`, `h53`, `h54`, `h55`, `h89`, `h90`, `h91`, `h96`, `h125`, `h126`, `h127`, `h132`, `h133`, `h139` | `dark magenta` |
| `h6`, `h23`, `h24`, `h25`, `h29`, `h30`, `h31`, `h35`, `h36`, `h37`, `h73` | `dark cyan` |
| `h7`, `h71`, `h103`, `h107`, `h108`, `h109`, `h114`, `h115`, `h116`, `h131`, `h137`, `h138`, `h143`, `h144`, `h145`, `h146`, `h150`, `h151`, `h152`, `h174`, `h180`, `h181`, `h186`, `h187`, `h188`, `h248`, `h249`, `h250`, `h251`, `h252`, `h253` | `light gray` |
| `h8`, `h59`, `h65`, `h66`, `h95`, `h101`, `h102`, `h238`, `h239`, `h240`, `h241`, `h242`, `h243`, `h244`, `h245`, `h246`, `h247` | `dark gray` |
| `h9`, `h160`, `h166`, `h167`, `h173`, `h196`, `h202`, `h203`, `h209`, `h215` | `light red` |
| `h10`, `h40`, `h41`, `h46`, `h47`, `h76`, `h77`, `h78`, `h82`, `h83`, `h84`, `h85`, `h113`, `h119`, `h120`, `h121`, `h155`, `h156` | `light green` |
| `h4`, `h17`, `h18`, `h19`, `h60`, `h61`, `h67`, `h97` | `dark_blue` |
| `h5`, `h53`, `h54`, `h55`, `h89`, `h90`, `h91`, `h96`, `h125`, `h126`, `h127`, `h132`, `h133`, `h139` | `dark_magenta` |
| `h6`, `h23`, `h24`, `h25`, `h29`, `h30`, `h31`, `h35`, `h36`, `h37`, `h73` | `dark_cyan` |
| `h7`, `h71`, `h103`, `h107`, `h108`, `h109`, `h114`, `h115`, `h116`, `h131`, `h137`, `h138`, `h143`, `h144`, `h145`, `h146`, `h150`, `h151`, `h152`, `h174`, `h180`, `h181`, `h186`, `h187`, `h188`, `h248`, `h249`, `h250`, `h251`, `h252`, `h253` | `light_gray` |
| `h8`, `h59`, `h65`, `h66`, `h95`, `h101`, `h102`, `h238`, `h239`, `h240`, `h241`, `h242`, `h243`, `h244`, `h245`, `h246`, `h247` | `dark_gray` |
| `h9`, `h160`, `h166`, `h167`, `h173`, `h196`, `h202`, `h203`, `h209`, `h215` | `light_red` |
| `h10`, `h40`, `h41`, `h46`, `h47`, `h76`, `h77`, `h78`, `h82`, `h83`, `h84`, `h85`, `h113`, `h119`, `h120`, `h121`, `h155`, `h156` | `light_green` |
| `h11`, `h112`, `h118`, `h148`, `h149`, `h154`, `h172`, `h178`, `h179`, `h184`, `h185`, `h190`, `h191`, `h208`, `h214`, `h220`, `h221`, `h226`, `h227` | `yellow` |
| `h12`, `h20`, `h21`, `h26`, `h27`, `h56`, `h57`, `h62`, `h63`, `h68`, `h69`, `h75`, `h98`, `h99`, `h104`, `h105`, `h110`, `h111`, `h135`, `h140`, `h141`, `h147` | `light blue` |
| `h13`, `h92`, `h93`, `h128`, `h134`, `h129`, `h161`, `h162`, `h163`, `h164`, `h165`, `h168`, `h169`, `h170`, `h171`, `h175`, `h176`, `h177`, `h182`, `h183`, `h197`, `h198`, `h199`, `h200`, `h201`, `h204`, `h205`, `h206`, `h207`, `h211`, `h212`, `h213`, `h218`, `h219`, `h225` | `light magenta` |
| `h14`, `h32`, `h33`, `h38`, `h39`, `h42`, `h43`, `h44`, `h45`, `h48`, `h49`, `h50`, `h51`, `h74`, `h79`, `h80`, `h81`, `h86`, `h87`, `h117`, `h122`, `h123` | `light cyan` |
| `h12`, `h20`, `h21`, `h26`, `h27`, `h56`, `h57`, `h62`, `h63`, `h68`, `h69`, `h75`, `h98`, `h99`, `h104`, `h105`, `h110`, `h111`, `h135`, `h140`, `h141`, `h147` | `light_blue` |
| `h13`, `h92`, `h93`, `h128`, `h134`, `h129`, `h161`, `h162`, `h163`, `h164`, `h165`, `h168`, `h169`, `h170`, `h171`, `h175`, `h176`, `h177`, `h182`, `h183`, `h197`, `h198`, `h199`, `h200`, `h201`, `h204`, `h205`, `h206`, `h207`, `h211`, `h212`, `h213`, `h218`, `h219`, `h225` | `light_magenta` |
| `h14`, `h32`, `h33`, `h38`, `h39`, `h42`, `h43`, `h44`, `h45`, `h48`, `h49`, `h50`, `h51`, `h74`, `h79`, `h80`, `h81`, `h86`, `h87`, `h117`, `h122`, `h123` | `light_cyan` |
| `h15`, `h153`, `h157`, `h158`, `h159`, `h189`, `h192`, `h193`, `h194`, `h195`, `h210`, `h216`, `h217`, `h222`, `h223`, `h224`, `h228`, `h229`, `h230`, `h231`, `h254`, `h255` | `white` |

### COLOR PROPERTIES
Expand Down