idf-build-apps 2.13.3__py3-none-any.whl → 2.15.0__py3-none-any.whl

idf_build_apps/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 """
@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.13.3'
+__version__ = '2.15.0'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/__main__.py

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

idf_build_apps/app.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import copy
@@ -511,7 +511,9 @@ class App(BaseModel):
             BuildStatus.UNKNOWN,
             BuildStatus.SHOULD_BE_BUILT,
         ):
-            self.build_comment = f'Build {self.build_status.value}. Skipping...'
+            if not self.build_comment:
+                self.build_comment = f'Build {self.build_status.value}. Skipping...'
+
             return
 
         # real build starts here
@@ -954,7 +956,11 @@ class CMakeApp(App):
 
     # While ESP-IDF component CMakeLists files can be identified by the presence of 'idf_component_register' string,
     # there is no equivalent for the project CMakeLists files. This seems to be the best option...
-    CMAKE_PROJECT_LINE: t.ClassVar[str] = r'include($ENV{IDF_PATH}/tools/cmake/project.cmake)'
+    # Support both build system v1 and v2 patterns
+    CMAKE_PROJECT_LINE: t.ClassVar[t.List[str]] = [
+        r'include($ENV{IDF_PATH}/tools/cmake/project.cmake)',
+        r'include($ENV{IDF_PATH}/tools/cmakev2/idf.cmake)',
+    ]
 
     build_system: Literal['cmake'] = 'cmake'  # type: ignore
 
@@ -1062,10 +1068,12 @@ class CMakeApp(App):
         if not cmakelists_file_content:
             return False
 
-        if cls.CMAKE_PROJECT_LINE not in cmakelists_file_content:
-            return False
+        # Check if any of the supported build system patterns are present
+        for pattern in cls.CMAKE_PROJECT_LINE:
+            if pattern in cmakelists_file_content:
+                return True
 
-        return True
+        return False
 
 
 class AppDeserializer(BaseModel):

idf_build_apps/args.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import argparse
@@ -302,6 +302,19 @@ class DependencyDrivenBuildArguments(GlobalArguments):
         ),
         default=None,  # type: ignore
     )
+    common_components: t.Optional[t.List[str]] = field(
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            type=semicolon_separated_str_to_list,
+            shorthand='-rc',
+        ),
+        description='semicolon-separated list of components. '
+        'expand the `- *common_components` placeholder in manifests. '
+        'Must be specified together with --modified-components. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
+        default=None,  # type: ignore
+    )
     deactivate_dependency_driven_build_by_filepatterns: t.Optional[t.List[str]] = field(
         FieldMetadata(
             validate_method=[ValidateMethod.TO_LIST],
@@ -374,6 +387,7 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             App.MANIFEST = Manifest.from_files(
                 self.manifest_files,
                 root_path=to_absolute_path(self.manifest_rootpath),
+                common_components=self.common_components,
             )
 
     @property

idf_build_apps/autocompletions.py

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

idf_build_apps/constants.py

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

idf_build_apps/finder.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2026 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-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .report import (

idf_build_apps/junit/report.py

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

idf_build_apps/junit/utils.py

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

idf_build_apps/log.py

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

idf_build_apps/main.py

@@ -1,6 +1,6 @@
 # PYTHON_ARGCOMPLETE_OK
 
-# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import argparse
@@ -386,23 +386,26 @@ def main():
         sys.exit(0)
 
     kwargs = vars(args)
+    kwargs_without_none = drop_none_kwargs(kwargs)
     action = kwargs.pop('action')
     config_file = kwargs.pop('config_file')
     if config_file:
         apply_config_file(config_file)
 
     if action == 'dump-manifest-sha':
-        arguments = DumpManifestShaArguments(**drop_none_kwargs(kwargs))
+        arguments = DumpManifestShaArguments(**kwargs_without_none)
         Manifest.from_files(arguments.manifest_files).dump_sha_values(arguments.output)
         sys.exit(0)
-    elif action == 'find':
-        arguments = FindArguments(**drop_none_kwargs(kwargs))
+
+    if action == 'find':
+        arguments = FindArguments(**kwargs_without_none)
     else:
-        arguments = BuildArguments(**drop_none_kwargs(kwargs))
+        arguments = BuildArguments(**kwargs_without_none)
 
     # real call starts here
     # build also needs to find first
-    apps = find_apps(args.paths, args.target, find_arguments=arguments)
+    apps = find_apps(args.paths, args.target, find_arguments=FindArguments.model_validate(kwargs_without_none))
+
     if isinstance(arguments, FindArguments):  # find only
         if arguments.output:
             os.makedirs(os.path.dirname(os.path.realpath(arguments.output)), exist_ok=True)
@@ -444,6 +447,12 @@ def main():
         for app in failed_apps:
             print(f'  {app}')
 
+    disabled_apps = [app for app in apps if app.build_status == BuildStatus.DISABLED]
+    if disabled_apps:
+        print('Disabled the following apps:')
+        for app in disabled_apps:
+            print(f'  {app}')
+
     if ret_code != 0:
         sys.exit(ret_code)
 

idf_build_apps/manifest/__init__.py

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

idf_build_apps/manifest/manifest.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 import contextvars
 import logging
@@ -45,7 +45,7 @@ class IfClause:
         try:
             self.stmt: BoolStmt = parse_bool_expr(stmt)
             self._stmt: str = stmt
-        except (ParseException, InvalidIfClause) as ex:
+        except (ParseException, InvalidIfClause, AttributeError) as ex:
             raise InvalidIfClause(f'Invalid if clause: {stmt}. {ex}')
 
         self.temporary = temporary
@@ -342,12 +342,19 @@ class Manifest:
         self._rule_paths = {rule.folder: rule for rule in self.rules}
 
     @classmethod
-    def from_files(cls, paths: t.Iterable[PathLike], *, root_path: str = os.curdir) -> 'Manifest':
+    def from_files(
+        cls,
+        paths: t.Iterable[PathLike],
+        *,
+        root_path: str = os.curdir,
+        common_components: t.Optional[t.Sequence[str]] = None,
+    ) -> 'Manifest':
         """
         Create a Manifest instance from multiple manifest files
 
         :param paths: manifest file paths
         :param root_path: root path for relative paths in manifest files
+        :param common_components: sequence of strings to expand the ``- *common_components`` placeholder in manifests
         :return: Manifest instance
         """
         # folder, defined as dict
@@ -356,7 +363,7 @@ class Manifest:
         rules: t.List[FolderRule] = []
         for path in paths:
             LOGGER.debug('Loading manifest file %s', path)
-            _manifest = cls.from_file(path, root_path=root_path)
+            _manifest = cls.from_file(path, root_path=root_path, common_components=common_components)
 
             for rule in _manifest.rules:
                 if rule.folder in _known_folders:
@@ -373,15 +380,22 @@ class Manifest:
         return Manifest(rules, root_path=root_path)
 
     @classmethod
-    def from_file(cls, path: PathLike, *, root_path: str = os.curdir) -> 'Manifest':
+    def from_file(
+        cls,
+        path: PathLike,
+        *,
+        root_path: str = os.curdir,
+        common_components: t.Optional[t.Sequence[str]] = None,
+    ) -> 'Manifest':
         """
         Create a Manifest instance from a manifest file
 
         :param path: path to the manifest file
         :param root_path: root path for relative paths in manifest file
+        :param common_components: sequence of strings to expand the ``{{root_components}}`` placeholder in manifests
         :return: Manifest instance
         """
-        manifest_dict = parse(path)
+        manifest_dict = parse(path, common_components=common_components)
 
         rules: t.List[FolderRule] = []
         for folder, folder_rule in manifest_dict.items():

idf_build_apps/manifest/soc_header.py

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

idf_build_apps/session_args.py

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

idf_build_apps/utils.py

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

idf_build_apps/yaml/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2026 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-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2026 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import typing as t
@@ -62,8 +62,43 @@ def parse_postfixes(manifest_dict: t.Dict):
         manifest_dict[folder] = updated_folder
 
 
-def parse(path: PathLike) -> t.Dict:
-    with open(path) as f:
-        manifest_dict = yaml.safe_load(f) or {}
+def flatten_common_components(manifest_dict: t.Dict):
+    """
+    Flattens nested lists under `depends_components` into a single list of strings.
+    """
+
+    for folder, folder_rule in manifest_dict.items():
+        if not isinstance(folder_rule, t.Dict):
+            continue
+
+        depends = folder_rule.get('depends_components')
+        if not isinstance(depends, t.List):
+            continue
+
+        flattened: t.List[str] = []
+        for item in depends:
+            if not item:
+                continue
+            if isinstance(item, t.List):
+                flattened.extend(map(str, item))
+            else:
+                flattened.append(item)
+
+        folder_rule['depends_components'] = flattened
+
+
+def parse(path: PathLike, *, common_components: t.Optional[t.Sequence[str]] = None) -> t.Dict:
+    common_components_yaml = (
+        '.common_components: &common_components\n' + '\n'.join(f'  - {component}' for component in common_components)
+        if common_components
+        else '.common_components: &common_components\n  null'
+    )
+
+    with open(path, encoding='utf-8') as f:
+        user_yaml = f.read()
+
+    manifest_dict = yaml.safe_load(f'{common_components_yaml}\n{user_yaml}') or {}
+
+    flatten_common_components(manifest_dict)
     parse_postfixes(manifest_dict)
     return manifest_dict

{idf_build_apps-2.13.3.dist-info → idf_build_apps-2.15.0.dist-info}/METADATA

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

idf_build_apps-2.15.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+idf_build_apps/__init__.py,sha256=_7nx4tOzrYWsNpO7ljwZ0nd5GM1pWe8-UfCv7K4MzRQ,711
+idf_build_apps/__main__.py,sha256=xbvcgp3sNxXZZ0MMr9XU12TjdzHBWq6DF1FYUSmAjHE,182
+idf_build_apps/app.py,sha256=XfZuDRvEbtsBGqagc4az-LYnbK3y7lxQIvpUk9r4A5Q,40469
+idf_build_apps/args.py,sha256=sdp7eI33BXKmqucs60sS0kK8l5p4fRpRS6H7Y0XyITY,40803
+idf_build_apps/autocompletions.py,sha256=UbswHAWRvqvq4TgDBFjqHGlDLS_NEBM8EE0LlLUYY0A,2143
+idf_build_apps/constants.py,sha256=CW7vKXV6brsNLWeGLNCoDj28r5GO9So3RFNqgk_X2CI,2166
+idf_build_apps/finder.py,sha256=eSIr-y5yPTInQk5IQHggRJyxOndciexaNzpU4VVhfQQ,5833
+idf_build_apps/log.py,sha256=2aJRqx3hPT9IhSv3RLkXR5j7PgB2RX47G766c4i_m5c,3899
+idf_build_apps/main.py,sha256=B5yb6cy5UgqHP8-f7VEc9CrbkQmWGEpf6ww70MC_1z8,18255
+idf_build_apps/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+idf_build_apps/session_args.py,sha256=BMWfW48hHHt5UsAbzTJ9BMnerVP5lnulb0h3Db-BNC8,2973
+idf_build_apps/utils.py,sha256=YAVIYTvz86G--qjh58H376taQ-qe1PbebXcWxYNdnFs,10976
+idf_build_apps/junit/__init__.py,sha256=ZFbtFP4nrRUsN_7rdCYWPZRSAYH_OXetZyd3JGv71bs,231
+idf_build_apps/junit/report.py,sha256=SUQ7VQwc4zUUwLt6srVncvue9iswIFm7AHOao7umyo4,6565
+idf_build_apps/junit/utils.py,sha256=bmrCn44DH3b_LrlKTN7t7l94ttEmitiwVGVBrCQC1yo,1303
+idf_build_apps/manifest/__init__.py,sha256=Fze5wbperMK1F35KXnkAEc93u-ldDl7eQQkv75DoJ18,479
+idf_build_apps/manifest/manifest.py,sha256=UG6t7l9BNmZ223pl674-gSpBgUos3wwHPWwO9Y7-R0A,18580
+idf_build_apps/manifest/soc_header.py,sha256=vBO8oDEIIcxWRCDOPNXtqHKU0yv8q4yMrTo22W55iNw,177
+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=lbBz5r6hp8dSsxIypGFcc5EbXgWw2codDmky8QCo-sg,167
+idf_build_apps/yaml/parser.py,sha256=fdqlRsepAhb-_iynn0_TPMCk9qutMSl0cDRMxYKoPr0,3287
+idf_build_apps-2.15.0.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.15.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.15.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+idf_build_apps-2.15.0.dist-info/METADATA,sha256=rF-7-4PDnWVxxke2CdNMxiq2NsDKv6nAkVsd_TMHf6Q,4795
+idf_build_apps-2.15.0.dist-info/RECORD,,

idf_build_apps-2.13.3.dist-info/RECORD

@@ -1,27 +0,0 @@
-idf_build_apps/__init__.py,sha256=ZxK4NQEmF-i7Ky7S7vMUuYokfUSr-JyUo70xIHbBueI,711
-idf_build_apps/__main__.py,sha256=pT6OsFQRjCw39Jg43HAeGKzq8h5E_0m7kHDE2QMqDe0,182
-idf_build_apps/app.py,sha256=iMu2m20O7vMpHWWQv107pjtqIJXMT-0Je3uWeWznfog,40179
-idf_build_apps/args.py,sha256=e9d4kxv2q7SEOF42rWn-GS9EfIYYLaMxNUagJ8SPGzk,40140
-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=CKppfxa-nPedHKXfyQ841q1DZc0BimVulXK52EfCD0o,5833
-idf_build_apps/log.py,sha256=15sSQhv9dJsHShDR2KgFGFp8ByjV0HogLr1X1lHYqGs,3899
-idf_build_apps/main.py,sha256=P_TsUA2s048qcRb-wVngF-zqNjH_NEYrQsAYKB1GHmU,17960
-idf_build_apps/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-idf_build_apps/session_args.py,sha256=1B7e3M9_eKdQezGNXaocqCq7iE4MOxpYJkfanCfdkDE,2973
-idf_build_apps/utils.py,sha256=YJZOXIpo3aoRkGZJoQUJHAPWi2VkTDAVzQG5DI2igxw,10976
-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=CP4_LSkh7sb_DsWLSzqkSZ3UojyVdM10bX9avlmn2pg,479
-idf_build_apps/manifest/manifest.py,sha256=i8bXxyHeIFxYN5Z1l0dNNBFdgP7SKl3t0TCVqhlF0Lo,18051
-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.13.3.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.13.3.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.13.3.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-idf_build_apps-2.13.3.dist-info/METADATA,sha256=qKTCSUSpN6ap36s9qCJGa8brz0_Nq05hkGKalJOPr6o,4795
-idf_build_apps-2.13.3.dist-info/RECORD,,