Add get_default_color_depth method to Output objects

Author: vxgmichel

prompt_toolkit/application/application.py

@@ -366,10 +366,10 @@ def color_depth(self) -> ColorDepth:
  depth = self._color_depth
 
  if callable(depth):
- return depth() or ColorDepth.default()
+ return depth() or self.output.get_default_color_depth()
 
  if depth is None:
- return ColorDepth.default()
+ return self.output.get_default_color_depth()
 
  return depth
 

prompt_toolkit/output/base.py

@@ -163,6 +163,10 @@ def get_rows_below_cursor_position(self) -> int:
  " For Windows only. "
  raise NotImplementedError
 
+ @abstractmethod
+ def get_default_color_depth(self) -> ColorDepth:
+ " Get default color depth for this output. "
+
 
 class DummyOutput(Output):
  """
@@ -265,3 +269,6 @@ def get_size(self) -> Size:
 
  def get_rows_below_cursor_position(self) -> int:
  return 40
+
+ def get_default_color_depth(self) -> ColorDepth:
+ return ColorDepth.DEPTH_1_BIT

prompt_toolkit/output/color_depth.py

@@ -35,7 +35,7 @@ class ColorDepth(str, Enum):
  TRUE_COLOR = DEPTH_24_BIT
 
  @classmethod
- def default(cls, term: Optional[str] = None) -> "ColorDepth":
+ def local_default(cls, term: Optional[str] = None) -> "ColorDepth":
  """
  Return the default color depth, according to the $TERM value.
 
@@ -50,25 +50,46 @@ def default(cls, term: Optional[str] = None) -> "ColorDepth":
  """
  # Take `TERM` value from environment variable if nothing was passed.
  if term is None:
- term = os.environ.get("TERM", "")
+ term = os.environ.get("TERM")
+
+ if is_dumb_terminal(term):
+ return cls.DEPTH_1_BIT
+
+ # Check the `PROMPT_TOOLKIT_COLOR_DEPTH` environment variable.
+ all_values = [i.value for i in ColorDepth]
+ if os.environ.get("PROMPT_TOOLKIT_COLOR_DEPTH") in all_values:
+ return cls(os.environ["PROMPT_TOOLKIT_COLOR_DEPTH"])
+
+ return cls.windows_default() if is_windows() else cls.vt100_default(term)
+
+ @classmethod
+ def vt100_default(cls, term: Optional[str] = None) -> "ColorDepth":
+ """Return the default color depth for a vt100 terminal, according to the term
+ value.
+
+ Contrary to `local_default`, this method doesn't take the local system into
+ account.
+ """
+ if term is None:
+ return cls.DEFAULT
 
  if is_dumb_terminal(term):
  return cls.DEPTH_1_BIT
 
  if term in ("linux", "eterm-color"):
  return cls.DEPTH_4_BIT
 
+ return cls.DEFAULT
+
+ @classmethod
+ def windows_default(cls) -> "ColorDepth":
+ """Return the default color depth for a windows terminal.
+
+ Contrary to `local_default`, this method doesn't take the local system into
+ account.
+ """
  # For now, always use 4 bit color on Windows 10 by default, even when
  # vt100 escape sequences with ENABLE_VIRTUAL_TERMINAL_PROCESSING are
  # supported. We don't have a reliable way yet to know whether our
  # console supports true color or only 4-bit.
- if is_windows() and "PROMPT_TOOLKIT_COLOR_DEPTH" not in os.environ:
- return cls.DEPTH_4_BIT
-
- # Check the `PROMPT_TOOLKIT_COLOR_DEPTH` environment variable.
- all_values = [i.value for i in ColorDepth]
-
- if os.environ.get("PROMPT_TOOLKIT_COLOR_DEPTH") in all_values:
- return cls(os.environ["PROMPT_TOOLKIT_COLOR_DEPTH"])
-
- return cls.DEPTH_8_BIT
+ return cls.DEPTH_4_BIT

prompt_toolkit/output/vt100.py

@@ -426,7 +426,7 @@ def __init__(
  self.stdout = stdout
  self.write_binary = write_binary
  self._get_size = get_size
- self.term = term or "xterm"
+ self.term = term
 
  # Cache for escape codes.
  self._escape_code_caches: Dict[ColorDepth, _EscapeCodeCache] = {
@@ -683,3 +683,6 @@ def bell(self) -> None:
  " Sound bell. "
  self.write_raw("\a")
  self.flush()
+
+ def get_default_color_depth(self) -> ColorDepth:
+ return ColorDepth.vt100_default(self.term)

prompt_toolkit/output/win32.py

@@ -479,6 +479,9 @@ def win32_refresh_window(cls) -> None:
  RDW_INVALIDATE = 0x0001
  windll.user32.RedrawWindow(handle, None, None, c_uint(RDW_INVALIDATE))
 
+ def get_default_color_depth(self) -> ColorDepth:
+ return ColorDepth.windows_default()
+
 
 class FOREGROUND_COLOR:
  BLACK = 0x0000

prompt_toolkit/output/windows10.py

@@ -60,6 +60,7 @@ def __getattr__(self, name: str) -> Any:
  "get_win32_screen_buffer_info",
  "enable_bracketed_paste",
  "disable_bracketed_paste",
+ "get_default_color_depth",
  ):
  return getattr(self.win32_output, name)
  else:

prompt_toolkit/renderer.py

@@ -742,7 +742,7 @@ def print_formatted_text(
  """
  fragments = to_formatted_text(formatted_text)
  style_transformation = style_transformation or DummyStyleTransformation()
- color_depth = color_depth or ColorDepth.default()
+ color_depth = color_depth or output.get_default_color_depth()
 
  # Reset first.
  output.reset_attributes()

prompt_toolkit/shortcuts/utils.py

@@ -114,7 +114,7 @@ def print_formatted_text(
  assert isinstance(output, Output)
 
  # Get color depth.
- color_depth = color_depth or ColorDepth.default()
+ color_depth = color_depth or output.get_default_color_depth()
 
  # Merges values.
  def to_text(val: Any) -> StyleAndTextTuples: