idf-build-apps 2.12.2__py3-none-any.whl → 2.13.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.12.2'
+__version__ = '2.13.0'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/app.py

@@ -109,6 +109,7 @@ class App(BaseModel):
     build_status: BuildStatus = BuildStatus.UNKNOWN
     build_comment: t.Optional[str] = None
     test_comment: t.Optional[str] = None
+    checked_should_build: bool = False
 
     _build_duration: float = 0
     _build_timestamp: t.Optional[datetime] = None
@@ -116,6 +117,7 @@ class App(BaseModel):
     __EQ_IGNORE_FIELDS__ = [
         'build_comment',
         'test_comment',
+        'checked_should_build',
     ]
     __EQ_TUNE_FIELDS__ = {
         'app_dir': lambda x: (os.path.realpath(os.path.expanduser(x))),
@@ -163,9 +165,6 @@ class App(BaseModel):
         self._kwargs = kwargs
         self._initialize_hook(**kwargs)
 
-        # private attrs, won't be dumped to json
-        self._checked_should_build = False
-
         self._sdkconfig_files, self._sdkconfig_files_defined_target = self._process_sdkconfig_files()
 
     @classmethod
@@ -750,12 +749,12 @@ class App(BaseModel):
                         self.build_comment += '\n'.join(f'- {clause}' for clause in rule.enable)
 
             self.build_status = BuildStatus.DISABLED
-            self._checked_should_build = True
+            self.checked_should_build = True
             return
 
         if not check_app_dependencies:
             self.build_status = BuildStatus.SHOULD_BE_BUILT
-            self._checked_should_build = True
+            self.checked_should_build = True
             return
 
         if (
@@ -765,26 +764,26 @@ class App(BaseModel):
         ):
             self.build_status = BuildStatus.SHOULD_BE_BUILT
             self.build_comment = 'current build modifies the related manifest rules'
-            self._checked_should_build = True
+            self.checked_should_build = True
             return
 
         if self.is_modified(modified_files):
             self.build_status = BuildStatus.SHOULD_BE_BUILT
             self.build_comment = 'current build modifies this app'
-            self._checked_should_build = True
+            self.checked_should_build = True
             return
 
         # if didn't modify any components, and no `depends_filepatterns` defined, skip
         if modified_components == [] and not self.depends_filepatterns:
             self.build_status = BuildStatus.SKIPPED
             self.build_comment = 'current build does not modify any components'
-            self._checked_should_build = True
+            self.checked_should_build = True
             return
 
         # if no special rules defined, we left it unknown and decide with idf.py reconfigure
         if not self.depends_components and not self.depends_filepatterns:
             # keep unknown
-            self._checked_should_build = True
+            self.checked_should_build = True
             self.build_comment = 'no special rules defined, run idf.py reconfigure to decide'
             return
 
@@ -795,7 +794,7 @@ class App(BaseModel):
         # depends components?
         if self.depends_components and modified_components is not None:
             if set(self.depends_components).intersection(set(modified_components)):
-                self._checked_should_build = True
+                self.checked_should_build = True
                 self.build_status = BuildStatus.SHOULD_BE_BUILT
                 self.build_comment = (
                     f'Requires components: {", ".join(self.depends_components)}. '
@@ -806,7 +805,7 @@ class App(BaseModel):
         # or depends file patterns?
         if self.depends_filepatterns and modified_files is not None:
             if files_matches_patterns(modified_files, self.depends_filepatterns, manifest_rootpath):
-                self._checked_should_build = True
+                self.checked_should_build = True
                 self.build_status = BuildStatus.SHOULD_BE_BUILT
                 self.build_comment = (
                     f'Requires file patterns: {", ".join(self.depends_filepatterns)}. '
@@ -817,7 +816,7 @@ class App(BaseModel):
         # special rules defined, but not matched
         self.build_status = BuildStatus.SKIPPED
         self.build_comment = 'current build does not modify any components or files required by this app'
-        self._checked_should_build = True
+        self.checked_should_build = True
 
     def check_should_test(self) -> None:
         """Check if testing is disabled for this app and set test_disable_reason."""
@@ -955,7 +954,7 @@ class CMakeApp(App):
             check_app_dependencies=check_app_dependencies,
         )
 
-        if not self._checked_should_build:
+        if not self.checked_should_build:
             self.check_should_build(
                 manifest_rootpath=manifest_rootpath,
                 modified_components=modified_components,

idf_build_apps/args.py

@@ -29,7 +29,7 @@ from pydantic_settings import (
 from typing_extensions import Concatenate, ParamSpec
 
 from . import SESSION_ARGS, App, CMakeApp, MakeApp, setup_logging
-from .constants import ALL_TARGETS, IDF_BUILD_APPS_TOML_FN
+from .constants import ALL_TARGETS, IDF_BUILD_APPS_TOML_FN, PREVIEW_TARGETS, SUPPORTED_TARGETS
 from .manifest.manifest import DEFAULT_BUILD_TARGETS, Manifest, reset_default_build_targets
 from .utils import InvalidCommand, files_matches_patterns, semicolon_separated_str_to_list, to_absolute_path, to_list
 from .vendors.pydantic_sources import PyprojectTomlConfigSettingsSource, TomlConfigSettingsSource
@@ -563,17 +563,22 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
             nargs='+',
         ),
         description='space-separated list of the default enabled build targets for the apps. '
-        'When not specified, the default value is the targets listed by `idf.py --list-targets`. '
-        'Cannot be used together with --enable-preview-targets',
+        'When not specified, the default value is the targets listed by `idf.py --list-targets`.',
+        default=None,  # type: ignore
+    )
+    additional_build_targets: t.Optional[t.List[str]] = field(
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            nargs='+',
+        ),
+        description='space-separated list of additional build targets to add to the default enabled build targets',
         default=None,  # type: ignore
     )
     enable_preview_targets: bool = field(
         FieldMetadata(
             action='store_true',
         ),
-        description='When enabled, all targets will be enabled by default, '
-        'including the preview targets. As the targets defined in `idf.py --list-targets --preview`. '
-        'Cannot be used together with --default-build-targets',
+        description='When enabled, PREVIEW_TARGETS will be added to the default enabled build targets',
         default=False,  # type: ignore
     )
     disable_targets: t.Optional[t.List[str]] = field(
@@ -616,39 +621,44 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
             LOGGER.debug('--target is missing. Set --target as "all".')
             self.target = 'all'
 
-        # Validate mutual exclusivity of enable_preview_targets and default_build_targets
-        if self.enable_preview_targets and self.default_build_targets:
-            raise InvalidCommand(
-                'Cannot specify both --enable-preview-targets and --default-build-targets at the same time. '
-                'Please use only one of these options.'
-            )
-
         reset_default_build_targets()  # reset first then judge again
+
+        # Build the target set by combining the options
+        default_build_targets: t.List[str] = []
+        # Step 1: Determine base targets
         if self.default_build_targets:
-            default_build_targets = []
-            for target in self.default_build_targets:
-                if target not in ALL_TARGETS:
-                    LOGGER.warning(
-                        f'Ignoring... Unrecognizable target {target} specified with "--default-build-targets". '
-                        f'Current ESP-IDF available targets: {ALL_TARGETS}'
-                    )
-                elif target not in default_build_targets:
-                    default_build_targets.append(target)
-            self.default_build_targets = default_build_targets
-            LOGGER.info('Overriding default build targets to %s', self.default_build_targets)
-            DEFAULT_BUILD_TARGETS.set(self.default_build_targets)
-        elif self.enable_preview_targets:
-            self.default_build_targets = deepcopy(ALL_TARGETS)
-            LOGGER.info('Overriding default build targets to %s', self.default_build_targets)
-            DEFAULT_BUILD_TARGETS.set(self.default_build_targets)
-
-        if self.disable_targets and DEFAULT_BUILD_TARGETS.get():
-            LOGGER.info('Disable targets: %s', self.disable_targets)
-            self.default_build_targets = [
-                _target for _target in DEFAULT_BUILD_TARGETS.get() if _target not in self.disable_targets
-            ]
-            DEFAULT_BUILD_TARGETS.set(self.default_build_targets)
+            LOGGER.info('--default-build-targets is set, using `%s`', self.default_build_targets)
+            default_build_targets = deepcopy(self.default_build_targets)
+        elif SUPPORTED_TARGETS:
+            LOGGER.info('Using default SUPPORTED_TARGETS: %s', SUPPORTED_TARGETS)
+            default_build_targets = deepcopy(SUPPORTED_TARGETS)
+
+        if self.enable_preview_targets:
+            LOGGER.info('--enable-preview-targets is set, adding preview targets `%s`', PREVIEW_TARGETS)
+            default_build_targets.extend(PREVIEW_TARGETS)
+
+        if self.additional_build_targets:
+            LOGGER.info('--additional-build-targets is set, adding `%s`', self.additional_build_targets)
+            default_build_targets.extend(self.additional_build_targets)
+
+        res = []
+        for _t in set(default_build_targets):
+            if _t not in ALL_TARGETS:
+                LOGGER.warning(
+                    f'Ignoring... Unrecognizable target {_t} specified. '
+                    f'Current ESP-IDF available targets: {ALL_TARGETS}'
+                )
+                continue
+
+            if self.disable_targets and _t in self.disable_targets:
+                LOGGER.info(f'Ignoring... Target {_t} is in the disabled targets list.')
+                continue
+
+            res.append(_t)
+        self.default_build_targets = sorted(res)
+        DEFAULT_BUILD_TARGETS.set(self.default_build_targets)
 
+        # Override sdkconfig files/items
         if self.override_sdkconfig_files or self.override_sdkconfig_items:
             SESSION_ARGS.set(self)
 

idf_build_apps/finder.py

@@ -16,6 +16,7 @@ from .app import (
 )
 from .args import FindArguments
 from .constants import (
+    ALL_TARGETS,
     BuildStatus,
 )
 from .utils import (
@@ -26,6 +27,14 @@ from .utils import (
 LOGGER = logging.getLogger(__name__)
 
 
+def _is_target_specific(filepath: str) -> bool:
+    for target in ALL_TARGETS:
+        if filepath.endswith(f'.{target}'):
+            return True
+
+    return False
+
+
 def _get_apps_from_path(
     path: str,
     target: str,
@@ -55,8 +64,8 @@ def _get_apps_from_path(
             sdkconfig_paths_matched = True  # skip the next block for no wildcard config rules
 
         for sdkconfig_path in sdkconfig_paths:
-            if sdkconfig_path.endswith(f'.{target}'):
-                LOGGER.debug('=> Skipping sdkconfig %s which is target-specific', sdkconfig_path)
+            if _is_target_specific(sdkconfig_path):
+                LOGGER.debug('=> Skipping sdkconfig file `%s` which is target-specific', sdkconfig_path)
                 continue
 
             # Figure out the config name

idf_build_apps/utils.py

@@ -386,6 +386,9 @@ class BaseModel(_BaseModel):
         hash_list = []
 
         self_model_dump = self.model_dump()
+        for _field in self.__EQ_IGNORE_FIELDS__:
+            self_model_dump.pop(_field, None)
+
         for _field in self.__EQ_TUNE_FIELDS__:
             self_model_dump[_field] = self.__EQ_TUNE_FIELDS__[_field](self_model_dump[_field])
 

{idf_build_apps-2.12.2.dist-info → idf_build_apps-2.13.0.dist-info}/METADATA

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

{idf_build_apps-2.12.2.dist-info → idf_build_apps-2.13.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
-idf_build_apps/__init__.py,sha256=h7XcljanhI0hCRrQs8Xc9lKiiXKDh2hwt8vTD6Lwbv4,711
+idf_build_apps/__init__.py,sha256=NMlLrPIwkNau5FvVguRJyW_C8qIaidZce8hpmlQXkhE,711
 idf_build_apps/__main__.py,sha256=pT6OsFQRjCw39Jg43HAeGKzq8h5E_0m7kHDE2QMqDe0,182
-idf_build_apps/app.py,sha256=QXNfn5HVgkjLR6Xswa-wdy3BEWgJJ1k0Zn2-Q9NC92I,39181
-idf_build_apps/args.py,sha256=m1tJl75P3yuDIaxQpg4bL8UIe2j_R1tNvQW_vpyR1AU,40099
+idf_build_apps/app.py,sha256=9TeFeQnvqETtmLV9v3mQzXmkJA1F3e8l_16MkCRhBT4,39149
+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=gpOcpGrzAGiBVRCgKQ_YW22_OUJv-D-hMApuE-tPhVQ,5644
+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=cQJ5N-53vrASa4d8WW0AQCPJzendArXyU3kB5Vx-AH8,10880
+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
@@ -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.12.2.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.12.2.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.12.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-idf_build_apps-2.12.2.dist-info/METADATA,sha256=vdzZqBwn3IGTFgVaKPD39ofId6UfAbvdNAZVDgyx4FQ,4795
-idf_build_apps-2.12.2.dist-info/RECORD,,
+idf_build_apps-2.13.0.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.13.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.13.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+idf_build_apps-2.13.0.dist-info/METADATA,sha256=yMOaaLlxZVkHHPhQjVHnaQRCtE4z0uTb_3DzIpTovFc,4795
+idf_build_apps-2.13.0.dist-info/RECORD,,