class documentation

Hook by executable file

Implements standard githooks(5) [0]:


Method __init__ Setup shell hook definition
Method execute Execute the hook with given args
Instance Variable cwd Undocumented
Instance Variable filepath Undocumented
Instance Variable name Undocumented
Instance Variable numparam Undocumented
Instance Variable post_exec_callback Undocumented
Instance Variable pre_exec_callback Undocumented
def __init__(self, name, path, numparam, pre_exec_callback=None, post_exec_callback=None, cwd=None):

Setup shell hook definition

namename of hook for error messages
pathabsolute path to executable file
numparamnumber of requirements parameters
pre_exec_callbackclosure for setup before execution Defaults to None. Takes in the variable argument list from the execute functions and returns a modified argument list for the shell hook.
post_exec_callbackclosure for cleanup after execution Defaults to None. Takes in a boolean for hook success and the modified argument list and returns the final hook return value if applicable
cwdworking directory to switch to when executing the hook
def execute(self, *args):

Execute the hook with given args

cwd =


filepath =


name =


numparam =


post_exec_callback =


pre_exec_callback =