idf-build-apps 2.9.0__py3-none-any.whl → 2.10.1__py3-none-any.whl

idf_build_apps/__init__.py

@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.9.0'
+__version__ = '2.10.1'
 
 from .session_args import (
     SessionArgs,
@@ -28,6 +28,7 @@ from .log import (
 from .main import (
     build_apps,
     find_apps,
+    json_list_files_to_apps,
     json_to_app,
 )
 
@@ -38,6 +39,7 @@ __all__ = [
     'MakeApp',
     'build_apps',
     'find_apps',
+    'json_list_files_to_apps',
     'json_to_app',
     'setup_logging',
 ]

idf_build_apps/app.py

@@ -1011,3 +1011,11 @@ class AppDeserializer(BaseModel):
     def from_json(cls, json_data: t.Union[str, bytes, bytearray]) -> App:
         json_dict = json.loads(json_data.strip())
         return cls.model_validate({'app': json_dict}).app
+
+    @classmethod
+    def from_json_list(cls, json_list: t.Sequence[t.Union[str, bytes, bytearray]]) -> t.List[App]:
+        apps = []
+        for app_json in json_list:
+            apps.append(cls.from_json(app_json))
+
+        return apps

idf_build_apps/args.py

@@ -4,6 +4,7 @@
 import argparse
 import enum
 import glob
+import importlib
 import inspect
 import logging
 import os
@@ -27,7 +28,7 @@ from pydantic_settings import (
 )
 from typing_extensions import Concatenate, ParamSpec
 
-from . import SESSION_ARGS, App, setup_logging
+from . import SESSION_ARGS, App, CMakeApp, MakeApp, setup_logging
 from .constants import ALL_TARGETS, IDF_BUILD_APPS_TOML_FN, SUPPORTED_TARGETS
 from .manifest.manifest import FolderRule, Manifest
 from .utils import InvalidCommand, files_matches_patterns, semicolon_separated_str_to_list, to_absolute_path, to_list
@@ -397,6 +398,12 @@ class DependencyDrivenBuildArguments(GlobalArguments):
 
 
 class FindBuildArguments(DependencyDrivenBuildArguments):
+    _KNOWN_APP_CLASSES: t.ClassVar[t.Dict[str, t.Type[App]]] = {
+        'cmake': CMakeApp,
+        'make': MakeApp,
+    }
+    _LOADED_MODULE_APPS: t.ClassVar[t.Dict[str, t.Type[App]]] = {}
+
     paths: t.List[str] = field(
         FieldMetadata(
             validate_method=[ValidateMethod.TO_LIST],
@@ -414,10 +421,9 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
         default='all',  # type: ignore
     )
     build_system: t.Union[str, t.Type[App]] = field(
-        FieldMetadata(
-            choices=['cmake', 'make'],
-        ),
-        description='Filter the apps by build system. By default set to "cmake"',
+        None,
+        description='Filter the apps by build system. By default set to "cmake". '
+        'Can be either "cmake", "make" or a custom App class path in format "module:class"',
         default='cmake',  # type: ignore
     )
     recursive: bool = field(
@@ -587,12 +593,56 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
 
         if self.disable_targets and FolderRule.DEFAULT_BUILD_TARGETS:
             LOGGER.info('Disable targets: %s', self.disable_targets)
-            self.default_build_targets = [t for t in FolderRule.DEFAULT_BUILD_TARGETS if t not in self.disable_targets]
+            self.default_build_targets = [
+                _target for _target in FolderRule.DEFAULT_BUILD_TARGETS if _target not in self.disable_targets
+            ]
             FolderRule.DEFAULT_BUILD_TARGETS = self.default_build_targets
 
         if self.override_sdkconfig_files or self.override_sdkconfig_items:
             SESSION_ARGS.set(self)
 
+        # load build system
+        # here could be a string or a class of type App
+        if not isinstance(self.build_system, str):
+            # do nothing, only cache
+            self._KNOWN_APP_CLASSES[self.build_system('', '').build_system] = self.build_system
+            return
+
+        # here could only be a string
+        if self.build_system in self._KNOWN_APP_CLASSES:
+            self.build_system = self._KNOWN_APP_CLASSES[self.build_system]
+            return
+
+        if ':' not in self.build_system:
+            raise ValueError(
+                f'Invalid build system: {self.build_system}. '
+                f'Known build systems: {", ".join(self._KNOWN_APP_CLASSES.keys())}'
+            )
+
+        # here could only be a string in format "module:class"
+        if self.build_system in self._LOADED_MODULE_APPS:
+            self.build_system = self._LOADED_MODULE_APPS[self.build_system]
+            return
+
+        # here could only be a string in format "module:class", and not loaded yet
+        module_path, class_name = self.build_system.split(':')
+        try:
+            module = importlib.import_module(module_path)
+        except ImportError as e:
+            raise ImportError(f'Failed to import module {module_path}. Error: {e!s}')
+
+        try:
+            app_cls = getattr(module, class_name)
+            if not issubclass(app_cls, App):
+                raise ValueError(f'Class {class_name} must be a subclass of App')
+        except (ValueError, AttributeError):
+            raise ValueError(f'Class {class_name} not found in module {module_path}')
+
+        self._LOADED_MODULE_APPS[self.build_system] = app_cls
+        self._KNOWN_APP_CLASSES[app_cls('', '').build_system] = app_cls
+
+        self.build_system = app_cls
+
 
 class FindArguments(FindBuildArguments):
     output: t.Optional[str] = field(

idf_build_apps/main.py

@@ -29,8 +29,6 @@ from idf_build_apps.args import (
 from .app import (
     App,
     AppDeserializer,
-    CMakeApp,
-    MakeApp,
 )
 from .autocompletions import activate_completions
 from .constants import ALL_TARGETS, BuildStatus, completion_instructions
@@ -88,18 +86,6 @@ def find_apps(
             **kwargs,
         )
 
-    app_cls: t.Type[App]
-    if isinstance(find_arguments.build_system, str):
-        # backwards compatible
-        if find_arguments.build_system == 'cmake':
-            app_cls = CMakeApp
-        elif find_arguments.build_system == 'make':
-            app_cls = MakeApp
-        else:
-            raise ValueError('Only Support "make" and "cmake"')
-    else:
-        app_cls = find_arguments.build_system
-
     apps: t.Set[App] = set()
     if find_arguments.target == 'all':
         targets = ALL_TARGETS
@@ -115,7 +101,7 @@ def find_apps(
                 _find_apps(
                     _p,
                     _t,
-                    app_cls=app_cls,
+                    app_cls=find_arguments.build_system,  # type: ignore
                     args=find_arguments,
                 )
             )
@@ -487,14 +473,43 @@ def json_to_app(json_str: str, extra_classes: t.Optional[t.List[t.Type[App]]] =
     :param extra_classes: extra App class
     :return: App object
     """
-    types = [App, CMakeApp, MakeApp]
+    _known_classes = list(FindArguments()._KNOWN_APP_CLASSES.values())
     if extra_classes:
-        types.extend(extra_classes)
+        _known_classes.extend(extra_classes)
 
     custom_deserializer = create_model(
         '_CustomDeserializer',
-        app=(t.Union[tuple(types)], Field(discriminator='build_system')),
+        app=(t.Union[tuple(_known_classes)], Field(discriminator='build_system')),
         __base__=AppDeserializer,
     )
 
     return custom_deserializer.from_json(json_str)
+
+
+def json_list_files_to_apps(
+    json_list_filepaths: t.List[str],
+    extra_classes: t.Optional[t.List[t.Type[App]]] = None,
+) -> t.List[App]:
+    """
+    Deserialize a list of json strings to App objects
+
+    :param json_list_filepaths: filepath to the files, each line is a json string
+    :param extra_classes: extra App class
+    :return: list of App object
+    """
+    _known_classes = list(FindArguments()._KNOWN_APP_CLASSES.values())
+    if extra_classes:
+        _known_classes.extend(extra_classes)
+
+    custom_deserializer = create_model(
+        '_CustomDeserializer',
+        app=(t.Union[tuple(_known_classes)], Field(discriminator='build_system')),
+        __base__=AppDeserializer,
+    )
+
+    jsons = []
+    for fp in json_list_filepaths:
+        with open(fp) as fr:
+            jsons.extend(fr.readlines())
+
+    return custom_deserializer.from_json_list(jsons)

{idf_build_apps-2.9.0.dist-info → idf_build_apps-2.10.1.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: idf-build-apps
-Version: 2.9.0
+Version: 2.10.1
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 License-File: LICENSE
 Requires-Dist: pyparsing
 Requires-Dist: pyyaml

{idf_build_apps-2.9.0.dist-info → idf_build_apps-2.10.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
-idf_build_apps/__init__.py,sha256=OZJ67f2AZ_iIZsd6KKhg9CsTDQLWPKJEjQD4r3ABbnU,650
+idf_build_apps/__init__.py,sha256=20NqJN4TGWNWQmCELK2yHFpTJtstbRhr5rMUOr6TkzQ,711
 idf_build_apps/__main__.py,sha256=pT6OsFQRjCw39Jg43HAeGKzq8h5E_0m7kHDE2QMqDe0,182
-idf_build_apps/app.py,sha256=DKofid9Z0DqoDL1DcsO05rVBtgSd5O9SoCDqKzl8iFQ,36674
-idf_build_apps/args.py,sha256=fkRCeADtNUgsPgR6-L-6ZaPxQZqzjg9e6Xq0RGQj--Q,35899
+idf_build_apps/app.py,sha256=wwwpEciOFwjTmkb-IoucM1CeIqAYVSPxNAEsxti-Frg,36914
+idf_build_apps/args.py,sha256=BBTDk87nBaHodn_VLp65jvhtwjLsskX7qZLTDLRH6kY,37968
 idf_build_apps/autocompletions.py,sha256=2fZQxzgZ21ie_2uk-B-7-xWYCChfOSgRFRYb7I2Onfo,2143
 idf_build_apps/constants.py,sha256=2iwLPZRhSQcn1v4RAcOJnHbqp1fDTp6A1gHaxn5ciTE,2166
 idf_build_apps/finder.py,sha256=wayWyUSCyMvkY72xU-b7IW7I48cv6C-pRqJHMHQsh0c,5794
 idf_build_apps/log.py,sha256=15sSQhv9dJsHShDR2KgFGFp8ByjV0HogLr1X1lHYqGs,3899
-idf_build_apps/main.py,sha256=7CGwRBxi9j2Yqw7zYkfNbKXg_DSkLWkWMYvgiYjUFl4,17393
+idf_build_apps/main.py,sha256=BOCAlcN019NkV7s4wBWlNht911Gh9BVT-x9JIj3IlOE,17927
 idf_build_apps/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 idf_build_apps/session_args.py,sha256=yM-78vFzCDCdhXHNxTALmzE4w2NSmka8yVBbh3wtvC8,2985
 idf_build_apps/utils.py,sha256=cQJ5N-53vrASa4d8WW0AQCPJzendArXyU3kB5Vx-AH8,10880
@@ -20,8 +20,8 @@ idf_build_apps/vendors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 idf_build_apps/vendors/pydantic_sources.py,sha256=cxSIPRc3eI5peVMhDxwf58YaGhuG4SCwPRVX2znFEek,4553
 idf_build_apps/yaml/__init__.py,sha256=R6pYasVsD31maeZ4dWRZnS10hwzM7gXdnfzDsOIRJ-4,167
 idf_build_apps/yaml/parser.py,sha256=IhY7rCWXOxrzzgEiKipTdPs_8yXDf8JZr-sMewV1pk8,2133
-idf_build_apps-2.9.0.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.9.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.9.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-idf_build_apps-2.9.0.dist-info/METADATA,sha256=uO2KdzYJfOdjNQShm3tVrbuWbzQowGaxxIc_de2dduI,4735
-idf_build_apps-2.9.0.dist-info/RECORD,,
+idf_build_apps-2.10.1.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.10.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.10.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+idf_build_apps-2.10.1.dist-info/METADATA,sha256=-lAyB6KVFTYVMK9NwDAcyl-sc_oYKxYNBfY79HFto3Y,4795
+idf_build_apps-2.10.1.dist-info/RECORD,,