idf-build-apps 2.2.2__py3-none-any.whl → 2.3.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.2.2'
+__version__ = '2.3.1'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/app.py

@@ -124,6 +124,7 @@ class App(BaseModel):
     verbose: bool = False
     check_warnings: bool = False
     preserve: bool = True
+    copy_sdkconfig: bool = False
 
     # build_apps() related
     build_apps_args: t.Optional[BuildAppsArgs] = None
@@ -561,6 +562,17 @@ class App(BaseModel):
     def _post_build(self) -> None:
         self._build_stage = BuildStage.POST_BUILD
 
+        if self.copy_sdkconfig:
+            try:
+                shutil.copy(
+                    os.path.join(self.work_dir, 'sdkconfig'),
+                    os.path.join(self.build_path, 'sdkconfig'),
+                )
+            except Exception as e:
+                self._logger.warning('Copy sdkconfig file from failed: %s', e)
+            else:
+                self._logger.debug('Copied sdkconfig file from %s to %s', self.work_dir, self.build_path)
+
         if not os.path.isfile(self.build_log_path):
             return
 

idf_build_apps/main.py

@@ -6,7 +6,6 @@ import json
 import logging
 import os
 import re
-import shutil
 import sys
 import textwrap
 import typing as t
@@ -66,12 +65,26 @@ def _check_app_dependency(
     manifest_rootpath: t.Optional[str] = None,
     modified_components: t.Optional[t.List[str]] = None,
     modified_files: t.Optional[t.List[str]] = None,
+    ignore_app_dependencies_components: t.Optional[t.List[str]] = None,
     ignore_app_dependencies_filepatterns: t.Optional[t.List[str]] = None,
 ) -> bool:
     # not check since modified_components and modified_files are not passed
     if modified_components is None and modified_files is None:
         return False
 
+    # not check since ignore_app_dependencies_components is passed and matched
+    if (
+        ignore_app_dependencies_components
+        and modified_components is not None
+        and set(modified_components).intersection(ignore_app_dependencies_components)
+    ):
+        LOGGER.info(
+            'Build all apps since modified components %s matches ignored components %s',
+            ', '.join(modified_components),
+            ', '.join(ignore_app_dependencies_components),
+        )
+        return False
+
     # not check since ignore_app_dependencies_filepatterns is passed and matched
     if (
         ignore_app_dependencies_filepatterns
@@ -79,7 +92,7 @@ def _check_app_dependency(
         and files_matches_patterns(modified_files, ignore_app_dependencies_filepatterns, manifest_rootpath)
     ):
         LOGGER.info(
-            'Build all apps since patterns %s matches modified files %s',
+            'Build all apps since modified files %s matches ignored file patterns %s',
             ', '.join(modified_files),
             ', '.join(ignore_app_dependencies_filepatterns),
         )
@@ -108,6 +121,7 @@ def find_apps(
     default_build_targets: t.Optional[t.Union[t.List[str], str]] = None,
     modified_components: t.Optional[t.Union[t.List[str], str]] = None,
     modified_files: t.Optional[t.Union[t.List[str], str]] = None,
+    ignore_app_dependencies_components: t.Optional[t.Union[t.List[str], str]] = None,
     ignore_app_dependencies_filepatterns: t.Optional[t.Union[t.List[str], str]] = None,
     sdkconfig_defaults: t.Optional[str] = None,
     include_skipped_apps: bool = False,
@@ -137,8 +151,8 @@ def find_apps(
     :param default_build_targets: default build targets used in manifest files
     :param modified_components: modified components
     :param modified_files: modified files
-    :param ignore_app_dependencies_filepatterns: file patterns that used for ignoring checking the component
-        dependencies
+    :param ignore_app_dependencies_components: components used for ignoring checking the app dependencies
+    :param ignore_app_dependencies_filepatterns: file patterns used for ignoring checking the app dependencies
     :param sdkconfig_defaults: semicolon-separated string, pass to idf.py -DSDKCONFIG_DEFAULTS if specified,
         also could be set via environment variables "SDKCONFIG_DEFAULTS"
     :param include_skipped_apps: include skipped apps or not
@@ -168,6 +182,7 @@ def find_apps(
 
     modified_components = to_list(modified_components)
     modified_files = to_list(modified_files)
+    ignore_app_dependencies_components = to_list(ignore_app_dependencies_components)
     ignore_app_dependencies_filepatterns = to_list(ignore_app_dependencies_filepatterns)
     config_rules_str = to_list(config_rules_str)
 
@@ -199,6 +214,7 @@ def find_apps(
                         manifest_rootpath=manifest_rootpath,
                         modified_components=modified_components,
                         modified_files=modified_files,
+                        ignore_app_dependencies_components=ignore_app_dependencies_components,
                         ignore_app_dependencies_filepatterns=ignore_app_dependencies_filepatterns,
                     ),
                     modified_components=modified_components,
@@ -225,6 +241,7 @@ def build_apps(
     manifest_rootpath: t.Optional[str] = None,
     modified_components: t.Optional[t.Union[t.List[str], str]] = None,
     modified_files: t.Optional[t.Union[t.List[str], str]] = None,
+    ignore_app_dependencies_components: t.Optional[t.Union[t.List[str], str]] = None,
     ignore_app_dependencies_filepatterns: t.Optional[t.Union[t.List[str], str]] = None,
     check_app_dependencies: t.Optional[bool] = None,
     # BuildAppsArgs
@@ -249,8 +266,8 @@ def build_apps(
         are relative paths. Use the current directory if not specified
     :param modified_components: modified components
     :param modified_files: modified files
-    :param ignore_app_dependencies_filepatterns: file patterns that used for ignoring checking the component
-        dependencies
+    :param ignore_app_dependencies_components: components used for ignoring checking the app dependencies
+    :param ignore_app_dependencies_filepatterns: file patterns used for ignoring checking the app dependencies
     :param check_app_dependencies: check app dependencies or not. if not set, will be calculated by modified_components,
         modified_files, and ignore_app_dependencies_filepatterns
     :param parallel_count: number of parallel tasks to run
@@ -263,6 +280,7 @@ def build_apps(
     apps = to_list(apps)
     modified_components = to_list(modified_components)
     modified_files = to_list(modified_files)
+    ignore_app_dependencies_components = to_list(ignore_app_dependencies_components)
     ignore_app_dependencies_filepatterns = to_list(ignore_app_dependencies_filepatterns)
 
     test_suite = TestSuite('build_apps')
@@ -305,6 +323,7 @@ def build_apps(
         app.dry_run = dry_run
         app.index = index
         app.verbose = build_verbose
+        app.copy_sdkconfig = copy_sdkconfig
 
         LOGGER.info('(%s/%s) Building app: %s', index, len(apps), app)
 
@@ -313,7 +332,11 @@ def build_apps(
             modified_components=modified_components,
             modified_files=modified_files,
             check_app_dependencies=_check_app_dependency(
-                manifest_rootpath, modified_components, modified_files, ignore_app_dependencies_filepatterns
+                manifest_rootpath=manifest_rootpath,
+                modified_components=modified_components,
+                modified_files=modified_files,
+                ignore_app_dependencies_components=ignore_app_dependencies_components,
+                ignore_app_dependencies_filepatterns=ignore_app_dependencies_filepatterns,
             )
             if check_app_dependencies is None
             else check_app_dependencies,
@@ -330,17 +353,6 @@ def build_apps(
                 fw.write(app.to_json() + '\n')
             LOGGER.debug('Recorded app info in %s', build_apps_args.collect_app_info)
 
-        if copy_sdkconfig:
-            try:
-                shutil.copy(
-                    os.path.join(app.work_dir, 'sdkconfig'),
-                    os.path.join(app.build_path, 'sdkconfig'),
-                )
-            except Exception as e:
-                LOGGER.warning('Copy sdkconfig file from failed: %s', e)
-            else:
-                LOGGER.debug('Copied sdkconfig file from %s to %s', app.work_dir, app.build_path)
-
         if app.build_status == BuildStatus.FAILED:
             if not keep_going:
                 return 1
@@ -563,6 +575,18 @@ def get_parser() -> argparse.ArgumentParser:
         'If set to "", the value would be considered as None. '
         'If set to ";", the value would be considered as an empty list',
     )
+    common_args.add_argument(
+        '-ic',
+        '--ignore-app-dependencies-components',
+        type=semicolon_separated_str_to_list,
+        help='semicolon-separated string which specifies the modified components used for '
+        'ignoring checking the app dependencies. '
+        'The `depends_components` and `depends_filepatterns` set in the manifest files will be ignored when any of the '
+        'specified components matches any of the modified components. '
+        'Must be used 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',
+    )
     common_args.add_argument(
         '-if',
         '--ignore-app-dependencies-filepatterns',
@@ -683,11 +707,13 @@ def validate_args(parser: argparse.ArgumentParser, args: argparse.Namespace) ->
                 default_build_targets.append(target)
     args.default_build_targets = default_build_targets
 
+    if args.ignore_app_dependencies_components is not None:
+        if args.modified_components is None:
+            raise InvalidCommand('Must specify "--ignore-app-dependencies-components" with "--modified-components", ')
+
     if args.ignore_app_dependencies_filepatterns is not None:
         if args.modified_files is None:
-            raise InvalidCommand(
-                'Must specify "--ignore-component-dependencies-file-patterns" with "--modified-files", '
-            )
+            raise InvalidCommand('Must specify "--ignore-app-dependencies-filepatterns" with "--modified-files", ')
 
 
 def apply_config_args(args: argparse.Namespace) -> None:
@@ -731,6 +757,7 @@ def main():
         default_build_targets=args.default_build_targets,
         modified_components=args.modified_components,
         modified_files=args.modified_files,
+        ignore_app_dependencies_components=args.ignore_app_dependencies_components,
         ignore_app_dependencies_filepatterns=args.ignore_app_dependencies_filepatterns,
         sdkconfig_defaults=args.sdkconfig_defaults,
     )
@@ -766,6 +793,7 @@ def main():
         manifest_rootpath=args.manifest_rootpath,
         modified_components=args.modified_components,
         modified_files=args.modified_files,
+        ignore_app_dependencies_components=args.ignore_app_dependencies_components,
         ignore_app_dependencies_filepatterns=args.ignore_app_dependencies_filepatterns,
         junitxml=args.junitxml,
     )

{idf_build_apps-2.2.2.dist-info → idf_build_apps-2.3.1.dist-info}/METADATA

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

{idf_build_apps-2.2.2.dist-info → idf_build_apps-2.3.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
-idf_build_apps/__init__.py,sha256=g7KWhbzxhtPjvHFxxiheaZzo6QmwQtOwWW_-u_QtwgE,650
+idf_build_apps/__init__.py,sha256=z1ITg-Ywq6Ena0ioI98C9E6iK4aFe--1PiSFX-iUHl4,650
 idf_build_apps/__main__.py,sha256=8E-5xHm2MlRun0L88XJleNh5U50dpE0Q1nK5KqomA7I,182
-idf_build_apps/app.py,sha256=vThFVR70Oleddt_nTVmO-3VBJLMrm5NmoZbC48zolTo,35393
+idf_build_apps/app.py,sha256=z6i55q_XaMjea34_nbAKgNTU-qOEkO_qTHCYSeQNUFw,35887
 idf_build_apps/build_apps_args.py,sha256=r6VCJDdCzE873X8OTputYkCBZPgECaKoNlAejfcamJk,1644
 idf_build_apps/config.py,sha256=I75uOQGarCWVKGi16ZYpo0qTVU25BUP4eh6-RWCtbvw,2924
 idf_build_apps/constants.py,sha256=xqclwUpWE5dEByL4kxdg2HaHjbAfkJtxodFfLZuAk8A,2818
 idf_build_apps/finder.py,sha256=qw5moNq7U5mHSsR0CCfGkKE9p4QsWYNcfkxzeQ73HgM,6252
 idf_build_apps/log.py,sha256=JysogBHoompfW9E9w0U4wZH7tt8dBdfoh-stPXQz1hw,2573
-idf_build_apps/main.py,sha256=jeQeNUiQoC1g5pS5vPpzfOpHCX7amdOqWpfp4BZjmac,32591
+idf_build_apps/main.py,sha256=lP2rUqtBfU7gxN63owZlAshdXvSFUfElfTsKthhBQus,34651
 idf_build_apps/session_args.py,sha256=2WDTy40IFAc0KQ57HaeBcYj_k10eUXRKkDOWLrFCaHY,2985
 idf_build_apps/utils.py,sha256=n9PNJEDDsA9hbbM0SNPdTFsO2_E8alNrX7CNYzaFHik,9644
 idf_build_apps/junit/__init__.py,sha256=IxvdaS6eSXp7kZxRuXqyZyGxuA_A1nOW1jF1HMi8Gns,231
@@ -18,8 +18,8 @@ idf_build_apps/manifest/manifest.py,sha256=P5ZaUd72A_HOVF6iuwap__Bw-w7WI72ugiTUR
 idf_build_apps/manifest/soc_header.py,sha256=ULLad1TI8mGfdJhB7LJ4T9A_8BugF1TmckgdO7jO7Fg,3956
 idf_build_apps/yaml/__init__.py,sha256=W-3z5no07RQ6eYKGyOAPA8Z2CLiMPob8DD91I4URjrA,162
 idf_build_apps/yaml/parser.py,sha256=Y2OyB4g1DCC7C7jrvpIyZV9lgeCB_XvuB75iGmqiTaM,2093
-idf_build_apps-2.2.2.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.2.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.2.2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-idf_build_apps-2.2.2.dist-info/METADATA,sha256=P8i_S7bXUBZquAMN0N90TN8wBQEC4mZ4IpDywZwTQ1I,4458
-idf_build_apps-2.2.2.dist-info/RECORD,,
+idf_build_apps-2.3.1.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.3.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.3.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+idf_build_apps-2.3.1.dist-info/METADATA,sha256=ET5FxoKnaafQWJGkpERufP1p7J_JLzz3gO3ZYLsRPVg,4458
+idf_build_apps-2.3.1.dist-info/RECORD,,