misc fixes

Author: rmorshea

pyproject.toml

@@ -51,7 +51,7 @@ per-file-ignores = [
     "docs/*/_examples/*.py:E402",
 ]
 max-line-length = 88
-max-complexity = 18
+max-complexity = 20
 select = ["B", "C", "E", "F", "W", "T4", "B9", "N", "ROH"]
 exclude = ["**/node_modules/*", ".eggs/*", ".tox/*"]
 # -- flake8-tidy-imports --

src/idom/__main__.py

@@ -1,14 +1,17 @@
 import click
 
-from idom import __version__
+import idom
 from idom._console.update_html_usages import update_html_usages
 
 
-app = click.Group(
-    commands=[
-        update_html_usages,
-    ]
-)
+@click.group()
+@click.version_option(idom.__version__, prog_name=idom.__name__)
+def app() -> None:
+    pass
+
+
+app.add_command(update_html_usages)
+
 
 if __name__ == "__main__":
     app()

src/idom/_console/update_html_usages.py

@@ -13,7 +13,6 @@
 from typing import Iterator
 
 import click
-from typing_extensions import TypeGuard
 
 from idom import html
 
@@ -61,42 +60,47 @@ def update_html_usages(directories: list[str]) -> None:
                 file.write_text(result)
 
 
-def generate_rewrite(file: Path, source: str) -> None:
+def generate_rewrite(file: Path, source: str) -> str | None:
     tree = ast.parse(source)
 
     changed: list[Sequence[ast.AST]] = []
     for parents, node in walk_with_parent(tree):
-        if isinstance(node, ast.Call) and node.args:
-            func = node.func
-            if isinstance(func, ast.Attribute):
-                name = func.attr
-            elif isinstance(func, ast.Name):
-                name = func.id
-            else:
-                continue
-            if hasattr(html, name) or name == "vdom":
-                if name == "vdom":
-                    maybe_attr_dict_node = node.args[1]
-                    # remove attr dict from new args
-                    new_args = node.args[:1] + node.args[2:]
+        if not (isinstance(node, ast.Call) and node.args):
+            continue
+
+        func = node.func
+        if isinstance(func, ast.Attribute):
+            name = func.attr
+        elif isinstance(func, ast.Name):
+            name = func.id
+        else:
+            continue
+
+        if not (hasattr(html, name) or name == "vdom"):
+            continue
+
+        if name == "vdom":
+            maybe_attr_dict_node = node.args[1]
+            # remove attr dict from new args
+            new_args = node.args[:1] + node.args[2:]
+        else:
+            maybe_attr_dict_node = node.args[0]
+            # remove attr dict from new args
+            new_args = node.args[1:]
+
+        if node.args:
+            new_keyword_info = extract_keywords(maybe_attr_dict_node)
+            if new_keyword_info is not None:
+                if new_keyword_info.replace:
+                    node.keywords = new_keyword_info.keywords
                 else:
-                    maybe_attr_dict_node = node.args[0]
-                    # remove attr dict from new args
-                    new_args = node.args[1:]
-
-                if node.args:
-                    new_keyword_info = extract_keywords(maybe_attr_dict_node)
-                    if new_keyword_info is not None:
-                        if new_keyword_info.replace:
-                            node.keywords = new_keyword_info.keywords
-                        else:
-                            node.keywords.extend(new_keyword_info.keywords)
+                    node.keywords.extend(new_keyword_info.keywords)
 
-                        node.args = new_args
-                        changed.append((node, *parents))
+                node.args = new_args
+                changed.append((node, *parents))
 
     if not changed:
-        return
+        return None
 
     ast.fix_missing_locations(tree)
 
@@ -124,7 +128,10 @@ def generate_rewrite(file: Path, source: str) -> None:
     )
     outermost_nodes_to_unparse = [current_outermost_node]
     for node in sorted_nodes_to_unparse:
-        if node.lineno > current_outermost_node.end_lineno:
+        if (
+            not current_outermost_node.end_lineno
+            or node.lineno > current_outermost_node.end_lineno
+        ):
             current_outermost_node = node
             outermost_nodes_to_unparse.append(node)
 
@@ -192,6 +199,7 @@ def extract_keywords(node: ast.AST) -> KeywordInfo | None:
             else:
                 keywords.append(kw)
         return KeywordInfo(replace=False, keywords=keywords)
+    return None
 
 
 def find_comments(lines: list[str]) -> list[str]:
@@ -220,4 +228,4 @@ def conv_attr_name(name: str) -> str:
 @dataclass
 class KeywordInfo:
     replace: bool
-    keywords: Sequence[ast.keyword]
+    keywords: list[ast.keyword]

src/idom/_option.py

@@ -2,8 +2,7 @@
 
 import os
 from logging import getLogger
-from typing import Any, Callable, Generic, Iterator, TypeVar, cast
-from warnings import warn
+from typing import Any, Callable, Generic, TypeVar, cast
 
 from idom._warnings import warn
 

src/idom/_warnings.py

@@ -8,7 +8,7 @@
 @wraps(_warn)
 def warn(*args: Any, **kwargs: Any) -> Any:
     # warn at call site outside of IDOM
-    _warn(*args, stacklevel=_frame_depth_in_module() + 1, **kwargs)
+    _warn(*args, stacklevel=_frame_depth_in_module() + 1, **kwargs)  # type: ignore
 
 
 def _frame_depth_in_module() -> int:

src/idom/core/types.py

@@ -2,7 +2,6 @@
 
 import sys
 from collections import namedtuple
-from collections.abc import Sequence
 from types import TracebackType
 from typing import (
     TYPE_CHECKING,
@@ -15,6 +14,7 @@
     Mapping,
     NamedTuple,
     Optional,
+    Sequence,
     Type,
     TypeVar,
     Union,
@@ -101,7 +101,7 @@ async def __aexit__(
 VdomChild = Union[ComponentType, "VdomDict", str]
 """A single child element of a :class:`VdomDict`"""
 
-VdomChildren = "Sequence[VdomChild]"
+VdomChildren = Sequence[VdomChild]
 """Describes a series of :class:`VdomChild` elements"""
 
 VdomAttributesAndChildren = Union[
@@ -211,7 +211,7 @@ class VdomDictConstructor(Protocol):
 
     def __call__(
         self,
-        *children: VdomChild,
+        *children: VdomChild | VdomChildren,
         key: Key | None = None,
         **attributes: Any,
     ) -> VdomDict:

src/idom/core/vdom.py

@@ -4,6 +4,7 @@
 from typing import Any, DefaultDict, Mapping, cast
 
 from fastjsonschema import compile as compile_json_schema
+from typing_extensions import TypeGuard
 
 from idom._warnings import warn
 from idom.config import IDOM_DEBUG_MODE
@@ -19,6 +20,7 @@
     ImportSourceDict,
     Key,
     VdomChild,
+    VdomChildren,
     VdomDict,
     VdomDictConstructor,
     VdomJson,
@@ -130,7 +132,10 @@ def is_vdom(value: Any) -> bool:
 
 
 def vdom(
-    tag: str, *children: VdomChild, key: Key | None = None, **attributes: Any
+    tag: str,
+    *children: VdomChild | VdomChildren,
+    key: Key | None = None,
+    **attributes: Any,
 ) -> VdomDict:
     """A helper function for creating VDOM elements.
 
@@ -179,7 +184,10 @@ def vdom(
         if _is_single_child(child):
             flattened_children.append(child)
         else:
-            flattened_children.extend(child)
+            # FIXME: Types do not narrow in negative case of TypeGaurd
+            # This cannot be fixed until there is some sort of "StrictTypeGuard".
+            # See: https://github.com/python/typing/discussions/1013
+            flattened_children.extend(child)  # type: ignore
 
     attributes, event_handlers = separate_attributes_and_event_handlers(attributes)
 
@@ -199,7 +207,7 @@ def vdom(
 
 
 def with_import_source(element: VdomDict, import_source: ImportSourceDict) -> VdomDict:
-    return {**element, "importSource": import_source}
+    return {**element, "importSource": import_source}  # type: ignore
 
 
 def make_vdom_constructor(
@@ -214,7 +222,9 @@ def make_vdom_constructor(
     """
 
     def constructor(
-        *children: VdomChild, key: Key | None = None, **attributes: Any
+        *children: VdomChild | VdomChildren,
+        key: Key | None = None,
+        **attributes: Any,
     ) -> VdomDict:
         if not allow_children and children:
             raise TypeError(f"{tag!r} nodes cannot have children.")
@@ -273,7 +283,7 @@ def separate_attributes_and_event_handlers(
     return separated_attributes, flat_event_handlers_dict
 
 
-def _is_single_child(value: Any) -> bool:
+def _is_single_child(value: Any) -> TypeGuard[VdomChild]:
     if isinstance(value, (str, Mapping)) or not hasattr(value, "__iter__"):
         return True
     if IDOM_DEBUG_MODE.current:

src/idom/html.py

@@ -157,7 +157,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Mapping
+from typing import Any
 
 from idom.core.types import Key, VdomDict
 from idom.core.vdom import make_vdom_constructor, vdom

src/idom/utils.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import re
 from itertools import chain
 from typing import Any, Callable, Generic, Iterable, TypeVar, cast