Add output.is_windows() method so remote terminals are not affected by the host configuration

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 ColorDepth.default(self.output)
 
  if depth is None:
- return ColorDepth.default()
+ return ColorDepth.default(self.output)
 
  return depth
 

prompt_toolkit/output/base.py

@@ -24,6 +24,9 @@ class Output(metaclass=ABCMeta):
  :class:`~prompt_toolkit.output.win32.Win32Output`.
  """
 
+ def is_windows(self):
+ return False
+
  @abstractmethod
  def fileno(self) -> int:
  " Return the file descriptor to which we can write for the output. "

prompt_toolkit/output/color_depth.py

@@ -35,9 +35,9 @@ class ColorDepth(str, Enum):
  TRUE_COLOR = DEPTH_24_BIT
 
  @classmethod
- def default(cls, term: Optional[str] = None) -> "ColorDepth":
+ def default(cls, output: Optional[Output] = None) -> "ColorDepth":
  """
- Return the default color depth, according to the $TERM value.
+ Return the default color depth, according to the provided output.
 
  We prefer 256 colors almost always, because this is what most terminals
  support these days, and is a good default.
@@ -46,9 +46,12 @@ def default(cls, term: Optional[str] = None) -> "ColorDepth":
  override this outcome. This is a way to enforce a certain color depth
  in all prompt_toolkit applications.
 
- If no `term` parameter is given, we use the $TERM environment variable.
+ If no `output` parameter is given or it does not provide a corresponding
+ `term`, we use the $TERM environment variable.
  """
  # Take `TERM` value from environment variable if nothing was passed.
+ term = getattr(output, "term", None)
+
  if term is None:
  term = os.environ.get("TERM", "")
 
@@ -62,7 +65,7 @@ def default(cls, term: Optional[str] = None) -> "ColorDepth":
  # 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:
+ if output.is_windows() and "PROMPT_TOOLKIT_COLOR_DEPTH" not in os.environ:
  return cls.DEPTH_4_BIT
 
  # Check the `PROMPT_TOOLKIT_COLOR_DEPTH` environment variable.

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] = {

prompt_toolkit/output/win32.py

@@ -104,6 +104,9 @@ def __init__(self, stdout: TextIO, use_complete_width: bool = False) -> None:
  if _DEBUG_RENDER_OUTPUT:
  self.LOG = open(_DEBUG_RENDER_OUTPUT_FILENAME, "ab")
 
+ def is_windows(self):
+ return True
+
  def fileno(self) -> int:
  " Return file descriptor. "
  return self.stdout.fileno()

prompt_toolkit/output/windows10.py

@@ -52,6 +52,8 @@ def flush(self) -> None:
 
  def __getattr__(self, name: str) -> Any:
  if name in (
+ "term",
+ "is_windows",
  "get_size",
  "get_rows_below_cursor_position",
  "enable_mouse_support",

prompt_toolkit/renderer.py

@@ -21,7 +21,6 @@
  DummyStyleTransformation,
  StyleTransformation,
 )
-from prompt_toolkit.utils import is_windows
 
 if TYPE_CHECKING:
  from prompt_toolkit.application import Application
@@ -396,7 +395,7 @@ def reset(self, _scroll: bool = False, leave_alternate_screen: bool = True) -> N
 
  # In case of Windows, also make sure to scroll to the current cursor
  # position. (Only when rendering the first time.)
- if is_windows() and _scroll:
+ if self.output.is_windows() and _scroll:
  self.output.scroll_buffer_to_prompt()
 
  # Quit alternate screen.
@@ -433,7 +432,9 @@ def height_is_known(self) -> bool:
  is known, in order to avoid flickering when the CPR response arrives.)
  """
  return (
- self.full_screen or self._min_available_height > 0 or is_windows()
+ self.full_screen
+ or self._min_available_height > 0
+ or self.output.is_windows()
  ) # On Windows, we don't have to wait for a CPR.
 
  @property
@@ -471,7 +472,7 @@ def request_absolute_cursor_position(self) -> None:
 
  # For Win32, we have an API call to get the number of rows below the
  # cursor.
- elif is_windows():
+ elif self.output.is_windows():
  self._min_available_height = self.output.get_rows_below_cursor_position()
 
  # Use CPR.
@@ -742,7 +743,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 ColorDepth.default(output)
 
  # 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 ColorDepth.default(output)
 
  # Merges values.
  def to_text(val: Any) -> StyleAndTextTuples: