khard.actions module

Names and aliases for the subcommands on the command line

class khard.actions.Actions

Bases: object

A class to manage the names and aliases of the command line subcommands.

action_map = {'add-email': [], 'addressbooks': ['abooks'], 'birthdays': ['bdays'], 'copy': ['cp'], 'edit': ['modify', 'ed'], 'email': [], 'export': [], 'filename': ['file'], 'list': ['ls'], 'merge': [], 'move': ['mv'], 'new': ['add'], 'phone': [], 'postaddress': ['post', 'postaddr'], 'remove': ['delete', 'del', 'rm'], 'show': ['details'], 'source': ['src'], 'template': []}
classmethod get_action(alias)

Find the name of the action for the supplied alias. If no action is asociated with the given alias, None is returned.

Parameters:alias (str) – the alias to look up
Rturns:the name of the corresponding action or None
Return type:str or NoneType
classmethod get_actions()

Find the names of all defined actions.

Returns:all action names
Return type:iterable(str)
classmethod get_aliases(action)

Find all aliases for the given action. If there is no such action, None is returned.

Parameters:action (str) – the action name to look up
Returns:the list of aliases corresponding to the action or None
Return type:list(str) or NoneType
classmethod get_all()

Find the names of all defined actions and their aliases.

Returns:the names of all actions and aliases
Return type:generator(str)