idf-build-apps 2.7.0__tar.gz → 2.8.0__tar.gz

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.8.0 (2025-02-20)
+
+### Feat
+
+- support '--disable-targets'
+
 ## v2.7.0 (2025-02-18)
 
 ### Feat

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: idf-build-apps
-Version: 2.7.0
+Version: 2.8.0
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+License-File: LICENSE
 Requires-Dist: pyparsing
 Requires-Dist: pyyaml
 Requires-Dist: packaging

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/idf_build_apps/__init__.py

@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.7.0'
+__version__ = '2.8.0'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/idf_build_apps/args.py

@@ -27,7 +27,7 @@ from pydantic_settings import (
 from typing_extensions import Concatenate, ParamSpec
 
 from . import SESSION_ARGS, App, setup_logging
-from .constants import ALL_TARGETS, IDF_BUILD_APPS_TOML_FN
+from .constants import ALL_TARGETS, IDF_BUILD_APPS_TOML_FN, SUPPORTED_TARGETS
 from .manifest.manifest import FolderRule, Manifest
 from .utils import InvalidCommand, files_matches_patterns, semicolon_separated_str_to_list, to_absolute_path, to_list
 from .vendors.pydantic_sources import PyprojectTomlConfigSettingsSource, TomlConfigSettingsSource
@@ -500,6 +500,14 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
         'including the preview targets. As the targets defined in `idf.py --list-targets --preview`',
         default=False,  # type: ignore
     )
+    disable_targets: t.Optional[t.List[str]] = field(
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            nargs='+',
+        ),
+        description='space-separated list of targets that should be disabled to all apps.',
+        default=None,  # type: ignore
+    )
     include_skipped_apps: bool = field(
         FieldMetadata(
             action='store_true',
@@ -549,6 +557,14 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
             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
+
+        if self.disable_targets and FolderRule.DEFAULT_BUILD_TARGETS:
+            LOGGER.info('Disable targets: %s', self.disable_targets)
+            self.default_build_targets = [t for t in FolderRule.DEFAULT_BUILD_TARGETS if t not in self.disable_targets]
+            FolderRule.DEFAULT_BUILD_TARGETS = self.default_build_targets
 
         if self.override_sdkconfig_items or self.override_sdkconfig_items:
             SESSION_ARGS.set(self)

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/pyproject.toml

@@ -64,7 +64,7 @@ idf-build-apps = "idf_build_apps:main.main"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.7.0"
+version = "2.8.0"
 tag_format = "v$version"
 version_files = [
     "idf_build_apps/__init__.py",

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/setup.py

@@ -38,7 +38,7 @@ entry_points = \
 {'console_scripts': ['idf-build-apps = idf_build_apps:main.main']}
 
 setup(name='idf-build-apps',
-      version='2.7.0',
+      version='2.8.0',
       description='Tools for building ESP-IDF related apps.',
       author=None,
       author_email='Fu Hanxi <fuhanxi@espressif.com>',

{idf_build_apps-2.7.0 → idf_build_apps-2.8.0}/tests/test_args.py

@@ -16,7 +16,7 @@ from idf_build_apps.args import (
     FindArguments,
     FindBuildArguments,
 )
-from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN
+from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN, PREVIEW_TARGETS, SUPPORTED_TARGETS
 from idf_build_apps.main import main
 
 
@@ -161,6 +161,54 @@ modified_files = [
     assert args.deactivate_dependency_driven_build_by_components == ['baz']
 
 
+def test_build_targets_cli(tmp_path, monkeypatch):
+    create_project('foo', tmp_path)
+    with open(IDF_BUILD_APPS_TOML_FN, 'w') as fw:
+        fw.write("""paths = ["foo"]
+build_dir = "build_@t"
+junitxml = "test.xml"
+dry_run = true
+""")
+
+    def get_enabled_targets(args):
+        with monkeypatch.context() as m:
+            m.setattr('sys.argv', args)
+            main()
+        with open('test.xml') as f:
+            xml = ElementTree.fromstring(f.read())
+        test_suite = xml.findall('testsuite')[0]
+        testcases = test_suite.findall('testcase')
+        # get targets
+        return [c.attrib['name'].replace('foo/build_', '') for c in testcases]
+
+    # default build SUPPORTED_TARGETS
+    targets = get_enabled_targets(['idf-build-apps', 'build'])
+    assert len(targets) == len(SUPPORTED_TARGETS)
+    assert set(targets) == set(SUPPORTED_TARGETS)
+    # build with --target
+    targets = get_enabled_targets(['idf-build-apps', 'build', '--target', 'esp32'])
+    assert len(targets) == 1
+    assert targets[0] == 'esp32'
+    # build with --default-build-targets
+    targets = get_enabled_targets(['idf-build-apps', 'build', '--default-build-targets', 'esp32', 'esp32s2'])
+    assert len(targets) == 2
+    assert set(targets) == {'esp32', 'esp32s2'}
+    # build with --enable-preview-targets
+    targets = get_enabled_targets(['idf-build-apps', 'build', '--enable-preview-targets'])
+    assert len(targets) == len(SUPPORTED_TARGETS) + len(PREVIEW_TARGETS)
+    assert set(targets) == set(SUPPORTED_TARGETS) | set(PREVIEW_TARGETS)
+    # build with --disable-targets
+    assert 'esp32' in SUPPORTED_TARGETS and 'esp32s2' in SUPPORTED_TARGETS
+    targets = get_enabled_targets(['idf-build-apps', 'build', '--disable-targets', 'esp32', 'esp32s2'])
+    assert set(targets) == set(SUPPORTED_TARGETS) - {'esp32', 'esp32s2'}
+    # build with --enable-preview-targets and --disable-targets
+    targets = get_enabled_targets(
+        ['idf-build-apps', 'build', '--enable-preview-targets', '--disable-targets', PREVIEW_TARGETS[0]]
+    )
+    assert len(targets) == len(SUPPORTED_TARGETS) + len(PREVIEW_TARGETS) - 1
+    assert set(targets) == set(SUPPORTED_TARGETS) | set(PREVIEW_TARGETS) - {PREVIEW_TARGETS[0]}
+
+
 class TestIgnoreWarningFile:
     def test_deprecated_cli(self, monkeypatch, capsys):
         with open('foo.txt', 'w') as fw: