AlignmentsArgs

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

Bases: FaceSwapArgs

Class to parse the command line arguments for Alignments tool

Methods Summary

get_argument_list()	Collect the argparse argument options.
get_info()	Obtain 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]]

Collect the argparse argument options.

Returns:

The argparse command line options for processing by argparse

Return type:

dict

static get_info() → str

Obtain command information.

Returns:

The help text for displaying in argparses help output

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

Collect the argparse argument options.

Returns:

The argparse command line options for processing by argparse

Return type:

dict

static get_info() → str

Obtain command information.

Returns:

The help text for displaying in argparses help output

Return type:

str