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

History

Frantisek Hrbata a5d3c2d443 tools: fix hints processing in interactive mode Currently hints are processed only once the process is finished and exits with non-error exit code. In interactive mode, e.g. for monitor, we want to process ouput lines for hints right away. This adds a simple buffer, which keeps the last line and once EOL is reached, it is processed for hints. Since the original hints processing was file based, a new helper function was added to allow processing hints in string. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>		2023-05-09 14:35:04 +02:00
..
__init__.py	Add idf.py extensions and move core actions to separate files	2019-10-30 10:34:17 +01:00
constants.py	esp32h4: removed esp32h4 related codes	2023-04-23 12:03:07 +00:00
core_ext.py	tools: fix custom sdkconfig renaming in set-target	2023-03-08 16:45:55 +01:00
create_ext.py	tools: Add python types hints	2022-06-15 14:33:29 +02:00
debug_ext.py	tools: allow to use hints for debug targets	2023-02-01 15:06:39 +01:00
dfu_ext.py	dfu: add esp32s3 to supported DFU targets for idf.py	2022-07-11 15:58:21 +08:00
errors.py	tools: Add python types hints	2022-06-15 14:33:29 +02:00
global_options.py	idf.py: Change copyright in tools dir	2022-05-24 14:01:50 +02:00
hints.yml	tools: Update idf-py hints with Bluedroid HFP AG info	2023-04-06 14:18:27 +08:00
README.md	Fix typo and naming format for extensions	2019-10-30 10:34:17 +01:00
roms_schema.json	tools: fixed elf symbols load if gdbinit specified	2022-09-21 22:39:03 +04:00
roms.json	tools: update esp-rom-elf to version 20230320	2023-03-20 19:20:34 +08:00
serial_ext.py	Merge branch 'monitor_win_color' into 'master'	2023-04-21 20:15:38 +08:00
tools.py	tools: fix hints processing in interactive mode	2023-05-09 14:35:04 +02:00
uf2_ext.py	tools: Add python types hints	2022-06-15 14:33:29 +02: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