idf-build-apps 2.1.1__tar.gz → 2.2.1__tar.gz

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/.git-blame-ignore-revs

@@ -3,3 +3,4 @@ aeeb64c027a3a0db195749fcba206620e7c9060e
 e9d5def7afa2f960da7d7b5863cea95e32898509
 703aec369076479d3d841003f0e193d02df43505
 dd8d3634c410c444029e1640e83a5c2f3280be47
+f146380f3268c8820d2762155863c3aec40411bc

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/.github/workflows/check-pre-commit.yml

@@ -13,6 +13,6 @@ jobs:
       - uses: actions/setup-python@v5
       - id: changed-files
         uses: tj-actions/changed-files@v42
-      - uses: pre-commit/action@v3.0.0
+      - uses: pre-commit/action@v3.0.1
         with:
           extra_args: --files ${{ steps.changed-files.outputs.all_changed_files }}

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/.pre-commit-config.yaml

@@ -6,9 +6,8 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
         args: [ '-f=lf' ]
-      - id: double-quote-string-fixer
   - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.5.4
+    rev: v1.5.5
     hooks:
       - id: insert-license
         files: \.py$
@@ -16,26 +15,15 @@ repos:
           - --license-filepath
           - license_header.txt        # defaults to: LICENSE.txt
           - --use-current-year
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
-    hooks:
-      - id: pyupgrade
-        args: [--py37-plus]
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 23.11.0
-    hooks:
-      - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.1.7'
+    rev: 'v0.2.1'
     hooks:
       - id: ruff
-        args: ['--fix']
+        args: ['--fix', '--preview']
+      - id: ruff-format
+        args: ['--preview']
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.7.1'
+    rev: 'v1.8.0'
     hooks:
       - id: mypy
         args: ['--warn-unused-ignores']

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.2.1 (2024-03-04)
+
+### Fix
+
+- override sdkconfig item keep possible double quotes
+
+## v2.2.0 (2024-02-22)
+
+### Feat
+
+- Support switch-like statements in `depends_components`, and `depends_filepatterns`
+
 ## v2.1.1 (2024-02-02)
 
 ### Fix

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/PKG-INFO

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

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/docs/conf.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os
@@ -15,7 +15,7 @@ import subprocess
 
 project = 'idf-build-apps'
 project_homepage = 'https://github.com/espressif/idf-build-apps'
-copyright = '2023, Espressif Systems (Shanghai) Co., Ltd.'
+copyright = '2023, Espressif Systems (Shanghai) Co., Ltd.'  # noqa: A001
 author = 'Fu Hanxi'
 
 # -- General configuration ---------------------------------------------------
@@ -52,17 +52,15 @@ docs_dir = os.path.dirname(__file__)
 api_dir = os.path.join(docs_dir, 'api')
 if os.path.isdir(api_dir):
     shutil.rmtree(api_dir)
-subprocess.run(
-    [
-        'sphinx-apidoc',
-        os.path.join(docs_dir, '..', 'idf_build_apps'),
-        '-f',
-        '-H',
-        'API Reference',
-        '--no-headings',
-        '-t',
-        '_apidoc_templates',
-        '-o',
-        api_dir,
-    ]
-)
+subprocess.run([
+    'sphinx-apidoc',
+    os.path.join(docs_dir, '..', 'idf_build_apps'),
+    '-f',
+    '-H',
+    'API Reference',
+    '--no-headings',
+    '-t',
+    '_apidoc_templates',
+    '-o',
+    api_dir,
+])

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/docs/manifest.md

@@ -78,80 +78,6 @@ examples/foo/bar:
     - if: IDF_TARGET == "esp32s2"
 ```
 
-## Enhanced YAML Syntax
-
-### Reuse Lists
-
-To reuse the items defined in a list, you can use the `+` and `-` postfixes respectively. The order of calculation is always `+` first, followed by `-`.
-
-#### Array Elements as Strings
-
-The following YAML code demonstrates how to reuse the elements from a list of strings:
-
-```yaml
-.base_depends_components: &base-depends-components
-  depends_components:
-    - esp_hw_support
-    - esp_rom
-    - esp_wifi
-
-examples/wifi/coexist:
-  <<: *base-depends-components
-  depends_components+:
-    - esp_coex
-  depends_components-:
-    - esp_rom
-```
-
-After interpretation, the resulting YAML will be:
-
-```yaml
-examples/wifi/coexist:
-  depends_components:
-    - esp_hw_support
-    - esp_wifi
-    - esp_coex
-```
-
-This means that the `esp_rom` element is removed, and the `esp_coex` element is added to the `depends_components` list.
-
-#### Array Elements as Dictionaries
-
-In addition to reuse elements from a list of strings, you can also perform these operations on a list of dictionaries. The matching is done based on the `if` key. Here's an example:
-
-```yaml
-.base: &base
-  enable:
-    - if: IDF_VERSION == "5.2.0"
-    - if: IDF_VERSION == "5.3.0"
-
-foo:
-  <<: *base
-  enable+:
-    # this if statement dictionary will override the one defined in `&base`
-    - if: IDF_VERSION == "5.2.0"
-      temp: true
-    - if: IDF_VERSION == "5.4.0"
-      reason: bar
-```
-
-After interpretation, the resulting YAML will be:
-
-```yaml
-foo:
-  enable:
-  - if: IDF_VERSION == "5.3.0"
-  - if: IDF_VERSION == "5.2.0"
-    temp: true
-  - if: IDF_VERSION == "5.4.0"
-    reason: bar
-```
-
-In this case, the `enable` list is extended with the new `if` statement and `reason` dictionary.
-It's important to note that the `if` dictionary defined in the `+` postfix will override the earlier one when the `if` statement matches.
-
-This demonstrates how you can use the `+` and `-` postfixes to extend and remove elements from both string and dictionary lists in our YAML.
-
 ## Practical Example
 
 Here's a practical example:
@@ -250,3 +176,101 @@ This app will not be built with the following CLI options:
 Low-level dependencies, are components or files that are used by many others. For example, component `freertos` provides the operating system support for all apps, and ESP-IDF build system related cmake files are also used by all apps. When these items are modified, we definitely need to build and test all the apps.
 
 To disable the build-apps-only-on-related-changes feature, you can use the CLI option `--ignore-app-dependencies-filepatterns`. Once any of the modified files matches the specified patterns, the special rules will be disabled. All apps will be built, no exceptions.
+
+## Enhanced YAML Syntax
+
+### Switch-Like Clauses
+
+The Switch-Like clauses are supported by two keywords in the YAML file: `depends_components` and `depends_filepatterns`.
+
+#### Operands
+
+Switch cases have two main components: the `if` clause and the `default` clause. Just like a switch statement in c language, The first matched `if` clause will be applied. If no `if` clause matched, the `default` clause will be applied. Here's an example:
+
+```yaml
+test1:
+  depends_components:
+    - if: IDF_VERSION == "{IDF_VERSION}"
+      content: [ "component_1" ]
+    - if: CONFIG_NAME == "AWESOME_CONFIG"
+      content: [ "component_2" ]
+    - default: [ "component_3", "component_4" ]
+```
+
+`default` clause is optional. If you don't specify any `default` clause, it will return an empty array.
+
+#### Limitations
+
+You cannot combine a list and a switch in one node.
+
+### Reuse Lists
+
+To reuse the items defined in a list, you can use the `+` and `-` postfixes respectively. The order of calculation is always `+` first, followed by `-`.
+
+#### Array Elements as Strings
+
+The following YAML code demonstrates how to reuse the elements from a list of strings:
+
+```yaml
+.base_depends_components: &base-depends-components
+  depends_components:
+    - esp_hw_support
+    - esp_rom
+    - esp_wifi
+
+examples/wifi/coexist:
+  <<: *base-depends-components
+  depends_components+:
+    - esp_coex
+  depends_components-:
+    - esp_rom
+```
+
+After interpretation, the resulting YAML will be:
+
+```yaml
+examples/wifi/coexist:
+  depends_components:
+    - esp_hw_support
+    - esp_wifi
+    - esp_coex
+```
+
+This means that the `esp_rom` element is removed, and the `esp_coex` element is added to the `depends_components` list.
+
+#### Array Elements as Dictionaries
+
+In addition to reuse elements from a list of strings, you can also perform these operations on a list of dictionaries. The matching is done based on the `if` key. Here's an example:
+
+```yaml
+.base: &base
+  enable:
+    - if: IDF_VERSION == "5.2.0"
+    - if: IDF_VERSION == "5.3.0"
+
+foo:
+  <<: *base
+  enable+:
+    # this if statement dictionary will override the one defined in `&base`
+    - if: IDF_VERSION == "5.2.0"
+      temp: true
+    - if: IDF_VERSION == "5.4.0"
+      reason: bar
+```
+
+After interpretation, the resulting YAML will be:
+
+```yaml
+foo:
+  enable:
+  - if: IDF_VERSION == "5.3.0"
+  - if: IDF_VERSION == "5.2.0"
+    temp: true
+  - if: IDF_VERSION == "5.4.0"
+    reason: bar
+```
+
+In this case, the `enable` list is extended with the new `if` statement and `reason` dictionary.
+It's important to note that the `if` dictionary defined in the `+` postfix will override the earlier one when the `if` statement matches.
+
+This demonstrates how you can use the `+` and `-` postfixes to extend and remove elements from both string and dictionary lists in our YAML.

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/idf_build_apps/__init__.py

@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.1.1'
+__version__ = '2.2.1'
 
 from .session_args import (
     SessionArgs,
@@ -36,8 +36,8 @@ __all__ = [
     'AppDeserializer',
     'CMakeApp',
     'MakeApp',
-    'find_apps',
     'build_apps',
+    'find_apps',
     'json_to_app',
     'setup_logging',
 ]

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/idf_build_apps/app.py

@@ -88,7 +88,7 @@ class App(BaseModel):
     IDF_VERSION_PLACEHOLDER: t.ClassVar[str] = '@v'  # replace it with the IDF version
     INDEX_PLACEHOLDER: t.ClassVar[str] = '@i'  # replace it with the build index (while build_apps)
 
-    SDKCONFIG_LINE_REGEX: t.ClassVar[t.Pattern] = re.compile(r"^([^=]+)=\"?([^\"\n]*)\"?\n*$")
+    SDKCONFIG_LINE_REGEX: t.ClassVar[t.Pattern] = re.compile(r'^([^=]+)=\"?([^\"\n]*)\"?\n*$')
 
     # could be assigned later, used for filtering out apps by supported_targets
     MANIFEST: t.ClassVar[t.Optional[Manifest]] = None
@@ -151,12 +151,10 @@ class App(BaseModel):
         size_json_filename: t.Optional[str] = None,
         **kwargs: t.Any,
     ) -> None:
-        kwargs.update(
-            {
-                'app_dir': app_dir,
-                'target': target,
-            }
-        )
+        kwargs.update({
+            'app_dir': app_dir,
+            'target': target,
+        })
         super().__init__(**kwargs)
 
         # These internal variables store the paths with environment variables and placeholders;
@@ -169,14 +167,12 @@ class App(BaseModel):
         self._is_build_log_path_temp = not bool(build_log_filename)
 
         # pass all parameters to initialize hook method
-        kwargs.update(
-            {
-                'work_dir': self._work_dir,
-                'build_dir': self._build_dir,
-                'build_log_filename': build_log_filename,
-                'size_json_filename': size_json_filename,
-            }
-        )
+        kwargs.update({
+            'work_dir': self._work_dir,
+            'build_dir': self._build_dir,
+            'build_log_filename': build_log_filename,
+            'size_json_filename': size_json_filename,
+        })
         self._kwargs = kwargs
         self._initialize_hook(**kwargs)
 
@@ -240,12 +236,10 @@ class App(BaseModel):
         return [DEFAULT_SDKCONFIG]
 
     @t.overload
-    def _expand(self, path: None) -> None:
-        ...
+    def _expand(self, path: None) -> None: ...
 
     @t.overload
-    def _expand(self, path: str) -> str:
-        ...
+    def _expand(self, path: str) -> str: ...
 
     def _expand(self, path):
         """
@@ -437,14 +431,18 @@ class App(BaseModel):
     @property
     def depends_components(self) -> t.List[str]:
         if self.MANIFEST:
-            return self.MANIFEST.depends_components(self.app_dir)
+            return self.MANIFEST.depends_components(
+                self.app_dir, self.sdkconfig_files_defined_idf_target, self.config_name
+            )
 
         return []
 
     @property
     def depends_filepatterns(self) -> t.List[str]:
         if self.MANIFEST:
-            return self.MANIFEST.depends_filepatterns(self.app_dir)
+            return self.MANIFEST.depends_filepatterns(
+                self.app_dir, self.sdkconfig_files_defined_idf_target, self.config_name
+            )
 
         return []
 
@@ -618,10 +616,10 @@ class App(BaseModel):
     def _build(
         self,
         *,
-        manifest_rootpath: t.Optional[str] = None,
-        modified_components: t.Optional[t.List[str]] = None,
-        modified_files: t.Optional[t.List[str]] = None,
-        check_app_dependencies: bool = False,
+        manifest_rootpath: t.Optional[str] = None,  # noqa: ARG002
+        modified_components: t.Optional[t.List[str]] = None,  # noqa: ARG002
+        modified_files: t.Optional[t.List[str]] = None,  # noqa: ARG002
+        check_app_dependencies: bool = False,  # noqa: ARG002
     ) -> None:
         self._build_stage = BuildStage.BUILD
 
@@ -654,14 +652,12 @@ class App(BaseModel):
         else:
             with open(self.size_json_path, 'w') as fw:
                 subprocess_run(
-                    (
-                        [
-                            sys.executable,
-                            str(IDF_SIZE_PY),
-                            '--json',
-                            map_file,
-                        ]
-                    ),
+                    ([
+                        sys.executable,
+                        str(IDF_SIZE_PY),
+                        '--json',
+                        map_file,
+                    ]),
                     log_terminal=False,
                     log_fs=fw,
                     check=True,
@@ -789,7 +785,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', *FolderRule.DEFAULT_BUILD_TARGETS]
 
     def _build(
         self,
@@ -910,7 +906,7 @@ class CMakeApp(App):
 
         if modified_components is not None and check_app_dependencies and self.build_status == BuildStatus.UNKNOWN:
             subprocess_run(
-                common_args + ['reconfigure'],
+                [*common_args, 'reconfigure'],
                 log_terminal=self._is_build_log_path_temp,
                 log_fs=self.build_log_path,
                 check=True,

idf_build_apps-2.2.1/idf_build_apps/junit/__init__.py

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+from .report import (
+    TestCase,
+    TestReport,
+    TestSuite,
+)
+
+__all__ = ['TestCase', 'TestReport', 'TestSuite']

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/idf_build_apps/junit/report.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 """
@@ -39,7 +39,9 @@ import typing as t
 from datetime import (
     datetime,
 )
-from xml.etree import ElementTree as ET
+from xml.etree import (
+    ElementTree,
+)
 from xml.sax.saxutils import (
     escape,
 )
@@ -118,8 +120,8 @@ class TestCase:
     def is_error(self) -> bool:
         return self.error_reason is not None
 
-    def to_xml_elem(self) -> ET.Element:
-        elem = ET.Element(
+    def to_xml_elem(self) -> ElementTree.Element:
+        elem = ElementTree.Element(
             'testcase',
             {
                 'name': self.name,
@@ -128,11 +130,11 @@ class TestCase:
             },
         )
         if self.error_reason:
-            ET.SubElement(elem, 'error', {'message': escape(self.error_reason)})
+            ElementTree.SubElement(elem, 'error', {'message': escape(self.error_reason)})
         elif self.failure_reason:
-            ET.SubElement(elem, 'failure', {'message': escape(self.failure_reason)})
+            ElementTree.SubElement(elem, 'failure', {'message': escape(self.failure_reason)})
         elif self.skipped_reason:
-            ET.SubElement(elem, 'skipped', {'message': escape(self.skipped_reason)})
+            ElementTree.SubElement(elem, 'skipped', {'message': escape(self.skipped_reason)})
 
         if self.properties:
             for k, v in self.properties.items():
@@ -171,8 +173,8 @@ class TestSuite:
 
         self.duration_sec += test_case.duration_sec
 
-    def to_xml_elem(self) -> ET.Element:
-        elem = ET.Element(
+    def to_xml_elem(self) -> ElementTree.Element:
+        elem = ElementTree.Element(
             'testsuite',
             {
                 'name': self.name,
@@ -199,10 +201,10 @@ class TestReport:
         self.filepath = filepath
 
     def create_test_report(self) -> None:
-        xml = ET.Element('testsuites')
+        xml = ElementTree.Element('testsuites')
 
         for test_suite in self.test_suites:
             xml.append(test_suite.to_xml_elem())
 
-        ET.ElementTree(xml).write(self.filepath, encoding='utf-8')
+        ElementTree.ElementTree(xml).write(self.filepath, encoding='utf-8')
         LOGGER.info('Test report written to %s', self.filepath)

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/idf_build_apps/log.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import logging
@@ -51,7 +51,7 @@ class ColoredFormatter(logging.Formatter):
 
         if record.levelno in [logging.WARNING, logging.ERROR]:
             record.msg = '>>> ' + str(record.msg)
-        elif record.levelno in [logging.CRITICAL]:
+        elif record.levelno == logging.CRITICAL:
             record.msg = '!!! ' + str(record.msg)
 
         formatter = logging.Formatter(log_fmt, datefmt=self.datefmt)

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/idf_build_apps/main.py

@@ -351,14 +351,12 @@ def build_apps(
                 if os.path.isfile(app.size_json_path):
                     with open(build_apps_args.collect_size_info, 'a') as fw:
                         fw.write(
-                            json.dumps(
-                                {
-                                    'app_name': app.name,
-                                    'config_name': app.config_name,
-                                    'target': app.target,
-                                    'path': app.size_json_path,
-                                }
-                            )
+                            json.dumps({
+                                'app_name': app.name,
+                                'config_name': app.config_name,
+                                'target': app.target,
+                                'path': app.size_json_path,
+                            })
                             + '\n'
                         )
                     LOGGER.debug('Recorded size info file path in %s', build_apps_args.collect_size_info)
@@ -488,7 +486,7 @@ def get_parser() -> argparse.ArgumentParser:
         type=str,
         help='The --override-sdkconfig-items option is a comma-separated list '
         'that permits the overriding of specific configuration items defined '
-        'in the SDK\'s sdkconfig file and Kconfig using a command-line argument. '
+        "in the SDK's sdkconfig file and Kconfig using a command-line argument. "
         'The sdkconfig items specified here override the same sdkconfig '
         'item defined in the --override-sdkconfig-files, if exists.',
     )
@@ -669,7 +667,7 @@ def validate_args(parser: argparse.ArgumentParser, args: argparse.Namespace) ->
     if not args.target:
         raise InvalidCommand(
             'Must specify current build target with CLI option "-t <target>" or "--target <target>". '
-            '(choices: [{}]'.format(','.join(ALL_TARGETS + ['all']))
+            '(choices: [{}]'.format(','.join([*ALL_TARGETS, 'all']))
         )
 
     default_build_targets = []
@@ -677,8 +675,8 @@ def validate_args(parser: argparse.ArgumentParser, args: argparse.Namespace) ->
         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)
+                    f'Unrecognizable target {target} specified with "--default-build-targets". '
+                    f'Current ESP-IDF available targets: {ALL_TARGETS}'
                 )
 
             if target not in default_build_targets:

{idf_build_apps-2.1.1 → idf_build_apps-2.2.1}/idf_build_apps/manifest/if_parser.py

@@ -1,6 +1,7 @@
-# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
+import operator
 import os
 from ast import (
     literal_eval,
@@ -113,7 +114,7 @@ class Integer(Stmt):
     def __init__(self, t: ParseResults):
         self.expr: str = t[0]
 
-    def get_value(self, target: str, config_name: str) -> Any:
+    def get_value(self, target: str, config_name: str) -> Any:  # noqa: ARG002
         return literal_eval(self.expr)
 
 
@@ -121,7 +122,7 @@ class String(Stmt):
     def __init__(self, t: ParseResults):
         self.expr: str = t[0]
 
-    def get_value(self, target: str, config_name: str) -> Any:
+    def get_value(self, target: str, config_name: str) -> Any:  # noqa: ARG002
         return literal_eval(f'"{self.expr}"')  # double quotes is swallowed by QuotedString
 
 
@@ -135,12 +136,12 @@ class List_(Stmt):
 
 class BoolStmt(Stmt):
     _OP_DICT = {
-        '==': lambda x, y: x == y,
-        '!=': lambda x, y: x != y,
-        '>': lambda x, y: x > y,
-        '>=': lambda x, y: x >= y,
-        '<': lambda x, y: x < y,
-        '<=': lambda x, y: x <= y,
+        '==': operator.eq,
+        '!=': operator.ne,
+        '>': operator.gt,
+        '>=': operator.ge,
+        '<': operator.lt,
+        '<=': operator.le,
         'not in': lambda x, y: x not in y,
         'in': lambda x, y: x in y,
     }