idf-build-apps 2.5.0rc2__py3-none-any.whl → 2.5.2__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.5.0rc2'
+__version__ = '2.5.2'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/args.py

@@ -11,6 +11,7 @@ import sys
 import typing as t
 from copy import deepcopy
 from dataclasses import dataclass
+from io import TextIOWrapper
 from pathlib import Path
 from typing import Any
 
@@ -51,6 +52,8 @@ class FieldMetadata:
     :param choices: choices for the argument, used in argparse
     :param type: type for the argument, used in argparse
     :param required: whether the argument is required, used in argparse
+    :param default: default value for the argument, used in argparse
+    :param hidden: whether the argument is hidden, used in argparse
     """
 
     # validate method
@@ -66,6 +69,8 @@ class FieldMetadata:
     required: bool = False
     # usually default is not needed. only set it when different from the default value of the field
     default: t.Any = None
+    # hidden field, use deprecated instead, or hide it in the argparse
+    hidden: bool = False
 
 
 P = ParamSpec('P')
@@ -112,6 +117,7 @@ class BaseArguments(BaseSettings):
         toml_file='.idf_build_apps.toml',
         pyproject_toml_table_header=('tool', 'idf-build-apps'),
         pyproject_toml_depth=sys.maxsize,
+        extra='ignore',
     )
 
     @classmethod
@@ -135,8 +141,9 @@ 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)
-            if meta and meta.validate_method and ValidateMethod.TO_LIST in meta.validate_method:
-                return to_list(v)
+            if meta and meta.validate_method:
+                if ValidateMethod.TO_LIST in meta.validate_method:
+                    return to_list(v)
 
         return v
 
@@ -195,7 +202,9 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             validate_method=[ValidateMethod.TO_LIST],
             type=semicolon_separated_str_to_list,
         ),
-        description='semicolon-separated list of modified components',
+        description='semicolon-separated list of modified components. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         default=None,
     )
     modified_files: t.Optional[t.List[str]] = field(
@@ -203,7 +212,9 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             validate_method=[ValidateMethod.TO_LIST],
             type=semicolon_separated_str_to_list,
         ),
-        description='semicolon-separated list of modified files',
+        description='semicolon-separated list of modified files. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         default=None,
     )
     deactivate_dependency_driven_build_by_components: t.Optional[t.List[str]] = field(
@@ -219,7 +230,10 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             shorthand='-dc',
         ),
         description='semicolon-separated list of components. '
-        'dependency-driven build feature will be deactivated when any of these components are modified',
+        'dependency-driven build feature will be deactivated when any of these components are modified. '
+        'Must be specified 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.',
         validation_alias=AliasChoices(
             'deactivate_dependency_driven_build_by_components', 'ignore_app_dependencies_components'
         ),
@@ -238,7 +252,10 @@ class DependencyDrivenBuildArguments(GlobalArguments):
             shorthand='-df',
         ),
         description='semicolon-separated list of file patterns. '
-        'dependency-driven build feature will be deactivated when any of matched files are modified',
+        'dependency-driven build feature will be deactivated when any of matched files are modified. '
+        'Must be specified together with --modified-files. '
+        'If set to "", the value would be considered as None. '
+        'If set to ";", the value would be considered as an empty list.',
         validation_alias=AliasChoices(
             'deactivate_dependency_driven_build_by_filepatterns', 'ignore_app_dependencies_filepatterns'
         ),
@@ -253,7 +270,7 @@ class DependencyDrivenBuildArguments(GlobalArguments):
     )
     compare_manifest_sha_filepath: t.Optional[str] = field(
         None,
-        description='Path to the file containing the sha256 hash of the manifest rules. '
+        description='Path to the file containing the hash of the manifest rules. '
         'Compare the hash with the current manifest rules. '
         'All matched apps will be built if the corresponding manifest rule is modified',
         default=None,
@@ -443,7 +460,10 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
         default=False,
     )
     default_build_targets: t.Optional[t.List[str]] = field(
-        None,
+        FieldMetadata(
+            validate_method=[ValidateMethod.TO_LIST],
+            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`',
         default=None,
@@ -602,10 +622,16 @@ class BuildArguments(FindBuildArguments):
         validation_alias=AliasChoices('ignore_warning_strs', 'ignore_warning_str'),
         default=None,
     )
-    ignore_warning_files: t.Optional[t.List[str]] = field(
+    ignore_warning_files: t.Optional[t.List[t.Union[str, TextIOWrapper]]] = field(
         FieldMetadata(
-            deprecates={'ignore_warning_file': {}},
+            validate_method=[ValidateMethod.TO_LIST],
+            deprecates={
+                'ignore_warning_file': {
+                    'type': argparse.FileType('r'),
+                }
+            },
             nargs='+',
+            type=argparse.FileType('r'),
         ),
         description='Path to the files containing the patterns to ignore the warnings in the build output',
         validation_alias=AliasChoices('ignore_warning_files', 'ignore_warning_file'),
@@ -621,7 +647,10 @@ class BuildArguments(FindBuildArguments):
 
     # Attrs that support placeholders
     collect_size_info_filename: t.Optional[str] = field(
-        None,
+        FieldMetadata(
+            deprecates={'collect_size_info': {}},
+            hidden=True,
+        ),
         description='Record size json filepath of the built apps to the specified file. '
         'Each line is a json string. Can expand placeholders @p',
         validation_alias=AliasChoices('collect_size_info_filename', 'collect_size_info'),
@@ -629,7 +658,10 @@ class BuildArguments(FindBuildArguments):
         exclude=True,  # computed field is used
     )
     collect_app_info_filename: t.Optional[str] = field(
-        None,
+        FieldMetadata(
+            deprecates={'collect_app_info': {}},
+            hidden=True,
+        ),
         description='Record serialized app model of the built apps to the specified file. '
         'Each line is a json string. Can expand placeholders @p',
         validation_alias=AliasChoices('collect_app_info_filename', 'collect_app_info'),
@@ -637,7 +669,10 @@ class BuildArguments(FindBuildArguments):
         exclude=True,  # computed field is used
     )
     junitxml_filename: t.Optional[str] = field(
-        None,
+        FieldMetadata(
+            deprecates={'junitxml': {}},
+            hidden=True,
+        ),
         description='Path to the junitxml file to record the build results. Can expand placeholder @p',
         validation_alias=AliasChoices('junitxml_filename', 'junitxml'),
         default=None,
@@ -654,8 +689,14 @@ class BuildArguments(FindBuildArguments):
             for s in self.ignore_warning_strs:
                 ignore_warnings_regexes.append(re.compile(s))
         if self.ignore_warning_files:
-            for s in self.ignore_warning_files:
-                ignore_warnings_regexes.append(re.compile(s.strip()))
+            for f in self.ignore_warning_files:
+                if isinstance(f, str):
+                    with open(f) as fr:
+                        for s in fr:
+                            ignore_warnings_regexes.append(re.compile(s.strip()))
+                else:
+                    for s in f:
+                        ignore_warnings_regexes.append(re.compile(s.strip()))
         App.IGNORE_WARNS_REGEXES = ignore_warnings_regexes
 
     @computed_field  # type: ignore
@@ -734,12 +775,20 @@ def add_args_to_parser(argument_cls: t.Type[BaseArguments], parser: argparse.Arg
                 if _shorthand:
                     _names.append(_shorthand)
 
+                if f_meta.hidden:  # f is hidden, use deprecated field instead
+                    help_msg = f.description
+                else:
+                    help_msg = f'[Deprecated] Use {_snake_case_to_cli_arg_name(f_name)} instead'
+
                 parser.add_argument(
                     *_names,
                     **dep_f_kwargs,
-                    help=f'[Deprecated] Use {_snake_case_to_cli_arg_name(f_name)} instead',
+                    help=help_msg,
                 )
 
+        if f_meta and f_meta.hidden:
+            continue
+
         names = [_snake_case_to_cli_arg_name(f_name)]
         if f_meta and f_meta.shorthand:
             names.append(f_meta.shorthand)
@@ -752,14 +801,19 @@ def add_args_to_parser(argument_cls: t.Type[BaseArguments], parser: argparse.Arg
                 kwargs['required'] = True
             if f_meta.action:
                 kwargs['action'] = f_meta.action
+                # to make the CLI override config file work
+                if f_meta.action == 'store_true':
+                    kwargs['default'] = None
+
             if f_meta.nargs:
                 kwargs['nargs'] = f_meta.nargs
             if f_meta.choices:
                 kwargs['choices'] = f_meta.choices
             if f_meta.default:
                 kwargs['default'] = f_meta.default
-        if 'default' not in kwargs:
-            kwargs['default'] = f.default
+
+        # here in CLI arguments, don't set the default to field.default
+        # otherwise it will override the config file settings
 
         parser.add_argument(
             *names,

idf_build_apps/finder.py

@@ -33,6 +33,7 @@ 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))

idf_build_apps/main.py

@@ -70,6 +70,15 @@ def find_apps(
     """
     apply_config_file(config_file)
 
+    # compatible with old usage
+    ## `preserve`
+    if 'preserve' in kwargs:
+        LOGGER.warning(
+            'Passing "preserve" directly is deprecated. '
+            'Pass "no_preserve" instead to disable preserving the build directory'
+        )
+        kwargs['no_preserve'] = not kwargs.pop('preserve')
+
     if find_arguments is None:
         find_arguments = FindArguments(
             paths=to_list(paths),  # type: ignore
@@ -125,7 +134,8 @@ def build_apps(
     """
     apply_config_file(config_file)
 
-    apps = to_list(apps)
+    # compatible with old usage
+    ## `check_app_dependencies`
     if 'check_app_dependencies' in kwargs:
         LOGGER.warning(
             'Passing "check_app_dependencies" directly is deprecated. '
@@ -138,6 +148,7 @@ def build_apps(
             **kwargs,
         )
 
+    apps = to_list(apps)
     if apps is None:
         apps = find_apps(
             find_arguments=FindArguments(
@@ -431,7 +442,8 @@ def main():
         for app in failed_apps:
             print(f'  {app}')
 
-    sys.exit(ret_code)
+    if ret_code != 0:
+        sys.exit(ret_code)
 
 
 def json_to_app(json_str: str, extra_classes: t.Optional[t.List[t.Type[App]]] = None) -> App:

idf_build_apps/manifest/if_parser.py

@@ -1,6 +1,5 @@
 # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
 import operator
 import os
 from ast import (
@@ -16,6 +15,7 @@ from packaging.version import (
 from pyparsing import (
     Keyword,
     Literal,
+    MatchFirst,
     ParseResults,
     QuotedString,
     Suppress,
@@ -35,6 +35,7 @@ from ..constants import (
     IDF_VERSION_PATCH,
 )
 from ..utils import (
+    InvalidIfClause,
     InvalidInput,
     to_version,
 )
@@ -177,22 +178,31 @@ class BoolExpr(Stmt):
     pass
 
 
-class BoolAnd(BoolExpr):
-    def __init__(self, t: ParseResults):
-        self.left: BoolStmt = t[0][0]
-        self.right: BoolStmt = t[0][2]
+def _and(_l, _r):
+    return _l and _r
 
-    def get_value(self, target: str, config_name: str) -> Any:
-        return self.left.get_value(target, config_name) and self.right.get_value(target, config_name)
+
+def _or(_l, _r):
+    return _l or _r
 
 
-class BoolOr(BoolExpr):
+class BoolOrAnd(BoolExpr):
     def __init__(self, t: ParseResults):
+        if len(t[0]) > 3:
+            raise InvalidIfClause(
+                'Chaining "and"/"or" is not allowed. Please use paratheses instead. '
+                'For example: "a and b and c" should be "(a and b) and c".'
+            )
         self.left: BoolStmt = t[0][0]
         self.right: BoolStmt = t[0][2]
 
+        if t[0][1] == 'and':
+            self.operation = _and
+        if t[0][1] == 'or':
+            self.operation = _or
+
     def get_value(self, target: str, config_name: str) -> Any:
-        return self.left.get_value(target, config_name) or self.right.get_value(target, config_name)
+        return self.operation(self.left.get_value(target, config_name), self.right.get_value(target, config_name))
 
 
 CAP_WORD = Word(alphas.upper(), nums + alphas.upper() + '_').setParseAction(ChipAttr)
@@ -225,7 +235,6 @@ OR = Keyword('or')
 BOOL_EXPR = infixNotation(
     BOOL_STMT,
     [
-        (AND, 2, opAssoc.LEFT, BoolAnd),
-        (OR, 2, opAssoc.LEFT, BoolOr),
+        (MatchFirst((AND, OR)), 2, opAssoc.LEFT, BoolOrAnd),
     ],
 )

idf_build_apps/manifest/manifest.py

@@ -35,14 +35,21 @@ class IfClause:
     def __init__(self, stmt: str, temporary: bool = False, reason: t.Optional[str] = None) -> None:
         try:
             self.stmt: BoolStmt = BOOL_EXPR.parseString(stmt)[0]
-        except ParseException:
-            raise InvalidIfClause(f'Invalid if statement: {stmt}')
+        except (ParseException, InvalidIfClause) as ex:
+            raise InvalidIfClause(f'Invalid if clause: {stmt}. {ex}')
 
         self.temporary = temporary
         self.reason = reason
 
         if self.temporary is True and not self.reason:
-            raise InvalidIfClause('"reason" must be set when "temporary: true"')
+            raise InvalidIfClause(
+                f'Invalid if clause "{stmt}". '
+                f'"reason" must be set when "temporary: true". '
+                f'For example:\n'
+                f'  - if: {stmt}\n'
+                f'    temporary: true\n'
+                f'    reason: lack of ci runners'
+            )
 
     def get_value(self, target: str, config_name: str) -> t.Any:
         return self.stmt.get_value(target, config_name)
@@ -249,6 +256,7 @@ class Manifest:
 
         rules: t.List[FolderRule] = []
         for path in paths:
+            LOGGER.debug('Loading manifest file %s', path)
             _manifest = cls.from_file(path, root_path=root_path)
 
             for rule in _manifest.rules:
@@ -344,11 +352,14 @@ class Manifest:
                 return x
 
         for folder, sha_value in recorded__rel_folder__sha__dict.items():
+            # removed
             if folder not in self__rel_folder__sha__dict:
                 diff_folders.add(_path(folder))
+            # modified
             elif sha_value != self__rel_folder__sha__dict[folder]:
                 diff_folders.add(_path(folder))
 
+        # new
         for folder in self__rel_folder__sha__dict:
             if folder not in recorded__rel_folder__sha__dict:
                 diff_folders.add(_path(folder))

{idf_build_apps-2.5.0rc2.dist-info → idf_build_apps-2.5.2.dist-info}/METADATA

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

{idf_build_apps-2.5.0rc2.dist-info → idf_build_apps-2.5.2.dist-info}/RECORD

@@ -1,27 +1,27 @@
-idf_build_apps/__init__.py,sha256=qNCNTH1dk1j7euO_o2AVw2usSipP9euNQd2j5_sDuY4,653
+idf_build_apps/__init__.py,sha256=_czizzLpsxKDZG61HbrIaZjdeib-_E4ZqTMOcxbxNxo,650
 idf_build_apps/__main__.py,sha256=8E-5xHm2MlRun0L88XJleNh5U50dpE0Q1nK5KqomA7I,182
 idf_build_apps/app.py,sha256=F-MKOsaz7cJ0H2wsEE4gpO4kkkEdkyFmIZBHDoM2qgs,37359
-idf_build_apps/args.py,sha256=bNVrFsB3V1vhukNGgF3YOL-92GHqQZF3rOkJhqIDDvU,29627
+idf_build_apps/args.py,sha256=L1r7iS3gvV5UDqaZpu9M4Y36LUp-m-BK0rOqfpJjXu4,31918
 idf_build_apps/autocompletions.py,sha256=g-bx0pzXoFKI0VQqftkHyGVWN6MLjuFOdozeuAf45yo,2138
 idf_build_apps/constants.py,sha256=07ve2FtWuLBuc_6LFzbs1XncB1VNi9HJUqGjQQauRNM,3952
-idf_build_apps/finder.py,sha256=kfZaGWJfPUwWAbaOj_W3Fu97SIIFEsv1R_dJucjbFHw,5691
+idf_build_apps/finder.py,sha256=Wv0QYArXmVZZDslLxfPwGgt202s94112AlAHk0s3N1g,5710
 idf_build_apps/log.py,sha256=pyvT7N4MWzGjIXph5mThQCGBiSt53RNPW0WrFfLr0Kw,2650
-idf_build_apps/main.py,sha256=OeWzXkA-68MIv6MmgBN_8XhDJQUvYjJiYxR5zkdQiT0,16094
+idf_build_apps/main.py,sha256=Z_hetbOavgCJZQPaP01_jx57fR1w0DefiFz0J2cCwp0,16498
 idf_build_apps/session_args.py,sha256=2WDTy40IFAc0KQ57HaeBcYj_k10eUXRKkDOWLrFCaHY,2985
 idf_build_apps/utils.py,sha256=s4D8P7QA17XcaCUQ_EoiNOW_VpU3cPQgiZVV9KQ8I30,10171
 idf_build_apps/junit/__init__.py,sha256=IxvdaS6eSXp7kZxRuXqyZyGxuA_A1nOW1jF1HMi8Gns,231
 idf_build_apps/junit/report.py,sha256=T7dVU3Sz5tqjfbcFW7wjsb65PDH6C2HFf73ePJqBhMs,6555
 idf_build_apps/junit/utils.py,sha256=j0PYhFTZjXtTwkENdeL4bFJcX24ktf1CsOOVXz65yNo,1297
 idf_build_apps/manifest/__init__.py,sha256=Q2-cb3ngNjnl6_zWhUfzZZB10f_-Rv2JYNck3Lk7UkQ,133
-idf_build_apps/manifest/if_parser.py,sha256=r0pivV9gmniPn3Ia6sTMbW5tFAKInhOXk-Lfd6GokqE,6381
-idf_build_apps/manifest/manifest.py,sha256=5BekZkLutVrpe6HaUYeBiNqbxkRAFjQpUo9hG1eN1zg,14090
+idf_build_apps/manifest/if_parser.py,sha256=AAEyYPgcBWL2ToCmcvhx3fl8ebYdC5-LMvvDkYtWn8o,6546
+idf_build_apps/manifest/manifest.py,sha256=6F6Nt93eaoBOHlGHZtv2hHT8Zw0HmJf0d_MESlgye6M,14478
 idf_build_apps/manifest/soc_header.py,sha256=PzJ37xFspt5f0AXWvAFNA_avHZA9fMXHBrwDYLi3qEI,4344
 idf_build_apps/vendors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 idf_build_apps/vendors/pydantic_sources.py,sha256=2IN6opo6qjCwaqhERFbgA4PtEwqKaTtEkccy5_fYAT0,4130
 idf_build_apps/yaml/__init__.py,sha256=W-3z5no07RQ6eYKGyOAPA8Z2CLiMPob8DD91I4URjrA,162
 idf_build_apps/yaml/parser.py,sha256=b3LvogO6do-eJPRsYzT-8xk8AT2MnXpLCzQutJqyC7M,2128
-idf_build_apps-2.5.0rc2.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.5.0rc2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.5.0rc2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-idf_build_apps-2.5.0rc2.dist-info/METADATA,sha256=i65JKj_Ul2N4ItjFbehykUlkzxKyjy1hSudWtnSPliw,4613
-idf_build_apps-2.5.0rc2.dist-info/RECORD,,
+idf_build_apps-2.5.2.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.5.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.5.2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+idf_build_apps-2.5.2.dist-info/METADATA,sha256=ZegY4svIIuKIUgCFWJdgiiMIZzhSzLWRbOCiwBAVoKo,4610
+idf_build_apps-2.5.2.dist-info/RECORD,,