Fix type hints (#822)

Author: pokey

cursorless-talon/src/actions/actions_callback.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any, Callable
 
 from talon import Module
 
@@ -11,7 +12,7 @@
 class CallbackAction:
     term: str
     identifier: str
-    callback: callable
+    callback: Callable[[dict], Any]
 
 
 # NOTE: Please do not change these dicts.  Use the CSVs for customization.

cursorless-talon/src/actions/actions_makeshift.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Any, Optional
 
 from talon import Module
 
@@ -8,9 +9,9 @@ class MakeshiftAction:
     term: str
     identifier: str
     vscode_command_id: str
-    vscode_command_args: list = None
+    vscode_command_args: Optional[list] = None
     restore_selection: bool = False
-    post_command_sleep_ms: int = None
+    post_command_sleep_ms: Optional[int] = None
     await_command: bool = True
 
 
@@ -56,13 +57,13 @@ class MakeshiftAction:
 
 @dataclass
 class TalonOptions:
-    post_command_sleep_ms: int = None
+    post_command_sleep_ms: Optional[int] = None
     await_command: bool = True
 
 
 def get_parameters(action: MakeshiftAction):
     command = action.vscode_command_id
-    command_options = {
+    command_options: dict[str, Any] = {
         "restoreSelection": action.restore_selection,
     }
     if action.vscode_command_args:

cursorless-talon/src/actions/get_text.py

@@ -1,8 +1,12 @@
+from typing import Optional
+
 from talon import actions
 
 
 def get_text(
-    target: dict, show_decorations: bool = None, ensure_single_target: bool = None
+    target: dict,
+    show_decorations: Optional[bool] = None,
+    ensure_single_target: Optional[bool] = None,
 ):
     """Get target texts"""
     return actions.user.cursorless_single_target_command_get(

cursorless-talon/src/actions/wrap.py

@@ -29,7 +29,7 @@ def cursorless_wrapper(m) -> dict[str, Any]:
 
 
 # Maps from (action_type, wrapper_type) to action name
-action_map = {
+action_map: dict[tuple[str, str], str] = {
     ("wrapWithPairedDelimiter", "pairedDelimiter"): "wrapWithPairedDelimiter",
     # This is awkward because we used an action name which was to verbose previously
     ("wrapWithPairedDelimiter", "snippet"): "wrapWithSnippet",
@@ -41,7 +41,9 @@ def cursorless_wrapper(m) -> dict[str, Any]:
 
 @mod.action_class
 class Actions:
-    def cursorless_wrap(action_type: str, targets: dict, cursorless_wrapper: dict):
+    def cursorless_wrap(
+        action_type: str, targets: dict, cursorless_wrapper: dict[str, str]
+    ):
         """Perform cursorless wrap action"""
         wrapper_type = cursorless_wrapper["type"]
         action = action_map[(action_type, wrapper_type)]

cursorless-talon/src/cheatsheet/cheat_sheet.py

@@ -1,5 +1,6 @@
 import math
 import webbrowser
+from typing import Optional
 
 from talon import Module, actions, cron, skia, ui
 from talon.canvas import Canvas
@@ -161,7 +162,7 @@ def draw_section(self, canvas, header_text, items):
         self.draw_items(canvas, items)
 
     def draw_multicolumn_section(
-        self, canvas, items, column_names: str, scopes_limit=25
+        self, canvas, items, column_names: list[str], scopes_limit=25
     ):
         items_0 = slice_dict(items, 0, scopes_limit)
         items_1 = slice_dict(items, scopes_limit)
@@ -338,6 +339,6 @@ def is_in_rect(canvas, mouse_pos, rect):
     )
 
 
-def slice_dict(dict: dict, start: int, end: int = None):
+def slice_dict(dict: dict, start: int, end: Optional[int] = None):
     keys = sorted(dict)[start:end]
     return {key: dict[key] for key in keys}

cursorless-talon/src/command.py

@@ -122,7 +122,7 @@ def cursorless_multiple_target_command_no_wait(
 
 
 def construct_cursorless_command_argument(
-    action: str, targets: list[dict], args: list[any]
+    action: str, targets: list[dict], args: list[Any]
 ):
     try:
         use_pre_phrase_snapshot = actions.user.did_emit_pre_phrase_signal()

cursorless-talon/src/compound_targets.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from talon import Module
 
 from .connective import default_range_connective
@@ -18,7 +20,7 @@
 @mod.capture(
     rule="[<user.cursorless_range_type>] {user.cursorless_range_connective} | <user.cursorless_range_type>"
 )
-def cursorless_range_connective_with_type(m) -> str:
+def cursorless_range_connective_with_type(m) -> dict[str, Any]:
     return {
         "connective": getattr(
             m, "cursorless_range_connective", default_range_connective
@@ -34,7 +36,7 @@ def cursorless_range_connective_with_type(m) -> str:
         "<user.cursorless_primitive_target> <user.cursorless_range_connective_with_type> <user.cursorless_primitive_target>"
     )
 )
-def cursorless_range(m) -> str:
+def cursorless_range(m) -> dict[str, Any]:
     primitive_targets = m.cursorless_primitive_target_list
     range_connective_with_type = getattr(
         m, "cursorless_range_connective_with_type", None

cursorless-talon/src/csv_overrides.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
+from typing import Container, Optional
 
 from talon import Context, Module, actions, app, fs
 
@@ -21,8 +21,8 @@
 
 def init_csv_and_watch_changes(
     filename: str,
-    default_values: dict[str, dict],
-    extra_ignored_values: list[str] = None,
+    default_values: dict[str, dict[str, str]],
+    extra_ignored_values: Optional[list[str]] = None,
     allow_unknown_values: bool = False,
     default_list_name: Optional[str] = None,
     headers: list[str] = [SPOKEN_FORM_HEADER, CURSORLESS_IDENTIFIER_HEADER],
@@ -81,7 +81,7 @@ def on_watch(path, flags):
                 ctx,
             )
 
-    fs.watch(file_path.parent, on_watch)
+    fs.watch(str(file_path.parent), on_watch)
 
     if file_path.is_file():
         current_values = update_file(
@@ -113,7 +113,7 @@ def on_watch(path, flags):
         )
 
     def unsubscribe():
-        fs.unwatch(file_path.parent, on_watch)
+        fs.unwatch(str(file_path.parent), on_watch)
 
     return unsubscribe
 
@@ -177,7 +177,7 @@ def update_dicts(
 def update_file(
     path: Path,
     headers: list[str],
-    default_values: dict,
+    default_values: dict[str, str],
     extra_ignored_values: list[str],
     allow_unknown_values: bool,
     no_update_file: bool,
@@ -250,7 +250,7 @@ def csv_error(path: Path, index: int, message: str, value: str):
 def read_file(
     path: Path,
     headers: list[str],
-    default_identifiers: list[str],
+    default_identifiers: Container[str],
     extra_ignored_values: list[str],
     allow_unknown_values: bool,
 ):
@@ -313,7 +313,7 @@ def get_full_path(filename: str):
     if not filename.endswith(".csv"):
         filename = f"{filename}.csv"
 
-    user_dir = actions.path.talon_user()
+    user_dir: Path = actions.path.talon_user()
     settings_directory = Path(cursorless_settings_directory.get())
 
     if not settings_directory.is_absolute():
@@ -322,8 +322,8 @@ def get_full_path(filename: str):
     return (settings_directory / filename).resolve()
 
 
-def get_super_values(values: dict[str, dict]):
-    result = {}
-    for dict in values.values():
-        result.update(dict)
+def get_super_values(values: dict[str, dict[str, str]]):
+    result: dict[str, str] = {}
+    for value_dict in values.values():
+        result.update(value_dict)
     return result

cursorless-talon/src/marks/mark.py

@@ -230,7 +230,7 @@ def on_watch(path, flags):
         fast_reload_job = cron.after("500ms", setup_hat_styles_csv)
         slow_reload_job = cron.after("10s", setup_hat_styles_csv)
 
-    fs.watch(vscode_settings_path, on_watch)
+    fs.watch(str(vscode_settings_path), on_watch)
 
 
 app.register("ready", on_ready)

cursorless-talon/src/modifiers/matching_pair_symbol.py

@@ -1,8 +1,10 @@
+from typing import Any
+
 from talon import Module
 
 mod = Module()
 
 
 @mod.capture(rule="matching")
-def cursorless_matching_paired_delimiter(m) -> str:
+def cursorless_matching_paired_delimiter(m) -> dict[str, Any]:
     return {"modifier": {"type": "matchingPairedDelimiter"}}

cursorless-talon/src/modifiers/position.py

@@ -19,7 +19,7 @@
 }
 
 
-def construct_positional_modifier(position: str) -> dict:
+def construct_positional_modifier(position: str) -> dict[str, Any]:
     return {"type": "position", "position": position}
 
 

cursorless-talon/src/modifiers/sub_token.py

@@ -11,7 +11,7 @@
 
 
 @mod.capture(rule="<user.ordinals_small> | last")
-def ordinal_or_last(m) -> str:
+def ordinal_or_last(m) -> int:
     """An ordinal or the word 'last'"""
     if m[0] == "last":
         return -1
@@ -21,7 +21,7 @@ def ordinal_or_last(m) -> str:
 @mod.capture(
     rule="<user.ordinal_or_last> [{user.cursorless_range_connective} <user.ordinal_or_last>]"
 )
-def cursorless_ordinal_range(m) -> str:
+def cursorless_ordinal_range(m) -> dict[str, Any]:
     """Ordinal range"""
     try:
         range_connective = m.cursorless_range_connective
@@ -40,7 +40,7 @@ def cursorless_ordinal_range(m) -> str:
 
 
 @mod.capture(rule="(first | last) <number_small>")
-def cursorless_first_last_range(m) -> str:
+def cursorless_first_last_range(m) -> dict[str, Any]:
     """First/last range"""
     if m[0] == "first":
         return {"anchor": 0, "active": m.number_small - 1}

cursorless-talon/src/positional_target.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from talon import Module
 
 from .modifiers.position import construct_positional_modifier
@@ -11,16 +13,16 @@
         "<user.cursorless_target>"
     )
 )
-def cursorless_positional_target(m) -> list[dict]:
-    target = m.cursorless_target
+def cursorless_positional_target(m) -> dict[str, Any]:
+    target: dict[str, Any] = m.cursorless_target
     try:
         modifier = construct_positional_modifier(m.cursorless_position)
         return update_first_primitive_target(target, modifier)
     except AttributeError:
         return target
 
 
-def update_first_primitive_target(target: dict, modifier: dict):
+def update_first_primitive_target(target: dict[str, Any], modifier: dict[str, Any]):
     if target["type"] == "primitive":
         if "modifiers" not in target:
             target["modifiers"] = []