idf-build-apps 2.8.1__py3-none-any.whl → 2.10.0__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.8.1'
+__version__ = '2.10.0'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/__main__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .main import (

idf_build_apps/args.py

@@ -14,6 +14,7 @@ from copy import deepcopy
 from dataclasses import dataclass
 from io import TextIOWrapper
 from pathlib import Path
+from string import Template
 from typing import Any
 
 from pydantic import AliasChoices, Field, computed_field, field_validator
@@ -112,6 +113,29 @@ def get_meta(f: FieldInfo) -> t.Optional[FieldMetadata]:
     return None
 
 
+def expand_vars(v: t.Optional[str]) -> t.Optional[str]:
+    """
+    Expand environment variables in the string. If the variable is not found, use an empty string.
+
+    :param v: string to expand
+    :return: expanded string or None if the input is None
+    """
+    if v is None:
+        return None
+
+    unknown_vars: t.Dict[str, str] = dict()
+    while True:
+        try:
+            v = Template(v).substitute(os.environ, **unknown_vars)
+        except KeyError as e:
+            LOGGER.debug('Environment variable %s not found. use empty string', e)
+            unknown_vars[e.args[0]] = ''
+        else:
+            break
+
+    return v
+
+
 class BaseArguments(BaseSettings):
     """Base settings class for all settings classes"""
 
@@ -154,7 +178,7 @@ class BaseArguments(BaseSettings):
                     if method == ValidateMethod.TO_LIST:
                         v = to_list(v)
                     elif method == ValidateMethod.EXPAND_VARS:
-                        v = os.path.expandvars(v)
+                        v = expand_vars(v)
                     else:
                         raise NotImplementedError(f'Unknown validate method: {method}')
 
@@ -390,10 +414,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(
@@ -689,9 +712,10 @@ class BuildArguments(FindBuildArguments):
         FieldMetadata(
             deprecates={'collect_size_info': {}},
             hidden=True,
+            validate_method=[ValidateMethod.EXPAND_VARS],
         ),
         description='Record size json filepath of the built apps to the specified file. '
-        'Each line is a json string. Can expand placeholders @p',
+        'Each line is a json string. Can expand placeholders @p. Support environment variables.',
         validation_alias=AliasChoices('collect_size_info_filename', 'collect_size_info'),
         default=None,  # type: ignore
         exclude=True,  # computed field is used
@@ -700,9 +724,10 @@ class BuildArguments(FindBuildArguments):
         FieldMetadata(
             deprecates={'collect_app_info': {}},
             hidden=True,
+            validate_method=[ValidateMethod.EXPAND_VARS],
         ),
         description='Record serialized app model of the built apps to the specified file. '
-        'Each line is a json string. Can expand placeholders @p',
+        'Each line is a json string. Can expand placeholders @p. Support environment variables.',
         validation_alias=AliasChoices('collect_app_info_filename', 'collect_app_info'),
         default=None,  # type: ignore
         exclude=True,  # computed field is used
@@ -711,8 +736,10 @@ class BuildArguments(FindBuildArguments):
         FieldMetadata(
             deprecates={'junitxml': {}},
             hidden=True,
+            validate_method=[ValidateMethod.EXPAND_VARS],
         ),
-        description='Path to the junitxml file to record the build results. Can expand placeholder @p',
+        description='Path to the junitxml file to record the build results. Can expand placeholder @p. '
+        'Support environment variables.',
         validation_alias=AliasChoices('junitxml_filename', 'junitxml'),
         default=None,  # type: ignore
         exclude=True,  # computed field is used

idf_build_apps/autocompletions.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os

idf_build_apps/finder.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import logging

idf_build_apps/junit/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .report import (

idf_build_apps/junit/utils.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os

idf_build_apps/main.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import argparse
+import importlib
 import json
 import logging
 import os
@@ -90,13 +91,24 @@ def find_apps(
 
     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
+        elif ':' in find_arguments.build_system:
+            # Custom App class in format "module:class"
+            try:
+                module_path, class_name = find_arguments.build_system.split(':')
+                module = importlib.import_module(module_path)
+                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, ImportError, AttributeError) as e:
+                raise ValueError(f'Invalid custom App class path: {find_arguments.build_system}. Error: {e!s}')
         else:
-            raise ValueError('Only Support "make" and "cmake"')
+            raise ValueError(
+                'build_system must be either "cmake", "make" or a custom App class path in format "module:class"'
+            )
     else:
         app_cls = find_arguments.build_system
 

idf_build_apps/manifest/manifest.py

@@ -89,7 +89,10 @@ class FolderRule:
         disable_test: t.Optional[t.List[t.Dict[str, t.Any]]] = None,
         depends_components: t.Optional[t.List[t.Union[str, t.Dict[str, t.Any]]]] = None,
         depends_filepatterns: t.Optional[t.List[t.Union[str, t.Dict[str, t.Any]]]] = None,
+        manifest_filepath: t.Optional[str] = None,
     ) -> None:
+        self._manifest_filepath = manifest_filepath
+
         self.folder = os.path.abspath(folder)
 
         def _clause_to_if_clause(clause: t.Dict[str, t.Any]) -> IfClause:
@@ -168,6 +171,10 @@ class FolderRule:
     def __repr__(self) -> str:
         return f'FolderRule({self.folder})'
 
+    @property
+    def by_manifest_file(self) -> t.Optional[str]:
+        return self._manifest_filepath
+
     def _enable_build(self, target: str, config_name: str) -> bool:
         if self.enable:
             res = False
@@ -309,7 +316,7 @@ class Manifest:
                     LOGGER.warning(msg)
 
             try:
-                rules.append(FolderRule(folder, **folder_rule if folder_rule else {}))
+                rules.append(FolderRule(folder, **folder_rule if folder_rule else {}, manifest_filepath=str(path)))
             except InvalidIfClause as e:
                 raise InvalidManifest(f'Invalid manifest file {path}: {e}')
 

idf_build_apps/session_args.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import logging

idf_build_apps/yaml/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .parser import (

idf_build_apps/yaml/parser.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import typing as t

{idf_build_apps-2.8.1.dist-info → idf_build_apps-2.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: idf-build-apps
-Version: 2.8.1
+Version: 2.10.0
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7

idf_build_apps-2.10.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+idf_build_apps/__init__.py,sha256=Ha5ZrybfsaB7tFsUqXP6HU-k0PWWSR-8MK-OvuOfHQk,651
+idf_build_apps/__main__.py,sha256=pT6OsFQRjCw39Jg43HAeGKzq8h5E_0m7kHDE2QMqDe0,182
+idf_build_apps/app.py,sha256=DKofid9Z0DqoDL1DcsO05rVBtgSd5O9SoCDqKzl8iFQ,36674
+idf_build_apps/args.py,sha256=Nbq5LBRowSFuJ4u4KFqPh7FVGMTHHxLqdH9ZUkCRTOI,35934
+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=COudSnUqLEuIGnIVKi06Q4h_McSXwwOpm8aDRGjwnSc,18106
+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
+idf_build_apps/junit/__init__.py,sha256=ljILW1rfeBAIlwZIw8jstYrVbugErlmCYzSzJwNFC2I,231
+idf_build_apps/junit/report.py,sha256=yzt5SiJEA_AUlw2Ld23J7enYlfDluvmKAcCnAM8ccqE,6565
+idf_build_apps/junit/utils.py,sha256=idBrLgsz6Co2QUQqq1AiyzRHnqbJf_EoykEAxCkjHZw,1303
+idf_build_apps/manifest/__init__.py,sha256=LYGR9doEKGPEdsJPuHnmJmV-qw2kuAipV0bodkhY_JE,399
+idf_build_apps/manifest/manifest.py,sha256=Y2NCwQE_T3kXtQJVPpA4wMi_X3amjjI-eSsKLtqmRXo,15031
+idf_build_apps/manifest/soc_header.py,sha256=_F6H5-HP6ateAqKUGlRGH-SUtQ8NJ1RI0hBeCFvsDYA,172
+idf_build_apps/vendors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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.10.0.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.10.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.10.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+idf_build_apps-2.10.0.dist-info/METADATA,sha256=TilWcEgDYDhf8AKhgjfo5s9X2Hdfhdr6eRnZigvRNQg,4736
+idf_build_apps-2.10.0.dist-info/RECORD,,

{idf_build_apps-2.8.1.dist-info → idf_build_apps-2.10.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.11.0
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any

idf_build_apps-2.8.1.dist-info/RECORD

@@ -1,27 +0,0 @@
-idf_build_apps/__init__.py,sha256=IMmTkYj0ST-jiyD0xXbUAvlIxu66jnXXcicRuu9tL-k,650
-idf_build_apps/__main__.py,sha256=8E-5xHm2MlRun0L88XJleNh5U50dpE0Q1nK5KqomA7I,182
-idf_build_apps/app.py,sha256=DKofid9Z0DqoDL1DcsO05rVBtgSd5O9SoCDqKzl8iFQ,36674
-idf_build_apps/args.py,sha256=4sDupbemB66vwX60Dr5FTqfz5MvBqtyk_OPwKNidAFM,34955
-idf_build_apps/autocompletions.py,sha256=g-bx0pzXoFKI0VQqftkHyGVWN6MLjuFOdozeuAf45yo,2138
-idf_build_apps/constants.py,sha256=2iwLPZRhSQcn1v4RAcOJnHbqp1fDTp6A1gHaxn5ciTE,2166
-idf_build_apps/finder.py,sha256=hY6uSMB2s65MqMKIDBSHABOfa93mOLT7x5hlMxC43EQ,5794
-idf_build_apps/log.py,sha256=15sSQhv9dJsHShDR2KgFGFp8ByjV0HogLr1X1lHYqGs,3899
-idf_build_apps/main.py,sha256=7CGwRBxi9j2Yqw7zYkfNbKXg_DSkLWkWMYvgiYjUFl4,17393
-idf_build_apps/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-idf_build_apps/session_args.py,sha256=2WDTy40IFAc0KQ57HaeBcYj_k10eUXRKkDOWLrFCaHY,2985
-idf_build_apps/utils.py,sha256=cQJ5N-53vrASa4d8WW0AQCPJzendArXyU3kB5Vx-AH8,10880
-idf_build_apps/junit/__init__.py,sha256=IxvdaS6eSXp7kZxRuXqyZyGxuA_A1nOW1jF1HMi8Gns,231
-idf_build_apps/junit/report.py,sha256=yzt5SiJEA_AUlw2Ld23J7enYlfDluvmKAcCnAM8ccqE,6565
-idf_build_apps/junit/utils.py,sha256=NXZxQD4tdbSVKjKMNx1kO2H3IoEiysXkDoDjLEf1RO8,1303
-idf_build_apps/manifest/__init__.py,sha256=LYGR9doEKGPEdsJPuHnmJmV-qw2kuAipV0bodkhY_JE,399
-idf_build_apps/manifest/manifest.py,sha256=5BIzNzGAk0w5qOCTMGsmvKcN4DQLwUi6JVGt2G4JKQs,14793
-idf_build_apps/manifest/soc_header.py,sha256=_F6H5-HP6ateAqKUGlRGH-SUtQ8NJ1RI0hBeCFvsDYA,172
-idf_build_apps/vendors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-idf_build_apps/vendors/pydantic_sources.py,sha256=cxSIPRc3eI5peVMhDxwf58YaGhuG4SCwPRVX2znFEek,4553
-idf_build_apps/yaml/__init__.py,sha256=W-3z5no07RQ6eYKGyOAPA8Z2CLiMPob8DD91I4URjrA,162
-idf_build_apps/yaml/parser.py,sha256=b3LvogO6do-eJPRsYzT-8xk8AT2MnXpLCzQutJqyC7M,2128
-idf_build_apps-2.8.1.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.8.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.8.1.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
-idf_build_apps-2.8.1.dist-info/METADATA,sha256=kQq1NI7VocSdPZtH66DlY5E1pj3D4ULgtNaIsmEkAto,4735
-idf_build_apps-2.8.1.dist-info/RECORD,,