idf-build-apps 2.10.2__py3-none-any.whl → 2.11.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.10.2'
+__version__ = '2.11.0'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/app.py

@@ -39,7 +39,7 @@ from .constants import (
     BuildStatus,
 )
 from .manifest.manifest import (
-    FolderRule,
+    DEFAULT_BUILD_TARGETS,
     Manifest,
 )
 from .utils import (
@@ -436,7 +436,7 @@ class App(BaseModel):
         if self.sdkconfig_files_defined_idf_target:
             return [self.sdkconfig_files_defined_idf_target]
 
-        return FolderRule.DEFAULT_BUILD_TARGETS
+        return DEFAULT_BUILD_TARGETS.get()
 
     @property
     def verified_targets(self) -> t.List[str]:
@@ -820,7 +820,7 @@ class MakeApp(App):
         if self.sdkconfig_files_defined_idf_target:
             return [self.sdkconfig_files_defined_idf_target]
 
-        return ['esp8266', *FolderRule.DEFAULT_BUILD_TARGETS]
+        return ['esp8266', *DEFAULT_BUILD_TARGETS.get()]
 
     def _build(
         self,

idf_build_apps/args.py

@@ -29,8 +29,8 @@ 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, SUPPORTED_TARGETS
-from .manifest.manifest import FolderRule, Manifest
+from .constants import ALL_TARGETS, IDF_BUILD_APPS_TOML_FN
+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
 
@@ -39,7 +39,6 @@ LOGGER = logging.getLogger(__name__)
 
 class ValidateMethod(str, enum.Enum):
     TO_LIST = 'to_list'
-    EXPAND_VARS = 'expand_vars'
 
 
 @dataclass
@@ -174,12 +173,17 @@ class BaseArguments(BaseSettings):
         if info.field_name and info.field_name in cls.model_fields:
             f = cls.model_fields[info.field_name]
             meta = get_meta(f)
+
+            # always expand vars for all fields
+            if isinstance(v, str):
+                v = expand_vars(v)
+            elif isinstance(v, list):
+                v = [expand_vars(item) if isinstance(item, str) else item for item in v]
+
             if meta and meta.validate_method:
                 for method in meta.validate_method:
                     if method == ValidateMethod.TO_LIST:
                         v = to_list(v)
-                    elif method == ValidateMethod.EXPAND_VARS:
-                        v = expand_vars(v)
                     else:
                         raise NotImplementedError(f'Unknown validate method: {method}')
 
@@ -241,9 +245,7 @@ class DependencyDrivenBuildArguments(GlobalArguments):
         default=None,  # type: ignore
     )
     manifest_rootpath: str = field(
-        FieldMetadata(
-            validate_method=[ValidateMethod.EXPAND_VARS],
-        ),
+        None,
         description='Root path to resolve the relative paths defined in the manifest files. '
         'By default set to the current directory. Support environment variables.',
         default=os.curdir,  # type: ignore
@@ -420,6 +422,15 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
         description='Filter the apps by target. By default set to "all"',
         default='all',  # type: ignore
     )
+    extra_pythonpaths: t.Optional[t.List[str]] = field(
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            nargs='+',
+        ),
+        description='space-separated list of additional Python paths to search for the app classes. '
+        'Will be injected into the head of sys.path.',
+        default=None,  # type: ignore
+    )
     build_system: t.Union[str, t.Type[App]] = field(
         None,
         description='Filter the apps by build system. By default set to "cmake". '
@@ -519,15 +530,17 @@ 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`',
+        'When not specified, the default value is the targets listed by `idf.py --list-targets`. '
+        'Cannot be used together with --enable-preview-targets',
         default=None,  # type: ignore
     )
     enable_preview_targets: bool = field(
         FieldMetadata(
             action='store_true',
         ),
-        description='When enabled, the default build targets will be set to all apps, '
-        'including the preview targets. As the targets defined in `idf.py --list-targets --preview`',
+        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',
         default=False,  # type: ignore
     )
     disable_targets: t.Optional[t.List[str]] = field(
@@ -570,6 +583,14 @@ 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
         if self.default_build_targets:
             default_build_targets = []
             for target in self.default_build_targets:
@@ -582,25 +603,30 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
                     default_build_targets.append(target)
             self.default_build_targets = default_build_targets
             LOGGER.info('Overriding default build targets to %s', self.default_build_targets)
-            FolderRule.DEFAULT_BUILD_TARGETS = 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)
-            FolderRule.DEFAULT_BUILD_TARGETS = self.default_build_targets
-        else:
-            # restore default build targets
-            FolderRule.DEFAULT_BUILD_TARGETS = SUPPORTED_TARGETS
+            DEFAULT_BUILD_TARGETS.set(self.default_build_targets)  # type: ignore
 
-        if self.disable_targets and FolderRule.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 FolderRule.DEFAULT_BUILD_TARGETS if _target not in self.disable_targets
+                _target for _target in DEFAULT_BUILD_TARGETS.get() if _target not in self.disable_targets
             ]
-            FolderRule.DEFAULT_BUILD_TARGETS = self.default_build_targets
+            DEFAULT_BUILD_TARGETS.set(self.default_build_targets)
 
         if self.override_sdkconfig_files or self.override_sdkconfig_items:
             SESSION_ARGS.set(self)
 
+        # update PYTHONPATH
+        if self.extra_pythonpaths:
+            LOGGER.debug('Adding extra Python paths: %s', self.extra_pythonpaths)
+            for path in self.extra_pythonpaths:
+                abs_path = to_absolute_path(path)
+                if abs_path not in sys.path:
+                    sys.path.insert(0, abs_path)
+
         # load build system
         # here could be a string or a class of type App
         if not isinstance(self.build_system, str):
@@ -763,7 +789,6 @@ 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. Support environment variables.',
@@ -775,7 +800,6 @@ 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. Support environment variables.',
@@ -787,7 +811,6 @@ 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. '
         'Support environment variables.',

idf_build_apps/finder.py

@@ -18,6 +18,7 @@ from .args import FindArguments
 from .constants import (
     BuildStatus,
 )
+from .manifest.manifest import DEFAULT_BUILD_TARGETS
 from .utils import (
     config_rules_from_str,
     to_absolute_path,
@@ -33,13 +34,23 @@ def _get_apps_from_path(
     app_cls: t.Type[App] = CMakeApp,
     args: FindArguments,
 ) -> t.List[App]:
-    # trigger test
     def _validate_app(_app: App) -> bool:
         if target not in _app.supported_targets:
             LOGGER.debug('=> Ignored. %s only supports targets: %s', _app, ', '.join(_app.supported_targets))
             _app.build_status = BuildStatus.DISABLED
             return args.include_disabled_apps
 
+        if target == 'all' and _app.target not in DEFAULT_BUILD_TARGETS.get():
+            LOGGER.debug(
+                '=> Ignored. %s is not in the default build targets: %s', _app.target, DEFAULT_BUILD_TARGETS.get()
+            )
+            _app.build_status = BuildStatus.DISABLED
+            return args.include_disabled_apps
+        elif _app.target != target:
+            LOGGER.debug('=> Ignored. %s is not for target %s', _app, target)
+            _app.build_status = BuildStatus.DISABLED
+            return args.include_disabled_apps
+
         _app.check_should_build(
             manifest_rootpath=args.manifest_rootpath,
             modified_manifest_rules_folders=args.modified_manifest_rules_folders,

idf_build_apps/main.py

@@ -31,7 +31,7 @@ from .app import (
     AppDeserializer,
 )
 from .autocompletions import activate_completions
-from .constants import ALL_TARGETS, BuildStatus, completion_instructions
+from .constants import BuildStatus, completion_instructions
 from .finder import (
     _find_apps,
 )
@@ -41,6 +41,7 @@ from .junit import (
     TestSuite,
 )
 from .manifest.manifest import (
+    DEFAULT_BUILD_TARGETS,
     Manifest,
 )
 from .utils import (
@@ -88,8 +89,8 @@ def find_apps(
 
     apps: t.Set[App] = set()
     if find_arguments.target == 'all':
-        targets = ALL_TARGETS
-        LOGGER.info('Searching for apps by all targets')
+        targets = DEFAULT_BUILD_TARGETS.get()
+        LOGGER.info('Searching for apps by default build targets: %s', targets)
     else:
         targets = [find_arguments.target]
         LOGGER.info('Searching for apps by target: %s', find_arguments.target)

idf_build_apps/manifest/__init__.py

@@ -7,11 +7,11 @@ Manifest file
 
 from esp_bool_parser import register_addition_attribute
 
-from .manifest import FolderRule
+from .manifest import DEFAULT_BUILD_TARGETS
 
 
 def folder_rule_attr(target, **kwargs):
-    return 1 if target in FolderRule.DEFAULT_BUILD_TARGETS else 0
+    return 1 if target in DEFAULT_BUILD_TARGETS.get() else 0
 
 
 register_addition_attribute('INCLUDE_DEFAULT', folder_rule_attr)

idf_build_apps/manifest/manifest.py

@@ -1,8 +1,10 @@
 # SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
+import contextvars
 import logging
 import os
 import typing as t
+import warnings
 from hashlib import sha512
 
 from esp_bool_parser import BoolStmt, parse_bool_expr
@@ -26,6 +28,16 @@ from ..yaml import (
 
 LOGGER = logging.getLogger(__name__)
 
+# Context variable for default build targets
+DEFAULT_BUILD_TARGETS: contextvars.ContextVar[t.List[str]] = contextvars.ContextVar(
+    'default_build_targets', default=SUPPORTED_TARGETS
+)
+
+
+def reset_default_build_targets() -> None:
+    """Reset DEFAULT_BUILD_TARGETS to the default value (SUPPORTED_TARGETS)"""
+    DEFAULT_BUILD_TARGETS.set(SUPPORTED_TARGETS)
+
 
 class IfClause:
     def __init__(self, stmt: str, temporary: bool = False, reason: t.Optional[str] = None) -> None:
@@ -78,8 +90,65 @@ class SwitchClause:
         )
 
 
-class FolderRule:
-    DEFAULT_BUILD_TARGETS = SUPPORTED_TARGETS
+def _getattr_default_build_targets(name: str) -> t.Any:
+    if name == 'DEFAULT_BUILD_TARGETS':
+        warnings.warn(
+            'FolderRule.DEFAULT_BUILD_TARGETS is deprecated. Use DEFAULT_BUILD_TARGETS.get() directly.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return DEFAULT_BUILD_TARGETS.get()
+    return None
+
+
+def _setattr_default_build_targets(name: str, value: t.Any) -> bool:
+    if name == 'DEFAULT_BUILD_TARGETS':
+        warnings.warn(
+            'FolderRule.DEFAULT_BUILD_TARGETS is deprecated. Use DEFAULT_BUILD_TARGETS.set() directly.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        if not isinstance(value, list):
+            raise TypeError('Default build targets must be a list')
+        DEFAULT_BUILD_TARGETS.set(value)
+        return True
+    return False
+
+
+class _FolderRuleMeta(type):
+    """Metaclass to handle class-level assignments to DEFAULT_BUILD_TARGETS"""
+
+    def __getattribute__(cls, name):
+        result = _getattr_default_build_targets(name)
+        if result is not None:
+            return result
+        return super().__getattribute__(name)
+
+    def __setattr__(cls, name, value):
+        if _setattr_default_build_targets(name, value):
+            return
+        super().__setattr__(name, value)
+
+    def __delattr__(cls, name):
+        if name == 'DEFAULT_BUILD_TARGETS':
+            # Don't actually delete anything, just ignore the deletion
+            # This handles monkeypatch teardown issues
+            pass
+        else:
+            super().__delattr__(name)
+
+
+class FolderRule(metaclass=_FolderRuleMeta):
+    def __getattribute__(self, name):  # instance attr
+        result = _getattr_default_build_targets(name)
+        if result is not None:
+            return result
+        return super().__getattribute__(name)
+
+    def __setattr__(self, name, value):
+        if _setattr_default_build_targets(name, value):
+            return
+        super().__setattr__(name, value)
 
     def __init__(
         self,

{idf_build_apps-2.10.2.dist-info → idf_build_apps-2.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: idf-build-apps
-Version: 2.10.2
+Version: 2.11.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.2.dist-info → idf_build_apps-2.11.0.dist-info}/RECORD

@@ -1,27 +1,27 @@
-idf_build_apps/__init__.py,sha256=zkzOAoCvbSslS9KdGqm47Zsd9VZD_XBc_R7g7ODZBTI,711
+idf_build_apps/__init__.py,sha256=dbJfW0hQTTG-x5k9tWW9qp2EUUYU0CFxCuabbnGJWt4,711
 idf_build_apps/__main__.py,sha256=pT6OsFQRjCw39Jg43HAeGKzq8h5E_0m7kHDE2QMqDe0,182
-idf_build_apps/app.py,sha256=wwwpEciOFwjTmkb-IoucM1CeIqAYVSPxNAEsxti-Frg,36914
-idf_build_apps/args.py,sha256=BBTDk87nBaHodn_VLp65jvhtwjLsskX7qZLTDLRH6kY,37968
+idf_build_apps/app.py,sha256=Z4TZegsyushNPvWcdSv4jJG1TIkuBMGdQ5FkpOSDFlE,36915
+idf_build_apps/args.py,sha256=Ria0VDBtnUyN3fgHbG9S9P7gyWYoJ3YxrN_C0z6XEeQ,38977
 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/finder.py,sha256=yJnsYdcbX-TzUDrp8h1YJrLfBziQW4RiyLiJ47sHRY4,6375
 idf_build_apps/log.py,sha256=15sSQhv9dJsHShDR2KgFGFp8ByjV0HogLr1X1lHYqGs,3899
-idf_build_apps/main.py,sha256=BOCAlcN019NkV7s4wBWlNht911Gh9BVT-x9JIj3IlOE,17927
+idf_build_apps/main.py,sha256=GQWx7KH6Qn6z43iZMpdh0myyCJRywf0wmLWFEqRDlL0,17980
 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=k33elhIdlYj7sEwLzlxA499_l_Ah6zBolMMk-nioVsg,15368
+idf_build_apps/manifest/__init__.py,sha256=TxNrtn6uiSI4Uh8mQWxws5F7Gd6Lr3rMuBzGyl3yFCE,405
+idf_build_apps/manifest/manifest.py,sha256=ROMK3m3bNfb1Up5pD9cTZOVvAbqVAYAdlGlXHLiQvhg,17693
 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.2.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.10.2.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.10.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-idf_build_apps-2.10.2.dist-info/METADATA,sha256=jaqohtgOUpOEjjxZX4MAOyuIRA-t8QEbxH0yR__bW_k,4795
-idf_build_apps-2.10.2.dist-info/RECORD,,
+idf_build_apps-2.11.0.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.11.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.11.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+idf_build_apps-2.11.0.dist-info/METADATA,sha256=v9SrMcpVGeGM3HhR8rxJrdO2WfRAwedxth8Pf4OBexY,4795
+idf_build_apps-2.11.0.dist-info/RECORD,,