fletext 0.1.0__tar.gz

fletext-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

fletext-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stone Zhong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fletext-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: fletext
+Version: 0.1.0
+Summary: Utility to build flet based UI application
+Project-URL: Homepage, https://github.com/pypa/sampleproject
+Project-URL: Issues, https://github.com/pypa/sampleproject/issues
+Author-email: Stone Zhong <stone.zhong@gmail.com>
+License-Expression: MIT
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13
+Requires-Dist: flet
+Description-Content-Type: text/markdown
+
+Wraps flet UI component and make it easier to build flext based UI app.

fletext-0.1.0/README.md

@@ -0,0 +1 @@
+Wraps flet UI component and make it easier to build flext based UI app.

fletext-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fletext"
+version = "0.1.0"
+authors = [
+    {name="Stone Zhong", email="stone.zhong@gmail.com"}
+]
+description = "Utility to build flet based UI application"
+readme = "README.md"
+requires-python = ">=3.13"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICENCSE"]
+
+dependencies = [
+    "flet"
+]
+
+[project.urls]
+Homepage = "https://github.com/pypa/sampleproject"
+Issues = "https://github.com/pypa/sampleproject/issues"

fletext-0.1.0/src/fletext/__init__.py

@@ -0,0 +1,5 @@
+from .ui import  Component, load_component_from_descriptor, queue_method, drain_dpc_queue
+from .dvalue import SettableVariable, CalculableVariable, VarEnvironment
+from .pubsub import PubSub
+
+__version__ = "0.1.0"

fletext-0.1.0/src/fletext/dvalue.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+from typing import Callable, Any, Dict, Optional
+from abc import ABC
+from .pubsub import PubSub
+from uuid import uuid4
+
+class VarEnvironment:
+    variable_map: Dict[str, BindVariable]
+    parent_env: Optional[VarEnvironment]
+    pubsub: Optional[PubSub] = None
+    name:str
+
+    def __init__(
+        self, 
+        parent_env = None, 
+        variable_map:Dict[str, BindVariable]={}, 
+        pubsub:Optional[PubSub]=None,
+        name:str="default"
+    ):
+        self.parent_env = parent_env
+        self.variable_map = variable_map.copy()
+        self.pubsub = pubsub
+        self.name = name
+    
+    def get_value(self, name:str):
+        if name in self.variable_map:
+            var = self.variable_map[name]
+            return var.get_value() if isinstance(var, BindVariable) else var
+        return self.parent_env.get_value(name) if self.parent_env is not None else None
+       
+    def __getattr__(self, name:str)->BindVariable:
+        return self.get_value(name)
+    
+    def new_settable(self, value:Any=None, name:Optional[str]=None):
+        if name is None:
+            name = str(uuid4())
+        ret = SettableVariable(self, name, value)
+        self.variable_map[name] = ret
+        return ret
+
+    def new_calculable(self, calculator:Callable[[], Any], **dependOn):
+        return CalculableVariable(self, calculator, **dependOn)
+    
+    # 将一个SettableVariable变量发布，这样其他人可以通过发布消息来设置这个变量的值
+    def publish_settable(self, name:str):
+        if name not in self.variable_map:
+            raise ValueError(f"There is no variable for \"{name}\"")
+        var = self.variable_map[name]
+        if not isinstance(var, SettableVariable):
+            raise ValueError(f"Variable \"{name}\" is not settable")
+        self.pubsub.subscribe(f"env.{self.name}.{name}", lambda new_value: var.set_value(new_value))
+
+class BindVariable(ABC):
+    env: VarEnvironment     # 这个变量对应的环境
+    name: str               # 这个变量在环境中的名字
+
+    def __init__(self, env:VarEnvironment, name:str):
+        self.env = env
+        self.name = name
+
+
+# 一个可以设置的变量，它不依赖于其他变量
+class SettableVariable(BindVariable):
+    _value: Any
+
+    def __init__(self, env:VarEnvironment, name:str, value:Any=None):
+        super().__init__(env, name=name)
+        self._value = value
+  
+    def get_value(self):
+        return self._value
+    
+    def set_value(self, value:Any=None):
+        self._value = value
+
+    def publish(self) -> SettableVariable:
+        if self.env.pubsub is None:
+            raise ValueError("The environment is not bind to a message bus")
+        print(f"subscribe: env.{self.env.name}.{self.name}")
+        self.env.pubsub.subscribe(f"env.{self.env.name}.{self.name}", lambda new_value: self.set_value(new_value))
+        return self
+
+
+# 一个由计算得到的变量
+class CalculableVariable(BindVariable):
+    calculator: Callable[[], Any]
+
+    def __init__(self, env:VarEnvironment, calculator:Callable[[], Any], name:Optional[str]=None):
+        super().__init__(env, name=name)
+        self.calculator = calculator
+  
+    def get_value(self):
+        return self.calculator(self.env)
+    

fletext-0.1.0/src/fletext/pubsub.py

@@ -0,0 +1,17 @@
+from typing import List, Callable, Dict, Any
+from collections import defaultdict
+
+#########################################################################################
+# 这个模块负责消息的订阅和消息的发送
+#########################################################################################
+class PubSub: 
+    callback_registry:Dict[str, List[Callable[[], None]]] = defaultdict(list)
+
+    # 订阅消息，一旦一个消息被发布，所有的订阅者登记注册的方法就会被处罚
+    def subscribe(self, subject_id:str, callback: Callable[[], None]):
+        self.callback_registry[subject_id].append(callback)
+
+    # 发布消息
+    def publish(self, subject_id, message:Any):
+        for callback in self.callback_registry.get(subject_id, []):
+            callback(message)

fletext-0.1.0/src/fletext/ui.py

@@ -0,0 +1,254 @@
+from __future__ import annotations
+from dataclasses import dataclass, field
+import flet as ft
+import sys
+from copy import copy
+from typing import Any, List, Optional, get_type_hints, Callable
+from .dvalue import VarEnvironment
+from enum import Enum
+
+#########################################################################################
+# 概念
+# - 组件描述符
+#       是一种JSON数据，描述组件。$type字段表示组件的类型。$refid表示组件的代号
+#       将来，你可以通过组件代号来寻找组件。
+# 
+# 在描述符中如果有属性的值是对象，且有"$type"字段，则视为一个组件的描述符。
+#
+# 要从UI Descriptor加载UI组件，客户端要调用函数 load_component_from_descriptor
+# 
+# 组件的ui property
+# - 只有在访问时才计算
+# - 计算的时候通过build_ui()函数获得。一旦获得，就不会再次计算了。
+#
+# 组件和变量的绑定, 绑定类型: 输出型。通过函数 bind_variable(variable_name, bind_type)
+#       这时，这个组件的值会被传送到其绑定的变量。当组件的值变化了，这个变量的值也会变化
+# 组件和变量的绑定, 绑定类型: 输入型
+#       这时，这个组件的值会从被绑定的变量中读取，如果被绑定的变量的值变化了，组件的值也会变化
+#########################################################################################
+
+
+##########################################################
+# This module helps to build flet UI based on YAML
+# descriptor.
+##########################################################
+
+TYPE_FIELD  = "$type"
+REFID_FIELD = "$refid"
+
+class BindType(Enum):
+    INPUT = 1
+    EXPORT = 2
+
+DPC_QUEUE = []
+
+def queue_method(method: Callable[[], None]):
+    DPC_QUEUE.append(method)
+
+def drain_dpc_queue():
+    while len(DPC_QUEUE) > 0:
+        method = DPC_QUEUE.pop()
+        method()    
+
+@dataclass
+class ValueRef:
+    value: Any = None
+
+# 解析yaml中一个字段的值
+def resolve(value, env:VarEnvironment, refs:dict, context:dict={}):
+    if isinstance(value, list):
+        return [resolve(item, env, refs, context=context) for item in value]
+    
+    if isinstance(value, dict) and value.get(TYPE_FIELD) is not None:
+        # 如果值是对象且有$type字段，则被视为一个子组件的描述符
+        return load_component_from_descriptor(env, value, refs=refs, context=context)
+
+    if not isinstance(value, str):
+        return value
+
+    # check if we are using context variable
+    if value.startswith("❔"):
+        return context.get(value[1:])
+
+    # 这是一个变量    
+    if value.startswith("❕"):
+        path = value[1:]
+        current_obj = sys.modules[__name__]
+        for seg_name in path.split("."):
+            current_obj = getattr(current_obj, seg_name)
+        return current_obj
+    
+    # 其他情况，假设就是字符串
+    return value
+
+# 从descriptor加载一个组件
+def load_component_from_descriptor(
+    env: VarEnvironment,
+    descriptor:dict, 
+    refs:Optional[dict] = None, 
+    context={},
+) -> Component:
+    if TYPE_FIELD not  in descriptor:
+        raise ValueError(f"{TYPE_FIELD} not found in desscriptor")
+
+    component_type = descriptor[TYPE_FIELD]
+    if component_type not in COMPONENT_MAP:
+        raise Exception(f"{component_type} is not valid UI Component type")
+    
+    component = COMPONENT_MAP[component_type]()
+    component._env = env
+    if refs is None:
+        component._refs = {}
+        new_refs = component._refs
+    else:
+        new_refs = refs
+
+    component.initialize_component_from_descriptor(descriptor, new_refs, context=context)
+    return component
+
+#################################################################
+# 所有组件类的共同祖先
+# ui:   这是指向flet ui组件。这是一个property，并且是lazy计算的。
+#       它只计算一次，并且只有在第一次访问的时候才出发计算
+#################################################################
+@dataclass
+class Component:
+    _refs: Optional[dict] = None
+    _ui: Optional[ft.Control] = None
+    _env: Optional[VarEnvironment] = None
+
+    def get_child(self, refid:str)->Optional[Component]:
+        if self._refs is None:
+            return None
+        return self._refs.get(refid)
+
+    @property
+    def ui(self):
+        if self._ui is not None:
+            return self._ui
+        self._ui = self.build_ui()
+        return self._ui
+    
+    # def bind_variable(self, variable_name:str, bind_type:BindType):
+    #     if bind_type == BindType.INPUT:
+    #         # 输入型绑定
+    #         # 组件的值从绑定的变量获得
+
+    #         def on_value_changed():
+    #             pass
+
+    #         self._env.pubsub.subscribe(
+    #             f"env.{self._env.name}.{variable_name}", lambda new_value: self.set_value(new_value))
+
+    #         pass
+    #     elif bind_type == BindType.EXPORT:
+    #         # 输出型绑定
+    #         pass
+    #     else:
+    #         assert False, "非法绑定类型"
+
+    def get_attr_value_for_building_ui(self, property_value:Any):
+        if isinstance(property_value, Component):
+            return property_value.ui
+        if isinstance(property_value, list):
+            return [self.get_attr_value_for_building_ui(item) for item in property_value]
+        if isinstance(property_value, dict):
+            return {
+                attr_name: self.get_attr_value_for_building_ui(attr_value) \
+                    for attr_name, attr_value in property_value.items() \
+                        if not attr_name.startswith("_") and attr_value is not None
+                # attr_value应该是ValueRef类型的。
+            }
+        
+        return property_value.value if isinstance(property_value, ValueRef) else property_value
+
+    def build_ui(self) -> ft.Control:
+        kwargs = self.get_attr_value_for_building_ui(vars(self))
+        ui_class = getattr(ft, type(self).__name__)
+        return ui_class(**kwargs)
+   
+    # 构造Component及其子类的时候，需要从JSON Descriptor中加载Component
+    def initialize_component_from_descriptor(self, descriptor:dict, refs:dict, context={}):
+        # 处理refid
+        refid = descriptor.get(REFID_FIELD)
+        if refid is not None:
+            refs[refid] = self
+
+        for field_name, field_value in descriptor.items():
+            if field_name in (TYPE_FIELD, REFID_FIELD):
+                continue
+            setattr(self, field_name, resolve(field_value, self._env, refs, context=context))
+        
+@dataclass
+class Text(Component):
+    # see https://flet.dev/docs/controls/text
+    value:                  Optional[ValueRef] = None
+    size:                   Optional[ValueRef] = None
+    weight:                 Optional[ValueRef] = None
+    font_family:            Optional[ValueRef] = None
+    selectable:             Optional[ValueRef] = None
+
+
+@dataclass
+class Column(Component):
+    controls:               List[Component] = field(default_factory=list)
+    horizontal_alignment:   Optional[ValueRef] = None
+    spacing:                Optional[ValueRef] = None
+    width:                  Optional[ValueRef] = None
+    expand:                 Optional[ValueRef] = None
+    tight:                  Optional[ValueRef] = None
+
+@dataclass
+class Row(Component):
+    controls:               List[Component] = field(default_factory=list)
+    alignment:              Optional[ValueRef] = None
+    spacing:                Optional[ValueRef] = None
+    expand:                 Optional[ValueRef] = None
+
+@dataclass
+class Container(Component):
+    content:                Optional[Component] = None
+    bgcolor:                Optional[ValueRef] = None
+    padding:                Optional[ValueRef] = None
+    border:                 Optional[ValueRef] = None
+    expand:                 Optional[ValueRef] = None
+    height:                 Optional[ValueRef] = None
+    width:                  Optional[ValueRef] = None
+    alignment:              Optional[ValueRef] = None
+    border_radius:          Optional[ValueRef] = None
+
+@dataclass
+class TextField(Component):
+    value:                  Optional[ValueRef] = None
+    label:                  Optional[ValueRef] = None
+    width:                  Optional[ValueRef] = None
+    expand:                 Optional[ValueRef] = None
+    font_family:            Optional[ValueRef] = None
+
+@dataclass
+class Button(Component):
+    disabled:               Optional[ValueRef] = None
+    content:                Optional[ValueRef] = None
+
+@dataclass
+class IconButton(Component):
+    disabled:               Optional[ValueRef] = None
+    icon:                   Optional[ValueRef] = None
+
+@dataclass
+class ExpansionTile(Component):
+    title:                  Optional[Component] = None
+    controls:               List[Component] = field(default_factory=list)
+    shape:                  Optional[ValueRef] = None
+
+COMPONENT_MAP = {
+    "Text":             Text,
+    "Column":           Column,
+    "Row":              Row,
+    "Container":        Container,
+    "TextField":        TextField,
+    "Button":           Button,
+    "IconButton":       IconButton,
+    "ExpansionTile":    ExpansionTile
+}
+