API Reference

• idf_build_apps package
  • Subpackages
    • idf_build_apps.junit package
      • Submodules
      • Module contents
    • idf_build_apps.manifest package
      • Submodules
      • Module contents
    • idf_build_apps.vendors package
      • Submodules
      • Module contents
    • idf_build_apps.yaml package
      • Submodules
      • Module contents
  • Submodules
    • App
      • App.TARGET_PLACEHOLDER
      • App.WILDCARD_PLACEHOLDER
      • App.NAME_PLACEHOLDER
      • App.FULL_NAME_PLACEHOLDER
      • App.IDF_VERSION_PLACEHOLDER
      • App.INDEX_PLACEHOLDER
      • App.SDKCONFIG_LINE_REGEX
      • App.MANIFEST
      • App.LOG_ERROR_WARNING_REGEX
      • App.LOG_DEBUG_LINES
      • App.IGNORE_WARNS_REGEXES
      • App.build_system
      • App.app_dir
      • App.target
      • App.sdkconfig_path
      • App.config_name
      • App.sdkconfig_defaults_str
      • App.size_json_extra_args
      • App.dry_run
      • App.verbose
      • App.check_warnings
      • App.preserve
      • App.copy_sdkconfig
      • App.index
      • App.build_status
      • App.build_comment
      • App.test_comment
      • App.checked_should_build
      • App.from_another()
      • App.sdkconfig_defaults_candidates
      • App.name
      • App.work_dir
      • App.build_dir
      • App.build_path
      • App.build_log_filename
      • App.build_log_path
      • App.size_json_filename
      • App.size_json_path
      • App.sdkconfig_files_defined_idf_target
      • App.sdkconfig_files
      • App.depends_components
      • App.depends_filepatterns
      • App.supported_targets
      • App.verified_targets
      • App.record_build_duration()
      • App.build()
      • App.write_size_json()
      • App.to_json()
      • App.is_error_or_warning()
      • App.is_app()
      • App.is_modified()
      • App.check_should_build()
      • App.check_should_test()
    • MakeApp
      • MakeApp.MAKE_PROJECT_LINE
      • MakeApp.build_system
      • MakeApp.supported_targets
      • MakeApp.is_app()
    • CMakeApp
      • CMakeApp.SDKCONFIG_TEST_OPTS
      • CMakeApp.SDKCONFIG_IGNORE_OPTS
      • CMakeApp.CMAKE_PROJECT_LINE
      • CMakeApp.build_system
      • CMakeApp.cmake_vars
      • CMakeApp.is_app()
    • AppDeserializer
      • AppDeserializer.app
      • AppDeserializer.from_json()
      • AppDeserializer.from_json_list()
    • ValidateMethod
      • ValidateMethod.TO_LIST
    • FieldMetadata
      • FieldMetadata.validate_method
      • FieldMetadata.deprecates
      • FieldMetadata.shorthand
      • FieldMetadata.action
      • FieldMetadata.nargs
      • FieldMetadata.choices
      • FieldMetadata.type
      • FieldMetadata.required
      • FieldMetadata.default
      • FieldMetadata.hidden
    • field()
    • get_meta()
    • expand_vars()
    • BaseArguments
      • BaseArguments.CONFIG_FILE_PATH
      • BaseArguments.settings_customise_sources()
      • BaseArguments.validate_by_validate_methods()
    • GlobalArguments
      • GlobalArguments.verbose
      • GlobalArguments.log_file
      • GlobalArguments.no_color
    • DependencyDrivenBuildArguments
      • DependencyDrivenBuildArguments.manifest_files
      • DependencyDrivenBuildArguments.manifest_filepatterns
      • DependencyDrivenBuildArguments.manifest_exclude_regexes
      • DependencyDrivenBuildArguments.manifest_rootpath
      • DependencyDrivenBuildArguments.modified_components
      • DependencyDrivenBuildArguments.modified_files
      • DependencyDrivenBuildArguments.deactivate_dependency_driven_build_by_components
      • DependencyDrivenBuildArguments.deactivate_dependency_driven_build_by_filepatterns
      • DependencyDrivenBuildArguments.check_manifest_rules
      • DependencyDrivenBuildArguments.compare_manifest_sha_filepath
      • DependencyDrivenBuildArguments.dependency_driven_build_enabled
      • DependencyDrivenBuildArguments.modified_manifest_rules_folders
    • FindBuildArguments
      • FindBuildArguments.paths
      • FindBuildArguments.target
      • FindBuildArguments.extra_pythonpaths
      • FindBuildArguments.build_system
      • FindBuildArguments.recursive
      • FindBuildArguments.exclude
      • FindBuildArguments.work_dir
      • FindBuildArguments.build_dir
      • FindBuildArguments.build_log_filename
      • FindBuildArguments.size_json_filename
      • FindBuildArguments.size_json_extra_args
      • FindBuildArguments.config_rules
      • FindBuildArguments.override_sdkconfig_items
      • FindBuildArguments.override_sdkconfig_files
      • FindBuildArguments.sdkconfig_defaults
      • FindBuildArguments.check_warnings
      • FindBuildArguments.default_build_targets
      • FindBuildArguments.additional_build_targets
      • FindBuildArguments.enable_preview_targets
      • FindBuildArguments.disable_targets
      • FindBuildArguments.include_skipped_apps
      • FindBuildArguments.include_disabled_apps
      • FindBuildArguments.include_all_apps
    • FindArguments
      • FindArguments.output
      • FindArguments.output_format
    • BuildArguments
      • BuildArguments.build_verbose
      • BuildArguments.parallel_count
      • BuildArguments.parallel_index
      • BuildArguments.dry_run
      • BuildArguments.keep_going
      • BuildArguments.no_preserve
      • BuildArguments.ignore_warning_strs
      • BuildArguments.ignore_warning_files
      • BuildArguments.copy_sdkconfig
      • BuildArguments.collect_size_info_filename
      • BuildArguments.collect_app_info_filename
      • BuildArguments.junitxml_filename
      • BuildArguments.PARALLEL_INDEX_PLACEHOLDER
      • BuildArguments.collect_size_info
      • BuildArguments.collect_app_info
      • BuildArguments.junitxml
    • DumpManifestShaArguments
      • DumpManifestShaArguments.manifest_files
      • DumpManifestShaArguments.output
    • add_args_to_parser()
    • add_args_to_obj_doc_as_params()
    • apply_config_file()
    • append_to_file()
    • activate_completions()
    • BuildStatus
      • BuildStatus.UNKNOWN
      • BuildStatus.DISABLED
      • BuildStatus.SKIPPED
      • BuildStatus.SHOULD_BE_BUILT
      • BuildStatus.FAILED
      • BuildStatus.SUCCESS
    • get_rich_log_handler()
    • setup_logging()
    • find_apps()
    • build_apps()
    • IdfBuildAppsCliFormatter
      • IdfBuildAppsCliFormatter.LINE_SEP
    • get_parser()
    • handle_completions()
    • main()
    • json_to_app()
    • json_list_files_to_apps()
    • SessionArgs
      • SessionArgs.workdir
      • SessionArgs.override_sdkconfig_items
      • SessionArgs.override_sdkconfig_file_path
      • SessionArgs.set()
      • SessionArgs.clean()
    • ConfigRule
    • config_rules_from_str()
    • get_parallel_start_stop()
    • BuildError
    • AutocompleteActivationError
    • InvalidCommand
    • InvalidInput
    • InvalidIfClause
    • InvalidManifest
    • rmdir()
    • find_first_match()
    • subprocess_run()
    • to_list()
    • to_set()
    • semicolon_separated_str_to_list()
    • to_absolute_path()
    • to_version()
    • files_matches_patterns()
    • BaseModel
    • drop_none_kwargs()
  • Module contents
    • App
      • App.TARGET_PLACEHOLDER
      • App.WILDCARD_PLACEHOLDER
      • App.NAME_PLACEHOLDER
      • App.FULL_NAME_PLACEHOLDER
      • App.IDF_VERSION_PLACEHOLDER
      • App.INDEX_PLACEHOLDER
      • App.SDKCONFIG_LINE_REGEX
      • App.MANIFEST
      • App.LOG_ERROR_WARNING_REGEX
      • App.LOG_DEBUG_LINES
      • App.IGNORE_WARNS_REGEXES
      • App.build_system
      • App.app_dir
      • App.target
      • App.sdkconfig_path
      • App.config_name
      • App.sdkconfig_defaults_str
      • App.size_json_extra_args
      • App.dry_run
      • App.verbose
      • App.check_warnings
      • App.preserve
      • App.copy_sdkconfig
      • App.index
      • App.build_status
      • App.build_comment
      • App.test_comment
      • App.checked_should_build
      • App.from_another()
      • App.sdkconfig_defaults_candidates
      • App.name
      • App.work_dir
      • App.build_dir
      • App.build_path
      • App.build_log_filename
      • App.build_log_path
      • App.size_json_filename
      • App.size_json_path
      • App.sdkconfig_files_defined_idf_target
      • App.sdkconfig_files
      • App.depends_components
      • App.depends_filepatterns
      • App.supported_targets
      • App.verified_targets
      • App.record_build_duration()
      • App.build()
      • App.write_size_json()
      • App.to_json()
      • App.is_error_or_warning()
      • App.is_app()
      • App.is_modified()
      • App.check_should_build()
      • App.check_should_test()
    • AppDeserializer
      • AppDeserializer.app
      • AppDeserializer.from_json()
      • AppDeserializer.from_json_list()
    • CMakeApp
      • CMakeApp.SDKCONFIG_TEST_OPTS
      • CMakeApp.SDKCONFIG_IGNORE_OPTS
      • CMakeApp.CMAKE_PROJECT_LINE
      • CMakeApp.build_system
      • CMakeApp.cmake_vars
      • CMakeApp.app_dir
      • CMakeApp.target
      • CMakeApp.sdkconfig_path
      • CMakeApp.config_name
      • CMakeApp.sdkconfig_defaults_str
      • CMakeApp.size_json_extra_args
      • CMakeApp.dry_run
      • CMakeApp.verbose
      • CMakeApp.check_warnings
      • CMakeApp.preserve
      • CMakeApp.copy_sdkconfig
      • CMakeApp.index
      • CMakeApp.build_status
      • CMakeApp.build_comment
      • CMakeApp.test_comment
      • CMakeApp.checked_should_build
      • CMakeApp.is_app()
    • MakeApp
      • MakeApp.MAKE_PROJECT_LINE
      • MakeApp.build_system
      • MakeApp.supported_targets
      • MakeApp.is_app()
      • MakeApp.app_dir
      • MakeApp.target
      • MakeApp.sdkconfig_path
      • MakeApp.config_name
      • MakeApp.sdkconfig_defaults_str
      • MakeApp.size_json_extra_args
      • MakeApp.dry_run
      • MakeApp.verbose
      • MakeApp.check_warnings
      • MakeApp.preserve
      • MakeApp.copy_sdkconfig
      • MakeApp.index
      • MakeApp.build_status
      • MakeApp.build_comment
      • MakeApp.test_comment
      • MakeApp.checked_should_build
    • build_apps()
    • find_apps()
    • json_list_files_to_apps()
    • json_to_app()
    • setup_logging()