idf-build-apps 2.4.2__py3-none-any.whl → 2.5.0rc0__py3-none-any.whl

idf_build_apps/manifest/manifest.py

@@ -1,10 +1,10 @@
 # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
 import logging
 import os
+import pickle
 import typing as t
-import warnings
+from hashlib import sha512
 
 from pyparsing import (
     ParseException,
@@ -17,6 +17,7 @@ from ..constants import (
 from ..utils import (
     InvalidIfClause,
     InvalidManifest,
+    to_absolute_path,
 )
 from ..yaml import (
     parse,
@@ -127,7 +128,26 @@ class FolderRule:
         self.depends_filepatterns = _clause_to_switch_or_list(depends_filepatterns)
 
     def __hash__(self) -> int:
-        return hash(self.folder)
+        return hash(self.sha)
+
+    @property
+    def sha(self) -> str:
+        """
+        SHA of the FolderRule instance
+
+        :return: SHA value
+        """
+        sha = sha512()
+        for obj in [
+            self.enable,
+            self.disable,
+            self.disable_test,
+            self.depends_components,
+            self.depends_filepatterns,
+        ]:
+            sha.update(pickle.dumps(obj))
+
+        return sha.hexdigest()
 
     def __repr__(self) -> str:
         return f'FolderRule({self.folder})'
@@ -207,23 +227,28 @@ class DefaultRule(FolderRule):
 
 class Manifest:
     # could be reassigned later
-    ROOTPATH = os.curdir
     CHECK_MANIFEST_RULES = False
 
-    def __init__(
-        self,
-        rules: t.Iterable[FolderRule],
-    ) -> None:
+    def __init__(self, rules: t.Iterable[FolderRule], *, root_path: str = os.curdir) -> None:
         self.rules = sorted(rules, key=lambda x: x.folder)
 
+        self._root_path = to_absolute_path(root_path)
+
     @classmethod
-    def from_files(cls, paths: t.List[str]) -> 'Manifest':
-        # folder, defined_at dict
+    def from_files(cls, paths: t.Iterable[str], *, root_path: str = os.curdir) -> 'Manifest':
+        """
+        Create a Manifest instance from multiple manifest files
+
+        :param paths: manifest file paths
+        :param root_path: root path for relative paths in manifest files
+        :return: Manifest instance
+        """
+        # folder, defined as dict
         _known_folders: t.Dict[str, str] = dict()
 
         rules: t.List[FolderRule] = []
         for path in paths:
-            _manifest = cls.from_file(path)
+            _manifest = cls.from_file(path, root_path=root_path)
 
             for rule in _manifest.rules:
                 if rule.folder in _known_folders:
@@ -231,43 +256,106 @@ class Manifest:
                     if cls.CHECK_MANIFEST_RULES:
                         raise InvalidManifest(msg)
                     else:
-                        warnings.warn(msg)
+                        LOGGER.warning(msg)
 
                 _known_folders[rule.folder] = path
 
             rules.extend(_manifest.rules)
 
-        return Manifest(rules)
+        return Manifest(rules, root_path=root_path)
 
     @classmethod
-    def from_file(cls, path: str) -> 'Manifest':
+    def from_file(cls, path: str, *, root_path: str = os.curdir) -> 'Manifest':
+        """
+        Create a Manifest instance from a manifest file
+
+        :param path: path to the manifest file
+        :param root_path: root path for relative paths in manifest file
+        :return: Manifest instance
+        """
         manifest_dict = parse(path)
 
         rules: t.List[FolderRule] = []
         for folder, folder_rule in manifest_dict.items():
-            # not a folder, but a anchor
+            # not a folder, but an anchor
             if folder.startswith('.'):
                 continue
 
             if not os.path.isabs(folder):
-                folder = os.path.join(cls.ROOTPATH, folder)
+                folder = os.path.join(root_path, folder)
 
             if not os.path.exists(folder):
                 msg = f'Folder "{folder}" does not exist. Please check your manifest file {path}'
                 if cls.CHECK_MANIFEST_RULES:
                     raise InvalidManifest(msg)
                 else:
-                    warnings.warn(msg)
+                    LOGGER.warning(msg)
 
             try:
                 rules.append(FolderRule(folder, **folder_rule if folder_rule else {}))
             except InvalidIfClause as e:
                 raise InvalidManifest(f'Invalid manifest file {path}: {e}')
 
-        return Manifest(rules)
+        return Manifest(rules, root_path=root_path)
+
+    def dump_sha_values(self, sha_filepath: str) -> None:
+        """
+        Dump the (relative path of the folder, SHA of the FolderRule instance) pairs
+        for all rules to the file in format: ``<relative_path>:<SHA>``
+
+        :param sha_filepath: output file path
+        :return: None
+        """
+        with open(sha_filepath, 'w') as fw:
+            for rule in self.rules:
+                fw.write(f'{os.path.relpath(rule.folder, self._root_path)}:{rule.sha}\n')
+
+    def diff_sha_with_filepath(self, sha_filepath: str, use_abspath: bool = False) -> t.Set[str]:
+        """
+        Compare the SHA recorded in the file with the current Manifest instance.
+
+        :param sha_filepath: dumped SHA file path
+        :param use_abspath: whether to return the absolute path of the folders
+        :return: Set of folders that have different SHA values
+        """
+        recorded__rel_folder__sha__dict = dict()
+        with open(sha_filepath) as fr:
+            for line in fr:
+                line = line.strip()
+                if line:
+                    try:
+                        folder, sha_value = line.strip().rsplit(':', maxsplit=1)
+                    except ValueError:
+                        raise InvalidManifest(f'Invalid line in SHA file: {line}. Expected format: <folder>:<SHA>')
+
+                    recorded__rel_folder__sha__dict[folder] = sha_value
+
+        self__rel_folder__sha__dict = {os.path.relpath(rule.folder, self._root_path): rule.sha for rule in self.rules}
+
+        diff_folders = set()
+        if use_abspath:
+
+            def _path(x):
+                return os.path.join(self._root_path, x)
+        else:
+
+            def _path(x):
+                return x
+
+        for folder, sha_value in recorded__rel_folder__sha__dict.items():
+            if folder not in self__rel_folder__sha__dict:
+                diff_folders.add(_path(folder))
+            elif sha_value != self__rel_folder__sha__dict[folder]:
+                diff_folders.add(_path(folder))
+
+        for folder in self__rel_folder__sha__dict:
+            if folder not in recorded__rel_folder__sha__dict:
+                diff_folders.add(_path(folder))
+
+        return diff_folders
 
-    def _most_suitable_rule(self, _folder: str) -> FolderRule:
-        folder = os.path.abspath(_folder)
+    def most_suitable_rule(self, _folder: str) -> FolderRule:
+        folder = to_absolute_path(_folder)
         for rule in self.rules[::-1]:
             if os.path.commonpath([folder, rule.folder]) == rule.folder:
                 return rule
@@ -277,17 +365,17 @@ class Manifest:
     def enable_build_targets(
         self, folder: str, default_sdkconfig_target: t.Optional[str] = None, config_name: t.Optional[str] = None
     ) -> t.List[str]:
-        return self._most_suitable_rule(folder).enable_build_targets(default_sdkconfig_target, config_name)
+        return self.most_suitable_rule(folder).enable_build_targets(default_sdkconfig_target, config_name)
 
     def enable_test_targets(
         self, folder: str, default_sdkconfig_target: t.Optional[str] = None, config_name: t.Optional[str] = None
     ) -> t.List[str]:
-        return self._most_suitable_rule(folder).enable_test_targets(default_sdkconfig_target, config_name)
+        return self.most_suitable_rule(folder).enable_test_targets(default_sdkconfig_target, config_name)
 
     def depends_components(
         self, folder: str, default_sdkconfig_target: t.Optional[str] = None, config_name: t.Optional[str] = None
     ) -> t.List[str]:
-        res = self._most_suitable_rule(folder).depends_components
+        res = self.most_suitable_rule(folder).depends_components
         if isinstance(res, list):
             return res
         return res.get_value(default_sdkconfig_target or '', config_name or '')
@@ -295,7 +383,7 @@ class Manifest:
     def depends_filepatterns(
         self, folder: str, default_sdkconfig_target: t.Optional[str] = None, config_name: t.Optional[str] = None
     ) -> t.List[str]:
-        res = self._most_suitable_rule(folder).depends_filepatterns
+        res = self.most_suitable_rule(folder).depends_filepatterns
         if isinstance(res, list):
             return res
         return res.get_value(default_sdkconfig_target or '', config_name or '')

idf_build_apps/utils.py

@@ -21,6 +21,24 @@ from pydantic import BaseModel as _BaseModel
 
 LOGGER = logging.getLogger(__name__)
 
+if sys.version_info < (3, 8):
+    from typing_extensions import (
+        Literal,
+    )
+else:
+    from typing import (
+        Literal,  # noqa
+    )
+
+if sys.version_info < (3, 11):
+    from typing_extensions import (
+        Self,
+    )
+else:
+    from typing import (
+        Self,  # noqa
+    )
+
 
 class ConfigRule:
     def __init__(self, file_name: str, config_name: str = '') -> None:
@@ -365,3 +383,7 @@ class BaseModel(_BaseModel):
                 hash_list.append(v)
 
         return hash((type(self), *tuple(hash_list)))
+
+
+def drop_none_kwargs(d: dict) -> dict:
+    return {k: v for k, v in d.items() if v is not None}

{idf_build_apps-2.4.2.dist-info → idf_build_apps-2.5.0rc0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: idf-build-apps
-Version: 2.4.2
+Version: 2.5.0rc0
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7
@@ -19,7 +19,7 @@ Requires-Dist: packaging
 Requires-Dist: toml; python_version < '3.11'
 Requires-Dist: pydantic~=2.0
 Requires-Dist: argcomplete>=3
-Requires-Dist: typing-extensions ; extra == "dev" and ( python_version < '3.8')
+Requires-Dist: typing-extensions; python_version < '3.11'
 Requires-Dist: sphinx ; extra == "doc"
 Requires-Dist: sphinx-rtd-theme ; extra == "doc"
 Requires-Dist: sphinx_copybutton ; extra == "doc"
@@ -32,7 +32,6 @@ Project-URL: changelog, https://github.com/espressif/idf-build-apps/blob/master/
 Project-URL: documentation, https://docs.espressif.com/projects/idf-build-apps
 Project-URL: homepage, https://github.com/espressif/idf-build-apps
 Project-URL: repository, https://github.com/espressif/idf-build-apps
-Provides-Extra: dev
 Provides-Extra: doc
 Provides-Extra: test
 
@@ -113,5 +112,5 @@ Thanks for your contribution! Please refer to our [Contributing Guide](CONTRIBUT
 [hello-world]: https://github.com/espressif/esp-idf/tree/master/examples/get-started/hello_world
 [supported-targets]: https://github.com/espressif/esp-idf/tree/v5.0#esp-idf-release-and-soc-compatibility
 [doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/
-[api-doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/api/modules.html
+[api-doc]: https://docs.espressif.com/projects/idf-build-apps/en/latest/references/api/modules.html
 

idf_build_apps-2.5.0rc0.dist-info/RECORD

@@ -0,0 +1,26 @@
+idf_build_apps/__init__.py,sha256=RPw7wTPPVr_WwSjWSYSAAdmKxRoFeZfkmvSrEE8cLcQ,653
+idf_build_apps/__main__.py,sha256=8E-5xHm2MlRun0L88XJleNh5U50dpE0Q1nK5KqomA7I,182
+idf_build_apps/app.py,sha256=T4quqTJ1F40QyAfr5aNZcPpvRBJOfc10hXCk1RMG8fo,37637
+idf_build_apps/args.py,sha256=VSnLDwFmgSNDzldzqdw0frd6gmCwhsd6ri76V296x00,35757
+idf_build_apps/autocompletions.py,sha256=g-bx0pzXoFKI0VQqftkHyGVWN6MLjuFOdozeuAf45yo,2138
+idf_build_apps/config.py,sha256=TvJ-puAhR7r7SYdAWsK5XdOTAVuw5k8xiqO2jRms_ZA,3586
+idf_build_apps/constants.py,sha256=mOHb74qX8WsA4sm-NoSFpLy4HzjIsc-ApUN6XGtrXXM,3904
+idf_build_apps/finder.py,sha256=evkHtNIhCB3wgCMGPxOC34v-_B4mtZ1VBiZ14IRVuFw,5727
+idf_build_apps/log.py,sha256=pyvT7N4MWzGjIXph5mThQCGBiSt53RNPW0WrFfLr0Kw,2650
+idf_build_apps/main.py,sha256=xw6lmVmAKD1f7aHb5c7qQbAfqmHfh_t_q57Q_z6htLs,15331
+idf_build_apps/session_args.py,sha256=2WDTy40IFAc0KQ57HaeBcYj_k10eUXRKkDOWLrFCaHY,2985
+idf_build_apps/utils.py,sha256=Cibdr7oHhcnl9uxJNfPLksp2nfPCPW0efAwDhX4dTmw,10099
+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=c9ooxNe3SOEndsVtJ-xxJNWPF6YlS-LpX_5wmjxCfOc,14003
+idf_build_apps/manifest/soc_header.py,sha256=PzJ37xFspt5f0AXWvAFNA_avHZA9fMXHBrwDYLi3qEI,4344
+idf_build_apps/yaml/__init__.py,sha256=W-3z5no07RQ6eYKGyOAPA8Z2CLiMPob8DD91I4URjrA,162
+idf_build_apps/yaml/parser.py,sha256=Y2OyB4g1DCC7C7jrvpIyZV9lgeCB_XvuB75iGmqiTaM,2093
+idf_build_apps-2.5.0rc0.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
+idf_build_apps-2.5.0rc0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+idf_build_apps-2.5.0rc0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+idf_build_apps-2.5.0rc0.dist-info/METADATA,sha256=ghIKlVQjTRflEhKdnQW8LC_bSYhdYuxlIfzN153oR8c,4580
+idf_build_apps-2.5.0rc0.dist-info/RECORD,,

idf_build_apps/build_apps_args.py

@@ -1,64 +0,0 @@
-# SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
-# SPDX-License-Identifier: Apache-2.0
-
-import typing as t
-
-from pydantic import (
-    computed_field,
-)
-
-from .utils import (
-    BaseModel,
-)
-
-
-class BuildAppsArgs(BaseModel):
-    PARALLEL_INDEX_PLACEHOLDER: t.ClassVar[str] = '@p'  # replace it with the parallel index
-
-    parallel_index: int = 1
-    parallel_count: int = 1
-
-    _junitxml: t.Optional[str] = None
-    _collect_app_info: t.Optional[str] = None
-    _collect_size_info: t.Optional[str] = None
-
-    def __init__(
-        self,
-        *,
-        collect_app_info: t.Optional[str] = None,
-        collect_size_info: t.Optional[str] = None,
-        junitxml: t.Optional[str] = None,
-        **kwargs,
-    ):
-        super().__init__(**kwargs)
-
-        self._junitxml = junitxml
-        self._collect_app_info = collect_app_info
-        self._collect_size_info = collect_size_info
-
-    @computed_field  # type: ignore
-    @property
-    def collect_app_info(self) -> t.Optional[str]:
-        if self._collect_app_info:
-            return self.expand(self._collect_app_info)
-
-        return None
-
-    @computed_field  # type: ignore
-    @property
-    def collect_size_info(self) -> t.Optional[str]:
-        if self._collect_size_info:
-            return self.expand(self._collect_size_info)
-
-        return None
-
-    @computed_field  # type: ignore
-    @property
-    def junitxml(self) -> t.Optional[str]:
-        if self._junitxml:
-            return self.expand(self._junitxml)
-
-        return None
-
-    def expand(self, path):
-        return path.replace(self.PARALLEL_INDEX_PLACEHOLDER, str(self.parallel_index))

idf_build_apps-2.4.2.dist-info/RECORD

@@ -1,26 +0,0 @@
-idf_build_apps/__init__.py,sha256=BwKVA9OBak7HwLAOrcfYb-ir3L5sCQDsB_FC7GO4KjE,650
-idf_build_apps/__main__.py,sha256=8E-5xHm2MlRun0L88XJleNh5U50dpE0Q1nK5KqomA7I,182
-idf_build_apps/app.py,sha256=q9udvZyBG3qWrNxlyuG3iTiLcayOSrSwRuyL2n7QALY,37002
-idf_build_apps/autocompletions.py,sha256=g-bx0pzXoFKI0VQqftkHyGVWN6MLjuFOdozeuAf45yo,2138
-idf_build_apps/build_apps_args.py,sha256=r6VCJDdCzE873X8OTputYkCBZPgECaKoNlAejfcamJk,1644
-idf_build_apps/config.py,sha256=I75uOQGarCWVKGi16ZYpo0qTVU25BUP4eh6-RWCtbvw,2924
-idf_build_apps/constants.py,sha256=8Bh99xGFpyLkEovQMglS2KydxoEZesAHQSgdpsUnSTM,4000
-idf_build_apps/finder.py,sha256=2TOQ6fq9q3MtsLnG4o0VvA2aMd3Zb6w6CL-U_tQrT3k,6362
-idf_build_apps/log.py,sha256=JysogBHoompfW9E9w0U4wZH7tt8dBdfoh-stPXQz1hw,2573
-idf_build_apps/main.py,sha256=wKDt5iQKjpDmxJecPJMMMYb2kDI2qIRH_Qlkg3u6jlY,39199
-idf_build_apps/session_args.py,sha256=2WDTy40IFAc0KQ57HaeBcYj_k10eUXRKkDOWLrFCaHY,2985
-idf_build_apps/utils.py,sha256=dYxNXPe7FRWxzUFlTzOb3G-LpKpRUrNWdQrsO5MXAB8,9702
-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=P5ZaUd72A_HOVF6iuwap__Bw-w7WI72ugiTURm9PNNQ,10708
-idf_build_apps/manifest/soc_header.py,sha256=PzJ37xFspt5f0AXWvAFNA_avHZA9fMXHBrwDYLi3qEI,4344
-idf_build_apps/yaml/__init__.py,sha256=W-3z5no07RQ6eYKGyOAPA8Z2CLiMPob8DD91I4URjrA,162
-idf_build_apps/yaml/parser.py,sha256=Y2OyB4g1DCC7C7jrvpIyZV9lgeCB_XvuB75iGmqiTaM,2093
-idf_build_apps-2.4.2.dist-info/entry_points.txt,sha256=3pVUirUEsb6jsDRikkQWNUt4hqLK2ci1HvW_Vf8b6uE,59
-idf_build_apps-2.4.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-idf_build_apps-2.4.2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-idf_build_apps-2.4.2.dist-info/METADATA,sha256=wk_YDe56T2b3qXhknNIRzcBtCpvcDQCqku22o7IbYIU,4608
-idf_build_apps-2.4.2.dist-info/RECORD,,