Add typechecking

Author: has2k1

Makefile

@@ -65,6 +65,9 @@ lint-fix:
 
 fix: format-fix lint-fix
 
+typecheck:
+	$(UVRUN) pyright
+
 test: clean-test
 	$(UVRUN) pytest
 

pyproject.toml

@@ -31,6 +31,7 @@ dev = [
     "pytest-cov>=4.0.0",
     "coveralls",
     "matplotlib",
+    "pyright>=1.1.405",
 ]
 
 [project.urls]
@@ -130,3 +131,45 @@ exclude = [
 
 # Allow unused variables when underscore-prefixed.
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+########## Tool - Pyright ##########
+[tool.pyright]
+# Paths of directories or files that should be included. If no paths
+# are specified, pyright defaults to the directory that contains the
+# config file. Paths may contain wildcard characters ** (a directory or
+# multiple levels of directories), * (a sequence of zero or more
+# characters), or ? (a single character). If no include paths are
+# specified, the root path for the workspace is assumed.
+include = [
+    "src/gnuplot_kernel/"
+]
+
+# Paths of directories or files whose diagnostic output (errors and
+# warnings) should be suppressed even if they are an included file or
+# within the transitive closure of an included file. Paths may contain
+# wildcard characters ** (a directory or multiple levels of
+# directories), * (a sequence of zero or more characters), or ? (a
+# single character).
+ignore = []
+
+# Set of identifiers that should be assumed to contain a constant
+# value wherever used within this program. For example, { "DEBUG": true
+# } indicates that pyright should assume that the identifier DEBUG will
+# always be equal to True. If this identifier is used within a
+# conditional expression (such as if not DEBUG:) pyright will use the
+# indicated value to determine whether the guarded block is reachable
+# or not. Member expressions that reference one of these constants
+# (e.g. my_module.DEBUG) are also supported.
+defineConstant = { DEBUG = true }
+
+# typeCheckingMode = "strict"
+useLibraryCodeForTypes = true
+reportUnnecessaryTypeIgnoreComment = true
+
+# Specifies a list of execution environments (see below). Execution
+# environments are searched from start to finish by comparing the path
+# of a source file with the root path specified in the execution
+# environment.
+executionEnvironments = []
+
+stubPath = ""

src/gnuplot_kernel/kernel.py

@@ -1,8 +1,11 @@
+from __future__ import annotations
+
 import contextlib
 import sys
 import uuid
 from itertools import chain
 from pathlib import Path
+from typing import cast
 
 from IPython.display import SVG, Image
 from metakernel import MetaKernel, ProcessMetaKernel, pexpect
@@ -25,8 +28,8 @@ class GnuplotKernel(ProcessMetaKernel):
     implementation = "Gnuplot Kernel"
     implementation_version = get_version("gnuplot_kernel")
     language = "gnuplot"
-    language_version = "5.0"
-    banner = "Gnuplot Kernel"
+    _banner = "Gnuplot Kernel"
+    language_version = "5.0"  # pyright: ignore[reportAssignmentType,reportIncompatibleMethodOverride]
     language_info = {
         "mimetype": "text/x-gnuplot",
         "name": "gnuplot",
@@ -50,20 +53,20 @@ class GnuplotKernel(ProcessMetaKernel):
     inline_plotting = True
     reset_code = ""
     _first = True
-    _image_files = []
+    _image_files: list[Path] = []
     _error = False
 
+    wrapper: GnuplotREPLWrapper
+
     def bad_prompt_warning(self):
         """
         Print warning if the prompt is not 'gnuplot>'
         """
-        if not self.wrapper.prompt.startswith("gnuplot>"):
-            msg = "Warning: The prompt is currently set to '{}'".format(
-                self.wrapper.prompt
-            )
-            print(msg)
+        prompt = cast("str", self.wrapper.prompt).strip()
+        if not prompt.endswith("gnuplot>"):
+            print(f"Warning: The prompt is currently set to '{prompt}'")
 
-    def do_execute_direct(self, code):
+    def do_execute_direct(self, code, silent=False):
         # We wrap the real function so that gnuplot_kernel can
         # give a message when an exception occurs. Without
         # this, an exception happens silently
@@ -73,7 +76,7 @@ def do_execute_direct(self, code):
             print(f"Error: {err}")
             raise err
 
-    def _do_execute_direct(self, code):
+    def _do_execute_direct(self, code: str) -> TextOutput | None:
         """
         Execute gnuplot code
         """
@@ -105,7 +108,7 @@ def _do_execute_direct(self, code):
         # No empty strings
         return result if (result and result.output) else None
 
-    def add_inline_image_statements(self, code):
+    def add_inline_image_statements(self, code: str) -> str:
         """
         Add 'set output ...' before every plotting statement
 
@@ -188,6 +191,8 @@ def display_images(self):
         settings = self.plot_settings
         if self.inline_plotting:
             _Image = SVG if settings["format"] == "svg" else Image
+        else:
+            return
 
         for filename in self.iter_image_files():
             try:
@@ -238,12 +243,11 @@ def makeWrapper(self):
         else:
             command = program
 
-        d = dict(
+        wrapper = GnuplotREPLWrapper(
             cmd_or_spawn=command,
             prompt_regex=PROMPT_RE,
             prompt_change_cmd=None,
         )
-        wrapper = GnuplotREPLWrapper(**d)
         # No sleeping before sending commands to gnuplot
         wrapper.child.delaybeforesend = 0
         return wrapper
@@ -258,11 +262,8 @@ def do_shutdown(self, restart):
     def get_kernel_help_on(self, info, level=0, none_on_fail=False):
         obj = info.get("help_obj", "")
         if not obj or len(obj.split()) > 1:
-            if none_on_fail:
-                return None
-            else:
-                return ""
-        res = self.do_execute_direct("help %s" % obj)
+            return None if none_on_fail else "" 
+        res = cast("TextOutput", self.do_execute_direct("help %s" % obj))
         text = PROMPT_REMOVE_RE.sub("", res.output)
         self.bad_prompt_warning()
         return text

src/gnuplot_kernel/magics/gnuplot_magic.py

@@ -108,23 +108,21 @@ def register_ipython_magics():
     # not the main kernel and it may not have access
     # to some functionality. This connects it to the
     # main kernel.
-    from IPython import get_ipython
+    from IPython.core.getipython import get_ipython
 
     ip = get_ipython()
-    kernel.makeSubkernel(ip.parent)
+    kernel.makeSubkernel(ip.parent)  # pyright: ignore[reportOptionalMemberAccess]
 
     # Make magics callable:
     kernel.line_magics["gnuplot"] = magic
     kernel.cell_magics["gnuplot"] = magic
 
     @register_line_magic
-    def gnuplot(line):
+    def _(line):
         magic.line_gnuplot(line)
 
-    del gnuplot
-
     @register_cell_magic
-    def gnuplot(line, cell):
+    def _(line, cell):
         magic.code = cell
         magic.cell_gnuplot()
 

src/gnuplot_kernel/py.typed

@@ -1,6 +1,7 @@
 import re
 import signal
 import textwrap
+from typing import cast
 
 from metakernel import REPLWrapper
 from metakernel.pexpect import TIMEOUT
@@ -84,7 +85,7 @@ def validate_input(self, code):
     def send(self, cmd):
         self.child.send(cmd + "\r")
 
-    def _force_prompt(self, timeout=30, n=4):
+    def _force_prompt(self, timeout: float=30, n=4):
         """
         Force prompt
         """
@@ -109,7 +110,7 @@ def patient_prompt():
 
         # Eagerly try to get a prompt quickly,
         # If that fails wait a while
-        for i in range(n):
+        for _ in range(n):
             if quick_prompt():
                 break
 
@@ -209,27 +210,32 @@ def _splitlines(self, code):
 
         return lines
 
-    def run_command(
-        self, code, timeout=-1, stream_handler=None, stdin_handler=None
+    def run_command(  # pyright: ignore[reportIncompatibleMethodOverride]
+        self,
+        command,
+        timeout=-1,
+        stream_handler=None,
+        line_handler=None,
+        stdin_handler=None,
     ):
         """
         Run code
 
         This overrides the baseclass method to allow for
         input validation and error handling.
         """
-        code = self.validate_input(code)
+        command = self.validate_input(command)
 
         # Split up multiline commands and feed them in bit-by-bit
-        stmts = self._splitlines(code)
+        stmts = self._splitlines(command)
         output_lines = []
         for line in stmts:
             self.send(line)
             self._force_prompt()
 
             # Removing any crlfs makes subsequent
             # processing cleaner
-            retval = self.child.before.replace(CRLF, "\n")
+            retval = cast("str", self.child.before).replace(CRLF, "\n")
             self.prompt = self.child.after
             if self.is_error_output(retval):
                 msg = "{}\n{}".format(line, textwrap.dedent(retval))

src/gnuplot_kernel/replwrap.py

@@ -5,7 +5,7 @@
 from importlib.metadata import version
 
 
-def get_version(package):
+def get_version(package: str) -> str:
     """
     Return the package version