Backward compatible ComponentType.

Author: T4rk1n

dash/development/_py_components_generation.py

@@ -13,6 +13,20 @@
 from ._py_prop_typing import get_prop_typing, shapes, custom_imports
 from .base_component import Component, ComponentType
 
+import_string = """# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+import numbers # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
+
+
+"""
+
 
 # pylint: disable=unused-argument,too-many-locals,too-many-branches
 def generate_class_string(
@@ -206,30 +220,22 @@ def generate_class_file(
     Returns
     -------
     """
-    import_string = (
-        "# AUTO GENERATED FILE - DO NOT EDIT\n\n"
-        "import typing  # noqa: F401\n"
-        "import numbers # noqa: F401\n"
-        "from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401\n"
-        "from dash.development.base_component import ComponentType # noqa: F401\n"
-        "from dash.development.base_component import "
-        "Component, _explicitize_args\n\n\n"
-    )
+    imports = import_string
 
     class_string = generate_class_string(
         typename, props, description, namespace, prop_reorder_exceptions, max_props
     )
 
     custom_imp = custom_imports[namespace][typename]
     if custom_imp:
-        import_string += "\n".join(custom_imp)
-        import_string += "\n\n"
+        imports += "\n".join(custom_imp)
+        imports += "\n\n"
 
     file_name = f"{typename:s}.py"
 
     file_path = os.path.join(namespace, file_name)
     with open(file_path, "w", encoding="utf-8") as f:
-        f.write(import_string)
+        f.write(imports)
         f.write(class_string)
 
     print(f"Generated {file_name}")

tests/unit/development/metadata_test.py

@@ -3,8 +3,11 @@
 import typing  # noqa: F401
 import numbers # noqa: F401
 from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
-from dash.development.base_component import ComponentType # noqa: F401
 from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.development.base_component import ComponentType # noqa: F401
+except ImportError:
+    ComponentType = typing.TypeVar("ComponentType", bound=Component)
 
 
 class Table(Component):
@@ -97,7 +100,7 @@ class Table(Component):
     OptionalObjectWithExactAndNestedDescriptionFigure = TypedDict(
         "OptionalObjectWithExactAndNestedDescriptionFigure",
             {
-            "data": NotRequired[typing.Union[typing.Sequence[dict], typing.Tuple]],
+            "data": NotRequired[typing.Sequence[dict]],
             "layout": NotRequired[dict]
         }
     )
@@ -114,7 +117,7 @@ class Table(Component):
     OptionalObjectWithShapeAndNestedDescriptionFigure = TypedDict(
         "OptionalObjectWithShapeAndNestedDescriptionFigure",
             {
-            "data": NotRequired[typing.Union[typing.Sequence[dict], typing.Tuple]],
+            "data": NotRequired[typing.Sequence[dict]],
             "layout": NotRequired[dict]
         }
     )
@@ -132,7 +135,7 @@ class Table(Component):
     def __init__(
         self,
         children: typing.Optional[typing.Union[str, int, float, ComponentType, typing.Sequence[typing.Union[str, int, float, ComponentType]]]] = None,
-        optionalArray: typing.Optional[typing.Union[typing.Sequence, typing.Tuple]] = None,
+        optionalArray: typing.Optional[typing.Sequence] = None,
         optionalBool: typing.Optional[bool] = None,
         optionalFunc: typing.Optional[typing.Any] = None,
         optionalNumber: typing.Optional[typing.Union[int, float, numbers.Number]] = None,
@@ -144,13 +147,13 @@ def __init__(
         optionalMessage: typing.Optional[typing.Any] = None,
         optionalEnum: typing.Optional[Literal["News", "Photos"]] = None,
         optionalUnion: typing.Optional[typing.Union[str, typing.Union[int, float, numbers.Number], typing.Any]] = None,
-        optionalArrayOf: typing.Optional[typing.Union[typing.Sequence[typing.Union[int, float, numbers.Number]], typing.Tuple]] = None,
+        optionalArrayOf: typing.Optional[typing.Sequence[typing.Union[int, float, numbers.Number]]] = None,
         optionalObjectOf: typing.Optional[typing.Dict[typing.Union[str, float, int], typing.Union[int, float, numbers.Number]]] = None,
         optionalObjectWithExactAndNestedDescription: typing.Optional["OptionalObjectWithExactAndNestedDescription"] = None,
         optionalObjectWithShapeAndNestedDescription: typing.Optional["OptionalObjectWithShapeAndNestedDescription"] = None,
         optionalAny: typing.Optional[typing.Any] = None,
         customProp: typing.Optional[typing.Any] = None,
-        customArrayProp: typing.Optional[typing.Union[typing.Sequence[typing.Any], typing.Tuple]] = None,
+        customArrayProp: typing.Optional[typing.Sequence[typing.Any]] = None,
         id: typing.Optional[str] = None,
         **kwargs
     ):

tests/unit/development/test_generate_class_file.py

@@ -8,20 +8,10 @@
 from dash.development._py_components_generation import (
     generate_class_string,
     generate_class_file,
+    import_string,
 )
 from . import _dir, has_trailing_space
 
-# Import string not included in generated class string
-import_string = (
-    "# AUTO GENERATED FILE - DO NOT EDIT\n\n"
-    "import typing  # noqa: F401\n"
-    "import numbers # noqa: F401\n"
-    "from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401\n"
-    "from dash.development.base_component import ComponentType # noqa: F401\n"
-    "from dash.development.base_component import "
-    "Component, _explicitize_args\n\n\n"
-)
-
 
 @pytest.fixture
 def make_component_dir(load_test_metadata_json):