Renamed functions in cmd2.ansi.Cursor to start with underscore to make it clear they are intended for internal use only

Author: tleonhardt

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Breaking Change
     - `cmd2` 2.6 supports Python 3.9+ (removed support for Python 3.8)
+    - Renamed methods in `cmd2.ansi.Cursor` to make it clear they are intended for internal use only as was documented
 - Enhancements
     - Add support for Python 3.14
 

cmd2/ansi.py

@@ -213,27 +213,27 @@ class Cursor:
     """Create ANSI sequences to alter the cursor position."""
 
     @staticmethod
-    def up(count: int = 1) -> str:
+    def _up(count: int = 1) -> str:
         """Move the cursor up a specified amount of lines (Defaults to 1)."""
         return f"{CSI}{count}A"
 
     @staticmethod
-    def down(count: int = 1) -> str:
+    def _down(count: int = 1) -> str:
         """Move the cursor down a specified amount of lines (Defaults to 1)."""
         return f"{CSI}{count}B"
 
     @staticmethod
-    def forward(count: int = 1) -> str:
+    def _forward(count: int = 1) -> str:
         """Move the cursor forward a specified amount of lines (Defaults to 1)."""
         return f"{CSI}{count}C"
 
     @staticmethod
-    def back(count: int = 1) -> str:
+    def _back(count: int = 1) -> str:
         """Move the cursor back a specified amount of lines (Defaults to 1)."""
         return f"{CSI}{count}D"
 
     @staticmethod
-    def set_pos(x: int, y: int) -> str:
+    def _set_pos(x: int, y: int) -> str:
         """Set the cursor position to coordinates which are 1-based."""
         return f"{CSI}{y};{x}H"
 
@@ -1059,11 +1059,11 @@ def async_alert_str(*, terminal_columns: int, prompt: str, line: str, cursor_off
 
     # Move the cursor down to the last input line
     if cursor_input_line != num_input_terminal_lines:
-        terminal_str += Cursor.down(num_input_terminal_lines - cursor_input_line)
+        terminal_str += Cursor._down(num_input_terminal_lines - cursor_input_line)
 
     # Clear each line from the bottom up so that the cursor ends up on the first prompt line
     total_lines = num_prompt_terminal_lines + num_input_terminal_lines
-    terminal_str += (clear_line() + Cursor.up(1)) * (total_lines - 1)
+    terminal_str += (clear_line() + Cursor._up(1)) * (total_lines - 1)
 
     # Clear the first prompt line
     terminal_str += clear_line()

tests/test_ansi.py

@@ -202,14 +202,14 @@ def test_clear_line() -> None:
 
 def test_cursor() -> None:
     count = 1
-    assert ansi.Cursor.up(count) == f"{ansi.CSI}{count}A"
-    assert ansi.Cursor.down(count) == f"{ansi.CSI}{count}B"
-    assert ansi.Cursor.forward(count) == f"{ansi.CSI}{count}C"
-    assert ansi.Cursor.back(count) == f"{ansi.CSI}{count}D"
+    assert ansi.Cursor._up(count) == f"{ansi.CSI}{count}A"
+    assert ansi.Cursor._down(count) == f"{ansi.CSI}{count}B"
+    assert ansi.Cursor._forward(count) == f"{ansi.CSI}{count}C"
+    assert ansi.Cursor._back(count) == f"{ansi.CSI}{count}D"
 
     x = 4
     y = 5
-    assert ansi.Cursor.set_pos(x, y) == f"{ansi.CSI}{y};{x}H"
+    assert ansi.Cursor._set_pos(x, y) == f"{ansi.CSI}{y};{x}H"
 
 
 @pytest.mark.parametrize(