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

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/.pre-commit-config.yaml

@@ -16,8 +16,8 @@ repos:
           - license_header.txt        # defaults to: LICENSE.txt
           - --use-current-year
         exclude: 'idf_build_apps/vendors/'
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.9.5'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.11.5'
     hooks:
       - id: ruff
         args: ['--fix']

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

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.9.0 (2025-04-16)
+
+### Feat
+
+- record manifest_path that introduced the folder rule
+- support env var expansion in some fields
+
+## v2.8.1 (2025-03-04)
+
+### Fix
+
+- --override-sdkconfig-files not working
+
 ## v2.8.0 (2025-02-20)
 
 ### Feat

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

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

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/docs/conf_common.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/docs/en/conf.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/docs/en/explanations/config_rules.rst

@@ -146,6 +146,12 @@ When building the project for the ESP32 target, `sdkconfig files`_ with the ``.e
       B --> C --> D -- "populates sdkconfig file, then build" --> F
       B --> E -- "populates sdkconfig file, then build" --> G
 
+.. warning::
+
+   Standalone target-specific sdkconfig files are ignored. To make the target-specific sdkconfig files effective, the original sdkconfig file, (without the target name suffix) must be present.
+
+   For example, ``sdkconfig.ci.foo.esp32`` will only be taken into account while building with target ``esp32`` if ``sdkconfig.ci.foo`` is also present.
+
 Override In CLI
 ===============
 

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/docs/en/references/config_file.rst

@@ -97,6 +97,18 @@ This indicates that in the configuration file, you should specify it with the na
        "bar",
    ]
 
+******************************
+ Expand Environment Variables
+******************************
+
+Some configuration options support environment variables. You can use environment variables in the configuration file by using the syntax ``${VAR_NAME}`` or ``$VAR_NAME``. Undeclared environment variables will be replaced with an empty string. For exmaple:
+
+.. code:: toml
+
+   collect_app_info_filename = "app_info_${CI_JOB_NAME_SLUG}"
+
+when the environment variable ``CI_JOB_NAME_SLUG`` is set to ``my_job``, the ``collect_app_info_filename`` will be expanded to ``app_info_my_job``. When the environment variable is not set, the value will be ``app_info_``.
+
 *************************
  CLI Argument Precedence
 *************************

{idf_build_apps-2.8.0 → idf_build_apps-2.9.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.8.0'
+__version__ = '2.9.0'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/__main__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .main import (

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

@@ -14,6 +14,7 @@ from copy import deepcopy
 from dataclasses import dataclass
 from io import TextIOWrapper
 from pathlib import Path
+from string import Template
 from typing import Any
 
 from pydantic import AliasChoices, Field, computed_field, field_validator
@@ -112,6 +113,29 @@ def get_meta(f: FieldInfo) -> t.Optional[FieldMetadata]:
     return None
 
 
+def expand_vars(v: t.Optional[str]) -> t.Optional[str]:
+    """
+    Expand environment variables in the string. If the variable is not found, use an empty string.
+
+    :param v: string to expand
+    :return: expanded string or None if the input is None
+    """
+    if v is None:
+        return None
+
+    unknown_vars: t.Dict[str, str] = dict()
+    while True:
+        try:
+            v = Template(v).substitute(os.environ, **unknown_vars)
+        except KeyError as e:
+            LOGGER.debug('Environment variable %s not found. use empty string', e)
+            unknown_vars[e.args[0]] = ''
+        else:
+            break
+
+    return v
+
+
 class BaseArguments(BaseSettings):
     """Base settings class for all settings classes"""
 
@@ -154,7 +178,7 @@ class BaseArguments(BaseSettings):
                     if method == ValidateMethod.TO_LIST:
                         v = to_list(v)
                     elif method == ValidateMethod.EXPAND_VARS:
-                        v = os.path.expandvars(v)
+                        v = expand_vars(v)
                     else:
                         raise NotImplementedError(f'Unknown validate method: {method}')
 
@@ -566,7 +590,7 @@ class FindBuildArguments(DependencyDrivenBuildArguments):
             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:
+        if self.override_sdkconfig_files or self.override_sdkconfig_items:
             SESSION_ARGS.set(self)
 
 
@@ -689,9 +713,10 @@ class BuildArguments(FindBuildArguments):
         FieldMetadata(
             deprecates={'collect_size_info': {}},
             hidden=True,
+            validate_method=[ValidateMethod.EXPAND_VARS],
         ),
         description='Record size json filepath of the built apps to the specified file. '
-        'Each line is a json string. Can expand placeholders @p',
+        'Each line is a json string. Can expand placeholders @p. Support environment variables.',
         validation_alias=AliasChoices('collect_size_info_filename', 'collect_size_info'),
         default=None,  # type: ignore
         exclude=True,  # computed field is used
@@ -700,9 +725,10 @@ class BuildArguments(FindBuildArguments):
         FieldMetadata(
             deprecates={'collect_app_info': {}},
             hidden=True,
+            validate_method=[ValidateMethod.EXPAND_VARS],
         ),
         description='Record serialized app model of the built apps to the specified file. '
-        'Each line is a json string. Can expand placeholders @p',
+        'Each line is a json string. Can expand placeholders @p. Support environment variables.',
         validation_alias=AliasChoices('collect_app_info_filename', 'collect_app_info'),
         default=None,  # type: ignore
         exclude=True,  # computed field is used
@@ -711,8 +737,10 @@ class BuildArguments(FindBuildArguments):
         FieldMetadata(
             deprecates={'junitxml': {}},
             hidden=True,
+            validate_method=[ValidateMethod.EXPAND_VARS],
         ),
-        description='Path to the junitxml file to record the build results. Can expand placeholder @p',
+        description='Path to the junitxml file to record the build results. Can expand placeholder @p. '
+        'Support environment variables.',
         validation_alias=AliasChoices('junitxml_filename', 'junitxml'),
         default=None,  # type: ignore
         exclude=True,  # computed field is used

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/autocompletions.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/finder.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import logging

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/junit/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .report import (

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/junit/utils.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import os

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/manifest/manifest.py

@@ -89,7 +89,10 @@ class FolderRule:
         disable_test: t.Optional[t.List[t.Dict[str, t.Any]]] = None,
         depends_components: t.Optional[t.List[t.Union[str, t.Dict[str, t.Any]]]] = None,
         depends_filepatterns: t.Optional[t.List[t.Union[str, t.Dict[str, t.Any]]]] = None,
+        manifest_filepath: t.Optional[str] = None,
     ) -> None:
+        self._manifest_filepath = manifest_filepath
+
         self.folder = os.path.abspath(folder)
 
         def _clause_to_if_clause(clause: t.Dict[str, t.Any]) -> IfClause:
@@ -168,6 +171,10 @@ class FolderRule:
     def __repr__(self) -> str:
         return f'FolderRule({self.folder})'
 
+    @property
+    def by_manifest_file(self) -> t.Optional[str]:
+        return self._manifest_filepath
+
     def _enable_build(self, target: str, config_name: str) -> bool:
         if self.enable:
             res = False
@@ -309,7 +316,7 @@ class Manifest:
                     LOGGER.warning(msg)
 
             try:
-                rules.append(FolderRule(folder, **folder_rule if folder_rule else {}))
+                rules.append(FolderRule(folder, **folder_rule if folder_rule else {}, manifest_filepath=str(path)))
             except InvalidIfClause as e:
                 raise InvalidManifest(f'Invalid manifest file {path}: {e}')
 

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/session_args.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import logging

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/yaml/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 from .parser import (

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/idf_build_apps/yaml/parser.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 import typing as t

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

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

{idf_build_apps-2.8.0 → idf_build_apps-2.9.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.8.0',
+      version='2.9.0',
       description='Tools for building ESP-IDF related apps.',
       author=None,
       author_email='Fu Hanxi <fuhanxi@espressif.com>',

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

@@ -15,6 +15,7 @@ from idf_build_apps.args import (
     DependencyDrivenBuildArguments,
     FindArguments,
     FindBuildArguments,
+    expand_vars,
 )
 from idf_build_apps.constants import IDF_BUILD_APPS_TOML_FN, PREVIEW_TARGETS, SUPPORTED_TARGETS
 from idf_build_apps.main import main
@@ -408,3 +409,12 @@ dry_run = false
         assert test_suite.attrib['errors'] == '0'
         assert test_suite.attrib['skipped'] == '1'
         assert test_suite.findall('testcase')[0].attrib['name'] == 'bar/build'
+
+
+def test_expand_vars(monkeypatch):
+    assert expand_vars('Value is $TEST_VAR') == 'Value is '
+    monkeypatch.setenv('TEST_VAR', 'test_value')
+    assert expand_vars('Value is $TEST_VAR') == 'Value is test_value'
+    assert expand_vars('Value is $TEST_VAR and $NON_EXISTING_VAR') == 'Value is test_value and '
+    assert expand_vars('No variables here') == 'No variables here'
+    assert expand_vars('') == ''

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/tests/test_cmd.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 import os
 import sys

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/tests/test_finder.py

@@ -1,7 +1,6 @@
 # SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
-import logging
 import os
 import tempfile
 from pathlib import (
@@ -443,7 +442,6 @@ class TestFindWithSdkconfigFiles:
             if not os.path.isfile(default_sdkconfig_path):
                 with open(default_sdkconfig_path, 'w') as fw:
                     fw.write('CONFIG_IDF_TARGET="linux"')
-                    logging.info('Created temp %s %s', DEFAULT_SDKCONFIG, default_sdkconfig_path)
                 _app = app
                 _default_sdkconfig_path = default_sdkconfig_path
                 break
@@ -456,7 +454,6 @@ class TestFindWithSdkconfigFiles:
         finally:
             try:
                 os.remove(_default_sdkconfig_path)
-                logging.info('Removed temp %s %s', DEFAULT_SDKCONFIG, _default_sdkconfig_path)
             except:  # noqa
                 pass
 

{idf_build_apps-2.8.0 → idf_build_apps-2.9.0}/tests/test_manifest.py

@@ -535,6 +535,28 @@ baz:
     }
 
 
+def test_folder_rule_introduced_by(tmp_path):
+    yaml_file = tmp_path / 'test.yml'
+    yaml_file.write_text(
+        """
+foo:
+  enable:
+    - if: IDF_TARGET == "esp32"
+    - if: IDF_TARGET == "esp32c3"
+bar:
+  enable:
+    - if: IDF_TARGET == "esp32"
+baz:
+  enable:
+    - if: IDF_TARGET == "esp32"
+""",
+        encoding='utf8',
+    )
+
+    manifest = Manifest.from_file(yaml_file)
+    assert manifest.most_suitable_rule('baz').by_manifest_file == str(yaml_file)
+
+
 class TestIfParser:
     def test_invalid_if_statement(self):
         statement = '1'

idf_build_apps-2.8.0/.github/workflows/check-pre-commit.yml

@@ -1,18 +0,0 @@
-name: pre-commit check
-
-on:
-  pull_request:
-
-jobs:
-  pre-commit:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v5
-      - id: changed-files
-        uses: tj-actions/changed-files@v45
-      - uses: pre-commit/action@v3.0.1
-        with:
-          extra_args: --files ${{ steps.changed-files.outputs.all_changed_files }}