Extend MonkeyType annotations to terminal, testing, and more utils modules

claude · Carreau · commit 74904ca90399 · 2026-03-19T14:11:34.000+01:00
Apply MonkeyType-generated type annotations to 12 additional files, completing coverage across all modules traced during the test suite run. Files annotated: - IPython/terminal/prompts.py: Prompts.__init__ shell param, out_prompt_tokens, write_format_data - IPython/terminal/shortcuts/filters.py: has_focus, preceding_text, following_text, eval_node, filter_from_string return types - IPython/testing/decorators.py: skipif, skip, onlyif -> MarkDecorator; module_not_available -> bool - IPython/testing/ipunittest.py: Doc2UnitTester.__init__ verbose param - IPython/testing/plugin/pytest_ipdoctest.py: from_parent return, get_optionflags, _get_continue_on_failure - IPython/testing/skipdoctest.py: skip_doctest f/return -> Callable - IPython/testing/tools.py: parse_test_output, default_argv, default_config, get_ipython_cmd, ipexec, ipexec_validate, mktmp, AssertPrints - IPython/utils/capture.py: CapturedIO.__init__, stdout/stderr properties, capture_output context manager - IPython/utils/ipstruct.py: __setitem__, __setattr__, __getattr__ -> Any - IPython/utils/py3compat.py: encode, cast_unicode - IPython/utils/strdispatch.py: add_s - IPython/utils/terminal.py: toggle_set_term_title Manual corrections applied: - prompts.py: circular import with interactiveshell fixed via TYPE_CHECKING + string annotation - pytest_ipdoctest.py: removed self-referential circular import of IPDoctestItem - filters.py: replaced verbose private prompt_toolkit internal types with public Filter/Condition; removed unused Buffer/Container/UIControl imports - ipstruct.py: replaced over-specific CommandChainDispatcher with Any for general dict methods - tools.py: options: None -> Optional[List[str]], commands: Tuple[()] -> Tuple[str, ...] - capture.py/tools.py: __exit__ None params -> proper Optional[Type[BaseException]] etc. - py3compat.py: encoding: None -> Optional[str] Tests: 146 passed, 6 skipped. https://claude.ai/code/session_01L2i6WEqHEX3HyCMWgimmEp
diff --git a/IPython/terminal/prompts.py b/IPython/terminal/prompts.py
@@ -1,17 +1,21 @@
 """Terminal input and output prompts."""
 
-from pygments.token import Token
+from pygments.token import _TokenType, Token
 import sys
 
 from IPython.core.displayhook import DisplayHook
 
 from prompt_toolkit.formatted_text import fragment_list_width, PygmentsTokens
 from prompt_toolkit.shortcuts import print_formatted_text
 from prompt_toolkit.enums import EditingMode
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple
+
+if TYPE_CHECKING:
+    from IPython.terminal.interactiveshell import TerminalInteractiveShell
 
 
 class Prompts:
-    def __init__(self, shell):
+    def __init__(self, shell: "TerminalInteractiveShell"):
         self.shell = shell
 
     def vi_mode(self):
@@ -84,7 +88,7 @@ def rewrite_prompt_tokens(self):
             (Token.Prompt, ('-' * (width - 2)) + '> '),
         ]
 
-    def out_prompt_tokens(self):
+    def out_prompt_tokens(self) -> List[Tuple[_TokenType, str]]:
         return [
             (Token.OutPrompt, 'Out['),
             (Token.OutPromptNum, str(self.shell.execution_count - 1)),
@@ -128,7 +132,7 @@ def write_output_prompt(self):
             else:
                 sys.stdout.write(prompt_txt)
 
-    def write_format_data(self, format_dict, md_dict=None) -> None:
+    def write_format_data(self, format_dict: Dict[str, str], md_dict: Optional[Dict[Any, Any]]=None) -> None:
         assert self.shell is not None
         if self.shell.mime_renderers:
 
diff --git a/IPython/terminal/shortcuts/filters.py b/IPython/terminal/shortcuts/filters.py
@@ -9,7 +9,7 @@
 import re
 import signal
 import sys
-from typing import Dict, Union
+from typing import Optional, Dict, Union
 from collections.abc import Callable
 
 from prompt_toolkit.application.current import get_app
@@ -40,7 +40,7 @@ def cursor_in_leading_ws():
     return (not before) or before.isspace()
 
 
-def has_focus(value: FocusableElement):
+def has_focus(value: FocusableElement) -> Condition:
     """Wrapper around has_focus adding a nice `__name__` to tester function"""
     tester = has_focus_impl(value).func
     tester.__name__ = f"is_focused({value})"
@@ -102,7 +102,7 @@ def all_quotes_paired(quote, buf):
 _following_text_cache: Dict[Union[str, Callable], Condition] = {}
 
 
-def preceding_text(pattern: Union[str, Callable]):
+def preceding_text(pattern: Union[str, Callable]) -> Condition:
     if pattern in _preceding_text_cache:
         return _preceding_text_cache[pattern]
 
@@ -129,7 +129,7 @@ def _preceding_text():
     return condition
 
 
-def following_text(pattern):
+def following_text(pattern: str) -> Condition:
     try:
         return _following_text_cache[pattern]
     except KeyError:
@@ -284,7 +284,7 @@ def __call__(self):
 }
 
 
-def eval_node(node: Union[ast.AST, None]):
+def eval_node(node: Union[ast.AST, None]) -> Optional[Filter]:
     if node is None:
         return None
     if isinstance(node, ast.Expression):
@@ -315,7 +315,7 @@ def eval_node(node: Union[ast.AST, None]):
     raise ValueError("Unhandled node", ast.dump(node))
 
 
-def filter_from_string(code: str):
+def filter_from_string(code: str) -> Union[Condition, Filter]:
     expression = ast.parse(code, mode="eval")
     return eval_node(expression)
 
diff --git a/IPython/testing/decorators.py b/IPython/testing/decorators.py
@@ -8,8 +8,10 @@
 
 # Expose the unittest-driven decorators
 from .ipunittest import ipdoctest, ipdocstring
+from _pytest.mark.structures import MarkDecorator
+from typing import Optional
 
-def skipif(skip_condition, msg=None):
+def skipif(skip_condition: bool, msg: Optional[str]=None) -> MarkDecorator:
     """Make function raise SkipTest exception if skip_condition is true
 
     Parameters
@@ -39,7 +41,7 @@ def skipif(skip_condition, msg=None):
 
 # A version with the condition set to true, common case just to attach a message
 # to a skip decorator
-def skip(msg=None):
+def skip(msg: Optional[str]=None) -> MarkDecorator:
     """Decorator factory - mark a test function for skipping from test suite.
 
     Parameters
@@ -61,15 +63,15 @@ def skip(msg=None):
     return skipif(True, msg)
 
 
-def onlyif(condition, msg):
+def onlyif(condition: bool, msg: str) -> MarkDecorator:
     """The reverse from skipif, see skipif for details."""
 
     return skipif(not condition, msg)
 
 
 # -----------------------------------------------------------------------------
 # Utility functions for decorators
-def module_not_available(module):
+def module_not_available(module: str) -> bool:
     """Can module be imported?  Returns true if module does NOT import.
 
     This is used to make a decorator to skip tests that require module to be
diff --git a/IPython/testing/ipunittest.py b/IPython/testing/ipunittest.py
@@ -122,7 +122,7 @@ class Doc2UnitTester:
     no attempt is made at turning it into a singleton, there is no need for
     that).
     """
-    def __init__(self, verbose=False):
+    def __init__(self, verbose: bool=False):
         """New decorator.
 
         Parameters
diff --git a/IPython/testing/plugin/pytest_ipdoctest.py b/IPython/testing/plugin/pytest_ipdoctest.py
@@ -36,6 +36,7 @@
 from _pytest.compat import safe_getattr
 from _pytest.config import Config
 from _pytest.config.argparsing import Parser
+from _pytest.fixtures import TopRequest
 
 try:
     from _pytest.fixtures import TopRequest as FixtureRequest
@@ -300,7 +301,7 @@ def from_parent(  # type: ignore
         name: str,
         runner: "IPDocTestRunner",
         dtest: "doctest.DocTest",
-    ):
+    ) -> "IPDoctestItem":
         # incompatible signature due to imposed limits on subclass
         """The public named constructor."""
         return super().from_parent(name=name, parent=parent, runner=runner, dtest=dtest)
@@ -475,7 +476,7 @@ def _get_flag_lookup() -> Dict[str, int]:
     )
 
 
-def get_optionflags(parent):
+def get_optionflags(parent: "IPDoctestModule") -> int:
     optionflags_str = parent.config.getini("ipdoctest_optionflags")
     flag_lookup_table = _get_flag_lookup()
     flag_acc = 0
@@ -484,7 +485,7 @@ def get_optionflags(parent):
     return flag_acc
 
 
-def _get_continue_on_failure(config):
+def _get_continue_on_failure(config: Config) -> bool:
     continue_on_failure = config.getvalue("ipdoctest_continue_on_failure")
     if continue_on_failure:
         # We need to turn off this if we use pdb since we should stop at
diff --git a/IPython/testing/skipdoctest.py b/IPython/testing/skipdoctest.py
@@ -4,12 +4,13 @@
 numpy and sympy if they're present. Since this decorator is used in core parts
 of IPython, it's in a separate module so that running IPython doesn't trigger
 those imports."""
+from typing import Callable
 
 # Copyright (C) IPython Development Team
 # Distributed under the terms of the Modified BSD License.
 
 
-def skip_doctest(f):
+def skip_doctest(f: Callable) -> Callable:
     """Decorator - mark a function or method for skipping its doctest.
 
     This decorator allows you to mark a function whose docstring you wish to
diff --git a/IPython/testing/tools.py b/IPython/testing/tools.py
@@ -29,6 +29,8 @@
 
 from . import decorators as dec
 from . import skipdoctest
+from types import TracebackType
+from typing import List, Optional, Tuple, Type
 
 
 # The docstring for full_path doctests differently on win32 (different path
@@ -67,7 +69,7 @@ def full_path(startPath: str, files: list[str]) -> list[str]:
     return [ os.path.join(base,f) for f in files ]
 
 
-def parse_test_output(txt):
+def parse_test_output(txt: str) -> Tuple[int, int]:
     """Parse the output of a test run and return errors, failures.
 
     Parameters
@@ -113,7 +115,7 @@ def parse_test_output(txt):
 parse_test_output.__test__ = False
 
 
-def default_argv():
+def default_argv() -> List[str]:
     """Return a valid default argv for creating testing instances of ipython"""
 
     return [
@@ -126,7 +128,7 @@ def default_argv():
     ]
 
 
-def default_config():
+def default_config() -> Config:
     """Return a config object with good defaults for testing."""
     config = Config()
     config.TerminalInteractiveShell.colors = "nocolor"
@@ -139,7 +141,7 @@ def default_config():
     return config
 
 
-def get_ipython_cmd(as_string=False):
+def get_ipython_cmd(as_string: bool=False) -> List[str]:
     """
     Return appropriate IPython command line name. By default, this will return
     a list that can be used with subprocess.Popen, for example, but passing
@@ -157,7 +159,7 @@ def get_ipython_cmd(as_string=False):
 
     return ipython_cmd
 
-def ipexec(fname, options=None, commands=()):
+def ipexec(fname: str, options: Optional[List[str]]=None, commands: Tuple[str, ...]=()) -> Tuple[str, str]:
     """Utility to call 'ipython filename'.
 
     Starts IPython with a minimal and safe configuration to make startup as fast
@@ -215,8 +217,8 @@ def ipexec(fname, options=None, commands=()):
     return out, err
 
 
-def ipexec_validate(fname, expected_out, expected_err='',
-                    options=None, commands=()):
+def ipexec_validate(fname: str, expected_out: str, expected_err: str='',
+                    options: Optional[List[str]]=None, commands: Tuple[str, ...]=()):
     """Utility to call 'ipython filename' and validate output/error.
 
     This function raises an AssertionError if the validation fails.
@@ -267,7 +269,7 @@ class TempFileMixin(unittest.TestCase):
 
     Meant as a mixin class for test cases."""
 
-    def mktmp(self, src, ext='.py'):
+    def mktmp(self, src: str, ext: str='.py'):
         """Make a valid python temp file."""
         fname = temp_pyfile(src, ext)
         if not hasattr(self, 'tmps'):
@@ -318,7 +320,7 @@ class AssertPrints:
     abcd
     def
     """
-    def __init__(self, s, channel='stdout', suppress=True):
+    def __init__(self, s: str, channel: str='stdout', suppress: bool=True):
         self.s = s
         if isinstance(self.s, (str, _re_type)):
             self.s = [self.s]
@@ -331,7 +333,7 @@ def __enter__(self):
         self.tee = Tee(self.buffer, channel=self.channel)
         setattr(sys, self.channel, self.buffer if self.suppress else self.tee)
 
-    def __exit__(self, etype, value, traceback):
+    def __exit__(self, etype: Optional[Type[BaseException]], value: Optional[BaseException], traceback: Optional[TracebackType]):
         __tracebackhide__ = True
 
         try:
diff --git a/IPython/utils/capture.py b/IPython/utils/capture.py
@@ -7,6 +7,8 @@
 
 import sys
 from io import StringIO
+from types import TracebackType
+from typing import Any, List, Optional, Type
 
 #-----------------------------------------------------------------------------
 # Classes and functions
@@ -72,7 +74,7 @@ class CapturedIO:
     above in the same order, and can be invoked simply via ``c()``.
     """
 
-    def __init__(self, stdout, stderr, outputs=None):
+    def __init__(self, stdout: StringIO, stderr: StringIO, outputs: Optional[List[Any]]=None):
         self._stdout = stdout
         self._stderr = stderr
         if outputs is None:
@@ -83,14 +85,14 @@ def __str__(self):
         return self.stdout
 
     @property
-    def stdout(self):
+    def stdout(self) -> str:
         "Captured standard output"
         if not self._stdout:
             return ''
         return self._stdout.getvalue()
 
     @property
-    def stderr(self):
+    def stderr(self) -> str:
         "Captured standard error"
         if not self._stderr:
             return ''
@@ -127,13 +129,13 @@ class capture_output:
     stderr = True
     display = True
 
-    def __init__(self, stdout=True, stderr=True, display=True):
+    def __init__(self, stdout: bool=True, stderr: bool=True, display: bool=True):
         self.stdout = stdout
         self.stderr = stderr
         self.display = display
         self.shell = None
 
-    def __enter__(self):
+    def __enter__(self) -> CapturedIO:
         from IPython.core.getipython import get_ipython
         from IPython.core.displaypub import CapturingDisplayPublisher
         from IPython.core.displayhook import CapturingDisplayHook
@@ -162,7 +164,7 @@ def __enter__(self):
 
         return CapturedIO(stdout, stderr, outputs)
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(self, exc_type: Optional[Type[BaseException]], exc_value: Optional[BaseException], traceback: Optional[TracebackType]):
         sys.stdout = self.sys_stdout
         sys.stderr = self.sys_stderr
         if self.display and self.shell:
diff --git a/IPython/utils/ipstruct.py b/IPython/utils/ipstruct.py
@@ -6,6 +6,8 @@
 * Fernando Perez (original)
 * Brian Granger (refactoring to a dict subclass)
 """
+from typing import Any
+from typing import Any
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2008-2011  The IPython Development Team
@@ -62,7 +64,7 @@ def __init__(self, *args, **kw):
         object.__setattr__(self, '_allownew', True)
         dict.__init__(self, *args, **kw)
 
-    def __setitem__(self, key, value):
+    def __setitem__(self, key: str, value: Any):
         """Set an item with check for allownew.
 
         Examples
@@ -85,7 +87,7 @@ def __setitem__(self, key, value):
                 "can't create new attribute %s when allow_new_attr(False)" % key)
         dict.__setitem__(self, key, value)
 
-    def __setattr__(self, key, value):
+    def __setattr__(self, key: str, value: Any):
         """Set an attr with protection of class members.
 
         This calls :meth:`self.__setitem__` but convert :exc:`KeyError` to
@@ -119,7 +121,7 @@ def __setattr__(self, key, value):
         except KeyError as e:
             raise AttributeError(e) from e
 
-    def __getattr__(self, key):
+    def __getattr__(self, key: str) -> Any:
         """Get an attr by calling :meth:`dict.__getitem__`.
 
         Like :meth:`__setattr__`, this method converts :exc:`KeyError` to
diff --git a/IPython/utils/py3compat.py b/IPython/utils/py3compat.py
diff --git a/IPython/utils/strdispatch.py b/IPython/utils/strdispatch.py
diff --git a/IPython/utils/terminal.py b/IPython/utils/terminal.py
