class documentation
class ShellHook(Hook):
Known subclasses: dulwich.hooks.CommitMsgShellHook
, dulwich.hooks.PostCommitShellHook
, dulwich.hooks.PostReceiveShellHook
, dulwich.hooks.PreCommitShellHook
Hook by executable file
Implements standard githooks(5) [0]:
[0] http://www.kernel.org/pub/software/scm/git/docs/githooks.html
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 |
Undocumented |
Instance Variable | pre |
Undocumented |
def __init__(self, name, path, numparam, pre_exec_callback=None, post_exec_callback=None, cwd=None):
¶
overridden in
dulwich.hooks.CommitMsgShellHook
, dulwich.hooks.PostCommitShellHook
, dulwich.hooks.PostReceiveShellHook
, dulwich.hooks.PreCommitShellHook
Setup shell hook definition
Parameters | |
name | name of hook for error messages |
path | absolute path to executable file |
numparam | number of requirements parameters |
pre | closure 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 | closure 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 |
cwd | working directory to switch to when executing the hook |
overrides
dulwich.hooks.Hook.execute
overridden in
dulwich.hooks.PostReceiveShellHook
Execute the hook with given args