Reorder __init__ (#2724)

* initial commit

* remove unused maintain_aspect_ratio

* reorder buttons prop

* reformat charts __init__

* reformat canvas __init__

* remove `__set_*` methods - Moving away from Literals in favour of Enums

* add deprecation docstring

* label as first init prop

* remove *String literals

* SearchBar: pass text attribute to close_view sync

* fix failing CI: remove Checkbox.__set_label_position

* fix failing CI: label_style and Enum import

* fix fix failing CI: scroll._set_attr

---------

Co-authored-by: Feodor Fitsner <[email protected]>

sdk/python/packages/flet-core/src/flet_core/alert_dialog.py

@@ -4,7 +4,7 @@
 from flet_core.buttons import OutlinedBorder
 from flet_core.control import Control, OptionalNumber
 from flet_core.ref import Ref
-from flet_core.types import MainAxisAlignment, MainAxisAlignmentString, PaddingValue
+from flet_core.types import MainAxisAlignment, PaddingValue
 
 
 class AlertDialog(AdaptiveControl):
@@ -79,7 +79,7 @@ def __init__(
         adaptive: Optional[bool] = None,
         on_dismiss=None,
         #
-        # Common
+        # AdaptiveControl
         #
         ref: Optional[Ref] = None,
         disabled: Optional[bool] = None,
@@ -251,13 +251,10 @@ def actions_alignment(self) -> MainAxisAlignment:
     @actions_alignment.setter
     def actions_alignment(self, value: MainAxisAlignment):
         self.__actions_alignment = value
-        if isinstance(value, MainAxisAlignment):
-            self._set_attr("actionsAlignment", value.value)
-        else:
-            self.__set_actions_alignment(value)
-
-    def __set_actions_alignment(self, value: MainAxisAlignmentString):
-        self._set_attr("actionsAlignment", value)
+        self._set_attr(
+            "actionsAlignment",
+            value.value if isinstance(value, MainAxisAlignment) else value,
+        )
 
     # shape
     @property

sdk/python/packages/flet-core/src/flet_core/animated_switcher.py

@@ -1,7 +1,7 @@
 from enum import Enum
 from typing import Any, Optional, Union
 
-from flet_core.animation import AnimationCurve, AnimationCurveString
+from flet_core.animation import AnimationCurve
 from flet_core.constrained_control import ConstrainedControl
 from flet_core.control import Control, OptionalNumber
 from flet_core.ref import Ref
@@ -80,6 +80,14 @@ def animate(e):
     def __init__(
         self,
         content: Optional[Control] = None,
+        duration: Optional[int] = None,
+        reverse_duration: Optional[int] = None,
+        switch_in_curve: Optional[AnimationCurve] = None,
+        switch_out_curve: Optional[AnimationCurve] = None,
+        transition: Optional[AnimatedSwitcherTransition] = None,
+        #
+        # ConstrainedControl
+        #
         ref: Optional[Ref] = None,
         width: OptionalNumber = None,
         height: OptionalNumber = None,
@@ -106,14 +114,6 @@ def __init__(
         visible: Optional[bool] = None,
         disabled: Optional[bool] = None,
         data: Any = None,
-        #
-        # Specific
-        #
-        duration: Optional[int] = None,
-        reverse_duration: Optional[int] = None,
-        switch_in_curve: Optional[AnimationCurve] = None,
-        switch_out_curve: Optional[AnimationCurve] = None,
-        transition: Optional[AnimatedSwitcherTransition] = None,
     ):
         ConstrainedControl.__init__(
             self,
@@ -200,13 +200,9 @@ def switch_in_curve(self) -> Optional[AnimationCurve]:
     @switch_in_curve.setter
     def switch_in_curve(self, value: Optional[AnimationCurve]):
         self.__switch_in_curve = value
-        if isinstance(value, AnimationCurve):
-            self._set_attr("switchInCurve", value.value)
-        else:
-            self.__set_switch_in_curve(value)
-
-    def __set_switch_in_curve(self, value: Optional[AnimationCurveString]):
-        self._set_attr("switchInCurve", value)
+        self._set_attr(
+            "switchInCurve", value.value if isinstance(value, AnimationCurve) else value
+        )
 
     # switch_out_curve
     @property
@@ -216,13 +212,10 @@ def switch_out_curve(self) -> Optional[AnimationCurve]:
     @switch_out_curve.setter
     def switch_out_curve(self, value: Optional[AnimationCurve]):
         self.__switch_out_curve = value
-        if isinstance(value, AnimationCurve):
-            self._set_attr("switchOutCurve", value.value)
-        else:
-            self.__set_switch_out_curve(value)
-
-    def __set_switch_out_curve(self, value: Optional[AnimationCurveString]):
-        self._set_attr("switchOutCurve", value)
+        self._set_attr(
+            "switchOutCurve",
+            value.value if isinstance(value, AnimationCurve) else value,
+        )
 
     # transition
     @property
@@ -232,10 +225,7 @@ def transition(self) -> Optional[AnimatedSwitcherTransition]:
     @transition.setter
     def transition(self, value: Optional[AnimatedSwitcherTransition]):
         self.__transition = value
-        if isinstance(value, AnimatedSwitcherTransition):
-            self._set_attr("transition", value.value)
-        else:
-            self.__set_transition(value)
-
-    def __set_transition(self, value: Optional[TransitionValueString]):
-        self._set_attr("transition", value)
+        self._set_attr(
+            "transition",
+            value.value if isinstance(value, AnimatedSwitcherTransition) else value,
+        )

sdk/python/packages/flet-core/src/flet_core/app_bar.py

@@ -51,7 +51,6 @@ def check_item_clicked(e):
 
     def __init__(
         self,
-        ref: Optional[Ref] = None,
         leading: Optional[Control] = None,
         leading_width: OptionalNumber = None,
         automatically_imply_leading: Optional[bool] = None,
@@ -62,6 +61,10 @@ def __init__(
         bgcolor: Optional[str] = None,
         elevation: OptionalNumber = None,
         actions: Optional[List[Control]] = None,
+        #
+        # AdaptiveControl
+        #
+        ref: Optional[Ref] = None,
         adaptive: Optional[bool] = None,
     ):
         Control.__init__(self, ref=ref)

sdk/python/packages/flet-core/src/flet_core/audio.py

@@ -43,9 +43,6 @@ def main(page: ft.Page):
     def __init__(
         self,
         src: Optional[str] = None,
-        ref: Optional[Ref] = None,
-        data: Any = None,
-        # specific
         src_base64: Optional[str] = None,
         autoplay: Optional[bool] = None,
         volume: OptionalNumber = None,
@@ -57,6 +54,11 @@ def __init__(
         on_state_changed=None,
         on_position_changed=None,
         on_seek_complete=None,
+        #
+        # Control
+        #
+        ref: Optional[Ref] = None,
+        data: Any = None,
     ):
         Control.__init__(
             self,

sdk/python/packages/flet-core/src/flet_core/audio_recorder.py

@@ -39,7 +39,7 @@ def __init__(
         bit_rate: OptionalNumber = None,
         on_state_changed=None,
         #
-        # common
+        # Control
         #
         ref: Optional[Ref] = None,
         data: Any = None,

sdk/python/packages/flet-core/src/flet_core/badge.py

@@ -52,13 +52,6 @@ def main(page: ft.Page):
     def __init__(
         self,
         content: Optional[Control] = None,
-        ref: Optional[Ref] = None,
-        opacity: OptionalNumber = None,
-        visible: Optional[bool] = None,
-        data: Any = None,
-        #
-        # Specific
-        #
         text: Optional[str] = None,
         offset: OffsetValue = None,
         alignment: Optional[Alignment] = None,
@@ -69,6 +62,13 @@ def __init__(
         small_size: OptionalNumber = None,
         text_color: Optional[str] = None,
         text_style: Optional[TextStyle] = None,
+        #
+        # Control
+        #
+        ref: Optional[Ref] = None,
+        opacity: OptionalNumber = None,
+        visible: Optional[bool] = None,
+        data: Any = None,
     ):
         Control.__init__(
             self,

sdk/python/packages/flet-core/src/flet_core/banner.py

@@ -49,13 +49,6 @@ def show_banner_click(e):
 
     def __init__(
         self,
-        ref: Optional[Ref] = None,
-        disabled: Optional[bool] = None,
-        visible: Optional[bool] = None,
-        data: Any = None,
-        #
-        # Specific
-        #
         open: bool = False,
         leading: Optional[Control] = None,
         leading_padding: Optional[PaddingValue] = None,
@@ -64,6 +57,13 @@ def __init__(
         actions: Optional[List[Control]] = None,
         force_actions_below: Optional[bool] = None,
         bgcolor: Optional[str] = None,
+        #
+        # Control
+        #
+        ref: Optional[Ref] = None,
+        disabled: Optional[bool] = None,
+        visible: Optional[bool] = None,
+        data: Any = None,
     ):
 
         Control.__init__(

sdk/python/packages/flet-core/src/flet_core/bottom_app_bar.py

@@ -6,7 +6,6 @@
 from flet_core.types import (
     AnimationValue,
     ClipBehavior,
-    ClipBehaviorString,
     NotchShape,
     OffsetValue,
     PaddingValue,
@@ -28,6 +27,17 @@ class BottomAppBar(ConstrainedControl):
     def __init__(
         self,
         content: Optional[Control] = None,
+        surface_tint_color: Optional[str] = None,
+        bgcolor: Optional[str] = None,
+        shadow_color: Optional[str] = None,
+        padding: PaddingValue = None,
+        clip_behavior: Optional[ClipBehavior] = None,
+        shape: Optional[NotchShape] = None,
+        notch_margin: OptionalNumber = None,
+        elevation: OptionalNumber = None,
+        #
+        # ConstrainedControl
+        #
         ref: Optional[Ref] = None,
         width: OptionalNumber = None,
         height: OptionalNumber = None,
@@ -53,17 +63,6 @@ def __init__(
         visible: Optional[bool] = None,
         disabled: Optional[bool] = None,
         data: Any = None,
-        #
-        # Specific
-        #
-        surface_tint_color: Optional[str] = None,
-        bgcolor: Optional[str] = None,
-        shadow_color: Optional[str] = None,
-        padding: PaddingValue = None,
-        clip_behavior: Optional[ClipBehavior] = None,
-        shape: Optional[NotchShape] = None,
-        notch_margin: OptionalNumber = None,
-        elevation: OptionalNumber = None,
     ):
         ConstrainedControl.__init__(
             self,
@@ -185,13 +184,9 @@ def clip_behavior(self) -> Optional[ClipBehavior]:
     @clip_behavior.setter
     def clip_behavior(self, value: Optional[ClipBehavior]):
         self.__clip_behavior = value
-        if isinstance(value, ClipBehavior):
-            self._set_attr("clipBehavior", value.value)
-        else:
-            self.__set_clip_behavior(value)
-
-    def __set_clip_behavior(self, value: Optional[ClipBehaviorString]):
-        self._set_attr("clipBehavior", value)
+        self._set_attr(
+            "clipBehavior", value.value if isinstance(value, ClipBehavior) else value
+        )
 
     # notch_margin
     @property

sdk/python/packages/flet-core/src/flet_core/bottom_sheet.py

@@ -52,13 +52,6 @@ def close_bs(e):
     def __init__(
         self,
         content: Optional[Control] = None,
-        ref: Optional[Ref] = None,
-        disabled: Optional[bool] = None,
-        visible: Optional[bool] = None,
-        data: Any = None,
-        #
-        # Specific
-        #
         open: bool = False,
         elevation: OptionalNumber = None,
         bgcolor: Optional[str] = None,
@@ -69,6 +62,13 @@ def __init__(
         is_scroll_controlled: Optional[bool] = None,
         maintain_bottom_view_insets_padding: Optional[bool] = None,
         on_dismiss=None,
+        #
+        # Control
+        #
+        ref: Optional[Ref] = None,
+        disabled: Optional[bool] = None,
+        visible: Optional[bool] = None,
+        data: Any = None,
     ):
         Control.__init__(
             self,

sdk/python/packages/flet-core/src/flet_core/canvas/arc.py

@@ -16,7 +16,9 @@ def __init__(
         sweep_angle: OptionalNumber = None,
         use_center: Optional[bool] = None,
         paint: Optional[Paint] = None,
-        # base
+        #
+        # Control
+        #
         ref=None,
         visible: Optional[bool] = None,
         disabled: Optional[bool] = None,

sdk/python/packages/flet-core/src/flet_core/canvas/canvas.py

@@ -22,6 +22,11 @@ def __init__(
         self,
         shapes: Optional[List[Shape]] = None,
         content: Optional[Control] = None,
+        resize_interval: OptionalNumber = None,
+        on_resize=None,
+        #
+        # ConstrainedControl
+        #
         ref: Optional[Ref] = None,
         width: OptionalNumber = None,
         height: OptionalNumber = None,
@@ -47,11 +52,6 @@ def __init__(
         visible: Optional[bool] = None,
         disabled: Optional[bool] = None,
         data: Any = None,
-        #
-        # CustomPaint specific
-        #
-        resize_interval: OptionalNumber = None,
-        on_resize=None,
     ):
         ConstrainedControl.__init__(
             self,

sdk/python/packages/flet-core/src/flet_core/canvas/circle.py

@@ -12,7 +12,9 @@ def __init__(
         y: OptionalNumber = None,
         radius: OptionalNumber = None,
         paint: Optional[Paint] = None,
-        # base
+        #
+        # Control
+        #
         ref=None,
         visible: Optional[bool] = None,
         disabled: Optional[bool] = None,

sdk/python/packages/flet-core/src/flet_core/canvas/color.py

@@ -1,15 +1,17 @@
 from typing import Any, Optional
 
 from flet_core.canvas.shape import Shape
-from flet_core.types import BlendMode, BlendModeString
+from flet_core.types import BlendMode
 
 
 class Color(Shape):
     def __init__(
         self,
         color: Optional[str] = None,
         blend_mode: BlendMode = BlendMode.NONE,
-        # base
+        #
+        # Control
+        #
         ref=None,
         visible: Optional[bool] = None,
         disabled: Optional[bool] = None,
@@ -43,10 +45,6 @@ def blend_mode(self) -> BlendMode:
     @blend_mode.setter
     def blend_mode(self, value: BlendMode):
         self.__blend_mode = value
-        if isinstance(value, BlendMode):
-            self._set_attr("blendMode", value.value)
-        else:
-            self.__set_blend_mode(value)
-
-    def __set_blend_mode(self, value: BlendModeString):
-        self._set_attr("blendMode", value)
+        self._set_attr(
+            "blendMode", value.value if isinstance(value, BlendMode) else value
+        )