class documentation

class PreReceiveShellHook(ShellHook):

Constructor: PreReceiveShellHook(controldir)

View In Hierarchy

pre-receive shell hook.

Method __init__ Initialize pre-receive hook.
Method execute Execute the pre-receive hook.
Instance Variable controldir Undocumented

Inherited from ShellHook:

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, controldir: str):

Initialize pre-receive hook.

Parameters
controldir:strPath to the git control directory (.git)
def execute(self, client_refs: Sequence[tuple[bytes, bytes, bytes]]) -> tuple[bytes, bytes]:

Execute the pre-receive hook.

Parameters
client_refs:Sequence[tuple[bytes, bytes, bytes]]List of tuples containing (old_sha, new_sha, ref_name) for each reference to be updated
Returns
tuple[bytes, bytes]Tuple of (stdout, stderr) from hook execution
Raises
HookErrorIf hook execution fails (exits with non-zero status)
controldir =

Undocumented