crashhandler: Cast rptdir to Path (ipython#14578)

Previously `self.app.ipython_dir` is a string, which makes
`Path.is_dir(<object>)` fail. Note that the argument is `self` i.e.
should be a `Path` instance.

If `ipython_dir` is `None` then this code would just catch it in the
`except:` branch, which makes it be set to `Path.cwd()` anyway.

Author: Carreau

IPython/core/crashhandler.py

@@ -24,14 +24,17 @@
 from pprint import pformat
 from pathlib import Path
 
+import builtins as builtin_mod
+
 from IPython.core import ultratb
+from IPython.core.application import Application
 from IPython.core.release import author_email
 from IPython.utils.sysinfo import sys_info
-from IPython.utils.py3compat import input
 
 from IPython.core.release import __version__ as version
 
-from typing import Optional
+from typing import Optional, Dict
+import types
 
 #-----------------------------------------------------------------------------
 # Code
@@ -84,7 +87,7 @@
 """
 
 
-class CrashHandler(object):
+class CrashHandler:
     """Customizable crash handlers for IPython applications.
 
     Instances of this class provide a :meth:`__call__` method which can be
@@ -95,10 +98,11 @@ def __call__(self, etype, evalue, etb)
 
     message_template = _default_message_template
     section_sep = '\n\n'+'*'*75+'\n\n'
+    info: Dict[str, Optional[str]]
 
     def __init__(
         self,
-        app,
+        app: Application,
         contact_name: Optional[str] = None,
         contact_email: Optional[str] = None,
         bug_tracker: Optional[str] = None,
@@ -142,10 +146,14 @@ def __init__(
                     bug_tracker = bug_tracker,
                     crash_report_fname = self.crash_report_fname)
 
-
-    def __call__(self, etype, evalue, etb):
+    def __call__(
+        self,
+        etype: type[BaseException],
+        evalue: BaseException,
+        etb: types.TracebackType,
+    ) -> None:
         """Handle an exception, call for compatible with sys.excepthook"""
-        
+
         # do not allow the crash handler to be called twice without reinstalling it
         # this prevents unlikely errors in the crash handling from entering an
         # infinite loop.
@@ -155,21 +163,23 @@ def __call__(self, etype, evalue, etb):
         color_scheme = 'NoColor'
 
         # Use this ONLY for developer debugging (keep commented out for release)
-        #color_scheme = 'Linux'   # dbg
-        try:
-            rptdir = self.app.ipython_dir
-        except:
+        # color_scheme = 'Linux'   # dbg
+        ipython_dir = getattr(self.app, "ipython_dir", None)
+        if ipython_dir is not None:
+            assert isinstance(ipython_dir, str)
+            rptdir = Path(ipython_dir)
+        else:
             rptdir = Path.cwd()
-        if rptdir is None or not Path.is_dir(rptdir):
+        if not rptdir.is_dir():
             rptdir = Path.cwd()
         report_name = rptdir / self.crash_report_fname
         # write the report filename into the instance dict so it can get
         # properly expanded out in the user message template
-        self.crash_report_fname = report_name
-        self.info['crash_report_fname'] = report_name
+        self.crash_report_fname = str(report_name)
+        self.info["crash_report_fname"] = str(report_name)
         TBhandler = ultratb.VerboseTB(
             color_scheme=color_scheme,
-            long_header=1,
+            long_header=True,
             call_pdb=self.call_pdb,
         )
         if self.call_pdb:
@@ -195,11 +205,11 @@ def __call__(self, etype, evalue, etb):
             print(self.message_template.format(**self.info), file=sys.stderr)
 
             # Construct report on disk
-            report.write(self.make_report(traceback))
+            report.write(self.make_report(str(traceback)))
 
-        input("Hit <Enter> to quit (your terminal may close):")
+        builtin_mod.input("Hit <Enter> to quit (your terminal may close):")
 
-    def make_report(self,traceback):
+    def make_report(self, traceback: str) -> str:
         """Return a string containing a crash report."""
 
         sec_sep = self.section_sep
@@ -211,8 +221,8 @@ def make_report(self,traceback):
         try:
             config = pformat(self.app.config)
             rpt_add(sec_sep)
-            rpt_add('Application name: %s\n\n' % self.app_name)
-            rpt_add('Current user configuration structure:\n\n')
+            rpt_add("Application name: %s\n\n" % self.app.name)
+            rpt_add("Current user configuration structure:\n\n")
             rpt_add(config)
         except:
             pass
@@ -221,7 +231,9 @@ def make_report(self,traceback):
         return ''.join(report)
 
 
-def crash_handler_lite(etype, evalue, tb):
+def crash_handler_lite(
+    etype: type[BaseException], evalue: BaseException, tb: types.TracebackType
+) -> None:
     """a light excepthook, adding a small message to the usual traceback"""
     traceback.print_exception(etype, evalue, tb)
 

IPython/utils/sysinfo.py

@@ -99,7 +99,7 @@ def get_sys_info() -> dict:
     path = Path(__file__, "..").resolve().parent
     return pkg_info(str(path))
 
-def sys_info():
+def sys_info() -> str:
     """Return useful information about IPython and the system, as a string.
 
     Examples

pyproject.toml

@@ -137,15 +137,27 @@ exclude = [
    'IPython/utils/_process_win32.py',
    'IPython/utils/path.py',
 ]
-disallow_untyped_defs = true
+# check_untyped_defs = true
+# disallow_untyped_calls = true
+# disallow_untyped_decorators = true
 # ignore_errors = false
 # ignore_missing_imports = false
-# disallow_untyped_calls = true
 disallow_incomplete_defs = true
-# check_untyped_defs = true
-# disallow_untyped_decorators = true
+disallow_untyped_defs = true
 warn_redundant_casts = true
 
+[[tool.mypy.overrides]]
+module = [
+    "IPython.core.crashhandler",
+]
+check_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+ignore_errors = false
+ignore_missing_imports = false
+
 [[tool.mypy.overrides]]
 module = [
     "IPython.utils.text",
@@ -165,6 +177,7 @@ disallow_incomplete_defs = false
 check_untyped_defs = false
 disallow_untyped_decorators = false
 
+
 # gloabl ignore error
 [[tool.mypy.overrides]]
 module = [
@@ -177,7 +190,6 @@ module = [
     "IPython.core.compilerop",
     "IPython.core.completer",
     "IPython.core.completerlib",
-    "IPython.core.crashhandler",
     "IPython.core.debugger",
     "IPython.core.display",
     "IPython.core.display_functions",