Automatically detect terminal background color #4674
Conversation
|
I would like to get some feedback on the approach I have taken to add support for this. I have only tested this with "Kitty" on Mac OS, more testing is needed. Should the auto light/dark detection be configurable? And maybe off by default? |
dhallas
force-pushed
the
detect_background_color
branch
from
54902b2
to
b5d55f9
Compare
dhallas
changed the title
Add support for automatically detecting the background color of the terminal using operating system command escape sequence. The response is then parsed and used to determine if the background is light or dark.
dhallas
force-pushed
the
detect_background_color
branch
from
b5d55f9
to
2192423
Compare
|
@willmcgugan - can you take a look at this MR to check if I am heading in the right direction? |
| @@ -31,6 +31,10 @@ | |||
| """Sequence received when the terminal receives focus.""" | |||
| FOCUSOUT: Final[str] = "\x1b[O" | |||
| """Sequence received when focus is lost from the terminal.""" | |||
| BG_COLOR: Final[str] = "\x1b]11;rgb:" | |||
There was a problem hiding this comment.
We have a policy in Textual of no abbreviations, so BG should be BACKGROUND.
I think this would be better done as a regex.
Do you have a reference to the docs? Can you be certain it is sent in a two hex characters?
There was a problem hiding this comment.
I will fix the abbreviation. Here is a link to some documentation on the escape sequence:
https://www.xfree86.org/current/ctlseqs.html
Search for "Operating System Controls"
| perceived_brightness = 0.2126 * r + 0.7152 * g + 0.0722 * b | ||
| return perceived_brightness < 128 | ||
|
|
||
| async def _on_background_color(self, event: events.BackgroundColor) -> None: |
There was a problem hiding this comment.
I wouldn't want to do this automatically, unless the dev explicitly requests this behaviour.
Sending the message is probably fine, until we have a mechanism for the dev to request automatic light / dark mode.
| @@ -248,6 +248,7 @@ def on_terminal_resize(signum, stack) -> None: | |||
| self.flush() | |||
| self._key_thread = Thread(target=self._run_input_thread) | |||
| send_size_event() | |||
| self.write("\x1b]11;?\x07") # Detect background color | |||
There was a problem hiding this comment.
AFAIK some terminals respond with nothing when they see a sequence they don't recognize/support, i.e. if you send requests <supported 1>;<unsupported 2>;<supported 3>; the responses will be <response 1>;<response 3> only. If anything expects order guarantee for requests it may end up waiting forever.
Is this case handled (I didn't do an in-depth review, just asking)?
There was a problem hiding this comment.
I try to handle this case gracefully by only parsing the RGB colors if the length is as expected. But, please take a good look at the code to ensure I do not have missed anything. I would also like to look into writing some unit tests for this, including the case you mention here
I tested this with the terminal.app and to my pleasant surprise it just worked, meaning that the terminal actual supports this escape sequence and responds correctly. |
Add support for automatically detecting the background color of the terminal using operating system command escape sequence. The response is then parsed and used to determine if the background is light or dark.
fixes #2419
Please review the following checklist.