ExtractConvertArgs

class lib.cli.args_extract_convert.ExtractConvertArgs(subparser: _SubParsersAction | None, command: str, description: str = 'default')

Bases: FaceSwapArgs

Parent class to capture arguments that will be used in both extract and convert processes.

Extract and Convert share a fair amount of arguments, so arguments that can be used in both of these processes should be placed here.

No further processing is done in this class (this is handled by the children), this just captures the shared arguments.

Methods Summary

get_argument_list()	Returns the argument list for shared Extract and Convert arguments.
get_info()	Returns the information text for the current command.
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() → list[dict[str, Any]]

Returns the argument list for shared Extract and Convert arguments.

Returns:

The list of command line options for the given Extract and Convert

Return type:

list

static get_info() → str

Returns the information text for the current command.

This function should be overridden with the actual command help text for each commands’ parser.

Returns:

The information text for this command.

Return type:

str

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() → list[dict[str, Any]]

Returns the argument list for shared Extract and Convert arguments.

Returns:

The list of command line options for the given Extract and Convert

Return type:

list