Add rudimentary type checking configuration and address some errors

.github/workflows/lint.yml

@@ -2,6 +2,7 @@ name: Lint
 
 on:
   push:
+    branch: master
     paths:
       - '.github/workflows/lint.yml'
       - '**.py'

.github/workflows/syntax.yml

@@ -2,6 +2,7 @@ name: Syntax Tests
 
 on:
   push:
+    branch: master
     paths:
       - '.github/workflows/syntax.yml'
       - '**.sublime-syntax'

.github/workflows/typecheck.yml

@@ -0,0 +1,23 @@
+name: Lint
+
+on:
+  push:
+    branch: master
+    paths:
+      - '.github/workflows/typecheck.yml'
+      - '**.py'
+  pull_request:
+    paths:
+      - '.github/workflows/typecheck.yml'
+      - '**.py'
+
+jobs:
+  ty:
+    name: Ty
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: astral-sh/setup-uv@v8.3.2
+
+      - run: uv run ty check .

main.py

@@ -1,6 +1,7 @@
 import sys
 
 # clear modules cache if package is reloaded (after update?)
+assert __package__
 prefix = __package__ + ".plugins"  # don't clear the base package
 for module_name in [
     module_name
@@ -10,4 +11,5 @@
     del sys.modules[module_name]
 del prefix
 
+assert __package__
 from .plugins import *  # noqa

plugins/color_scheme_dev.py

@@ -112,7 +112,7 @@ def _collect_inherited_variables(name=None, extends=None, excludes=set()):
                     logger.debug("Skipping old-style theme '%s'", resource)
                     continue
                 if not isinstance(contents, dict):
-                    logger.warn("Unexpected root value in '%s': %s", resource, type(contents))
+                    logger.warning("Unexpected root value in '%s': %s", resource, type(contents))
                     continue
                 if 'variables' in contents:
                     for k, v in contents['variables'].items():
@@ -201,8 +201,10 @@ def _scope_prefix(self, locations):
         prefixes = set()
         for point in locations:
             text = self._line_prefix(point)
-            real_prefix = re.search(r'[\w.-]*$', text).group(0)  # may be zero-length
-            prefixes.add(real_prefix)
+            match = re.search(r'[\w.-]*$', text)
+            if not match:
+                return None
+            prefixes.add(match.group(0))  # may be zero-length
 
         if len(prefixes) > 1:
             return None

plugins/file_conversion.py

@@ -144,6 +144,7 @@ def run(
             # Auto-detect the file type if it's not specified
             if not source_format:
                 output.write("Input type not specified, auto-detecting...")
+                Loader = None
                 for Loader in loaders.get.values():
                     if Loader.file_is_valid(self.view):
                         source_format = Loader.ext
@@ -152,7 +153,7 @@ def run(
 
                 if not source_format:
                     return output.print("\nUnable to detect file type.")
-                elif target_format == source_format:
+                elif Loader and target_format == source_format:
                     return output.print(f"File already is {Loader.name}.")
 
             # Load inline options

plugins/lib/fileconv/dumpers.py

@@ -75,7 +75,7 @@ class DumperProto:
     ext: ClassVar[str] = ""
     output_panel_name: ClassVar[str] = "package_dev"
     default_params: ClassVar[dict[str, Any]] = {}
-    allowed_params: ClassVar[set] = set()
+    allowed_params: ClassVar[set[str]] = set()
 
     def __init__(self, window, view, new_file_path, output=None, file_path=None, *args, **kwargs):
         """Guess what this does."""

plugins/lib/fileconv/loaders.py

@@ -227,6 +227,8 @@ def load_options(self, view):
             try:
                 line = coorded_substr(view, (i, 0), (i, -1))
                 optstr = re.search(self.opt_regex, line)
+                if not optstr:
+                    continue
                 # Just parse the string with yaml; wrapped in {}
                 # Yeah, I'm lazy like that, but see, I even put "safe_" in front of it
                 return yaml.safe_load(f'{{{optstr.group(1)}}}')

plugins/lib/scope_data/__init__.py

@@ -34,31 +34,6 @@ def create_scope_suffix_completion(name: str):
     return create_scope_completion(name, "base suffix", True)
 
 
-class NodeSet(set):
-    """
-    Methods:
-        * find(name)
-        * find_all(name)
-        * to_completion()
-    """
-
-    def find(self, name):
-        for node in self:
-            if node == name:
-                return node
-        return None
-
-    def find_all(self, name):
-        res = NodeSet()
-        for node in self:
-            if node == name:
-                res.add(node)
-        return res
-
-    def to_completion(self):
-        return [create_scope_completion(n.name) for n in self]
-
-
 class ScopeNode:
     """
     Attributes:
@@ -111,6 +86,31 @@ def __repr__(self):
         return ret
 
 
+class NodeSet(set[ScopeNode]):
+    """
+    Methods:
+        * find(name)
+        * find_all(name)
+        * to_completion()
+    """
+
+    def find(self, name):
+        for node in self:
+            if node == name:
+                return node
+        return None
+
+    def find_all(self, name):
+        res = NodeSet()
+        for node in self:
+            if node == name:
+                res.add(node)
+        return res
+
+    def to_completion(self):
+        return [create_scope_completion(n.name) for n in self]
+
+
 #######################################
 
 # output values

plugins/lib/syntax_paths.py

@@ -2,6 +2,7 @@
 
 _BASE_TMPL = "Packages/{package_name}/Package/{sub_package_name}/{file_name}{ext}"
 
+assert __package__
 _package_name = __package__.split(".")[0]
 
 

plugins/settings/__init__.py

@@ -127,17 +127,17 @@ def __init__(self, view):
         # See also https://lists.gt.net/python/python/139992
         sublime_plugin.ViewEventListener.__init__(self, view)
 
-        filepath = view.file_name()
+        filepath: str | None = view.file_name()
         logger.debug("initializing SettingsListener for %r", view.file_name())
 
         self.known_settings = None
         if filepath:
             filename = os.path.basename(filepath)
             if filepath.endswith(".sublime-project") or is_widget_file(filename):
                 logger.debug("Opening a widget settings or project file")
-                self.known_settings = KnownSettings(PREF_FILE)
+                self.known_settings = KnownSettings.load(PREF_FILE)
             elif filepath.endswith(".sublime-settings"):
-                self.known_settings = KnownSettings(filename)
+                self.known_settings = KnownSettings.load(filename)
 
         if self.known_settings:
             self.known_settings.add_on_loaded(self.do_linting)

plugins/settings/known_settings.py

@@ -1,10 +1,13 @@
+from __future__ import annotations
+
 import collections
 import logging
 import os
 import re
 import textwrap
 import time
-import weakref
+from typing import ClassVar
+from weakref import WeakValueDictionary
 
 import sublime
 from sublime_lib import ResourcePath, encodings
@@ -87,51 +90,46 @@ class KnownSettings:
 
     # cache for instances, keyed by the basename
     # and using weakrefs for easy garbage collection
-    cache = weakref.WeakValueDictionary()
-
-    _is_initialized = False
-    _is_loaded = False
-    filename = None
-    on_loaded_callbacks = None
-    on_loaded_once_callbacks = None
-    defaults = None
-    comments = None
-    fallback_settings = None
-
-    def __new__(cls, filename, on_loaded=None, **kwargs):
-        # __init__ will be called on the return value
+    cache: ClassVar[WeakValueDictionary[str, KnownSettings]] = WeakValueDictionary()
+
+    on_loaded_callbacks: list[WeakMethodProxy]
+    on_loaded_once_callbacks: list[WeakMethodProxy]
+    defaults: collections.ChainMap[str, object]
+    comments: collections.ChainMap[str, str]
+    fallback_settings: KnownSettings | None = None
+
+    @classmethod
+    def load(cls, filename, /) -> KnownSettings:
+        # Implements weakref caching to avoid duplicate instances
+        # for the same setting file names.
         obj = cls.cache.get(filename)
         if obj:
             logger.debug("cache hit %r", filename)
             return cls.cache[filename]
         else:
-            obj = super().__new__(cls, **kwargs)
+            obj = cls(filename)
             cls.cache[filename] = obj
             return obj
 
-    def __init__(self, filename):
+    def __init__(self, filename: str) -> None:
         """Initialize view event listener object.
 
         Arguments:
             filename (str):
                 Settings file name to index.
         """
-        # Because __init__ may be called multiple times
-        # and we only want to trigger a reload once,
-        # we need special handling here.
-        if not self._is_initialized:
-            # the associated settings file name all the settings belong to
-            self.filename = filename
-            # callback lists
-            self.on_loaded_callbacks = []
-            self.on_loaded_once_callbacks = []
-            self._is_initialized = True
-            # the dictionary with all defaults of a setting
-            self.defaults = collections.ChainMap()
-            # the dictionary with all comments of each setting
-            self.comments = collections.ChainMap()
-
-            self.trigger_settings_reload()
+        # the associated settings file name all the settings belong to
+        self.filename = filename
+        self._is_loaded = False
+        # callback lists
+        self.on_loaded_callbacks = []
+        self.on_loaded_once_callbacks = []
+        # the dictionary with all defaults of a setting
+        self.defaults = collections.ChainMap()
+        # the dictionary with all comments of each setting
+        self.comments = collections.ChainMap()
+
+        self.trigger_settings_reload()
 
     def add_on_loaded(self, on_loaded, once=False):
         """Add a callback to call once settings have been indexed (asynchronously).
@@ -153,9 +151,11 @@ def add_on_loaded(self, on_loaded, once=False):
             sublime.set_timeout_async(on_loaded, 0)
 
         if not once:
-            self.on_loaded_callbacks.append(WeakMethodProxy(on_loaded))
+            if callbacks := self.on_loaded_callbacks:
+                callbacks.append(WeakMethodProxy(on_loaded))
         elif not self._is_loaded:
-            self.on_loaded_once_callbacks.append(WeakMethodProxy(on_loaded))
+            if callbacks := self.on_loaded_once_callbacks:
+                callbacks.append(WeakMethodProxy(on_loaded))
 
     def __del__(self):
         logger.debug("deleting KnownSettings instance for %r", self.filename)

plugins/snippet_dev.py

@@ -11,6 +11,7 @@
     'PackagedevRawSnippetFromSnippetCommand',
 )
 
+assert __package__
 PACKAGE_NAME = __package__.split(".")[0]
 SNIPPET_PATH = f"Packages/{PACKAGE_NAME}/Package/Sublime Text Snippet/Snippet.sublime-snippet"
 
@@ -47,6 +48,8 @@ def is_enabled(self):
     def run(self, edit):
         snippet = get_text(self.view)
         content = ET.fromstring(snippet).findtext(".//content")
+        if content is None:
+            return
         content = content.replace("]]$UNDEFINED>", "]]>")  # undo defusing
 
         v = self.view.window().new_file()

plugins/syntax_dev/completions.py

@@ -18,6 +18,8 @@
 
 logger = logging.getLogger(__name__)
 
+assert __package__
+
 CompletionTemplate = namedtuple('CompletionTemplate', ['kind', 'format', 'suffix'])
 
 Completion = namedtuple('Completion', ['trigger', 'template', 'details'])
@@ -292,7 +294,10 @@ def _complete_context(self, prefix, locations):
         # Verify that we're not looking for an external include
         for point in locations:
             line_prefix = self._line_prefix(point)
-            real_prefix = re.search(r"[^,\[ ]*$", line_prefix).group(0)
+            match = re.search(r"[^,\[ ]*$", line_prefix)
+            if not match:
+                return []
+            real_prefix = match.group(0)
             if real_prefix.startswith("scope:") or "/" in real_prefix:
                 return []  # Don't show any completions here
             elif real_prefix != prefix:

plugins/syntax_dev_legacy.py

@@ -17,6 +17,7 @@
     'PackagedevRearrangeYamlSyntaxDefCommand',
 )
 
+assert __package__
 PACKAGE_NAME = __package__.split('.')[0]
 
 
@@ -408,6 +409,7 @@ def inhibit(ret):
 
                     # Browse the nodes and their children
                     nodes = COMPILED_HEADS
+                    node = None
                     for i, token in enumerate(tokens):
                         node = nodes.find(token)
                         if not node:

plugins/syntaxtest_dev.py

@@ -151,6 +151,7 @@ def get_details_of_line_being_tested(self):
         lines = []
         pos = self.view.sel()[0].begin()
         first_line = True
+        details = None
         while pos >= 0:
             details = self.get_details_of_test_assertion_line(pos)
             pos = details.line_region.begin() - 1
@@ -162,7 +163,7 @@ def get_details_of_line_being_tested(self):
                 lines.append(details)
             first_line = False
 
-        return (lines, details.line_region)
+        return (lines, details.line_region if details else None)
 
     def on_selection_modified_async(self):
         """Update highlighting of what the current line's test assertions point at."""