flet-flashlight 0.1.0.dev1__tar.gz → 0.70.0.dev6611__tar.gz

{flet_flashlight-0.1.0.dev1/src/flutter/flet_flashlight → flet_flashlight-0.70.0.dev6611}/LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

flet_flashlight-0.70.0.dev6611/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: flet-flashlight
+Version: 0.70.0.dev6611
+Summary: Control device torch/flashlight from Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://docs.flet.dev/flashlight
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-flashlight
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==0.70.0.dev6611
+Dynamic: license-file
+
+# flet-flashlight
+
+[![pypi](https://img.shields.io/pypi/v/flet-flashlight.svg)](https://pypi.python.org/pypi/flet-flashlight)
+[![downloads](https://static.pepy.tech/badge/flet-flashlight/month)](https://pepy.tech/project/flet-flashlight)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-flashlight/LICENSE)
+
+A [Flet](https://flet.dev) extension to manage the device torch/flashlight.
+
+It is based on the [flashlight](https://pub.dev/packages/flashlight) Flutter package.
+
+> **Important:** Add `Flashlight` instances to `page.services` before calling toggle or other methods.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://docs.flet.dev/flashlight/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ❌    |   ❌   |   ❌   |  ✅  |    ✅    |  ❌  |
+
+## Usage
+
+### Installation
+
+To install the `flet-flashlight` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-flashlight
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-flashlight
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/examples/controls/flashlight).

flet_flashlight-0.70.0.dev6611/README.md

@@ -0,0 +1,42 @@
+# flet-flashlight
+
+[![pypi](https://img.shields.io/pypi/v/flet-flashlight.svg)](https://pypi.python.org/pypi/flet-flashlight)
+[![downloads](https://static.pepy.tech/badge/flet-flashlight/month)](https://pepy.tech/project/flet-flashlight)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-flashlight/LICENSE)
+
+A [Flet](https://flet.dev) extension to manage the device torch/flashlight.
+
+It is based on the [flashlight](https://pub.dev/packages/flashlight) Flutter package.
+
+> **Important:** Add `Flashlight` instances to `page.services` before calling toggle or other methods.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://docs.flet.dev/flashlight/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ❌    |   ❌   |   ❌   |  ✅  |    ✅    |  ❌  |
+
+## Usage
+
+### Installation
+
+To install the `flet-flashlight` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-flashlight
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-flashlight
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/examples/controls/flashlight).

flet_flashlight-0.70.0.dev6611/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "flet-flashlight"
+version = "0.70.0.dev6611"
+description = "Control device torch/flashlight from Flet apps."
+readme = "README.md"
+authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "flet==0.70.0.dev6611",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://docs.flet.dev/flashlight"
+Repository = "https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-flashlight"
+Issues = "https://github.com/flet-dev/flet/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_flashlight" = ["**/*"]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flet_flashlight-0.70.0.dev6611/src/flet_flashlight/__init__.py

@@ -0,0 +1,21 @@
+from .exceptions import (
+    FlashlightDisableException,
+    FlashlightDisableExistentUserException,
+    FlashlightDisableNotAvailableException,
+    FlashlightEnableException,
+    FlashlightEnableExistentUserException,
+    FlashlightEnableNotAvailableException,
+    FlashlightException,
+)
+from .flashlight import Flashlight
+
+__all__ = [
+    "Flashlight",
+    "FlashlightDisableException",
+    "FlashlightDisableExistentUserException",
+    "FlashlightDisableNotAvailableException",
+    "FlashlightEnableException",
+    "FlashlightEnableExistentUserException",
+    "FlashlightEnableNotAvailableException",
+    "FlashlightException",
+]

flet_flashlight-0.70.0.dev6611/src/flet_flashlight/exceptions.py

@@ -0,0 +1,65 @@
+__all__ = [
+    "FlashlightDisableException",
+    "FlashlightDisableExistentUserException",
+    "FlashlightDisableNotAvailableException",
+    "FlashlightEnableException",
+    "FlashlightEnableExistentUserException",
+    "FlashlightEnableNotAvailableException",
+    "FlashlightException",
+]
+
+
+class FlashlightException(Exception):
+    """
+    Base class for all [`Flashlight`][(p).] exceptions.
+
+    See these subclasses:
+    - [`FlashlightEnableExistentUserException`][(p).]
+    - [`FlashlightEnableNotAvailableException`][(p).]
+    - [`FlashlightEnableException`][(p).]
+    - [`FlashlightDisableExistentUserException`][(p).]
+    - [`FlashlightDisableNotAvailableException`][(p).]
+    - [`FlashlightDisableException`][(p).]
+    """
+
+
+class FlashlightEnableExistentUserException(FlashlightException):
+    """
+    An attempt was made to turn on the torch
+    but it was detected that the camera was being used by another process.
+    This means that the torch cannot be controlled.
+    """
+
+
+class FlashlightEnableNotAvailableException(FlashlightException):
+    """
+    An attempt was made to turn on the torch
+    but it was detected that the device does not have one equipped.
+    """
+
+
+class FlashlightEnableException(FlashlightException):
+    """
+    An error occurred while trying to turn on the device torch.
+    """
+
+
+class FlashlightDisableExistentUserException(FlashlightException):
+    """
+    An attempt was made to turn off the torch
+    but it was detected that the camera was being used by another process.
+    This means that the torch cannot be controlled.
+    """
+
+
+class FlashlightDisableNotAvailableException(FlashlightException):
+    """
+    An attempt was made to turn off the torch,
+    but it was detected that the device does not have one equipped.
+    """
+
+
+class FlashlightDisableException(FlashlightException):
+    """
+    An error occurred while trying to turn off the device torch.
+    """

flet_flashlight-0.70.0.dev6611/src/flet_flashlight/flashlight.py

@@ -0,0 +1,89 @@
+from typing import Optional
+
+import flet as ft
+
+from .exceptions import (
+    FlashlightDisableException,
+    FlashlightDisableExistentUserException,
+    FlashlightDisableNotAvailableException,
+    FlashlightEnableException,
+    FlashlightEnableExistentUserException,
+    FlashlightEnableNotAvailableException,
+    FlashlightException,
+)
+
+__all__ = ["Flashlight"]
+
+
+@ft.control("Flashlight")
+class Flashlight(ft.Service):
+    """
+    A control to use FlashLight. Works on iOS and Android.
+    """
+
+    on = False
+    """
+    Whether the flashlight is currently turned on.
+    """
+
+    on_error: Optional[ft.ControlEventHandler["Flashlight"]] = None
+    """
+    Fires when an error occurs.
+
+    The [`data`][flet.Event.data] property of the event handler argument
+    contains information on the error.
+    """
+
+    async def turn_on(self):
+        """
+        Turns the flashlight on.
+        """
+        r = await self._invoke_method("on")
+        if r is True:
+            self.on = True
+        else:  # error occured
+            error_type = r.get("error_type")
+            error_msg = r.get("error_msg")
+            if error_type == "EnableTorchExistentUserException":
+                raise FlashlightEnableExistentUserException(error_msg)
+            elif error_type == "EnableTorchNotAvailableException":
+                raise FlashlightEnableNotAvailableException(error_msg)
+            else:
+                raise FlashlightEnableException(error_msg)
+
+    async def turn_off(self):
+        """
+        Turns the flashlight off.
+        """
+        r = await self._invoke_method("off")
+        if r is True:
+            self.on = False
+        else:  # error occured
+            error_type = r.get("error_type")
+            error_msg = r.get("error_msg")
+            if error_type == "DisableTorchExistentUserException":
+                raise FlashlightDisableExistentUserException(error_msg)
+            elif error_type == "DisableTorchNotAvailableException":
+                raise FlashlightDisableNotAvailableException(error_msg)
+            else:
+                raise FlashlightDisableException(error_msg)
+
+    async def toggle(self):
+        """
+        Toggles the flashlight on and off.
+        """
+        if self.on:
+            await self.turn_off()
+        else:
+            await self.turn_on()
+
+    async def is_available(self):
+        """
+        Checks if the flashlight is available on the device.
+        """
+        r = await self._invoke_method("is_available")
+        if isinstance(r, bool):
+            return r
+        else:  # error occured
+            error_msg = r.get("error_msg")
+            raise FlashlightException(error_msg)

flet_flashlight-0.70.0.dev6611/src/flet_flashlight.egg-info/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: flet-flashlight
+Version: 0.70.0.dev6611
+Summary: Control device torch/flashlight from Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://docs.flet.dev/flashlight
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-flashlight
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==0.70.0.dev6611
+Dynamic: license-file
+
+# flet-flashlight
+
+[![pypi](https://img.shields.io/pypi/v/flet-flashlight.svg)](https://pypi.python.org/pypi/flet-flashlight)
+[![downloads](https://static.pepy.tech/badge/flet-flashlight/month)](https://pepy.tech/project/flet-flashlight)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-flashlight/LICENSE)
+
+A [Flet](https://flet.dev) extension to manage the device torch/flashlight.
+
+It is based on the [flashlight](https://pub.dev/packages/flashlight) Flutter package.
+
+> **Important:** Add `Flashlight` instances to `page.services` before calling toggle or other methods.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://docs.flet.dev/flashlight/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ❌    |   ❌   |   ❌   |  ✅  |    ✅    |  ❌  |
+
+## Usage
+
+### Installation
+
+To install the `flet-flashlight` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-flashlight
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-flashlight
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/examples/controls/flashlight).

{flet_flashlight-0.1.0.dev1 → flet_flashlight-0.70.0.dev6611}/src/flet_flashlight.egg-info/SOURCES.txt

@@ -1,18 +1,17 @@
+LICENSE
 README.md
 pyproject.toml
 src/flet_flashlight/__init__.py
+src/flet_flashlight/exceptions.py
 src/flet_flashlight/flashlight.py
 src/flet_flashlight.egg-info/PKG-INFO
 src/flet_flashlight.egg-info/SOURCES.txt
 src/flet_flashlight.egg-info/dependency_links.txt
 src/flet_flashlight.egg-info/requires.txt
 src/flet_flashlight.egg-info/top_level.txt
-src/flutter/flet_flashlight/CHANGELOG.md
-src/flutter/flet_flashlight/LICENSE
-src/flutter/flet_flashlight/README.md
 src/flutter/flet_flashlight/analysis_options.yaml
 src/flutter/flet_flashlight/pubspec.lock
 src/flutter/flet_flashlight/pubspec.yaml
 src/flutter/flet_flashlight/lib/flet_flashlight.dart
-src/flutter/flet_flashlight/lib/src/create_control.dart
+src/flutter/flet_flashlight/lib/src/extension.dart
 src/flutter/flet_flashlight/lib/src/flashlight.dart

flet_flashlight-0.70.0.dev6611/src/flet_flashlight.egg-info/requires.txt

@@ -0,0 +1 @@
+flet==0.70.0.dev6611

{flet_flashlight-0.1.0.dev1 → flet_flashlight-0.70.0.dev6611}/src/flutter/flet_flashlight/analysis_options.yaml

@@ -2,4 +2,4 @@ include: package:flutter_lints/flutter.yaml
 
 
 # Additional information about this file can be found at
-# https://dart.dev/guides/language/analysis-options
+# https://dart.dev/guides/language/analysis-options

flet_flashlight-0.70.0.dev6611/src/flutter/flet_flashlight/lib/flet_flashlight.dart

@@ -0,0 +1,3 @@
+library flet_flashlight;
+
+export 'src/extension.dart' show Extension;

flet_flashlight-0.70.0.dev6611/src/flutter/flet_flashlight/lib/src/extension.dart

@@ -0,0 +1,15 @@
+import 'package:flet/flet.dart';
+
+import 'flashlight.dart';
+
+class Extension extends FletExtension {
+  @override
+  FletService? createService(Control control) {
+    switch (control.type) {
+      case "Flashlight":
+        return FlashlightControl(control: control);
+      default:
+        return null;
+    }
+  }
+}

flet_flashlight-0.70.0.dev6611/src/flutter/flet_flashlight/lib/src/flashlight.dart

@@ -0,0 +1,101 @@
+import 'package:flet/flet.dart';
+import 'package:flutter/widgets.dart';
+import 'package:torch_light/torch_light.dart';
+
+class FlashlightControl extends FletService {
+  FlashlightControl({required super.control});
+
+  @override
+  void init() {
+    super.init();
+    debugPrint("Flashlight(${control.id}).init: ${control.properties}");
+    control.addInvokeMethodListener(_invokeMethod);
+  }
+
+  Future<dynamic> _invokeMethod(String name, dynamic args) async {
+    debugPrint("Flashlight.$name($args)");
+    if (isMobilePlatform()) {
+      Map<String, String?>? errorInfo;
+      switch (name) {
+        case "on":
+          try {
+            await TorchLight.enableTorch();
+            return true;
+          } catch (e) {
+            if (e is EnableTorchExistentUserException) {
+              errorInfo = {
+                "error_type": "EnableTorchExistentUserException",
+                "error_msg": e.message
+              };
+            } else if (e is EnableTorchNotAvailableException) {
+              errorInfo = {
+                "error_type": "EnableTorchNotAvailableException",
+                "error_msg": e.message
+              };
+            } else {
+              errorInfo = {
+                "error_type": "EnableTorchException",
+                "error_msg": (e as EnableTorchException).message
+              };
+            }
+            control.triggerEvent("error", errorInfo);
+            debugPrint(
+                "Error enabling Flashlight: ${errorInfo["error_type"]}(${errorInfo["error_msg"]})");
+            return errorInfo;
+          }
+        case "off":
+          try {
+            await TorchLight.disableTorch();
+            return true;
+          } catch (e) {
+            if (e is DisableTorchExistentUserException) {
+              errorInfo = {
+                "error_type": "DisableTorchExistentUserException",
+                "error_msg": e.message
+              };
+            } else if (e is DisableTorchNotAvailableException) {
+              errorInfo = {
+                "error_type": "DisableTorchNotAvailableException",
+                "error_msg": e.message
+              };
+            } else {
+              errorInfo = {
+                "error_type": "DisableTorchException",
+                "error_msg": (e as DisableTorchException).message
+              };
+            }
+            control.triggerEvent("error", errorInfo);
+            debugPrint(
+                "Error disabling Flashlight: ${errorInfo["error_type"]}(${errorInfo["error_msg"]})");
+            return errorInfo;
+          }
+        case "is_available":
+          try {
+            final available = await TorchLight.isTorchAvailable();
+            return available;
+          } on EnableTorchException catch (e) {
+            errorInfo = {
+              "error_type": "EnableTorchException",
+              "error_msg": e.message
+            };
+            control.triggerEvent("error", errorInfo);
+            debugPrint(
+                "Error checking Flashlight availability: EnableTorchException(${e.message})");
+            return errorInfo;
+          }
+        default:
+          throw Exception("Unknown Flashlight method: $name");
+      }
+    } else {
+      throw Exception(
+          "Flashlight control is supported only on Android and iOS devices.");
+    }
+  }
+
+  @override
+  void dispose() {
+    debugPrint("Flashlight(${control.id}).dispose");
+    control.removeInvokeMethodListener(_invokeMethod);
+    super.dispose();
+  }
+}