Flet new packages structure and flet build v2
#4122
Conversation
Close #4025
Reviewer's Guide by SourceryThis pull request implements a significant restructuring of the Flet packages and introduces a new Sequence diagram for the new build process in flet_clisequenceDiagram
participant User
participant CLI as flet_cli
participant Core as flet_core
participant Desktop as flet_desktop
participant Web as flet_web
User->>CLI: Run flet build
CLI->>Core: Initialize build environment
CLI->>Desktop: Prepare desktop build
CLI->>Web: Prepare web build
CLI->>CLI: Execute build commands
CLI->>User: Return build results
Architecture diagram for the new Flet package structuregraph TD;
subgraph Flet
subgraph CLI
flet_cli --> flet_cli_commands
end
subgraph Core
flet_core --> flet_core_utils
end
subgraph Desktop
flet_desktop
end
subgraph Web
flet_web
end
end
flet_cli --> flet_core
flet_cli --> flet_desktop
flet_cli --> flet_web
flet_desktop --> flet_core
flet_web --> flet_core
Class diagram for the updated Command class in flet_cliclassDiagram
class Command {
-emojis: dict
-dart_exe: Optional[str]
-verbose: bool
-build_dir: Optional[Path]
-flutter_dir: Optional[Path]
-flutter_exe: Optional[str]
-platforms: dict
-cross_platform_permissions: dict
+add_arguments(parser: argparse.ArgumentParser) void
+handle(options: argparse.Namespace) void
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @FeodorFitsner - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| python --version | ||
| pip install --upgrade setuptools wheel twine poetry tomlkit virtualenv | ||
|
|
||
| function patch_python_package_versions() { |
There was a problem hiding this comment.
suggestion (bug_risk): Enhance error handling in version patching function
The patch_python_package_versions function is a critical part of the build process. Consider adding error handling and logging to make troubleshooting easier if issues arise during version patching.
function patch_python_package_versions() {
set -e
local log_file="/tmp/version_patch.log"
echo "Starting version patching process..." > "$log_file"
if ! PYPI_VER="${APPVEYOR_BUILD_VERSION/+/.dev}"; then
echo "Error: Failed to set PYPI_VER" >> "$log_file"
return 1
fi
echo "PYPI_VER set to: $PYPI_VER" >> "$log_file"
}
| # Flet CLI | ||
|
|
||
| Flet CLI. |
There was a problem hiding this comment.
suggestion (documentation): Consider expanding the README with more information about Flet CLI
This README could benefit from additional details about what Flet CLI does, its main features, and basic usage instructions.
# Flet CLI
Flet CLI is a command-line interface tool for Flet, a framework for building interactive multi-platform applications using Python.
## Features
- Create new Flet projects
- Run Flet applications
- Package and deploy Flet apps
## Basic Usage
To create a new Flet project:
flet create myapp
| {{flutter_js}} | ||
| {{flutter_build_config}} | ||
|
|
||
| var loading = document.querySelector('#loading'); |
There was a problem hiding this comment.
issue (code-quality): Use const or let instead of var. (avoid-using-var)
Explanation
`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code). `let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than function-scoped.From the Airbnb JavaScript Style Guide
| for member in tar.getmembers(): | ||
| member_path = os.path.join(path, member.name) | ||
| if not is_within_directory(path, member_path): | ||
| raise Exception("Attempted Path Traversal in Tar File") |
There was a problem hiding this comment.
issue (code-quality): Raise a specific error instead of the general Exception or BaseException (raise-specific-error)
Explanation
If a piece of code raises a specific exception type rather than the generic [`BaseException`](https://docs.python.org/3/library/exceptions.html#BaseException) or [`Exception`](https://docs.python.org/3/library/exceptions.html#Exception), the calling code can:- get more information about what type of error it is
- define specific exception handling for it
This way, callers of the code can handle the error appropriately.
How can you solve this?
- Use one of the built-in exceptions of the standard library.
- Define your own error class that subclasses
Exception.
So instead of having code raising Exception or BaseException like
if incorrect_input(value):
raise Exception("The input is incorrect")you can have code raising a specific error like
if incorrect_input(value):
raise ValueError("The input is incorrect")or
class IncorrectInputError(Exception):
pass
if incorrect_input(value):
raise IncorrectInputError("The input is incorrect")|
|
||
|
|
||
| def get_platform(): | ||
| p = platform.system() if not is_mobile() else "" |
There was a problem hiding this comment.
suggestion (code-quality): Swap if/else branches of if expression to remove negation (swap-if-expression)
| p = platform.system() if not is_mobile() else "" | |
| p = "" if is_mobile() else platform.system() |
Explanation
Negated conditions are more difficult to read than positive ones, so it is bestto avoid them where we can. By swapping the
if and else conditions around wecan invert the condition and make it positive.
| from cryptography.hazmat.primitives.ciphers.aead import AESGCM | ||
| from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC | ||
| except ImportError: | ||
| raise Exception('Install "cryptography" Python package to use Flet security utils.') |
There was a problem hiding this comment.
issue (code-quality): Raise a specific error instead of the general Exception or BaseException (raise-specific-error)
Explanation
If a piece of code raises a specific exception type rather than the generic [`BaseException`](https://docs.python.org/3/library/exceptions.html#BaseException) or [`Exception`](https://docs.python.org/3/library/exceptions.html#Exception), the calling code can:- get more information about what type of error it is
- define specific exception handling for it
This way, callers of the code can handle the error appropriately.
How can you solve this?
- Use one of the built-in exceptions of the standard library.
- Define your own error class that subclasses
Exception.
So instead of having code raising Exception or BaseException like
if incorrect_input(value):
raise Exception("The input is incorrect")you can have code raising a specific error like
if incorrect_input(value):
raise ValueError("The input is incorrect")or
class IncorrectInputError(Exception):
pass
if incorrect_input(value):
raise IncorrectInputError("The input is incorrect")| data = f.read(blocksize) | ||
| if not data: | ||
| break |
There was a problem hiding this comment.
issue (code-quality): We've found these issues:
- Use named expression to simplify assignment and conditional (
use-named-expression) - Lift code into else after jump in control flow (
reintroduce-else) - Swap if/else branches (
swap-if-else-branches)
|
|
||
| def get_arch(): | ||
| a = platform.machine().lower() if not is_mobile() else "" | ||
| if a == "x86_64" or a == "amd64": |
There was a problem hiding this comment.
suggestion (code-quality): Replace multiple comparisons of same variable with in operator (merge-comparisons)
| if a == "x86_64" or a == "amd64": | |
| if a in ["x86_64", "amd64"]: |
| os.remove(pid_file) | ||
|
|
||
|
|
||
| def __locate_and_unpack_flet_view(page_url, assets_dir, hidden): |
There was a problem hiding this comment.
issue (code-quality): We've found these issues:
- Use named expression to simplify assignment and conditional [×2] (
use-named-expression) - Extract code out into function (
extract-method) - Inline variable that is immediately returned (
inline-immediately-returned-variable) - Swap if/else branches (
swap-if-else-branches) - Extract duplicate code into function (
extract-duplicate-method) - Merge else clause's nested if statement into elif (
merge-else-if-into-elif) - Low code quality found in __locate_and_unpack_flet_view - 21% (
low-code-quality)
Explanation
The quality score for this function is below the quality threshold of 25%.
This score is a combination of the method length, cognitive complexity and working memory.
How can you solve this?
It might be worth refactoring this function to make it shorter and more readable.
- Reduce the function length by extracting pieces of functionality out into
their own functions. This is the most important thing you can do - ideally a
function should be less than 10 lines. - Reduce nesting, perhaps by introducing guard clauses to return early.
- Ensure that variables are tightly scoped, so that code using related concepts
sits together within the function rather than being scattered.
Co-authored-by: TheEthicalBoy <[email protected]>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
…into flet-new-packages
|
Thanks for the new features :) |
|
Hopefully next week. |
Closes #3839
Closes #3050
Summary by Sourcery
Revamp the Flet CLI with a new package structure and introduce version 2 of the
flet buildcommand. Add cross-platform permissions, support for compiling Python files, and deep linking configuration. Enhance the build and CI processes to support multiple platforms and Python 3.12, and improve security utilities. Update documentation with new README files for Flet packages.New Features:
Enhancements:
Build:
CI:
Documentation:
Python 3.12
Closes #4007
Packaged Flet app runs on Python 3.12.6 runtime for all platforms.
New packages structure
Closes #3163
Closes #2637
The structure avoids rewriting pip dependencies while installing
fletpackage on various platforms. There was a problem of detecting the correctfletpackage to install (flet-runtime,flet-embedorflet-pyodide?) iffletwas not a direct dependency in user's app.New Flet packages.
flet- required for minimal Flet setup, app entry point for various platforms.flet-core- required for minimal Flet setup, core logic and controls.flet-cli- installed on desktop only, Flet CLI.flet-desktop- installed on desktop only. Contains pre-built Flet "client" app binary for macOS, Windows and Linux.flet-desktop-light- installed on Linux desktop only. Contains a light-weight version of Flet "client" for Linux.flet-web- installed on desktop only. Contains Flet web "client" and FastAPI integration.Faster re-builds
Closes #4036
Flutter app created by
flet buildcommand is not re-created all the time in a temp directory, but cached inbuild/flutterdirectory which gives faster re-builds, improves packaging troubleshooting and does not pollute temp directory.Permissions
AndroidManifest.xmlfor Android.Info.plistfor iOS.Info.plistand*.entitlementsfor macOS.iOS
No more hard-coded permissions in
Info.plist.Setting iOS permissions:
For example:
macOS
No hard-coded entitlements in
Release.entitlements.Setting macOS entitlements:
Default macOS entitlements:
com.apple.security.app-sandbox = Falsecom.apple.security.cs.allow-jit = Truecom.apple.security.network.client = Truecom.apple.security.network.server" = TrueAndroid
No hard-coded permissions in
AndroidManifest.xml.Setting Android permissions and features:
For example:
Default Android permissions:
android.permission.INTERNETDefault permissions can be disabled with
--android-permissionsoption andFalsevalue, for example:Default Android features:
android.software.leanback=False(Falsemeans it's written in manifest asandroid:required="false")android.hardware.touchscreen=FalseCross-platform permission groups
There are pre-defined permissions that mapped to
Info.plist,*.entitlementsandAndroidManifest.xmlfor respective platforms.Setting cross-platform permissions:
Supported permissions:
locationcameramicrophonephoto_libraryiOS mapping to
Info.plistentrieslocationNSLocationWhenInUseUsageDescription = This app uses location service when in use.NSLocationAlwaysAndWhenInUseUsageDescription = This app uses location service.cameraNSCameraUsageDescription = This app uses the camera to capture photos and videos.microphoneNSMicrophoneUsageDescription = This app uses microphone to record sounds.photo_libraryNSPhotoLibraryUsageDescription = This app saves photos and videos to the photo library.macOS mapping to entitlements
locationcom.apple.security.personal-information.location = Truecameracom.apple.security.device.camera = Truemicrophonecom.apple.security.device.audio-input = Truephoto_librarycom.apple.security.personal-information.photos-library = TrueAndroid mappings
locationandroid.permission.ACCESS_FINE_LOCATION": Trueandroid.permission.ACCESS_COARSE_LOCATION": Trueandroid.permission.ACCESS_BACKGROUND_LOCATION": Trueandroid.hardware.location.network": Falseandroid.hardware.location.gps": Falsecameraandroid.permission.CAMERA": Trueandroid.hardware.camera": Falseandroid.hardware.camera.any": Falseandroid.hardware.camera.front": Falseandroid.hardware.camera.external": Falseandroid.hardware.camera.autofocus": Falsemicrophoneandroid.permission.RECORD_AUDIO": Trueandroid.permission.WRITE_EXTERNAL_STORAGE": Trueandroid.permission.READ_EXTERNAL_STORAGE": Truephoto_libraryandroid.permission.READ_MEDIA_VISUAL_USER_SELECTED": True"Data" and "Temp" directories for the app
Closes #4114
Closes #2357
Flet developers have been asking where to store application data, such as uploaded files, SQLite databases, etc. that are persistent across application updates.
This release introduce two environment variables that are available in your Flet apps:
FLET_APP_DATA- directory for storing application data that is preserved between app updates. That directory is already pre-created.FLET_APP_TEMP- directory for temporary application files, i.e. cache. That directory is already pre-created.For example, data folder path can be read in your app as:
To make it work in development mode define those variables to suitable locations on your drive, for example:
Deep linking support
Closes #4025
There is a new
--deep-linking-urloption to configure deep linking for iOS and Android builds. The value must be in the format<sheme>://<host>.Other features and fixes
--split-per-abioption forflet buildcommand. Closes flutter-build-args=--split-per-abi #4041packagingdependency is relaxed. Closes flet 0.25.0.dev3382 has requirement packaging<24.0,>=23.1, but you have packaging 24.1. #3945