MaskArgs

class tools.mask.cli.MaskArgs(subparser: _SubParsersAction | None, command: str, description: str = 'default')

Bases: FaceSwapArgs

Class to parse the command line arguments for Mask tool

Methods Summary

get_argument_list()

Returns the argument list for the current command.

get_info()

Return command information

get_optional_arguments()

Returns the optional argument list for the current command.

Methods Documentation

Parameters:
  • subparser (_SubParsersAction | None)

  • command (str)

  • description (str)

static get_argument_list()

Returns the argument list for the current command.

The argument list should be a list of dictionaries pertaining to each option for a command. This function should be overridden with the actual argument list for each command’s argument list.

See existing parsers for examples.

Returns:

The list of command line options for the given command

Return type:

list

static get_info()

Return command information

static get_optional_arguments() list[dict[str, Any]]

Returns the optional argument list for the current command.

The optional arguments list is not always required, but is used when there are shared options between multiple commands (e.g. convert and extract). Only override if required.

Returns:

The list of optional command line options for the given command

Return type:

list

static get_argument_list()

Returns the argument list for the current command.

The argument list should be a list of dictionaries pertaining to each option for a command. This function should be overridden with the actual argument list for each command’s argument list.

See existing parsers for examples.

Returns:

The list of command line options for the given command

Return type:

list

static get_info()

Return command information