idf_build_apps 1.0.0__tar.gz → 1.0.0.dev0__tar.gz

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/.github/workflows/test-build-idf-apps.yml

@@ -66,10 +66,9 @@ jobs:
           python -m idf_build_apps build -vv -t esp32 \
             -p $IDF_PATH/examples/get-started/hello_world \
             --size-file size_info.json \
-            --ignore-warning-str \
-              "Python 3 versions older than 3.6 are not supported" \
-              "Python 2 is no longer supported" \
-              "Support for Python 2 is deprecated"
+            --ignore-warning-str "Python 3 versions older than 3.6 are not supported" \
+            --ignore-warning-str "Python 2 is no longer supported" \
+            --ignore-warning-str "Support for Python 2 is deprecated"
 
   build-apps-on-idf-env:
     if: ${{ github.ref == 'refs/heads/main' }}

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/CHANGELOG.md

@@ -2,35 +2,32 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.0.0] (2023-05-25)
+## [Unreleased - 1.0.0]
 
 ## Added
 
-- Support keyword `depends_filepatterns` in the manifest file
-- Support expanding environment variables in the manifest files
+- Support keyword `depends_filepatterns` in the manfiest file
 
 ## BREAKING CHANGES
 
-- Attributes Renamed
-  - `App.requires_components` renamed to `App.depends_components`
-  - `FolderRule.requires_components` renamed to `FolderRule.depends_components`
-- Functions Renamed
-  - `Manifest.requires_components()` renamed to `Manifest.depends_components()`
-- Signatures Changed
-  - `App.build()`
-  - `App.is_modified()`
+- Renames
+  - Members
+    - `App.requires_components` renamed to `App.depends_components`
+    - `FolderRule.requires_components` renamed to `FolderRule.depends_components`
+    - `Manifest.requires_components()` renamed to `Manifest.depends_components()`
+  - Parameters
+    - `App.build()` parameter `depends_on_components` renamed to `modified_components`
+    - `App.is_modified()` parameter `depends_on_components` renamed to `modified_components`
+    - `find_apps()`  parameter `depends_on_components` renamed to `modified_components`
+    - `find_apps()`  parameter `depends_on_files` renamed to `modified_files`
+    - `build_apps()`  parameter `depends_on_components` renamed to `modified_components`
+    - `build_apps()`  parameter `depends_on_files` renamed to `modified_files`
+  - CLI Options
+    - `--depends-on-components` renamed to `--modified-components`
+    - `--depends-on-files` renamed to `--modified-files`
+- Reorder Parameters
   - `find_apps()`
   - `build_apps()`
-- CLI Options Renamed
-  - `--depends-on-components` renamed to `--modified-components`
-  - `--depends-on-files` renamed to `--modified-files`
-  - `--ignore-components-dependencies-file-patterns` renamed to `--ignore-app-dependencies-filepatterns`
-- Removed the deprecated CLI call methods, now these options only support space-separated list
-  - `--exclude`
-  - `--config`
-  - `--manifest-file`
-  - `--ignore-warning-str`
-  - `--default-build-targets`
 
 ## [0.6.1] (2023-05-10)
 
@@ -130,7 +127,7 @@ This is the last version to support ESP-IDF v4.1 since it's EOL on Feb. 24th, 20
 
 ### Fixed
 
-- Relative path defined in the manifest files depend on the current work path
+- Ralative path defined in the manifest files depend on the current work path
 
   Added `manifest_rootpath` argument in `find_apps()`. Will use this value instead as the root folder for calculating absolute path
 

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: idf-build-apps
-Version: 1.0.0
+Version: 1.0.0.dev0
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/docs/find_build.md

@@ -114,7 +114,7 @@ By default, `idf-build-apps` would use the project directory as the work directo
 
 #### Build Directory
 
-Build directory is the directory where the binary files output would be generated. If it is set to a relative path, the full path would be calculated based on the work directory. If it is an absolute path, it would override the work directory settings.
+Build directory is the directory where the binary files output would be generated. If it is set to a relative path, the full path would be calculated based on the work directory. If it is a absolute path, it would override the work directory settings.
 
 By default, `idf-build-apps` would follow what ESP-IDF does, use `build` as the build directory.
 

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/docs/manifest.md

@@ -23,14 +23,12 @@ One typical manifest file look like this:
 
 ### Operands
 
-- Capitalized Words
-  - Variables start with `SOC_`. The value would be parsed from `IDF_PATH/components/soc/[TARGET]/include/soc/*_caps.h`
-  - `IDF_TARGET`
-  - `IDF_VERSION_MAJOR`
-  - `IDF_VERSION_MINOR`
-  - `IDF_VERSION_PATCH`
-  - `INCLUDE_DEFAULT` (The default value of officially supported targets is 1, otherwise is 0)
-  - environment variables, default to `0` if not set
+- Variables start with `SOC_`. The value would be parsed from `IDF_PATH/components/soc/[TARGET]/include/soc/*_caps.h`
+- `IDF_TARGET`
+- `IDF_VERSION_MAJOR`
+- `IDF_VERSION_MINOR`
+- `IDF_VERSION_PATCH`
+- `INCLUDE_DEFAULT` (The default value of officially supported targets is 1, otherwise is 0)
 - String, must be double-quoted. e.g., `"esp32"`, `"12345"`
 - Integer, support decimal and hex. e.g., `1`, `0xAB`
 - List of strings or integers, or both types at the same time. e.g., `["esp32", 1]`
@@ -114,57 +112,3 @@ examples/get-started/blink:
     - if: INCLUDE_DEFAULT == 1 or IDF_TARGET == "linux"
       reason: This one supports all supported targets and linux
 ```
-
-## Check App Dependencies
-
-`idf-build-apps` also supports building only related apps by checking app dependencies via modified components and modified files.
-
-### Basic Usage
-
-To enable this feature, you need to declare the modified files or components using the CLI option:
-
-- `--modified-files`
-- `--modified-components`
-
-To declare the dependencies for an app, you could add two more keywords in the corresponding manifest file:
-
-- `depends_components`
-- `depends_filepatterns`
-
-One app will be built when:
-
-- The app itself is modified (`.md` files are excluded)
-- Any of the specified `depends_components` in the corresponding manifest file are modified
-- Files that matches any of the specified `depends_filepatterns` in the corresponding manifest file are modified
-- Any of the `build_components` are modified. `build_components` are defined in the `project_description.json`, which is generated by running `idf.py reconfigure` or `idf.py build`
-
-For example, this is an app `example/foo`, which depends on `comp1`, `comp2`, `comp3` and all files under `common_header_files`:
-
-```yaml
-examples/foo:
-  depends_components:
-    - comp1
-    - comp2
-    - comp3
-  depends_files:
-    - "common_header_files/**/*"
-```
-
-This app will be built with the following CLI options:
-
-- `--modified-files examples/foo/main/foo.c`
-- `--modified-components comp1`
-- `--modified-components comp2 comp3`
-- `--modified-files common_header_files/foo.h`
-
-This app will not be built with the following CLI options:
-
-- `--modified-files examples/foo/main/foo.md`
-- `--modified-components bar`
-- `/tmp/foo.c`
-
-### Advanced Usage
-
-Sometimes, we have some root dependencies. All apps should be built if these root dependencies are modified.
-
-After adding `--ignore-app-dependencies-filepatterns` to the CLI options, if files that matches any of the specified patterns are modified, the check app dependency feature will be disabled.

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/idf_build_apps/__init__.py

@@ -7,7 +7,7 @@ Tools for building ESP-IDF related apps.
 
 import logging
 
-__version__ = '1.0.0'
+__version__ = '1.0.0.dev0'
 
 LOGGER = logging.getLogger('idf_build_apps')
 

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/idf_build_apps/app.py

@@ -37,7 +37,6 @@ from .manifest.manifest import (
 )
 from .utils import (
     BuildError,
-    files_matches_patterns,
     find_first_match,
     rmdir,
     subprocess_run,
@@ -51,12 +50,6 @@ except ImportError:
     pass
 
 
-class BuildOrNot:
-    YES = 'yes'
-    NO = 'no'
-    UNKNOWN = 'unknown'
-
-
 class App(object):
     TARGET_PLACEHOLDER = '@t'  # replace it with self.target
     WILDCARD_PLACEHOLDER = '@w'  # replace it with the wildcard, usually the sdkconfig
@@ -108,10 +101,6 @@ class App(object):
         self.check_warnings = check_warnings
         self.preserve = preserve
 
-        # should be built or not
-        self.should_build = BuildOrNot.UNKNOWN
-        self._checked_should_build = False
-
         # Some miscellaneous build properties which are set later, at the build stage
         self.dry_run = False
         self.index = None
@@ -402,10 +391,9 @@ class App(object):
     @abstractmethod
     def build(
         self,
-        manifest_rootpath=None,  # type: str | None
         modified_components=None,  # type: list[str] | str | None
-        modified_files=None,  # type: list[str] | str | None
-        check_app_dependencies=False,  # type: bool
+        check_component_dependencies=False,  # type: bool
+        is_modified=False,  # type: bool
     ):  # type: (...) -> bool
         pass
 
@@ -481,68 +469,6 @@ class App(object):
 
         return False
 
-    def check_should_build(
-        self,
-        manifest_rootpath,  # type: str
-        check_app_dependencies,  # type: bool
-        modified_components,  # type: list[str] | None
-        modified_files,  # type: list[str] | None
-    ):  # type: (...) -> None
-        if self.should_build != BuildOrNot.UNKNOWN:
-            return
-
-        if not check_app_dependencies:
-            self.should_build = BuildOrNot.YES
-            self._checked_should_build = True
-            return
-
-        if self.is_modified(modified_files):
-            self.should_build = BuildOrNot.YES
-            self._checked_should_build = True
-            return
-
-        # check app dependencies
-        modified_components = to_list(modified_components)
-        modified_files = to_list(modified_files)
-
-        _modified_components = BuildOrNot.UNKNOWN
-        _modified_files = BuildOrNot.UNKNOWN
-
-        # depends components?
-        if check_app_dependencies and modified_components is not None:
-            if set(self.depends_components).intersection(set(modified_components)):
-                LOGGER.debug(
-                    '=> Should be built. %s requires components: %s, modified components %s',
-                    self,
-                    ', '.join(self.depends_components),
-                    ', '.join(modified_components),
-                )
-                _modified_components = BuildOrNot.YES
-            # if not defined dependency, we left it unknown and decide with idf.py reconfigure
-            elif self.depends_components:
-                _modified_components = BuildOrNot.NO
-
-        # or depends file patterns?
-        if check_app_dependencies and modified_files is not None:
-            if files_matches_patterns(modified_files, self.depends_filepatterns, manifest_rootpath):
-                LOGGER.debug(
-                    '=> Should be built. %s depends on file patterns: %s, modified files %s',
-                    self,
-                    ', '.join(self.depends_filepatterns),
-                    ', '.join(modified_files),
-                )
-                _modified_files = BuildOrNot.YES
-            # if not defined dependency, we left it unknown and decide with idf.py reconfigure
-            elif self.depends_filepatterns:
-                _modified_files = BuildOrNot.NO
-
-        if _modified_components == BuildOrNot.YES or _modified_files == BuildOrNot.YES:
-            self.should_build = BuildOrNot.YES
-        elif _modified_components == BuildOrNot.NO or _modified_files == BuildOrNot.NO:
-            self.should_build = BuildOrNot.NO
-
-        self._checked_should_build = True
-
 
 class CMakeApp(App):
     BUILD_SYSTEM = 'cmake'
@@ -567,14 +493,10 @@ class CMakeApp(App):
 
     def build(
         self,
-        manifest_rootpath=None,  # type: str | None
         modified_components=None,  # type: list[str] | str | None
-        modified_files=None,  # type: list[str] | str | None
-        check_app_dependencies=False,  # type: bool
+        check_component_dependencies=False,  # type: bool
+        is_modified=False,  # type: bool
     ):  # type: (...) -> bool
-        modified_components = to_list(modified_components)
-        modified_files = to_list(modified_files)
-
         LOGGER.debug('=> Preparing...')
         if self.work_dir != self.app_dir:
             if os.path.exists(self.work_dir):
@@ -632,15 +554,8 @@ class CMakeApp(App):
             '-DSDKCONFIG_DEFAULTS={}'.format(';'.join(self.sdkconfig_files) if self.sdkconfig_files else ';'),
         ]
 
-        if not self._checked_should_build:
-            self.check_should_build(
-                manifest_rootpath=manifest_rootpath,
-                modified_components=modified_components,
-                modified_files=modified_files,
-                check_app_dependencies=check_app_dependencies,
-            )
-
-        if modified_components is not None and check_app_dependencies and self.should_build == BuildOrNot.UNKNOWN:
+        modified_components = to_list(modified_components)
+        if modified_components is not None and check_component_dependencies and not is_modified:
             subprocess_run(
                 common_args + ['reconfigure'],
                 log_terminal=False if self.build_log_path else True,
@@ -660,12 +575,6 @@ class CMakeApp(App):
                     modified_components,
                 )
                 return False
-            else:
-                self.should_build = BuildOrNot.YES
-
-        if self.should_build == BuildOrNot.NO:
-            LOGGER.info('=> Skip building...')
-            return False
 
         # idf.py build
         build_args = deepcopy(common_args)

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/idf_build_apps/finder.py

@@ -12,12 +12,11 @@ from . import (
 )
 from .app import (
     App,
-    BuildOrNot,
     CMakeApp,
 )
 from .utils import (
     config_rules_from_str,
-    to_absolute_path,
+    files_matches_patterns,
     to_list,
 )
 
@@ -36,7 +35,7 @@ def _get_apps_from_path(
     manifest_rootpath=None,  # type: str | None
     modified_components=None,  # type: list[str] | str | None
     modified_files=None,  # type: list[str] | str | None,
-    check_app_dependencies=False,  # type: bool
+    check_component_dependencies=False,  # type: bool
     sdkconfig_defaults_str=None,  # type: str | None
 ):  # type: (...) -> list[App]
     modified_components = to_list(modified_components)
@@ -47,16 +46,28 @@ def _get_apps_from_path(
             LOGGER.debug('=> Skipping. %s only supports targets: %s', _app, ', '.join(_app.supported_targets))
             return False
 
-        _app.check_should_build(
-            manifest_rootpath=manifest_rootpath,
-            modified_components=modified_components,
-            modified_files=modified_files,
-            check_app_dependencies=check_app_dependencies,
-        )
-
-        # for unknown ones, we keep them to the build stage to judge
-        if _app.should_build == BuildOrNot.NO:
-            return False
+        if _app.is_modified(modified_files):
+            return True
+
+        if _app.depends_components and check_component_dependencies:
+            if not set(_app.depends_components).intersection(set(modified_components)):
+                LOGGER.debug(
+                    '=> Skipping. %s requires components: %s, but you passed "--modified-components %s"',
+                    _app,
+                    ', '.join(_app.depends_components),
+                    ', '.join(modified_components),
+                )
+                return False
+
+        if _app.depends_filepatterns and check_component_dependencies:
+            if not files_matches_patterns(modified_files, _app.depends_filepatterns, manifest_rootpath):
+                LOGGER.debug(
+                    '=> Skipping. %s depends on file patterns: %s, but you passed "--modified-files %s"',
+                    _app,
+                    ', '.join(_app.depends_filepatterns),
+                    ', '.join(modified_files),
+                )
+                return False
 
         return True
 
@@ -166,18 +177,15 @@ def _find_apps(
 
     # The remaining part is for recursive == True
     apps = []
-    # handle the exclude list, since the config file might use linux style, but run in windows
-    exclude_list = [to_absolute_path(p) for p in exclude_list]
     for root, dirs, _ in os.walk(path):
         LOGGER.debug('Entering %s', root)
-        root_path = to_absolute_path(root)
-        if root_path in exclude_list:
+        if root in exclude_list:
             LOGGER.debug('=> Skipping %s (excluded)', root)
             del dirs[:]
             continue
 
-        if root_path.parts[-1] == 'managed_components':  # idf-component-manager
-            LOGGER.debug('=> Skipping %s (managed components)', root_path)
+        if root.endswith('managed_components'):  # idf-component-manager
+            LOGGER.debug('=> Skipping %s (managed components)', root)
             del dirs[:]
             continue
 

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/idf_build_apps/main.py

@@ -2,12 +2,14 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import argparse
+import io
 import json
 import os
 import re
 import shutil
 import sys
 import textwrap
+import warnings
 from pathlib import (
     Path,
 )
@@ -49,26 +51,26 @@ except ImportError:
     pass
 
 
-def _check_app_dependency(
+def _check_components_dependency(
     manifest_rootpath,  # type: str
     modified_components,  # type: list[str] | None
     modified_files,  # type: list[str] | None
-    ignore_app_dependencies_filepatterns,  # type: list[str] | None
+    ignore_component_dependencies_file_patterns,  # type: list[str] | None
 ):  # type: (...) -> bool
-    # not check since modified_components and modified_files are not passed
+    # not check since `--modified-components` is not passed
     if modified_components is None and modified_files is None:
         return False
 
-    # not check since ignore_app_dependencies_filepatterns is passed and matched
+    # not check since `--ignore-component-dependency-file-pattern` is passed and matched
     if (
-        ignore_app_dependencies_filepatterns
-        and modified_files is not None
-        and files_matches_patterns(modified_files, ignore_app_dependencies_filepatterns, manifest_rootpath)
+        ignore_component_dependencies_file_patterns
+        and modified_files
+        and files_matches_patterns(modified_files, ignore_component_dependencies_file_patterns, manifest_rootpath)
     ):
         LOGGER.debug(
             'Skipping check component dependencies for apps since files %s matches patterns: %s',
             ', '.join(modified_files),
-            ', '.join(ignore_app_dependencies_filepatterns),
+            ', '.join(ignore_component_dependencies_file_patterns),
         )
         return False
 
@@ -93,7 +95,7 @@ def find_apps(
     default_build_targets=None,  # type: list[str] | str | None
     modified_components=None,  # type: list[str] | str | None
     modified_files=None,  # type: list[str] | str | None
-    ignore_app_dependencies_filepatterns=None,  # type: list[str] | str | None
+    ignore_component_dependencies_file_patterns=None,  # type: list[str] | str | None
     sdkconfig_defaults=None,  # type: str | None
 ):  # type: (...) -> list[App]
     """
@@ -137,9 +139,9 @@ def find_apps(
     :type modified_components: list[str] | str | None
     :param modified_files: modified files
     :type modified_files: list[str] | str | None
-    :param ignore_app_dependencies_filepatterns: file patterns that used for ignoring checking the component
+    :param ignore_component_dependencies_file_patterns: file patterns that used for ignoring checking the component
         dependencies
-    :type ignore_app_dependencies_filepatterns: list[str] | str | None
+    :type ignore_component_dependencies_file_patterns: list[str] | str | None
     :param sdkconfig_defaults: semicolon-separated string, pass to idf.py -DSDKCONFIG_DEFAULTS if specified,
         also could be set via environment variables "SDKCONFIG_DEFAULTS"
     :type sdkconfig_defaults: str | None
@@ -164,7 +166,7 @@ def find_apps(
 
     modified_components = to_list(modified_components)
     modified_files = to_list(modified_files)
-    ignore_app_dependencies_filepatterns = to_list(ignore_app_dependencies_filepatterns)
+    ignore_component_dependencies_file_patterns = to_list(ignore_component_dependencies_file_patterns)
 
     apps = []
     if target == 'all':
@@ -189,14 +191,14 @@ def find_apps(
                     check_warnings=check_warnings,
                     preserve=preserve,
                     manifest_rootpath=manifest_rootpath,
-                    check_app_dependencies=_check_app_dependency(
-                        manifest_rootpath=manifest_rootpath,
-                        modified_components=modified_components,
-                        modified_files=modified_files,
-                        ignore_app_dependencies_filepatterns=ignore_app_dependencies_filepatterns,
-                    ),
                     modified_components=modified_components,
                     modified_files=modified_files,
+                    check_component_dependencies=_check_components_dependency(
+                        manifest_rootpath,
+                        modified_components,
+                        modified_files,
+                        ignore_component_dependencies_file_patterns,
+                    ),
                     sdkconfig_defaults_str=sdkconfig_defaults,
                 )
             )
@@ -221,7 +223,7 @@ def build_apps(
     manifest_rootpath=None,  # type: str | None
     modified_components=None,  # type: list[str] | str | None
     modified_files=None,  # type: list[str] | str | None
-    ignore_app_dependencies_filepatterns=None,  # type: list[str] | str | None
+    ignore_component_dependencies_file_patterns=None,  # type: list[str] | str | None
 ):  # type: (...) -> (int, list[App]) | int
     """
     Build all the specified apps
@@ -256,9 +258,9 @@ def build_apps(
     :type modified_components: list[str] | str | None
     :param modified_files: modified files
     :type modified_files: list[str] | str | None
-    :param ignore_app_dependencies_filepatterns: file patterns that used for ignoring checking the component
+    :param ignore_component_dependencies_file_patterns: file patterns that used for ignoring checking the component
         dependencies
-    :type ignore_app_dependencies_filepatterns: list[str] | str | None
+    :type ignore_component_dependencies_file_patterns: list[str] | str | None
     :return: (exit_code, built_apps) if specified ``modified_components``
     :rtype: int, list[App]
     :return: exit_code if not specified ``modified_components``
@@ -267,7 +269,7 @@ def build_apps(
     apps = to_list(apps)  # type: list[App]
     modified_components = to_list(modified_components)
     modified_files = to_list(modified_files)
-    ignore_app_dependencies_filepatterns = to_list(ignore_app_dependencies_filepatterns)
+    ignore_component_dependencies_file_patterns = to_list(ignore_component_dependencies_file_patterns)
 
     ignore_warnings_regexes = []
     if ignore_warning_strs:
@@ -298,13 +300,27 @@ def build_apps(
         app.parallel_count = parallel_count
 
         if collect_app_info:
-            app._collect_app_info = collect_app_info
+            if isinstance(collect_app_info, io.TextIOWrapper):
+                warnings.warn(
+                    '"collect_app_info" does not support file stream in idf-build-apps 1.0.0, Please use str instead',
+                    DeprecationWarning,
+                )
+                app._collect_app_info = collect_app_info.name
+            else:
+                app._collect_app_info = collect_app_info
 
             if app.collect_app_info not in collect_files:
                 collect_files.append(app.collect_app_info)
 
         if collect_size_info:
-            app._collect_size_info = collect_size_info
+            if isinstance(collect_size_info, io.TextIOWrapper):
+                warnings.warn(
+                    '"collect_size_info" does not support file stream in idf-build-apps 1.0.0, Please use str instead',
+                    DeprecationWarning,
+                )
+                app._collect_size_info = collect_size_info.name
+            else:
+                app._collect_size_info = collect_size_info
 
             if app.collect_size_info not in collect_files:
                 collect_files.append(app.collect_size_info)
@@ -332,12 +348,11 @@ def build_apps(
         is_built = False
         try:
             is_built = app.build(
-                manifest_rootpath=manifest_rootpath,
                 modified_components=modified_components,
-                modified_files=modified_files,
-                check_app_dependencies=_check_app_dependency(
-                    manifest_rootpath, modified_components, modified_files, ignore_app_dependencies_filepatterns
+                check_component_dependencies=_check_components_dependency(
+                    manifest_rootpath, modified_components, modified_files, ignore_component_dependencies_file_patterns
                 ),
+                is_modified=app.is_modified(modified_files),
             )
         except BuildError as e:
             LOGGER.error(str(e))
@@ -452,7 +467,15 @@ class IdfBuildAppsCliFormatter(argparse.HelpFormatter):
             else:
                 default_type = type(action.default)
 
-            if action.nargs in [argparse.ZERO_OR_MORE, argparse.ONE_OR_MORE]:
+            if isinstance(action, argparse._AppendAction):  # noqa
+                _help += (
+                    '. Could be specified for multiple times'
+                    '{} ! DeprecationWarning: will change to space-separated list in idf-build-apps 1.0.0 version'.format(
+                        self.LINE_SEP
+                    )
+                )
+                _type = 'list[{}]'.format(default_type.__name__)
+            elif action.nargs in [argparse.ZERO_OR_MORE, argparse.ONE_OR_MORE]:
                 _type = 'list[{}]'.format(default_type.__name__)
             else:
                 _type = default_type.__name__
@@ -498,7 +521,11 @@ def get_parser():  # type: () -> argparse.ArgumentParser
         action='store_true',
         help='Look for apps in the specified paths recursively',
     )
-    common_args.add_argument('--exclude', nargs='+', help='Ignore specified path (if --recursive is given)')
+    common_args.add_argument(
+        '--exclude',
+        action='append',
+        help='Ignore specified directory (if --recursive is given)',
+    )
     common_args.add_argument(
         '--work-dir',
         help='If set, the app is first copied into the specified directory, and then built. '
@@ -520,7 +547,7 @@ def get_parser():  # type: () -> argparse.ArgumentParser
     )
     common_args.add_argument(
         '--config',
-        nargs='+',
+        action='append',
         help='Adds configurations (sdkconfig file names) to build. '
         'This can either be FILENAME[=NAME] or FILEPATTERN. FILENAME is the name of the sdkconfig file, '
         'relative to the project directory, to be used. Optional NAME can be specified, '
@@ -550,7 +577,7 @@ def get_parser():  # type: () -> argparse.ArgumentParser
     )
     common_args.add_argument(
         '--manifest-file',
-        nargs='+',
+        action='append',
         help='Manifest files which specify the build test rules of the apps',
     )
     common_args.add_argument(
@@ -562,7 +589,10 @@ def get_parser():  # type: () -> argparse.ArgumentParser
         '--default-build-targets',
         nargs='+',
         help='space-separated list of supported targets. Targets supported in current ESP-IDF branch '
-        '(except preview ones) would be used if this option is not set.',
+        '(except preview ones) would be used if this option is not set.'
+        '{} ! DeprecationWarning: comma-separated list support will be removed in idf-build-apps 1.0.0 version'.format(
+            IdfBuildAppsCliFormatter.LINE_SEP
+        ),
     )
     common_args.add_argument(
         '--modified-components',
@@ -581,12 +611,13 @@ def get_parser():  # type: () -> argparse.ArgumentParser
     )
     common_args.add_argument(
         '-if',
-        '--ignore-app-dependencies-filepatterns',
+        '--ignore-component-dependencies-file-patterns',
         nargs='*',
         default=None,
-        help='space-separated list which specifies the file patterns 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 file patterns matches any of the modified files. Must be used together with --modified-files',
+        help='space-separated list which specifies the file patterns used for ignoring the component dependencies. '
+        'The `depends_components` and `depends_filepatterns` set in the manifest files will be ignored when any of '
+        'the specified file patterns matches any of the modified files. Must be used together with '
+        '--modified-files',
     )
 
     common_args.add_argument(
@@ -643,7 +674,7 @@ def get_parser():  # type: () -> argparse.ArgumentParser
     )
     build_parser.add_argument(
         '--ignore-warning-str',
-        nargs='+',
+        action='append',
         help='Ignore the warning string that match the specified regex in the build output',
     )
     build_parser.add_argument(
@@ -680,17 +711,20 @@ def validate_args(parser, args):  # type: (argparse.ArgumentParser, argparse.Nam
     default_build_targets = []
     if args.default_build_targets:
         for target in args.default_build_targets:
-            if target not in ALL_TARGETS:
-                raise InvalidCommand(
-                    'Unrecognizable target {} specified with "--default-build-targets". '
-                    'Current ESP-IDF available targets: {}'.format(target, ALL_TARGETS)
-                )
+            t_list = [_t.strip() for _t in target.split(',')] if ',' in target else [target.strip()]
+            for _t in t_list:
+                if _t not in ALL_TARGETS:
+                    raise InvalidCommand(
+                        'Unrecognizable target {} specified with "--default-build-targets". '
+                        'Current ESP-IDF available targets: {}'.format(_t, ALL_TARGETS)
+                    )
+
+                if _t not in default_build_targets:
+                    default_build_targets.append(_t)
 
-            if target not in default_build_targets:
-                default_build_targets.append(target)
     args.default_build_targets = default_build_targets
 
-    if args.ignore_app_dependencies_filepatterns:
+    if args.ignore_component_dependencies_file_patterns:
         if args.modified_files is None:
             raise InvalidCommand(
                 'Must specify "--ignore-component-dependencies-file-patterns" with "--modified-files", '
@@ -732,7 +766,7 @@ def main():
         default_build_targets=args.default_build_targets,
         modified_components=args.modified_components,
         modified_files=args.modified_files,
-        ignore_app_dependencies_filepatterns=args.ignore_app_dependencies_filepatterns,
+        ignore_component_dependencies_file_patterns=args.ignore_component_dependencies_file_patterns,
         sdkconfig_defaults=args.sdkconfig_defaults,
     )
 
@@ -766,7 +800,7 @@ def main():
         manifest_rootpath=args.manifest_rootpath,
         modified_components=args.modified_components,
         modified_files=args.modified_files,
-        ignore_app_dependencies_filepatterns=args.ignore_app_dependencies_filepatterns,
+        ignore_component_dependencies_file_patterns=args.ignore_component_dependencies_file_patterns,
     )
 
     if args.modified_components is not None:

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/idf_build_apps/manifest/if_parser.py

@@ -1,7 +1,6 @@
 # SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
-import os
 from ast import (
     literal_eval,
 )
@@ -87,10 +86,6 @@ class ChipAttr(Stmt):
         if self.attr in SOC_HEADERS[target]:
             return SOC_HEADERS[target][self.attr]
 
-        # for non-keyword cap words, check if it is defined in the environment variables
-        if self.attr in os.environ:
-            return os.environ[self.attr]
-
         return 0  # default return 0 as false
 
 

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/idf_build_apps/utils.py

@@ -213,7 +213,7 @@ def files_matches_patterns(
     patterns,  # type: list[str] | str
     rootpath=None,  # type: str
 ):  # type: (...) -> bool
-    # can't match an absolute pattern with a relative path
+    # can't match a absolute pattern with a relative path
     # change all to absolute paths
     files = [to_absolute_path(f, rootpath) for f in to_list(files)]
     patterns = [to_absolute_path(p, rootpath) for p in to_list(patterns)]

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/setup.py

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

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/tests/test_build.py

@@ -4,9 +4,6 @@ import shutil
 
 import pytest
 
-from idf_build_apps import (
-    find_apps,
-)
 from idf_build_apps.app import (
     CMakeApp,
 )
@@ -27,7 +24,7 @@ class TestBuild:
         assert 'Project build complete.' in captured.out
 
     @pytest.mark.parametrize(
-        'modified_components, check_app_dependencies, should_be_built',
+        'modified_components, check_component_dependencies, assert_build_done',
         [
             (None, True, True),
             ([], True, False),
@@ -40,15 +37,21 @@ class TestBuild:
         ],
     )
     def test_build_with_modified_components(
-        self, tmpdir, capsys, modified_components, check_app_dependencies, should_be_built
+        self, tmpdir, capsys, modified_components, check_component_dependencies, assert_build_done
     ):
         path = IDF_PATH / 'examples' / 'get-started' / 'hello_world'
 
-        is_built = CMakeApp(str(path), 'esp32', work_dir=str(tmpdir / 'test')).build(
+        CMakeApp(str(path), 'esp32', work_dir=str(tmpdir / 'test')).build(
             modified_components=modified_components,
-            check_app_dependencies=check_app_dependencies,
+            check_component_dependencies=check_component_dependencies,
         )
-        assert is_built == should_be_built
+
+        captured = capsys.readouterr()
+        assert 'Configuring done' in captured.out
+        if assert_build_done:
+            assert 'Project build complete.' in captured.out
+        else:
+            assert 'Project build complete.' not in captured.out
 
     @pytest.mark.parametrize(
         'modified_files, is_built',
@@ -71,26 +74,12 @@ class TestBuild:
         app = CMakeApp(test_dir, 'esp32')
         built = app.build(
             modified_components=[],
-            modified_files=modified_files,
-            check_app_dependencies=True,
+            check_component_dependencies=True,
+            is_modified=app.is_modified(modified_files),
         )
 
         assert built == is_built
 
-    def test_build_without_modified_components_but_ignored_app_dependency_check(self):
-        test_dir = str(IDF_PATH / 'examples' / 'get-started' / 'hello_world')
-
-        apps = find_apps(
-            test_dir,
-            'esp32',
-            modified_components=[],
-            modified_files=['foo.c'],
-            ignore_app_dependencies_filepatterns=['foo.c'],
-        )
-
-        for app in apps:
-            assert app.build()
-
 
 @pytest.mark.skipif(not shutil.which('idf.py'), reason='idf.py not found')
 def test_idf_version_keywords_type():

{idf_build_apps-1.0.0 → idf_build_apps-1.0.0.dev0}/tests/test_finder.py

@@ -3,7 +3,6 @@
 
 import logging
 import os
-import tempfile
 from pathlib import (
     Path,
 )
@@ -112,7 +111,7 @@ get-started:
             (['soc', 'fake'], True),
         ],
     )
-    def test_with_depends_and_modified_components(self, tmpdir, modified_components, could_find_apps):
+    def test_with_requires_and_modified_components(self, tmpdir, modified_components, could_find_apps):
         test_dir = str(IDF_PATH / 'examples')
         apps = find_apps(test_dir, 'esp32', recursive=True)
         assert apps
@@ -184,13 +183,12 @@ get-started:
             assert not filtered_apps
 
     @pytest.mark.parametrize(
-        'modified_components, modified_files, could_find_apps',
+        'modified_files, could_find_apps',
         [
-            ([], '/foo', True),
-            ([], str(IDF_PATH / 'examples' / 'README.md'), False),
-            (None, [str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md')], True),
+            ('/foo', True),
+            (str(IDF_PATH / 'examples' / 'README.md'), False),
+            ([str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md')], True),
             (
-                [],
                 [
                     str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md'),
                     str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.c'),
@@ -199,7 +197,7 @@ get-started:
             ),
         ],
     )
-    def test_with_depends_filepatterns(self, tmp_path, modified_components, modified_files, could_find_apps):
+    def test_with_depends_filepatterns(self, tmp_path, modified_files, could_find_apps):
         test_dir = str(IDF_PATH / 'examples' / 'get-started' / 'hello_world')
         apps = find_apps(test_dir, 'esp32', recursive=True)
         assert apps
@@ -222,39 +220,6 @@ get-started:
             recursive=True,
             manifest_rootpath=str(IDF_PATH),
             manifest_files=yaml_file,
-            modified_components=modified_components,
-            modified_files=modified_files,
-        )
-        if could_find_apps:
-            assert filtered_apps == apps
-        else:
-            assert not filtered_apps
-
-    @pytest.mark.parametrize(
-        'modified_files, could_find_apps',
-        [
-            (None, True),
-            (str(IDF_PATH / 'examples' / 'README.md'), True),
-            ([str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md')], True),
-            (
-                [
-                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.md'),
-                    str(IDF_PATH / 'examples' / 'get-started' / 'hello_world' / 'a.c'),
-                ],
-                True,
-            ),
-            ([str(IDF_PATH / 'examples' / 'a.c')], True),
-        ],
-    )
-    def test_with_filepattern_but_calculate_component_later(self, modified_files, could_find_apps):
-        test_dir = str(IDF_PATH / 'examples' / 'get-started' / 'hello_world')
-        apps = find_apps(test_dir, 'esp32', recursive=True)
-        assert apps
-
-        filtered_apps = find_apps(
-            test_dir,
-            'esp32',
-            recursive=True,
             modified_files=modified_files,
         )
         if could_find_apps:
@@ -418,84 +383,3 @@ class TestFindWithSdkconfigFiles:
         assert apps[0].sdkconfig_files == [
             str(tmp_path / 'test1' / 'sdkconfig.defaults'),
         ]
-
-    def test_env_var(self, tmp_path, monkeypatch):
-        create_project('test1', tmp_path)
-
-        (tmp_path / 'test1' / 'sdkconfig.ci.foo').touch()
-        (tmp_path / 'test1' / 'sdkconfig.ci.bar').touch()
-        (tmp_path / 'test1' / 'sdkconfig.ci.baz').touch()
-
-        yaml_file = tmp_path / 'test.yml'
-        yaml_file.write_text(
-            f'''
-{tmp_path}:
-  enable:
-    - if: CONFIG_NAME == "foo" and IDF_TARGET == "esp32"
-    - if: CONFIG_NAME == "bar" and IDF_TARGET == "esp32s2"
-    - if: TEST_ENV_VAR == "1"
-    - if: CONFIG_NAME == "baz" and TEST_ENV_VAR == 0
-''',
-            encoding='utf8',
-        )
-
-        # in case you set it...
-        monkeypatch.delenv('CONFIG_NAME', raising=False)
-        monkeypatch.delenv('TEST_ENV_VAR', raising=False)
-
-        # CONFIG_NAME should NOT be overridden by env var
-        monkeypatch.setenv('CONFIG_NAME', 'bar')
-        apps = find_apps(
-            str(tmp_path / 'test1'),
-            'esp32',
-            config_rules_str=['sdkconfig.ci=default', 'sdkconfig.ci.*='],
-            manifest_files=yaml_file,
-        )
-        assert len(apps) == 2
-        assert apps[0].sdkconfig_files == [
-            str(tmp_path / 'test1' / 'sdkconfig.ci.baz'),
-        ]
-        assert apps[1].sdkconfig_files == [
-            str(tmp_path / 'test1' / 'sdkconfig.ci.foo'),
-        ]
-        monkeypatch.delenv('CONFIG_NAME')
-
-        # env var should be expanded
-        monkeypatch.setenv('TEST_ENV_VAR', '1')
-        apps = find_apps(
-            str(tmp_path / 'test1'),
-            'esp32',
-            config_rules_str=['sdkconfig.ci=default', 'sdkconfig.ci.*='],
-            manifest_files=yaml_file,
-        )
-        assert len(apps) == 3
-        monkeypatch.delenv('TEST_ENV_VAR')
-
-
-@pytest.mark.parametrize(
-    'exclude_list, apps_count',
-    [
-        (['test1'], 3),  # not excluded
-        (['folder1/test2'], 2),
-        (['folder1'], 1),
-        (['folder2/test2'], 2),
-    ],
-)
-def test_find_apps_with_exclude(tmp_path, exclude_list, apps_count):
-    (tmp_path / 'folder1').mkdir()
-    (tmp_path / 'folder2').mkdir()
-
-    create_project('test1', tmp_path / 'folder1')
-    create_project('test2', tmp_path / 'folder1')
-    create_project('test2', tmp_path / 'folder2')
-
-    os.chdir(tmp_path)
-    apps = find_apps(str(tmp_path), 'esp32', recursive=True, exclude_list=exclude_list)
-    assert len(apps) == apps_count
-
-    # or with absolute_path
-    exclude_list = [os.path.abspath(x) for x in exclude_list]
-    tmp_path = os.path.abspath(tmp_path)
-    os.chdir(tempfile.tempdir)
-    apps = find_apps(str(tmp_path), 'esp32', recursive=True, exclude_list=exclude_list)
-    assert len(apps) == apps_count