flet-cli 0.80.6.dev7605__tar.gz → 0.80.6.dev7615__tar.gz

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-cli
-Version: 0.80.6.dev7605
+Version: 0.80.6.dev7615
 Summary: Flet CLI
 Author-email: "Appveyor Systems Inc." <hello@flet.dev>
 License-Expression: Apache-2.0
@@ -18,6 +18,9 @@ Requires-Dist: cookiecutter>=2.6.0
 
 # Flet CLI
 
+[![python](https://img.shields.io/badge/python-%3E%3D3.10-%2334D058)](https://pypi.org/project/flet-cli)
+[![docstring coverage](https://docs.flet.dev/assets/badges/docs-coverage/flet-cli.svg)](https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet/docs/assets/badges/docs-coverage)
+
 Flet CLI is a command-line interface tool for Flet, a framework for building interactive multi-platform applications using Python.
 
 ## Features

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/README.md

@@ -1,5 +1,8 @@
 # Flet CLI
 
+[![python](https://img.shields.io/badge/python-%3E%3D3.10-%2334D058)](https://pypi.org/project/flet-cli)
+[![docstring coverage](https://docs.flet.dev/assets/badges/docs-coverage/flet-cli.svg)](https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet/docs/assets/badges/docs-coverage)
+
 Flet CLI is a command-line interface tool for Flet, a framework for building interactive multi-platform applications using Python.
 
 ## Features
@@ -14,4 +17,4 @@ To create a new Flet project:
 
 ```
 flet create myapp
-```
+```

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flet-cli"
-version = "0.80.6.dev7605"
+version = "0.80.6.dev7615"
 description = "Flet CLI"
 authors = [{ name = "Appveyor Systems Inc.", email = "hello@flet.dev" }]
 license = "Apache-2.0"

flet_cli-0.80.6.dev7615/src/flet_cli/__pyinstaller/__init__.py

@@ -0,0 +1,9 @@
+import os
+
+
+def get_hook_dirs():
+    """
+    Return directories containing PyInstaller hook modules for `flet-cli`.
+    """
+
+    return [os.path.dirname(__file__)]

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/src/flet_cli/__pyinstaller/macos_utils.py

@@ -5,11 +5,22 @@ import subprocess
 import tarfile
 from pathlib import Path
 
-from flet.utils import safe_tar_extractall
 from PyInstaller.building.icon import normalize_icon_type
 
+from flet.utils import safe_tar_extractall
+
 
 def unpack_app_bundle(tar_path):
+    """
+    Extract a macOS app bundle archive and remove the source tarball.
+
+    Args:
+        tar_path: Path to a `*.tar.gz` archive containing `Flet.app`.
+
+    Returns:
+        Path to extracted `Flet.app`.
+    """
+
     bin_dir = str(Path(tar_path).parent)
 
     with tarfile.open(tar_path, "r:gz") as tar_arch:
@@ -20,6 +31,14 @@ def unpack_app_bundle(tar_path):
 
 
 def update_flet_view_icon(app_path, icon_path):
+    """
+    Replace app icon in a macOS app bundle and update Info.plist metadata.
+
+    Args:
+        app_path: Path to app bundle directory.
+        icon_path: Path to source icon file.
+    """
+
     print("Updating Flet View icon", app_path, icon_path)
 
     icon_file = "AppIcon.icns"
@@ -50,6 +69,20 @@ def update_flet_view_version_info(
     product_version,
     copyright,
 ):
+    """
+    Update selected Info.plist metadata fields in a macOS app bundle.
+
+    Args:
+        app_path: Path to app bundle directory.
+        bundle_id: Optional bundle identifier override.
+        product_name: Optional display/bundle name override.
+        product_version: Optional version string.
+        copyright: Optional copyright text.
+
+    Returns:
+        Final app bundle path (may change when app bundle is renamed).
+    """
+
     print("Updating Flet View plist", app_path)
 
     pl = __load_info_plist(app_path)
@@ -75,6 +108,17 @@ def update_flet_view_version_info(
 
 
 def assemble_app_bundle(app_path, tar_path):
+    """
+    Code-sign a macOS app bundle, package it as tar.gz, and remove unpacked bundle.
+
+    Args:
+        app_path: Path to app bundle directory.
+        tar_path: Destination tar.gz path.
+
+    Raises:
+        SystemError: If `codesign` fails.
+    """
+
     # sign app bundle
     print(f"Signing file {app_path}")
     cmd_args = [
@@ -91,11 +135,12 @@ def assemble_app_bundle(app_path, tar_path):
         cmd_args,
         stdout=subprocess.PIPE,
         stderr=subprocess.STDOUT,
-        universal_newlines=True,
+        text=True,
     )
     if p.returncode:
         raise SystemError(
-            f"codesign command ({cmd_args}) failed with error code {p.returncode}!\noutput: {p.stdout}"
+            f"codesign command ({cmd_args}) failed with "
+            f"error code {p.returncode}!\noutput: {p.stdout}"
         )
 
     # pack tar
@@ -107,14 +152,30 @@ def assemble_app_bundle(app_path, tar_path):
 
 
 def __load_info_plist(app_path):
+    """
+    Load Info.plist content from a macOS app bundle.
+    """
+
     with open(__get_plist_path(app_path), "rb") as fp:
         return plistlib.load(fp)
 
 
 def __save_info_plist(app_path, pl):
+    """
+    Save Info.plist content to a macOS app bundle.
+
+    Args:
+        app_path: Path to app bundle directory.
+        pl: Parsed plist dictionary to persist.
+    """
+
     with open(__get_plist_path(app_path), "wb") as fp:
         plistlib.dump(pl, fp)
 
 
 def __get_plist_path(app_path):
+    """
+    Return path to `Info.plist` inside a macOS app bundle.
+    """
+
     return os.path.join(app_path, "Contents", "Info.plist")

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/src/flet_cli/__pyinstaller/utils.py

@@ -8,6 +8,13 @@ from flet_desktop import get_package_bin_dir
 
 
 def get_flet_bin_path():
+    """
+    Return path to packaged Flet desktop binaries, if available.
+
+    Returns:
+        Absolute binaries directory path or `None` when not found.
+    """
+
     bin_path = get_package_bin_dir()
     if not os.path.exists(bin_path):
         return None
@@ -15,6 +22,14 @@ def get_flet_bin_path():
 
 
 def copy_flet_bin():
+    """
+    Copy packaged Flet desktop binaries into a temporary directory.
+
+    Returns:
+        Path to the temporary copied binaries directory, or `None` when source
+        binaries are unavailable.
+    """
+
     bin_path = get_flet_bin_path()
     if not bin_path:
         return None

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/src/flet_cli/__pyinstaller/win_utils.py

@@ -12,6 +12,14 @@ from PyInstaller.utils.win32.icon import IconFile, normalize_icon_type
 
 
 def update_flet_view_icon(exe_path, icon_path):
+    """
+    Replace icon resources in a Windows executable.
+
+    Args:
+        exe_path: Path to target executable file.
+        icon_path: Path to source icon file or executable resource.
+    """
+
     print("Updating Flet View icon", exe_path, icon_path)
 
     RT_ICON = 3
@@ -26,8 +34,8 @@ def update_flet_view_icon(exe_path, icon_path):
     hdst = win32api.BeginUpdateResource(exe_path, 0)
 
     iconid = 1
-    # Each step in the following enumerate() will instantiate an IconFile object, as a result of deferred execution
-    # of the map() above.
+    # Each step in the following enumerate() will instantiate an IconFile object,
+    # as a result of deferred execution of the map() above.
     i = 101
     data = icon.grp_icon_dir()
     data = data + icon.grp_icondir_entries(iconid)
@@ -49,7 +57,23 @@ def update_flet_view_version_info(
     file_version,
     company_name,
     copyright,
-):
+) -> str:
+    """
+    Update VERSIONINFO resources in a Windows executable.
+
+    Args:
+        exe_path: Path to target executable file.
+        product_name: Optional product name value.
+        file_description: Optional file description value.
+        product_version: Optional product version string.
+        file_version: Optional file version string (`n.n.n.n` expected).
+        company_name: Optional company name value.
+        copyright: Optional legal copyright value.
+
+    Returns:
+        Path to a temporary text file containing serialized version info.
+    """
+
     print("Updating Flet View version info", exe_path)
 
     # load versioninfo from exe

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/src/flet_cli/commands/base.py

@@ -16,6 +16,17 @@ class CustomArgumentDefaultsHelpFormatter(argparse.HelpFormatter):
     """
 
     def _get_help_string(self, action: argparse.Action) -> str:
+        """
+        Return help text for an argparse action with optional default annotation.
+
+        Args:
+            action: Parser action whose help text should be formatted.
+
+        Returns:
+            The action help string, optionally suffixed with
+            `"(default: %(default)s)"` when the default is meaningful.
+        """
+
         help_text = action.help or ""
         default = action.default
 

{flet_cli-0.80.6.dev7605 → flet_cli-0.80.6.dev7615}/src/flet_cli/commands/build.py

@@ -10,18 +10,34 @@ class Command(BaseBuildCommand):
     """
     Build a Flet Python app into a platform-specific executable or
     installable bundle. It supports building for desktop (macOS, Linux, Windows), web,
-    Android (APK/AAB), and iOS (IPA), with a wide range of customization options for
-    metadata, assets, splash screens, and signing.
+    Android (APK/AAB), and iOS (IPA and simulator .app), with a wide range of
+    customization options for metadata, assets, splash screens, and signing.
     """
 
     def __init__(self, parser: argparse.ArgumentParser) -> None:
         super().__init__(parser)
 
     def add_arguments(self, parser: argparse.ArgumentParser) -> None:
+        """
+        Register build-specific CLI arguments.
+
+        Args:
+            parser: Argument parser configured by the command runner.
+        """
+
         parser.add_argument(
             "target_platform",
             type=str.lower,
-            choices=["macos", "linux", "windows", "web", "apk", "aab", "ipa"],
+            choices=[
+                "macos",
+                "linux",
+                "windows",
+                "web",
+                "apk",
+                "aab",
+                "ipa",
+                "ios-simulator",
+            ],
             help="The target platform or type of package to build",
         )
         parser.add_argument(
@@ -35,6 +51,13 @@ class Command(BaseBuildCommand):
         super().add_arguments(parser)
 
     def handle(self, options: argparse.Namespace) -> None:
+        """
+        Execute the full build pipeline for the selected target platform.
+
+        Args:
+            options: Parsed command-line options.
+        """
+
         super().handle(options)
         assert self.target_platform
         self.status = console.status(
@@ -74,6 +97,13 @@ class Command(BaseBuildCommand):
             )
 
     def add_flutter_command_args(self, args: list[str]):
+        """
+        Append `flutter build` arguments derived from CLI options and project config.
+
+        Args:
+            args: Mutable command argument list to extend.
+        """
+
         assert self.options
         assert self.build_dir
         assert self.get_pyproject
@@ -97,6 +127,8 @@ class Command(BaseBuildCommand):
                 )
             else:
                 args.append("--no-codesign")
+        elif self.target_platform == "ios-simulator":
+            args.append("--simulator")
 
         build_number = self.options.build_number or self.get_pyproject(
             "tool.flet.build_number"
@@ -120,6 +152,10 @@ class Command(BaseBuildCommand):
             args.append(arg)
 
     def run_flutter(self):
+        """
+        Run Flutter build command and log completion status.
+        """
+
         assert self.platforms
         assert self.target_platform