Trial ty for type checking, with Python 3.10 TypedDict and TypeAlias and other syntax

Author: thibaudcolas

.github/workflows/ci.yml

@@ -20,7 +20,10 @@ jobs:
           python-version-file: "pyproject.toml"
       - uses: astral-sh/setup-uv@v7
       - run: uv sync --dev
-      - run: uv run make lint
+      - run: uv run ruff check --output-format=github .
+      - run: uv run ruff format --check
+      - run: uv run mypy draftjs_exporter tests
+      - run: uv run ty check --output-format=github .
       - run: uv run make benchmark
       - run: make build
       - uses: actions/setup-node@v6

Makefile

@@ -13,7 +13,8 @@ init: clean-pyc ## Install dependencies and initialise for development.
 lint: ## Lint the project.
 	ruff check
 	ruff format --check
-	mypy **/*.py
+	mypy draftjs_exporter tests
+	ty check
 
 format: ## Format project files.
 	ruff format

README.md

@@ -82,7 +82,8 @@ from draftjs_exporter.dom import DOM
 config = {
     # `block_map` is a mapping from Draft.js block types to a definition of their HTML representation.
     # Extend BLOCK_MAP to start with sane defaults, or make your own from scratch.
-    'block_map': dict(BLOCK_MAP, **{
+    'block_map': {
+        **BLOCK_MAP,
         # The most basic mapping format, block type to tag name.
         BLOCK_TYPES.HEADER_TWO: 'h2',
         # Use a dict to define props on the block.
@@ -101,17 +102,18 @@ config = {
         },
         # Provide a fallback component (advanced).
         BLOCK_TYPES.FALLBACK: block_fallback
-    }),
+    },
     # `style_map` defines the HTML representation of inline elements.
     # Extend STYLE_MAP to start with sane defaults, or make your own from scratch.
-    'style_map': dict(STYLE_MAP, **{
+    'style_map': {
+        **STYLE_MAP,
         # Use the same mapping format as in the `block_map`.
         'KBD': 'kbd',
         # The `style` prop can be defined as a dict, that will automatically be converted to a string.
         'HIGHLIGHT': {'element': 'strong', 'props': {'style': {'textDecoration': 'underline'}}},
         # Provide a fallback component (advanced).
         INLINE_STYLES.FALLBACK: style_fallback,
-    }),
+    },
     'entity_decorators': {
         # Map entities to components so they can be rendered with their data.
         ENTITY_TYPES.IMAGE: image,
@@ -206,10 +208,11 @@ Add the following to the exporter config,
 
 ```python
 config = {
-    'block_map': dict(BLOCK_MAP, **{
+    'block_map': {
+        **BLOCK_MAP,
         # Provide a fallback for block types.
         BLOCK_TYPES.FALLBACK: block_fallback
-    }),
+    },
 }
 ```
 

benchmark.py

@@ -3,15 +3,16 @@
 import os
 import re
 from pstats import Stats
+from typing import cast
 
 import memray
 from markov_draftjs import get_content_sample
 
 from draftjs_exporter.constants import BLOCK_TYPES, ENTITY_TYPES
 from draftjs_exporter.defaults import BLOCK_MAP, STYLE_MAP
 from draftjs_exporter.dom import DOM
-from draftjs_exporter.html import HTML
-from draftjs_exporter.types import Element, Props
+from draftjs_exporter.html import HTML, ExporterConfig
+from draftjs_exporter.types import ContentState, Element, Props
 from example import br, entity_fallback, image, list_item, ordered_list
 
 
@@ -34,27 +35,25 @@ def block_fallback(props: Props) -> Element:
     return DOM.create_element("div", {}, props["children"])
 
 
-config = {
-    "block_map": dict(
-        BLOCK_MAP,
-        **{
-            BLOCK_TYPES.HEADER_TWO: "h2",
-            BLOCK_TYPES.HEADER_THREE: {
-                "element": "h3",
-                "props": {"class": "u-text-center"},
-            },
-            BLOCK_TYPES.UNORDERED_LIST_ITEM: {
-                "element": "li",
-                "wrapper": "ul",
-                "wrapper_props": {"class": "bullet-list"},
-            },
-            BLOCK_TYPES.ORDERED_LIST_ITEM: {
-                "element": list_item,
-                "wrapper": ordered_list,
-            },
-            BLOCK_TYPES.FALLBACK: block_fallback,
+config: ExporterConfig = {
+    "block_map": {
+        **BLOCK_MAP,
+        BLOCK_TYPES.HEADER_TWO: "h2",
+        BLOCK_TYPES.HEADER_THREE: {
+            "element": "h3",
+            "props": {"class": "u-text-center"},
         },
-    ),
+        BLOCK_TYPES.UNORDERED_LIST_ITEM: {
+            "element": "li",
+            "wrapper": "ul",
+            "wrapper_props": {"class": "bullet-list"},
+        },
+        BLOCK_TYPES.ORDERED_LIST_ITEM: {
+            "element": list_item,
+            "wrapper": ordered_list,
+        },
+        BLOCK_TYPES.FALLBACK: block_fallback,
+    },
     "style_map": STYLE_MAP,
     "entity_decorators": {
         ENTITY_TYPES.IMAGE: image,
@@ -70,7 +69,8 @@ def block_fallback(props: Props) -> Element:
 
 exporter = HTML(config)
 
-content_states = get_content_sample()
+# markov_draftjs has slightly different type declarations.
+content_states = cast(list[ContentState], get_content_sample())
 
 BENCHMARK_RUNS = int(os.environ.get("BENCHMARK_RUNS", 1))
 

draftjs_exporter/defaults.py

@@ -1,6 +1,6 @@
 from draftjs_exporter.constants import BLOCK_TYPES, INLINE_STYLES
 from draftjs_exporter.dom import DOM
-from draftjs_exporter.types import Element, Props
+from draftjs_exporter.types import ConfigMap, Element, Props
 
 
 def render_children(props: Props) -> Element:
@@ -18,7 +18,7 @@ def code_block(props: Props) -> Element:
 
 
 # Default block map to extend.
-BLOCK_MAP = {
+BLOCK_MAP: ConfigMap = {
     BLOCK_TYPES.UNSTYLED: "p",
     BLOCK_TYPES.HEADER_ONE: "h1",
     BLOCK_TYPES.HEADER_TWO: "h2",
@@ -38,7 +38,7 @@ def code_block(props: Props) -> Element:
 # Tags come from https://developer.mozilla.org/en-US/docs/Web/HTML/Element.
 # and are loosely aligned with https://github.com/jpuri/draftjs-to-html.
 # Only styles that map to HTML elements are allowed as defaults.
-STYLE_MAP = {
+STYLE_MAP: ConfigMap = {
     INLINE_STYLES.BOLD: "strong",
     INLINE_STYLES.CODE: "code",
     INLINE_STYLES.ITALIC: "em",

draftjs_exporter/engines/base.py

@@ -1,8 +1,8 @@
-from typing import Any
+from typing import Any, TypeAlias
 
 from draftjs_exporter.types import HTML, Element, Tag
 
-Attr = dict[str, str]
+Attr: TypeAlias = dict[str, str]
 
 
 class DOMEngine:

draftjs_exporter/engines/html5lib.py

@@ -25,7 +25,7 @@ def create_tag(type_: Tag, attr: Attr | None = None) -> Element:
         if not attr:
             attr = {}
 
-        return soup.new_tag(type_, **attr)
+        return soup.new_tag(type_, attrs=attr)
 
     @staticmethod
     def parse_html(markup: HTML) -> Element:

draftjs_exporter/engines/lxml.py

@@ -1,6 +1,6 @@
 import re
 
-from lxml import etree, html
+from lxml import etree, html  # type: ignore
 
 from draftjs_exporter.engines.base import Attr, DOMEngine
 from draftjs_exporter.types import HTML, Tag

draftjs_exporter/engines/string.py

@@ -35,7 +35,7 @@ class Elt:
     def __init__(self, type_: Tag, attr: Attr | None, markup: HTML = ""):
         self.type = type_
         self.attr = attr
-        self.children: list["Elt"] = []
+        self.children: list[str | "Elt"] = []
         self.markup = markup
 
     @staticmethod

draftjs_exporter/entity_state.py

@@ -3,7 +3,7 @@
 from draftjs_exporter.dom import DOM
 from draftjs_exporter.error import ExporterException
 from draftjs_exporter.options import Options, OptionsMap
-from draftjs_exporter.types import Block, Element, EntityDetails, EntityKey, EntityMap
+from draftjs_exporter.types import Block, Element, Entity, EntityKey, EntityMap
 
 
 class EntityException(ExporterException):
@@ -44,7 +44,7 @@ def has_entity(self) -> list[EntityKey]:
     def has_no_entity(self) -> bool:
         return not self.entity_stack
 
-    def get_entity_details(self, entity_key: EntityKey) -> EntityDetails:
+    def get_entity_details(self, entity_key: EntityKey) -> Entity:
         details = self.entity_map.get(entity_key)
 
         if details is None: