filled in some docs for hooks

rhodecode/lib/hooks.py

@@ -1,105 +1,116 b''
-#!/usr/bin/env python
-# encoding: utf-8
-# custom hooks for application
-# Copyright (C) 2009-2011 Marcin Kuzminski <[e-mail]>
-#
+# -*- coding: utf-8 -*-
+"""
+    rhodecode.lib.hooks
+    ~~~~~~~~~~~~~~~~~~~
+
+    Hooks runned by rhodecode
+    
+    :created_on: Aug 6, 2010
+    :author: marcink
+    :copyright: (C) 2009-2011 Marcin Kuzminski <[e-mail]>    
+    :license: GPLv3, see COPYING for more details.
+"""
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
 # as published by the Free Software Foundation; version 2
 # of the License or (at your opinion) any later version of the license.
 # 
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 # 
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 # MA  02110-1301, USA.
-"""
-Created on Aug 6, 2010
+import os
+import sys
+import getpass
 
-@author: marcink
-"""
 from mercurial.cmdutil import revrange
 from mercurial.node import nullrev
+
 from rhodecode.lib import helpers as h
 from rhodecode.lib.utils import action_logger
-import os
-import sys
 
 def repo_size(ui, repo, hooktype=None, **kwargs):
+    """Presents size of repository after push
+    
+    :param ui:
+    :param repo:
+    :param hooktype:
+    """
 
     if hooktype != 'changegroup':
         return False
     size_hg, size_root = 0, 0
     for path, dirs, files in os.walk(repo.root):
         if path.find('.hg') != -1:
             for f in files:
                 try:
                     size_hg += os.path.getsize(os.path.join(path, f))
                 except OSError:
                     pass
         else:
             for f in files:
                 try:
                     size_root += os.path.getsize(os.path.join(path, f))
                 except OSError:
                     pass
 
     size_hg_f = h.format_byte_size(size_hg)
     size_root_f = h.format_byte_size(size_root)
     size_total_f = h.format_byte_size(size_root + size_hg)
     sys.stdout.write('Repository size .hg:%s repo:%s total:%s\n' \
                      % (size_hg_f, size_root_f, size_total_f))
 
 def log_pull_action(ui, repo, **kwargs):
-    """
-    Logs user last pull action
+    """Logs user last pull action
+    
     :param ui:
     :param repo:
     """
 
     extra_params = dict(repo.ui.configitems('rhodecode_extras'))
     username = extra_params['username']
     repository = extra_params['repository']
     action = 'pull'
 
     action_logger(username, action, repository, extra_params['ip'])
 
     return 0
 
 def log_push_action(ui, repo, **kwargs):
-    """
-    Maps user last push action to new changeset id, from mercurial
+    """Maps user last push action to new changeset id, from mercurial
+    
     :param ui:
     :param repo:
     """
 
     extra_params = dict(repo.ui.configitems('rhodecode_extras'))
     username = extra_params['username']
     repository = extra_params['repository']
     action = 'push:%s'
     node = kwargs['node']
 
     def get_revs(repo, rev_opt):
         if rev_opt:
             revs = revrange(repo, rev_opt)
 
             if len(revs) == 0:
                 return (nullrev, nullrev)
             return (max(revs), min(revs))
         else:
             return (len(repo) - 1, 0)
 
     stop, start = get_revs(repo, [node + ':'])
 
     revs = (str(repo[r]) for r in xrange(start, stop + 1))
 
     action = action % ','.join(revs)
 
     action_logger(username, action, repository, extra_params['ip'])
 
     return 0