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

idf_build_apps/config.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
@@ -7,7 +7,7 @@ from pathlib import (
     Path,
 )
 
-from idf_build_apps.utils import (
+from .utils import (
     to_absolute_path,
 )
 
@@ -65,6 +65,23 @@ def _get_config_from_path(dirpath: str) -> t.Tuple[t.Optional[dict], str]:
 
 
 def get_valid_config(starts_from: str = os.getcwd(), custom_path: t.Optional[str] = None) -> t.Optional[dict]:
+    """
+    Get the valid config from the current directory or its parent directories.
+
+    If the custom path is provided, it will be used to get the config file.
+
+    Otherwise, the search will start from the current working directory and go up to the root directory.
+
+    The search will stop in the following cases:
+
+    - A valid config file is found.
+    - A `.git` directory is found.
+    - The root directory is reached.
+
+    :param starts_from: starting directory to search for the config file. Default is the current working directory.
+    :param custom_path: custom path to the config file.
+    :return: the valid config dict if found, otherwise None.
+    """
     root_dir = to_absolute_path('/')
     cur_dir = to_absolute_path(starts_from)
 

idf_build_apps/constants.py

@@ -7,7 +7,6 @@ import logging
 import os
 import re
 import sys
-import tempfile
 import typing as t
 
 from .utils import (
@@ -16,19 +15,10 @@ from .utils import (
 
 LOGGER = logging.getLogger(__name__)
 
-_BUILDING_DOCS = bool(os.getenv('BUILDING_DOCS'))
-if _BUILDING_DOCS:
-    print('Building Docs... Faking lots of constant values')
-
-
-if _BUILDING_DOCS:
-    _idf_env = tempfile.gettempdir()
-else:
-    _idf_env = os.getenv('IDF_PATH') or ''
-    if not _idf_env:
-        raise SystemExit('environment variable IDF_PATH must be set')
-
-
+_idf_env = os.getenv('IDF_PATH') or ''
+if not _idf_env:
+    LOGGER.warning('IDF_PATH environment variable is not set. Entering test mode...')
+    LOGGER.warning('- Setting IDF_PATH to current directory...')
 IDF_PATH = os.path.abspath(_idf_env)
 IDF_PY = os.path.join(IDF_PATH, 'tools', 'idf.py')
 IDF_SIZE_PY = os.path.join(IDF_PATH, 'tools', 'idf_size.py')
@@ -36,15 +26,16 @@ PROJECT_DESCRIPTION_JSON = 'project_description.json'
 DEFAULT_SDKCONFIG = 'sdkconfig.defaults'
 
 
-sys.path.append(os.path.join(IDF_PATH, 'tools', 'idf_py_actions'))
-if _BUILDING_DOCS:
-    _idf_py_constant_py = object()
-else:
-    try:
-        _idf_py_constant_py = importlib.import_module('constants')
-    except ModuleNotFoundError:
-        LOGGER.warning('Cannot import constants from idf_py_actions')
-        _idf_py_constant_py = object()
+_idf_py_actions = os.path.join(IDF_PATH, 'tools', 'idf_py_actions')
+sys.path.append(_idf_py_actions)
+try:
+    _idf_py_constant_py = importlib.import_module('constants')
+except ModuleNotFoundError:
+    LOGGER.warning(
+        '- Set supported/preview targets to empty list... (ESP-IDF constants.py module not found under %s)',
+        _idf_py_actions,
+    )
+    _idf_py_constant_py = object()  # type: ignore
 SUPPORTED_TARGETS = getattr(_idf_py_constant_py, 'SUPPORTED_TARGETS', [])
 PREVIEW_TARGETS = getattr(_idf_py_constant_py, 'PREVIEW_TARGETS', [])
 ALL_TARGETS = SUPPORTED_TARGETS + PREVIEW_TARGETS
@@ -53,7 +44,8 @@ ALL_TARGETS = SUPPORTED_TARGETS + PREVIEW_TARGETS
 def _idf_version_from_cmake() -> t.Tuple[int, int, int]:
     version_path = os.path.join(IDF_PATH, 'tools', 'cmake', 'version.cmake')
     if not os.path.isfile(version_path):
-        raise ValueError(f'File {version_path} does not exist')
+        LOGGER.warning('- Setting ESP-IDF version to 1.0.0... (ESP-IDF version.cmake not exists at %s)', version_path)
+        return 1, 0, 0
 
     regex = re.compile(r'^\s*set\s*\(\s*IDF_VERSION_([A-Z]{5})\s+(\d+)')
     ver = {}
@@ -70,10 +62,7 @@ def _idf_version_from_cmake() -> t.Tuple[int, int, int]:
         raise ValueError(f'Cannot find ESP-IDF version in {version_path}')
 
 
-if _BUILDING_DOCS:
-    IDF_VERSION_MAJOR, IDF_VERSION_MINOR, IDF_VERSION_PATCH = 1, 0, 0
-else:
-    IDF_VERSION_MAJOR, IDF_VERSION_MINOR, IDF_VERSION_PATCH = _idf_version_from_cmake()
+IDF_VERSION_MAJOR, IDF_VERSION_MINOR, IDF_VERSION_PATCH = _idf_version_from_cmake()
 
 IDF_VERSION = to_version(f'{IDF_VERSION_MAJOR}.{IDF_VERSION_MINOR}.{IDF_VERSION_PATCH}')
 

idf_build_apps/finder.py

@@ -14,13 +14,13 @@ from .app import (
     App,
     CMakeApp,
 )
+from .args import FindArguments
 from .constants import (
     BuildStatus,
 )
 from .utils import (
     config_rules_from_str,
     to_absolute_path,
-    to_list,
 )
 
 LOGGER = logging.getLogger(__name__)
@@ -29,41 +29,27 @@ LOGGER = logging.getLogger(__name__)
 def _get_apps_from_path(
     path: str,
     target: str,
+    *,
     app_cls: t.Type[App] = CMakeApp,
-    work_dir: t.Optional[str] = None,
-    build_dir: str = 'build',
-    config_rules_str: t.Optional[t.List[str]] = None,
-    build_log_filename: t.Optional[str] = None,
-    size_json_filename: t.Optional[str] = None,
-    check_warnings: bool = False,
-    preserve: bool = True,
-    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,
-    sdkconfig_defaults_str: t.Optional[str] = None,
-    include_skipped_apps: bool = False,
-    include_disabled_apps: bool = False,
+    args: FindArguments = FindArguments(),
 ) -> t.List[App]:
-    modified_components = to_list(modified_components)
-    modified_files = to_list(modified_files)
-
     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))
             _app.build_status = BuildStatus.DISABLED
-            return include_disabled_apps
-
-        _app._check_should_build(
-            manifest_rootpath=manifest_rootpath,
-            modified_components=modified_components,
-            modified_files=modified_files,
-            check_app_dependencies=check_app_dependencies,
+            return args.include_disabled_apps
+
+        _app.check_should_build(
+            manifest_rootpath=args.manifest_rootpath,
+            modified_manifest_rules_folders=args.modified_manifest_rules_folders,
+            modified_components=args.modified_components,
+            modified_files=args.modified_files,
+            check_app_dependencies=args.dependency_driven_build_enabled,
         )
 
         # for unknown ones, we keep them to the build stage to judge
         if _app.build_status == BuildStatus.SKIPPED:
-            return include_skipped_apps
+            return args.include_skipped_apps
 
         return True
 
@@ -71,9 +57,7 @@ def _get_apps_from_path(
         LOGGER.debug('Skipping. %s is not an app', path)
         return []
 
-    config_rules = config_rules_from_str(config_rules_str)
-    if not config_rules:
-        config_rules = []
+    config_rules = config_rules_from_str(args.config_rules)
 
     apps = []
     default_config_name = ''
@@ -107,13 +91,12 @@ def _get_apps_from_path(
                 target,
                 sdkconfig_path=sdkconfig_path,
                 config_name=config_name,
-                work_dir=work_dir,
-                build_dir=build_dir,
-                build_log_filename=build_log_filename,
-                size_json_filename=size_json_filename,
-                check_warnings=check_warnings,
-                preserve=preserve,
-                sdkconfig_defaults_str=sdkconfig_defaults_str,
+                work_dir=args.work_dir,
+                build_dir=args.build_dir,
+                build_log_filename=args.build_log_filename,
+                size_json_filename=args.size_json_filename,
+                check_warnings=args.check_warnings,
+                sdkconfig_defaults_str=args.sdkconfig_defaults,
             )
             if _validate_app(app):
                 LOGGER.debug('Found app: %s', app)
@@ -128,13 +111,12 @@ def _get_apps_from_path(
             target,
             sdkconfig_path=None,
             config_name=default_config_name,
-            work_dir=work_dir,
-            build_dir=build_dir,
-            build_log_filename=build_log_filename,
-            size_json_filename=size_json_filename,
-            check_warnings=check_warnings,
-            preserve=preserve,
-            sdkconfig_defaults_str=sdkconfig_defaults_str,
+            work_dir=args.work_dir,
+            build_dir=args.build_dir,
+            build_log_filename=args.build_log_filename,
+            size_json_filename=args.size_json_filename,
+            check_warnings=args.check_warnings,
+            sdkconfig_defaults_str=args.sdkconfig_defaults,
         )
 
         if _validate_app(app):
@@ -149,30 +131,28 @@ def _get_apps_from_path(
 def _find_apps(
     path: str,
     target: str,
+    *,
     app_cls: t.Type[App] = CMakeApp,
-    recursive: bool = False,
-    exclude_list: t.Optional[t.List[str]] = None,
-    **kwargs,
+    args: FindArguments = FindArguments(),
 ) -> t.List[App]:
-    exclude_list = exclude_list or []
     LOGGER.debug(
         'Looking for %s apps in %s%s with target %s',
         app_cls.__name__,
         path,
-        ' recursively' if recursive else '',
+        ' recursively' if args.recursive else '',
         target,
     )
 
-    if not recursive:
-        if exclude_list:
-            LOGGER.warning('--exclude option is ignored when used without --recursive')
+    if not args.recursive:
+        if args.exclude:
+            LOGGER.debug('--exclude option is ignored when used without --recursive')
 
-        return _get_apps_from_path(path, target, app_cls, **kwargs)
+        return _get_apps_from_path(path, target, app_cls=app_cls, args=args)
 
     # The remaining part is for recursive == True
     apps = []
     # handle the exclude list, since the config file might use linux style, but run in windows
-    exclude_paths_list = [to_absolute_path(p) for p in exclude_list]
+    exclude_paths_list = [to_absolute_path(p) for p in args.exclude or []]
     for root, dirs, _ in os.walk(path):
         LOGGER.debug('Entering %s', root)
         root_path = to_absolute_path(root)
@@ -186,7 +166,7 @@ def _find_apps(
             del dirs[:]
             continue
 
-        _found_apps = _get_apps_from_path(root, target, app_cls, **kwargs)
+        _found_apps = _get_apps_from_path(root, target, app_cls=app_cls, args=args)
         if _found_apps:  # root has at least one app
             LOGGER.debug('=> Stop iteration sub dirs of %s since it has apps', root)
             del dirs[:]

idf_build_apps/log.py

@@ -82,5 +82,7 @@ def setup_logging(verbose: int = 0, log_file: t.Optional[str] = None, colored: b
         handler = logging.StreamHandler(sys.stderr)
     handler.setFormatter(ColoredFormatter(colored))
 
+    if package_logger.hasHandlers():
+        package_logger.handlers.clear()
     package_logger.addHandler(handler)
     package_logger.propagate = False  # don't propagate to root logger