PreviewArgs

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

Bases: FaceSwapArgs

Class to parse the command line arguments for Preview (Convert Settings) tool

Methods Summary

get_argument_list()	Put the arguments in a list so that they are accessible from both argparse and gui
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() → list[dict[str, Any]]

Put the arguments in a list so that they are accessible from both argparse and gui

Returns:

Top command line options for the preview tool

Return type:

list[dict[str, Any]]

static get_info() → str

Return command information

Returns:

Top line information about the Preview tool

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]]

Put the arguments in a list so that they are accessible from both argparse and gui

Returns:

Top command line options for the preview tool

Return type:

list[dict[str, Any]]

static get_info() → str

Return command information

Returns:

Top line information about the Preview tool

Return type:

str