nvflare.tool.package_checker.check_rule module

class CheckAddressBinding(name: str, get_host_and_port_from_package)

Bases: CheckRule

Creates a CheckRule.

Parameters:

• name (str) – name of the rule

• required (bool) – whether this rule is required to pass.

class CheckResult(problem='', solution='', data=None)

Bases: object

class CheckRule(name: str, required: bool = True)

Bases: ABC

Creates a CheckRule.

Parameters:

• name (str) – name of the rule

• required (bool) – whether this rule is required to pass.

class CheckServerAvailable(name: str, role: str)

Bases: CheckRule

Initialize server availability checker.

This rule automatically detects the communication scheme (GRPC, HTTP, etc.) and uses the appropriate method to check server connectivity.

Parameters:

• name – Name of the check rule

• role – Role of the entity performing the check (server/client/admin)

class CheckWriting(name: str, get_filename_from_package)

Bases: CheckRule

Creates a CheckRule.

Parameters:

• name (str) – name of the rule

• required (bool) – whether this rule is required to pass.