idf-build-apps 2.4.2__py3-none-any.whl → 2.5.0rc0__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.4.2'
+__version__ = '2.5.0rc0'
 
 from .session_args import (
     SessionArgs,

idf_build_apps/app.py

@@ -26,9 +26,6 @@ from pydantic import (
 from . import (
     SESSION_ARGS,
 )
-from .build_apps_args import (
-    BuildAppsArgs,
-)
 from .constants import (
     DEFAULT_SDKCONFIG,
     IDF_PY,
@@ -49,6 +46,7 @@ from .manifest.manifest import (
 from .utils import (
     BaseModel,
     BuildError,
+    Literal,
     files_matches_patterns,
     find_first_match,
     rmdir,
@@ -57,15 +55,6 @@ from .utils import (
     to_list,
 )
 
-if sys.version_info < (3, 8):
-    from typing_extensions import (
-        Literal,
-    )
-else:
-    from typing import (
-        Literal,
-    )
-
 
 class _AppBuildStageFilter(logging.Filter):
     def __init__(self, *args, app, **kwargs):
@@ -85,6 +74,7 @@ class App(BaseModel):
     NAME_PLACEHOLDER: t.ClassVar[str] = '@n'  # replace it with self.name
     FULL_NAME_PLACEHOLDER: t.ClassVar[str] = '@f'  # replace it with escaped self.app_dir
     IDF_VERSION_PLACEHOLDER: t.ClassVar[str] = '@v'  # replace it with the IDF version
+    PARALLEL_INDEX_PLACEHOLDER: t.ClassVar[str] = '@p'  # replace it with the parallel index
     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*$')
@@ -125,7 +115,7 @@ class App(BaseModel):
     copy_sdkconfig: bool = False
 
     # build_apps() related
-    build_apps_args: t.Optional[BuildAppsArgs] = None
+    parallel_index: t.Optional[int] = None  # used for expand
     index: t.Optional[int] = None
 
     # build status related
@@ -254,8 +244,8 @@ class App(BaseModel):
 
         if self.index is not None:
             path = path.replace(self.INDEX_PLACEHOLDER, str(self.index))
-        if self.build_apps_args:
-            path = self.build_apps_args.expand(path)
+        if self.parallel_index:
+            path = path.replace(self.PARALLEL_INDEX_PLACEHOLDER, str(self.parallel_index))
         path = path.replace(
             self.IDF_VERSION_PLACEHOLDER, f'{IDF_VERSION_MAJOR}_{IDF_VERSION_MINOR}_{IDF_VERSION_PATCH}'
         )
@@ -320,7 +310,7 @@ class App(BaseModel):
             return os.path.join(self.build_path, self.build_log_filename)
 
         # use a temp file if build log path is not specified
-        return os.path.join(self.build_path, f'.temp.build.{hash(self)}.log')
+        return os.path.join(self.build_path, '.temp.build.log')
 
     @computed_field  # type: ignore
     @property
@@ -569,6 +559,8 @@ class App(BaseModel):
 
         self._post_build()
 
+        self._finalize()
+
     def _post_build(self) -> None:
         """Post build actions for failed/success builds"""
         if self.build_status not in (
@@ -615,14 +607,7 @@ class App(BaseModel):
                         self._logger.warning('%s', line)
                         has_unignored_warning = True
 
-        # correct build status for originally successful builds
-        if self.build_status == BuildStatus.SUCCESS:
-            if self.check_warnings and has_unignored_warning:
-                self.build_status = BuildStatus.FAILED
-                self.build_comment = 'build succeeded with warnings'
-            elif has_unignored_warning:
-                self.build_comment = 'build succeeded with warnings'
-
+        # for failed builds, print last few lines to help debug
         if self.build_status == BuildStatus.FAILED:
             # print last few lines to help debug
             self._logger.error(
@@ -632,10 +617,21 @@ class App(BaseModel):
             )
             for line in lines[-self.LOG_DEBUG_LINES :]:
                 self._logger.error('%s', line)
+        # correct build status for originally successful builds
+        elif self.build_status == BuildStatus.SUCCESS:
+            if self.check_warnings and has_unignored_warning:
+                self.build_status = BuildStatus.FAILED
+                self.build_comment = 'build succeeded with warnings'
+            elif has_unignored_warning:
+                self.build_comment = 'build succeeded with warnings'
 
+    def _finalize(self) -> None:
+        """
+        Actions for real success builds
+        """
+        if self.build_status != BuildStatus.SUCCESS:
             return
 
-        # Actions for real success builds
         # remove temp log file
         if self._is_build_log_path_temp:
             os.unlink(self.build_log_path)
@@ -751,9 +747,11 @@ class App(BaseModel):
 
         return False
 
-    def _check_should_build(
+    def check_should_build(
         self,
+        *,
         manifest_rootpath: t.Optional[str] = None,
+        modified_manifest_rules_folders: t.Optional[t.Set[str]] = None,
         check_app_dependencies: bool = False,
         modified_components: t.Optional[t.List[str]] = None,
         modified_files: t.Optional[t.List[str]] = None,
@@ -766,6 +764,16 @@ class App(BaseModel):
             self._checked_should_build = True
             return
 
+        if (
+            self.MANIFEST
+            and modified_manifest_rules_folders
+            and self.MANIFEST.most_suitable_rule(self.app_dir).folder in modified_manifest_rules_folders
+        ):
+            self.build_status = BuildStatus.SHOULD_BE_BUILT
+            self.build_comment = 'current build modifies the related manifest rules'
+            self._checked_should_build = True
+            return
+
         if self.is_modified(modified_files):
             self.build_status = BuildStatus.SHOULD_BE_BUILT
             self.build_comment = 'current build modifies this app'
@@ -925,7 +933,7 @@ class CMakeApp(App):
         )
 
         if not self._checked_should_build:
-            self._check_should_build(
+            self.check_should_build(
                 manifest_rootpath=manifest_rootpath,
                 modified_components=modified_components,
                 modified_files=modified_files,