linkcheck.cmdline

Utility functions suitable for command line clients.

Functions

aggregate_url(aggregate, url[, err_exit_code])

Append given commandline URL to input queue.

print_plugins(folders[, exit_code])

Print available plugins and exit.

print_usage(msg[, exit_code])

Print a program msg text to stderr and exit.

print_version([exit_code])

Print the program version and exit.

Classes

LCArgumentParser([prog, usage, description, …])

Custom argument parser to format help text.

class linkcheck.cmdline.LCArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)[source]

Bases: argparse.ArgumentParser

Custom argument parser to format help text.

print_help(file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)[source]

Print a help message to stdout.

linkcheck.cmdline.aggregate_url(aggregate, url, err_exit_code=2)[source]

Append given commandline URL to input queue.

linkcheck.cmdline.print_plugins(folders, exit_code=0)[source]

Print available plugins and exit.

linkcheck.cmdline.print_usage(msg, exit_code=2)[source]

Print a program msg text to stderr and exit.

linkcheck.cmdline.print_version(exit_code=0)[source]

Print the program version and exit.