pic_scanner.cli.arguments

Attributes

PROG_NAME

The name of the program.

AUTHORS

The authors of the project.

PROG_DESC

The description of the program.

Classes

BaseSubCommandHandler

CommandHandler

Parser

Object for parsing command line strings into Python objects.

Functions

parse_version(→ str)

Parses the version information into a string.

Package Contents

pic_scanner.cli.arguments.parse_version() → str

Parses the version information into a string.

Returns:

The version information.

Return type:

str

Since:

v1.3.2

pic_scanner.cli.arguments.PROG_NAME = 'IS-NSFW-Scanner'

The name of the program.

pic_scanner.cli.arguments.AUTHORS

The authors of the project.

pic_scanner.cli.arguments.PROG_DESC = 'A tool for scanning (and managing) images for NSFW content.'

The description of the program.

class pic_scanner.cli.arguments.BaseSubCommandHandler
class pic_scanner.cli.arguments.CommandHandler(args)
class pic_scanner.cli.arguments.Parser(*args, **kwargs)

Bases: argparse.ArgumentParser

Object for parsing command line strings into Python objects.

Keyword Arguments:

  • (default (- usage -- A usage message) – os.path.basename(sys.argv[0]))

  • (default – auto-generated from arguments)

  • does (- description -- A description of what the program)

  • descriptions (- epilog -- Text following the argument)

  • one (- parents -- Parsers whose arguments should be copied into this)

  • messages (- formatter_class -- HelpFormatter class for printing help)

  • arguments (- argument_default -- The default value for all)

  • containing (- fromfile_prefix_chars -- Characters that prefix files) – additional arguments

  • arguments

  • conflicts (- conflict_handler -- String indicating how to handle)

  • option (- add_help -- Add a -h/-help)

  • unambiguously (- allow_abbrev -- Allow long options to be abbreviated)

  • with (- exit_on_error -- Determines whether or not ArgumentParser exits) – error info when an error occurs

parse_args(*args, **kwargs)
register_subcommand(sub_command_handler: SubCommandHandler, *args, **kwargs)
Parameters:

sub_command_handler (SubCommandHandler)