mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Angus Gratton aecb2bd8ee idf.py: Disable CMake --warn-uninitialized option by default Can still be enabled by passing --cmake-warn-uninitialized on the command line Prevents CMake warnings printed by default if IDF_PATH is underneath the CMake project directory. The reason for this is that CMake --warn-uninitialized only enables checks inside the project directory (ie top-level CMakeLists.txt directory and subdirectories), it doesn't enable for files included from other directories. (The only way to enable warnings in other directories is to pass --check-system-dirs and this looks like it's only useful for CMake's own developers as it prints a lot of warnings from inside CMake otherwise - see https://gitlab.kitware.com/cmake/cmake/-/issues/19645 ) Plan to follow up with a later commit to clean up most of the warnings (which aren't problems for CMake execution), but we'll also disable this option by default to avoid this unexpected triggering of IDF warnings.		2020-10-05 05:35:02 +00:00
..
__init__.py	Add idf.py extensions and move core actions to separate files	2019-10-30 10:34:17 +01:00
constants.py	tools: Force the order of cmake generators	2020-03-03 11:39:59 +01:00
core_ext.py	idf.py: Disable CMake --warn-uninitialized option by default	2020-10-05 05:35:02 +00:00
errors.py	Use component manager if available as python package	2019-12-19 16:48:36 +01:00
global_options.py	Add idf.py extensions and move core actions to separate files	2019-10-30 10:34:17 +01:00
README.md	Fix typo and naming format for extensions	2019-10-30 10:34:17 +01:00
serial_ext.py	Tools: Mention ESPPORT and ESPBAUD in idf.py --help	2020-06-25 08:17:55 +02:00
tools.py	idf.py: Disable CMake --warn-uninitialized option by default	2020-10-05 05:35:02 +00:00

README.md

idf.py extensions

Python modules (subdirectories and files) in this directory named [your_extension]_ext will be loaded as idf.py extensions. If you want to provide extra extensions just provide ; separated list of directories with extensions in IDF_EXTRA_ACTIONS_PATH. Extensions will be loaded in alphanumeric order. Command line arguments parsing and extension mechanism is implemented on top of Click (versions >=5.0 are supported).

They should define a function action_extensions(base_actions, project_path) where:

base_actions - dictionary with actions that are already available for idf.py
project_path - working dir, may be defaulted to os.getcwd()

This function have to return a dict with 3 possible keys:

{
    # Additional options that will be available from id
    "global_options": [{
        "names": ["--option-name"],
        "help": "Help for option --option-name.",
    }],
    # List of functions that will have access to full app context, and can mangle with arguments
    "global_action_callbacks": [global_callback],
    # Additional subcommands for idf.py
    "actions": {
        "subcommand_name": {
            "callback": subcommand_callback,
            "help": "Help for subcommand.",
        },
    },
}

Where function global_callback(ctx, global_args, tasks) accepts 3 arguments:

ctx - Click context
global_args - dictionary of all available global arguments
tasks - list of Task objects

And subcommand_callback(subcommand_name, ctx, args) accepts 3 arguments:

subcommand_name - name of subcommand
ctx - Click context
args - list of command's arguments