nvflare.tool.package_checker.package_checker module

class PackageChecker

Bases: ABC

add_report(check_name, problem_text: str, fix_text: str)

check() → int

Checks if the package is runnable on the current system.

Returns:

if no dry-run process started. 1: if the dry-run process is started and return code is 0. 2: if the dry-run process is started and return code is not 0.

Return type:

0

check_dry_run() → int

Runs dry run command.

Returns:

if no process started. 1: if the process is started and return code is 0. 2: if the process is started and return code is not 0.

Return type:

0

abstract get_dry_run_command() → str

Returns dry run command.

get_dry_run_inputs()

get_report_data() → dict

Get report data as structured dictionary.

init(package_path: str)

abstract init_rules(package_path: str)

print_report()

set_json_output(enabled: bool)

Enable or disable JSON output format.

abstract should_be_checked() → bool

Check if this package should be checked by this checker.

stop_dry_run(force: bool = True)