ExtractArgs

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

Bases: ExtractConvertArgs

Creates the command line arguments for extraction.

This class inherits base options from ExtractConvertArgs where arguments that are used for both Extract and Convert should be placed.

Commands explicit to Extract should be added in get_optional_arguments()

Methods Summary

get_argument_list()

Returns the argument list for shared Extract and Convert arguments.

get_info()

The information text for the Extract command.

get_optional_arguments()

Returns the argument list unique to the Extract 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

The information text for the Extract command.

Returns:

The information text for the Extract command.

Return type:

str

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

Returns the argument list unique to the Extract command.

Returns:

The list of optional command line options for the Extract command

Return type:

list

static get_info() str

The information text for the Extract command.

Returns:

The information text for the Extract command.

Return type:

str

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

Returns the argument list unique to the Extract command.

Returns:

The list of optional command line options for the Extract command

Return type:

list