ape.plugins.sleep_plugin.Sleep

class ape.plugins.sleep_plugin.Sleep(*args, **kwargs)

A plugin for TheBigSleep

Constructor for Sleep

__init__(*args, **kwargs)

Constructor for Sleep

Methods

__init__(*args, **kwargs)	Constructor for Sleep
fetch_config()	prints a config-file sample
help([width])	Prints a help-string for the plugin
log_error(error[, message])	Logs the error in bold red

Attributes

help_page	A HelpPage to use if self.sections has been defined
logger	return:A logging object.
product	A built TheBigSleep object
sections	Help dictionary

fetch_config()

prints a config-file sample

help(width=80)

Prints a help-string for the plugin

Param:

• width: number of characters wide to print help

log_error(error, message='')

Logs the error in bold red

Param:

• error: error type (prefix in red and bold)
• message: descriptive message (red but not bold)

help_page

A HelpPage to use if self.sections has been defined

logger

Returns:A logging object.

product

A built TheBigSleep object

Returns:TheBigSleep

sections

Help dictionary

subsection

the plugin sub-section