idf-build-apps 2.6.4__tar.gz → 2.7.0__tar.gz

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/.github/workflows/test-build-docs.yml

@@ -22,4 +22,4 @@ jobs:
           cd docs
           pushd en && make html && popd
       - name: markdown-link-check
-        uses: gaurav-nelson/github-action-markdown-link-check@1.0.15
+        uses: gaurav-nelson/github-action-markdown-link-check@1.0.16

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/.pre-commit-config.yaml

@@ -38,6 +38,7 @@ repos:
           - pytest
           - argcomplete>=3
           - esp-bool-parser>=0.1.2,<1
+          - rich
   - repo: https://github.com/hfudev/rstfmt
     rev: v0.1.4
     hooks:

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.7.0 (2025-02-18)
+
+### Feat
+
+- improve debug info with rich
+
 ## v2.6.4 (2025-02-14)
 
 ### Fix

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: idf-build-apps
-Version: 2.6.4
+Version: 2.7.0
 Summary: Tools for building ESP-IDF related apps.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.7
@@ -22,6 +22,7 @@ Requires-Dist: pydantic_settings
 Requires-Dist: argcomplete>=3
 Requires-Dist: typing-extensions; python_version < '3.11'
 Requires-Dist: esp-bool-parser>=0.1.2,<1
+Requires-Dist: rich
 Requires-Dist: sphinx ; extra == "doc"
 Requires-Dist: sphinx-rtd-theme ; extra == "doc"
 Requires-Dist: sphinx_copybutton ; extra == "doc"

{idf_build_apps-2.6.4 → idf_build_apps-2.7.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.6.4'
+__version__ = '2.7.0'
 
 from .session_args import (
     SessionArgs,

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/idf_build_apps/app.py

@@ -36,7 +36,6 @@ from .constants import (
     IDF_VERSION_PATCH,
     PREVIEW_TARGETS,
     PROJECT_DESCRIPTION_JSON,
-    BuildStage,
     BuildStatus,
 )
 from .manifest.manifest import (
@@ -55,17 +54,7 @@ from .utils import (
     to_list,
 )
 
-
-class _AppBuildStageFilter(logging.Filter):
-    def __init__(self, *args, app, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.app = app
-
-    def filter(self, record: logging.LogRecord) -> bool:
-        if self.app._build_stage:
-            record.build_stage = self.app._build_stage.value
-
-        return True
+LOGGER = logging.getLogger(__name__)
 
 
 class App(BaseModel):
@@ -120,7 +109,6 @@ class App(BaseModel):
     build_status: BuildStatus = BuildStatus.UNKNOWN
     build_comment: t.Optional[str] = None
 
-    _build_stage: t.Optional[BuildStage] = None
     _build_duration: float = 0
     _build_timestamp: t.Optional[datetime] = None
 
@@ -176,9 +164,6 @@ class App(BaseModel):
         # private attrs, won't be dumped to json
         self._checked_should_build = False
 
-        self._logger = logging.getLogger(f'{__name__}.{hash(self)}')
-        self._logger.addFilter(_AppBuildStageFilter(app=self))
-
         self._sdkconfig_files, self._sdkconfig_files_defined_target = self._process_sdkconfig_files()
 
     @classmethod
@@ -346,10 +331,10 @@ class App(BaseModel):
             # use filepath if abs/rel already point to itself
             if not os.path.isfile(f):
                 # find it in the app_dir
-                self._logger.debug('sdkconfig file %s not found, checking under app_dir...', f)
+                LOGGER.debug('sdkconfig file %s not found, checking under app_dir...', f)
                 f = os.path.join(self.app_dir, f)
                 if not os.path.isfile(f):
-                    self._logger.debug('sdkconfig file %s not found, skipping...', f)
+                    LOGGER.debug('sdkconfig file %s not found, skipping...', f)
                     continue
 
             expanded_fp = os.path.join(expanded_dir, os.path.basename(f))
@@ -377,14 +362,14 @@ class App(BaseModel):
             with open(f) as fr:
                 with open(expanded_fp) as new_fr:
                     if fr.read() == new_fr.read():
-                        self._logger.debug('Use sdkconfig file %s', f)
+                        LOGGER.debug('Use sdkconfig file %s', f)
                         try:
                             os.unlink(expanded_fp)
                         except OSError:
-                            self._logger.debug('Failed to remove file %s', expanded_fp)
+                            LOGGER.debug('Failed to remove file %s', expanded_fp)
                         real_sdkconfig_files.append(f)
                     else:
-                        self._logger.debug('Expand sdkconfig file %s to %s', f, expanded_fp)
+                        LOGGER.debug('Expand sdkconfig file %s to %s', f, expanded_fp)
                         real_sdkconfig_files.append(expanded_fp)
                         # copy the related target-specific sdkconfig files
                         par_dir = os.path.abspath(os.path.join(f, '..'))
@@ -392,7 +377,7 @@ class App(BaseModel):
                             os.path.join(par_dir, str(p))
                             for p in Path(par_dir).glob(os.path.basename(f) + f'.{self.target}')
                         ):
-                            self._logger.debug(
+                            LOGGER.debug(
                                 'Copy target-specific sdkconfig file %s to %s', target_specific_file, expanded_dir
                             )
                             shutil.copy(target_specific_file, expanded_dir)
@@ -474,21 +459,16 @@ class App(BaseModel):
         return wrapper
 
     def _pre_build(self) -> None:
-        if self.dry_run:
-            self._build_stage = BuildStage.DRY_RUN
-        else:
-            self._build_stage = BuildStage.PRE_BUILD
-
         if self.build_status == BuildStatus.SKIPPED:
             return
 
         if self.work_dir != self.app_dir:
             if os.path.exists(self.work_dir):
-                self._logger.debug('Removed existing work dir: %s', self.work_dir)
+                LOGGER.debug('Removed existing work dir: %s', self.work_dir)
                 if not self.dry_run:
                     shutil.rmtree(self.work_dir)
 
-            self._logger.debug('Copied app from %s to %s', self.app_dir, self.work_dir)
+            LOGGER.debug('Copied app from %s to %s', self.app_dir, self.work_dir)
             if not self.dry_run:
                 # if the new directory inside the original directory,
                 # make sure not to go into recursion.
@@ -502,7 +482,7 @@ class App(BaseModel):
                 shutil.copytree(self.app_dir, self.work_dir, ignore=ignore, symlinks=True)
 
         if os.path.exists(self.build_path):
-            self._logger.debug('Removed existing build dir: %s', self.build_path)
+            LOGGER.debug('Removed existing build dir: %s', self.build_path)
             if not self.dry_run:
                 shutil.rmtree(self.build_path)
 
@@ -511,17 +491,17 @@ class App(BaseModel):
 
         sdkconfig_file = os.path.join(self.work_dir, 'sdkconfig')
         if os.path.exists(sdkconfig_file):
-            self._logger.debug('Removed existing sdkconfig file: %s', sdkconfig_file)
+            LOGGER.debug('Removed existing sdkconfig file: %s', sdkconfig_file)
             if not self.dry_run:
                 os.unlink(sdkconfig_file)
 
         if os.path.isfile(self.build_log_path):
-            self._logger.debug('Removed existing build log file: %s', self.build_log_path)
+            LOGGER.debug('Removed existing build log file: %s', self.build_log_path)
             if not self.dry_run:
                 os.unlink(self.build_log_path)
         elif not self.dry_run:
             os.makedirs(os.path.dirname(self.build_log_path), exist_ok=True)
-        self._logger.info('Writing build log to %s', self.build_log_path)
+        LOGGER.info('Writing build log to %s', self.build_log_path)
 
         if self.dry_run:
             self.build_status = BuildStatus.SKIPPED
@@ -570,8 +550,6 @@ class App(BaseModel):
         ):
             return
 
-        self._build_stage = BuildStage.POST_BUILD
-
         # both status applied
         if self.copy_sdkconfig:
             try:
@@ -580,9 +558,9 @@ class App(BaseModel):
                     os.path.join(self.build_path, 'sdkconfig'),
                 )
             except Exception as e:
-                self._logger.warning('Copy sdkconfig file from failed: %s', e)
+                LOGGER.warning('Copy sdkconfig file from failed: %s', e)
             else:
-                self._logger.debug('Copied sdkconfig file from %s to %s', self.work_dir, self.build_path)
+                LOGGER.debug('Copied sdkconfig file from %s to %s', self.work_dir, self.build_path)
 
         # for originally success builds generate size.json if enabled
         #
@@ -592,7 +570,7 @@ class App(BaseModel):
             self.write_size_json()
 
         if not os.path.isfile(self.build_log_path):
-            self._logger.warning(f'{self.build_log_path} does not exist. Skipping post build actions...')
+            LOGGER.warning(f'{self.build_log_path} does not exist. Skipping post build actions...')
             return
 
         # check warnings
@@ -603,21 +581,21 @@ class App(BaseModel):
                 is_error_or_warning, ignored = self.is_error_or_warning(line)
                 if is_error_or_warning:
                     if ignored:
-                        self._logger.info('[Ignored warning] %s', line)
+                        LOGGER.info('[Ignored warning] %s', line)
                     else:
-                        self._logger.warning('%s', line)
+                        LOGGER.warning('%s', line)
                         has_unignored_warning = True
 
         # 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(
+            LOGGER.error(
                 'Last %s lines from the build log "%s":',
                 self.LOG_DEBUG_LINES,
                 self.build_log_path,
             )
             for line in lines[-self.LOG_DEBUG_LINES :]:
-                self._logger.error('%s', line)
+                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:
@@ -636,7 +614,7 @@ class App(BaseModel):
         # remove temp log file
         if self._is_build_log_path_temp:
             os.unlink(self.build_log_path)
-            self._logger.debug('Removed success build temporary log file: %s', self.build_log_path)
+            LOGGER.debug('Removed success build temporary log file: %s', self.build_log_path)
 
         # Cleanup build directory if not preserving
         if not self.preserve:
@@ -649,17 +627,17 @@ class App(BaseModel):
                 self.build_path,
                 exclude_file_patterns=exclude_list,
             )
-            self._logger.debug('Removed built binaries under: %s', self.build_path)
+            LOGGER.debug('Removed built binaries under: %s', self.build_path)
 
     def _build(
         self,
         *,
-        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
+        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,
     ) -> None:
-        self._build_stage = BuildStage.BUILD
+        pass
 
     def _write_size_json(self) -> None:
         if not self.size_json_path:
@@ -667,7 +645,7 @@ class App(BaseModel):
 
         map_file = find_first_match('*.map', self.build_path)
         if not map_file:
-            self._logger.warning(
+            LOGGER.warning(
                 '.map file not found. Cannot write size json to file: %s',
                 self.size_json_path,
             )
@@ -703,18 +681,18 @@ class App(BaseModel):
                     check=True,
                 )
 
-        self._logger.debug('Generated size info to %s', self.size_json_path)
+        LOGGER.debug('Generated size info to %s', self.size_json_path)
 
     def write_size_json(self) -> None:
         if self.target in PREVIEW_TARGETS:
             # targets in preview may not yet have support in esp-idf-size
-            self._logger.info('Skipping generation of size json for target %s as it is in preview.', self.target)
+            LOGGER.info('Skipping generation of size json for target %s as it is in preview.', self.target)
             return
 
         try:
             self._write_size_json()
         except Exception as e:
-            self._logger.warning('Failed to generate size json: %s', e)
+            LOGGER.warning('Failed to generate size json: %s', e)
 
     def to_json(self) -> str:
         return self.model_dump_json()
@@ -969,7 +947,7 @@ class CMakeApp(App):
                 check=True,
                 additional_env_dict=additional_env_dict,
             )
-            self._logger.debug('generated project_description.json to check app dependencies')
+            LOGGER.debug('generated project_description.json to check app dependencies')
 
             with open(os.path.join(self.build_path, PROJECT_DESCRIPTION_JSON)) as fr:
                 build_components = {item for item in json.load(fr)['build_components'] if item}

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/idf_build_apps/constants.py

@@ -31,17 +31,6 @@ class BuildStatus(str, enum.Enum):
     SUCCESS = 'build success'
 
 
-class BuildStage(str, enum.Enum):
-    DRY_RUN = 'Dry Run'
-    PRE_BUILD = 'Pre Build'
-    BUILD = 'Build'
-    POST_BUILD = 'Post Build'
-
-    @classmethod
-    def max_length(cls) -> int:
-        return max(len(v.value) for v in cls.__members__.values())
-
-
 completion_instructions = """
 With the `--activate` option, detect your shell type and add the appropriate commands to your shell's config file
 so that it runs on startup. You will likely have to restart.

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/idf_build_apps/junit/report.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
 
 """
@@ -211,4 +211,4 @@ class TestReport:
             xml.append(test_suite.to_xml_elem())
 
         ElementTree.ElementTree(xml).write(self.filepath, encoding='utf-8')
-        LOGGER.info('Test report written to %s', self.filepath)
+        LOGGER.info('Generated build junit report at: %s', self.filepath)

idf_build_apps-2.7.0/idf_build_apps/log.py

@@ -0,0 +1,119 @@
+# SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import typing as t
+from datetime import datetime
+
+from rich import get_console
+from rich._log_render import LogRender
+from rich.console import Console, ConsoleRenderable
+from rich.containers import Renderables
+from rich.logging import RichHandler
+from rich.text import Text, TextType
+
+
+class _OneLineLogRender(LogRender):
+    def __call__(  # type: ignore # the original method returns Table instead of Text
+        self,
+        console: Console,
+        renderables: t.Iterable[ConsoleRenderable],
+        log_time: t.Optional[datetime] = None,
+        time_format: t.Optional[t.Union[str, t.Callable[[datetime], Text]]] = None,
+        level: TextType = '',
+        path: t.Optional[str] = None,
+        line_no: t.Optional[int] = None,
+        link_path: t.Optional[str] = None,
+    ) -> Text:
+        output = Text(no_wrap=True)
+        if self.show_time:
+            log_time = log_time or console.get_datetime()
+            time_format = time_format or self.time_format
+            if callable(time_format):
+                log_time_display = time_format(log_time)
+            else:
+                log_time_display = Text(log_time.strftime(time_format), style='log.time')
+            if log_time_display == self._last_time and self.omit_repeated_times:
+                output.append(' ' * len(log_time_display), style='log.time')
+            else:
+                output.append(log_time_display)
+                self._last_time = log_time_display
+            output.pad_right(1)
+
+        if self.show_level:
+            output.append(level)
+            if self.level_width:
+                output.pad_right(max(1, self.level_width - len(level)))
+            else:
+                output.pad_right(1)
+
+        for renderable in Renderables(renderables):  # type: ignore
+            if isinstance(renderable, Text):
+                renderable.stylize('log.message')
+
+            output.append(renderable)
+            output.pad_right(1)
+
+        if self.show_path and path:
+            path_text = Text(style='log.path')
+            path_text.append(path, style=f'link file://{link_path}' if link_path else '')
+            if line_no:
+                path_text.append(':')
+                path_text.append(
+                    f'{line_no}',
+                    style=f'link file://{link_path}#{line_no}' if link_path else '',
+                )
+            output.append(path_text)
+            output.pad_right(1)
+
+        output.rstrip()
+        return output
+
+
+def get_rich_log_handler(level: int = logging.WARNING, no_color: bool = False) -> RichHandler:
+    console = get_console()
+    console.soft_wrap = True
+    console.no_color = no_color
+    console.stderr = True
+
+    handler = RichHandler(
+        level,
+        console,
+    )
+    handler._log_render = _OneLineLogRender(
+        show_level=True,
+        show_path=False,
+        omit_repeated_times=False,
+    )
+
+    return handler
+
+
+def setup_logging(verbose: int = 0, log_file: t.Optional[str] = None, colored: bool = True) -> None:
+    """
+    Setup logging stream handler
+
+    :param verbose: 0 - WARNING, 1 - INFO, 2 - DEBUG
+    :param log_file: log file path
+    :param colored: colored output or not
+    :return: None
+    """
+    if not verbose:
+        level = logging.WARNING
+    elif verbose == 1:
+        level = logging.INFO
+    else:
+        level = logging.DEBUG
+
+    package_logger = logging.getLogger(__package__)
+    package_logger.setLevel(level)
+
+    if log_file:
+        handler: logging.Handler = logging.FileHandler(log_file)
+    else:
+        handler = get_rich_log_handler(level, not colored)
+    if package_logger.hasHandlers():
+        package_logger.handlers.clear()
+    package_logger.addHandler(handler)
+
+    package_logger.propagate = False  # don't propagate to root logger

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/idf_build_apps/main.py

@@ -76,7 +76,7 @@ def find_apps(
     ## `preserve`
     if 'preserve' in kwargs:
         LOGGER.warning(
-            'Passing "preserve" directly is deprecated. '
+            'DEPRECATED: Passing "preserve" directly is deprecated. '
             'Pass "no_preserve" instead to disable preserving the build directory'
         )
         kwargs['no_preserve'] = not kwargs.pop('preserve')
@@ -103,11 +103,14 @@ def find_apps(
     apps: t.Set[App] = set()
     if find_arguments.target == 'all':
         targets = ALL_TARGETS
+        LOGGER.info('Searching for apps by all targets')
     else:
         targets = [find_arguments.target]
+        LOGGER.info('Searching for apps by target: %s', find_arguments.target)
 
     for _t in targets:
         for _p in find_arguments.paths:
+            LOGGER.debug('Searching for apps in path %s for target %s', _p, _t)
             apps.update(
                 _find_apps(
                     _p,
@@ -117,7 +120,7 @@ def find_apps(
                 )
             )
 
-    LOGGER.info(f'Found {len(apps)} apps in total')
+    LOGGER.info('Found %d apps in total', len(apps))
 
     return sorted(apps)
 
@@ -141,7 +144,7 @@ def build_apps(
     ## `check_app_dependencies`
     if 'check_app_dependencies' in kwargs:
         LOGGER.warning(
-            'Passing "check_app_dependencies" directly is deprecated. '
+            'DEPRECATED: Passing "check_app_dependencies" directly is deprecated. '
             'Pass "modified_components" instead to enable dependency-driven build feature'
         )
         kwargs.pop('check_app_dependencies')
@@ -162,20 +165,22 @@ def build_apps(
     test_suite = TestSuite('build_apps')
 
     start, stop = get_parallel_start_stop(len(apps), build_arguments.parallel_count, build_arguments.parallel_index)
-    LOGGER.info('Total %s apps. running build for app %s-%s', len(apps), start, stop)
+    LOGGER.info('Processing %d total apps: building apps %d-%d', len(apps), start, stop)
 
     # cleanup collect files if exists at this early-stage
     for f in (build_arguments.collect_app_info, build_arguments.collect_size_info, build_arguments.junitxml):
         if f and os.path.isfile(f):
+            LOGGER.debug('Removing existing collect file: %s', f)
             os.remove(f)
-            LOGGER.debug('Remove existing collect file %s', f)
 
     exit_code = 0
 
     # create empty files, avoid no file when no app is built
     if build_arguments.collect_app_info:
+        LOGGER.debug('Creating empty app info file: %s', build_arguments.collect_app_info)
         Path(build_arguments.collect_app_info).touch()
     if build_arguments.collect_size_info:
+        LOGGER.debug('Creating empty size info file: %s', build_arguments.collect_size_info)
         Path(build_arguments.collect_size_info).touch()
 
     for i, app in enumerate(apps):
@@ -189,7 +194,7 @@ def build_apps(
         app.verbose = build_arguments.build_verbose
         app.copy_sdkconfig = build_arguments.copy_sdkconfig
 
-        LOGGER.info('(%s/%s) Building app: %s', index, len(apps), app)
+        LOGGER.info('(%d/%d) Building app: %s', index, len(apps), app)
 
         app.build(
             manifest_rootpath=build_arguments.manifest_rootpath,
@@ -207,12 +212,14 @@ def build_apps(
         if build_arguments.collect_app_info:
             with open(build_arguments.collect_app_info, 'a') as fw:
                 fw.write(app.to_json() + '\n')
-            LOGGER.debug('Recorded app info in %s', build_arguments.collect_app_info)
+            LOGGER.debug('Recorded app info in file: %s', build_arguments.collect_app_info)
 
         if app.build_status == BuildStatus.FAILED:
             if not build_arguments.keep_going:
+                LOGGER.error('Build failed and keep_going=False, stopping build process')
                 return 1
             else:
+                LOGGER.warning('Build failed but keep_going=True, continuing with next app')
                 exit_code = 1
         elif app.build_status == BuildStatus.SUCCESS:
             if build_arguments.collect_size_info and app.size_json_path:
@@ -229,13 +236,12 @@ def build_apps(
                             )
                             + '\n'
                         )
-                    LOGGER.debug('Recorded size info file path in %s', build_arguments.collect_size_info)
+                    LOGGER.debug('Recorded size info file path: %s', build_arguments.collect_size_info)
 
         LOGGER.info('')  # add one empty line for separating different builds
 
     if build_arguments.junitxml:
         TestReport([test_suite], build_arguments.junitxml).create_test_report()
-        LOGGER.info('Generated junit report for build apps: %s', build_arguments.junitxml)
 
     return exit_code
 

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/pyproject.toml

@@ -31,7 +31,9 @@ dependencies = [
     "pydantic_settings",
     "argcomplete>=3",
     "typing-extensions; python_version < '3.11'",
-    "esp-bool-parser>=0.1.2,<1"
+    "esp-bool-parser>=0.1.2,<1",
+    # debug/print
+    "rich",
 ]
 
 [project.optional-dependencies]
@@ -62,7 +64,7 @@ idf-build-apps = "idf_build_apps:main.main"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.6.4"
+version = "2.7.0"
 tag_format = "v$version"
 version_files = [
     "idf_build_apps/__init__.py",

{idf_build_apps-2.6.4 → idf_build_apps-2.7.0}/setup.py

@@ -20,7 +20,8 @@ install_requires = \
  'pydantic~=2.0',
  'pydantic_settings',
  'argcomplete>=3',
- 'esp-bool-parser>=0.1.2,<1']
+ 'esp-bool-parser>=0.1.2,<1',
+ 'rich']
 
 extras_require = \
 {":python_version < '3.11'": ['toml', 'typing-extensions'],
@@ -37,7 +38,7 @@ entry_points = \
 {'console_scripts': ['idf-build-apps = idf_build_apps:main.main']}
 
 setup(name='idf-build-apps',
-      version='2.6.4',
+      version='2.7.0',
       description='Tools for building ESP-IDF related apps.',
       author=None,
       author_email='Fu Hanxi <fuhanxi@espressif.com>',

idf_build_apps-2.6.4/idf_build_apps/log.py

@@ -1,88 +0,0 @@
-# SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
-# SPDX-License-Identifier: Apache-2.0
-
-import logging
-import sys
-import typing as t
-
-from .constants import (
-    BuildStage,
-)
-
-
-class ColoredFormatter(logging.Formatter):
-    grey: str = '\x1b[37;20m'
-    yellow: str = '\x1b[33;20m'
-    red: str = '\x1b[31;20m'
-    bold_red: str = '\x1b[31;1m'
-
-    reset: str = '\x1b[0m'
-
-    fmt: str = '%(asctime)s %(levelname)8s %(message)s'
-    app_fmt: str = f'%(asctime)s %(levelname)8s [%(build_stage){BuildStage.max_length()}s] %(message)s'
-
-    datefmt: str = '%Y-%m-%d %H:%M:%S'
-
-    FORMATS: t.Dict[int, str] = {
-        logging.DEBUG: f'{grey}{{}}{reset}',
-        logging.INFO: '{}',
-        logging.WARNING: f'{yellow}{{}}{reset}',
-        logging.ERROR: f'{red}{{}}{reset}',
-        logging.CRITICAL: f'{bold_red}{{}}{reset}',
-    }
-
-    def __init__(self, colored: bool = True) -> None:
-        self.colored = colored
-        if sys.platform == 'win32':  # does not support it
-            self.colored = False
-
-        super().__init__(datefmt=self.datefmt)
-
-    def format(self, record: logging.LogRecord) -> str:
-        if getattr(record, 'build_stage', None):
-            base_fmt = self.app_fmt
-        else:
-            base_fmt = self.fmt
-
-        if self.colored:
-            log_fmt = self.FORMATS[record.levelno].format(base_fmt)
-        else:
-            log_fmt = base_fmt
-
-        if record.levelno in [logging.WARNING, logging.ERROR]:
-            record.msg = '>>> ' + str(record.msg)
-        elif record.levelno == logging.CRITICAL:
-            record.msg = '!!! ' + str(record.msg)
-
-        formatter = logging.Formatter(log_fmt, datefmt=self.datefmt)
-        return formatter.format(record)
-
-
-def setup_logging(verbose: int = 0, log_file: t.Optional[str] = None, colored: bool = True) -> None:
-    """
-    Setup logging stream handler
-
-    :param verbose: 0 - WARNING, 1 - INFO, 2 - DEBUG
-    :param log_file: log file path
-    :param colored: colored output or not
-    :return: None
-    """
-    if not verbose:
-        level = logging.WARNING
-    elif verbose == 1:
-        level = logging.INFO
-    else:
-        level = logging.DEBUG
-
-    package_logger = logging.getLogger(__package__)
-    package_logger.setLevel(level)
-    if log_file:
-        handler: logging.Handler = logging.FileHandler(log_file)
-    else:
-        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