exceptions

Author: ndonkoHenri

docs/exceptions.md

@@ -0,0 +1 @@
+::: flet_flashlight.exceptions

mkdocs.yml

@@ -76,6 +76,7 @@ nav:
   - Getting Started: index.md
   - API Reference:
       - Flashlight: flashlight.md
+      - Exceptions: exceptions.md
   - Changelog: changelog.md
   - License: license.md
 

src/flet_flashlight/flashlight.py

@@ -2,43 +2,39 @@
 
 import flet as ft
 
-__all__ = ["Flashlight"]
-
 from .exceptions import *
 
+__all__ = ["Flashlight"]
+
 
 @ft.control("Flashlight")
 class Flashlight(ft.Service):
     """
     A control to use FlashLight. Works on iOS and Android. Based on torch_light Flutter widget (https://pub.dev/packages/torch_light).
 
-    Flashlight control is non-visual and should be added to `page.overlay` list.
-
-    Example:
-    ```
-    import flet as ft
-
-    import flet_flashlight as ffl
-
-    def main(page: ft.Page):
-        flashLight = ffl.Flashlight()
-        page.overlay.append(flashLight)
-        page.add(
-            ft.TextButton("toggle", on_click: lambda _: flashlight.toggle())
-        )
-
-    ft.app(target=main)
-    ```
+    Note:
+        This control is a non-visual and should be added to `page.services` list before it can be used.
+    """
 
+    on = False
+    """
+    Whether the flashlight is currently turned on.
     """
 
-    turned_on = False
     on_error: ft.OptionalControlEventCallable = None
+    """
+    Fires when an error occurs.
+    
+    The `data` property of the event handler argument contains information on the error.
+    """
 
     async def turn_on_async(self):
+        """
+        Turns the flashlight on.
+        """
         r = await self._invoke_method_async("on")
         if r is True:
-            self.turned_on = True
+            self.on = True
         else:  # error occured
             error_type = r.get("error_type")
             error_msg = r.get("error_msg")
@@ -50,12 +46,18 @@ async def turn_on_async(self):
                 raise FlashlightEnableException(error_msg)
 
     def turn_on(self):
+        """
+        Turns the flashlight on.
+        """
         asyncio.create_task(self.turn_on_async())
 
     async def turn_off_async(self):
+        """
+        Turns the flashlight off.
+        """
         r = await self._invoke_method_async("off")
         if r is True:
-            self.turned_on = False
+            self.on = False
         else:  # error occured
             error_type = r.get("error_type")
             error_msg = r.get("error_msg")
@@ -67,17 +69,29 @@ async def turn_off_async(self):
                 raise FlashlightDisableException(error_msg)
 
     def turn_off(self):
+        """
+        Turns the flashlight off.
+        """
         asyncio.create_task(self.turn_off_async())
 
     async def toggle_async(self):
-        if self.turned_on:
+        """
+        Toggles the flashlight on and off.
+        """
+        if self.on:
             await self.turn_off_async()
         await self.turn_on_async()
 
     def toggle(self):
+        """
+        Toggles the flashlight on and off.
+        """
         asyncio.create_task(self.toggle_async())
 
     async def is_available_async(self):
+        """
+        Checks if the flashlight is available on the device.
+        """
         r = await self._invoke_method_async("is_available")
         if r is bool:
             return r