idf-build-apps 2.0.0b5__tar.gz → 2.0.0rc1__tar.gz

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/.github/workflows/check-pre-commit.yml

@@ -11,4 +11,8 @@ jobs:
         with:
           fetch-depth: 0
       - uses: actions/setup-python@v5
+      - id: changed-files
+        uses: tj-actions/changed-files@v41
       - uses: pre-commit/action@v3.0.0
+        with:
+          extra_args: --files ${{ steps.changed-files.outputs.all_changed_files }}

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/.github/workflows/test-build-idf-apps.yml

@@ -28,7 +28,7 @@ jobs:
           pip install flit
           flit build
       - name: Upload built python packages
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: wheel
           path: dist/idf_build_apps-*.whl
@@ -38,13 +38,13 @@ jobs:
     needs: build-python-packages
     strategy:
       matrix:
-        idf-branch: [ release-v5.0, release-v5.1 ]
+        idf-branch: [ release-v5.0, release-v5.1, release-v5.2 ]
     runs-on: ubuntu-latest
     container:
       image: espressif/idf:${{ matrix.idf-branch }}
     steps:
       - name: Download wheel
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: wheel
       - name: Build the Apps

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 All notable changes to this project will be documented in this file.
 
+## v2.0.0rc1 (2024-01-05)
+
+### BREAKING CHANGE
+
+-  - Turn `app.build()` arguments to kwargs
+
+### Feat
+
+- support custom `_pre_build`, `_post_build` in App instances
+- add `json_to_app` method with support custom classes
+
+### Fix
+
+- remove os-specific `os.mknod`
+- sort App instance correctly
+- modify yaml dict shared by yaml anchors
+- make build_comment a `dump_only` field
+- improve error message when env var IDF_PATH not set
+- search sdkconfig path
+
+## v2.0.0rc0 (2023-12-18)
+
+### Refactor
+
+- remove useless code
+
+### Perf
+
+- optimize pathlib and os call
+
 ## v2.0.0b5 (2023-12-13)
 
 ### Feat
@@ -96,6 +126,12 @@ All notable changes to this project will be documented in this file.
 - migrate `App` class to pydantic model
 - update dependencies and do code upgrade to python 3.7
 
+## v1.1.4 (2023-12-29)
+
+### Fix
+
+- stop modifying yaml dict shared by yaml anchors
+
 ## v1.1.3 (2023-11-13)
 
 ### Fix

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/PKG-INFO

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

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/docs/find_build.md

@@ -225,6 +225,7 @@ Placeholders are a set of symbols, which could be used when setting work directo
 - `@w`: Would be replaced by the wildcard if exists, otherwise would be replaced by the config name.
 - `@n`: Would be replaced by the project name.
 - `@f`: Would be replaced by the escaped project path (replaced "/" to "_").
+- `@v`: Would be replaced by the ESP-IDF version like `5_3_0`.
 - `@i`: Would be replaced by the build index. (only available in `build` command)
 - `@p`: Would be replaced by the parallel build index. (default to `1`, only available in `build` command)
 

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/docs/index.rst

@@ -17,5 +17,6 @@ Welcome to idf-build-apps's documentation!
    config_file
    cli
    api/modules
+   migration/1.x_to_2.x
    CHANGELOG
    CONTRIBUTING

idf_build_apps-2.0.0rc1/docs/migration/1.x_to_2.x.md

@@ -0,0 +1,135 @@
+# Migration From 1.x to 2.x
+
+There are a few breaking changes in 2.x. This document will help you migrate your code from 1.x to 2.x.
+
+## Python Version Support
+
+idf-build-apps 1.x supports Python 2.7 and Python 3.4 or newer. idf-build-apps 2.x only supports Python 3.7 or newer.
+
+## Logging Related Changes
+
+In 2.x, we're following the standard Python logging convention.
+
+Before:
+
+```python
+from idf_build_apps import LOGGER
+```
+
+After:
+
+```python
+import logging
+idf_build_apps_logger = logging.getLogger('idf_build_apps')
+```
+
+## Normal Arguments to Keyword-only Arguments
+
+In 2.x, we move some arguments from normal arguments to keyword-only arguments. This is to make the API more consistent and easier to use.
+
+To understand the difference between these terms better, here's a quick summary:
+- "positonal-only argument" means the argument is a positional-only argument. (python 3.8+ only)
+- "keyword-only argument" means the argument is a keyword-only argument.
+- "normal argument" means the argument is not a positional-only argument, nor a keyword-only argument.
+
+For example, in the following function:
+
+```python
+def foo(a, /, b, c, *, d=1, e=2, f=3):
+    pass
+```
+
+- "a" is a positional-only argument.
+- "b" and "c" are normal arguments.
+- "d", "e", and "f" are keyword-only arguments.
+
+The following calls are valid:
+
+```python
+foo(1, 2, 3, d=4, e=5, f=6)
+foo(1, 2, c=3, d=4, e=5, f=6)
+foo(1, b=2, c=3, d=4, e=5, f=6)
+```
+
+The following calls are invalid:
+
+```python
+foo(1, 2, 3, 4, 5, 6)
+foo(1, b=2, 3, d=4, e=5, f=6)
+foo(a=1, b=2, c=3, d=4, e=5, f=6)
+```
+
+### `App.__init__()`
+
+The `__init__` function of `App` class, and all its sub-classes, like `CMakeApp`, and `MakeApp`, now takes only `app_dir`, and `target` as normal arguments. All the rest of the arguments are keyword-only arguments.
+
+Before:
+
+```python
+app = App('foo', 'esp32', 'sdkconfig.ci', 'default')
+```
+
+After:
+
+```python
+app = App('foo', 'esp32', sdkconfig_path='sdkconfig.ci', config_name='default')
+```
+
+or all in keyword-only arguments:
+
+```python
+app = App(app_dir='foo', target='esp32', sdkconfig_path='sdkconfig.ci', config_name='default')
+```
+
+### `App.build()`
+
+The `build` function of `App` class, and all its sub-classes, like `CMakeApp`, and `MakeApp`, now takes all arguments as keyword-only arguments.
+
+### `find_apps()`
+
+The `find_apps` function now takes only `paths` and `target` as normal arguments. All the rest of the arguments are keyword-only arguments.
+
+### `build_apps()`
+
+The `build_apps` function now takes only `apps` as normal argument. All the rest of the arguments are keyword-only arguments.
+
+## Function Signature Changes
+
+In 2.x, we change the signature of some functions to make them more intuitive and self-explanatory.
+
+### `find_apps()`
+
+- `build_log_path` is renamed to `build_log_filename`. The file will be generated under `build_dir` if specified.
+- `size_json_path` is renamed to `size_json_filename`. The file will be generated under `build_dir` if specified.
+
+## CLI Changes
+
+In 2.x, we change the separator for some options to better differentiate them from `None` and empty list.
+
+- `--modified-components`
+- `--modified-files`
+- `--ignore-app-dependencies-filepatterns`
+
+Before:
+
+```shell
+idf-build-apps build -p foo -t esp32 --modified-components foo bar --modified-files foo bar --ignore-app-dependencies-filepatterns foo bar
+```
+
+After:
+
+```shell
+idf-build-apps build -p foo -t esp32 --modified-components 'foo;bar' --modified-files 'foo;bar' --ignore-app-dependencies-filepatterns 'foo;bar'
+```
+
+passing `''` to specify it as `None`
+
+```shell
+idf-build-apps build -p foo -t esp32 --modified-components ''
+```
+
+or passing `';'` to specify it as an empty list
+
+```shell
+idf-build-apps build -p foo -t esp32 --modified-components ';'
+```

{idf_build_apps-2.0.0b5 → idf_build_apps-2.0.0rc1}/idf_build_apps/__init__.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 
 """
@@ -8,7 +8,7 @@ Tools for building ESP-IDF related apps.
 # ruff: noqa: E402
 # avoid circular imports
 
-__version__ = '2.0.0b5'
+__version__ = '2.0.0rc1'
 
 from .session_args import (
     SessionArgs,
@@ -28,6 +28,7 @@ from .log import (
 from .main import (
     build_apps,
     find_apps,
+    json_to_app,
 )
 
 __all__ = [
@@ -37,6 +38,6 @@ __all__ = [
     'MakeApp',
     'find_apps',
     'build_apps',
+    'json_to_app',
     'setup_logging',
-    'SESSION_ARGS',
 ]