nvflare.tool.package_checker.check_rule module

class CheckAddressBinding(name: str, get_host_and_port_from_package)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckNonPrimarySPGRPCServerAvailable(name: str, required: bool = True)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckNonPrimarySPSocketServerAvailable(name: str, required: bool = True)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckOverseerRunning(name: str, role: str)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckPrimarySPGRPCServerAvailable(name: str, required: bool = True)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckPrimarySPSocketServerAvailable(name: str, required: bool = True)[source]

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)[source]

Bases: object

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

Bases: ABC

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckSPListInResponse(name: str, required: bool = True)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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

class CheckWriting(name: str, get_filename_from_package)[source]

Bases: CheckRule

Creates a CheckRule.

Parameters:
  • name (str) – name of the rule

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