rfctr: add type-stubs for behave

Author: scanny

features/steps/helpers.py

@@ -3,15 +3,15 @@
 import os
 
 
-def absjoin(*paths):
+def absjoin(*paths: str) -> str:
     return os.path.abspath(os.path.join(*paths))
 
 
-thisdir = os.path.split(__file__)[0]
-scratch_dir = absjoin(thisdir, "../_scratch")
+thisdir: str = os.path.split(__file__)[0]
+scratch_dir: str = absjoin(thisdir, "../_scratch")
 
 # scratch output docx file -------------
-saved_docx_path = absjoin(scratch_dir, "test_out.docx")
+saved_docx_path: str = absjoin(scratch_dir, "test_out.docx")
 
 bool_vals = {"True": True, "False": False}
 
@@ -24,15 +24,11 @@ def absjoin(*paths):
 }
 
 
-def test_docx(name):
-    """
-    Return the absolute path to test .docx file with root name `name`.
-    """
+def test_docx(name: str):
+    """Return the absolute path to test .docx file with root name `name`."""
     return absjoin(thisdir, "test_files", "%s.docx" % name)
 
 
-def test_file(name):
-    """
-    Return the absolute path to file with `name` in test_files directory
-    """
+def test_file(name: str):
+    """Return the absolute path to file with `name` in test_files directory"""
     return absjoin(thisdir, "test_files", "%s" % name)

pyrightconfig.json

@@ -13,6 +13,8 @@
     "pythonVersion": "3.7",
     "reportImportCycles": true,
     "reportUnnecessaryCast": true,
+    "reportUnnecessaryTypeIgnoreComment": true,
+    "stubPath": "./typings",
     "typeCheckingMode": "strict",
     "useLibraryCodeForTypes": false,
     "verboseOutput": true

typings/behave/__init__.pyi

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from typing import Callable
+
+from typing_extensions import Concatenate, ParamSpec, TypeAlias
+
+from .runner import Context
+
+_P = ParamSpec("_P")
+
+_ArgsStep: TypeAlias = Callable[Concatenate[Context, _P], None]
+_NoArgsStep: TypeAlias = Callable[[Context], None]
+
+_Step: TypeAlias = _NoArgsStep | _ArgsStep[str]
+
+def given(phrase: str) -> Callable[[_Step], _Step]: ...
+def when(phrase: str) -> Callable[[_Step], _Step]: ...
+def then(phrase: str) -> Callable[[_Step], _Step]: ...

typings/behave/runner.pyi

@@ -0,0 +1,3 @@
+from types import SimpleNamespace
+
+class Context(SimpleNamespace): ...