Fu Hanxi bee690aa8d idf.py: add linux target support for `idf.py flash` and `idf.py monitor`		%!s(int64=4) %!d(string=hai) anos
..
README.md	5e6aae3e04 Fix typo and naming format for extensions	%!s(int64=6) %!d(string=hai) anos
__init__.py	1c798393e2 Add idf.py extensions and move core actions to separate files	%!s(int64=6) %!d(string=hai) anos
constants.py	0b9afa509f tools: Add docs subcommand docs which opens browser with documentation for current version of idf and model of your target	%!s(int64=4) %!d(string=hai) anos
core_ext.py	ff18a96f7d tools: replace _ with - in idf.py	%!s(int64=4) %!d(string=hai) anos
create_ext.py	0146f258d7 style: format python files with isort and double-quote-string-fixer	%!s(int64=5) %!d(string=hai) anos
debug_ext.py	ff18a96f7d tools: replace _ with - in idf.py	%!s(int64=4) %!d(string=hai) anos
dfu_ext.py	6b75bad2b1 tools: Split up large binaries into smaller chunks in the DFU binary	%!s(int64=4) %!d(string=hai) anos
errors.py	179e23b38a Fixed automatic connection in idf_monitor	%!s(int64=4) %!d(string=hai) anos
global_options.py	0146f258d7 style: format python files with isort and double-quote-string-fixer	%!s(int64=5) %!d(string=hai) anos
serial_ext.py	bee690aa8d idf.py: add linux target support for `idf.py flash` and `idf.py monitor`	%!s(int64=4) %!d(string=hai) anos
tools.py	844dd5075f Tools: make idf_size work with overflow	%!s(int64=4) %!d(string=hai) anos
uf2_ext.py	0146f258d7 style: format python files with isort and double-quote-string-fixer	%!s(int64=5) %!d(string=hai) anos

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

README.md

idf.py extensions