kallithea Changeset - 061ce7c3071a

Changeset - 061ce7c3071a

Parent rev.

Child rev.

[Not reviewed]

default

0 2 0

Mads Kiilerich - 10 years ago 2015-08-20 17:29:55
madski@unity3d.com

hooks: add some docstrings

2 files changed with 15 insertions and 12 deletions:

kallithea/lib/hooks.py

kallithea/model/scm.py

0 comments (0 inline, 0 general)

kallithea/lib/hooks.py

➞

Show inline comments

@@ @@ -154,16 +154,14 @@ def log_pull_action(ui, repo, **kwargs): @@
             sys.stdout.write(_http_ret.title)
     return 0
 def log_push_action(ui, repo, **kwargs):
     """
     Maps user last push action to new changeset id, from mercurial
     :param ui:
     :param repo: repo object containing the `ui` object
     Register that changes have been pushed.
     Mercurial invokes this directly as a hook, git uses handle_git_receive.
     """
     ex = _extract_extras()
     action_tmpl = ex.action + ':%s'
     revs = []
@@ @@ -366,19 +364,19 @@ def log_delete_user(user_dict, deleted_b @@
     if callable(callback):
         return callback(deleted_by=deleted_by, **user_dict)
     return 0
 handle_git_pre_receive = (lambda repo_path, revs, env:
     handle_git_receive(repo_path, revs, env, hook_type='pre'))
 handle_git_post_receive = (lambda repo_path, revs, env:
     handle_git_receive(repo_path, revs, env, hook_type='post'))
 def handle_git_pre_receive(repo_path, revs, env):
     return handle_git_receive(repo_path, revs, env, hook_type='pre')
 def handle_git_post_receive(repo_path, revs, env):
     return handle_git_receive(repo_path, revs, env, hook_type='post')
-def handle_git_receive(repo_path, revs, env, hook_type='post'):
 def handle_git_receive(repo_path, revs, env, hook_type):
     """
     A really hacky method that is run by git post-receive hook and logs
     an push action together with pushed revisions. It's executed by subprocess
     thus needs all info to be able to create a on the fly pylons environment,
     connect to database and run the logging code. Hacky as sh*t but works.

kallithea/model/scm.py

➞

Show inline comments

@@ @@ -502,12 +502,15 @@ class ScmModel(BaseModel): @@
             return GitInMemoryChangeset
         raise Exception('Invalid scm_type, must be one of hg,git got %s'
                         % (scm_type,))
     def pull_changes(self, repo, username):
         """
         Pull from "clone URL".
         """
         dbrepo = self.__get_repo(repo)
         clone_uri = dbrepo.clone_uri
         if not clone_uri:
             raise Exception("This repository doesn't have a clone uri")
         repo = dbrepo.scm_instance
@@ @@ -533,16 +536,15 @@ class ScmModel(BaseModel): @@
             log.error(traceback.format_exc())
             raise
     def commit_change(self, repo, repo_name, cs, user, author, message,
                       content, f_path):
         """
-        Commits changes
+        Commit a change to a single file
         :param repo: SCM instance
         :param repo: a db_repo.scm_instance
         """
         user = self._get_user(user)
         IMC = self._get_IMC_module(repo.alias)
         # decoding here will force that we have proper encoded values
         # in any other case this will throw exceptions and deny commit
@@ @@ -674,12 +676,15 @@ class ScmModel(BaseModel): @@
                               repo_name=repo.repo_name,
                               revisions=[tip.raw_id])
         return tip
     def update_nodes(self, user, repo, message, nodes, parent_cs=None,
                      author=None, trigger_push_hook=True):
         """
         Commits specified nodes to repo. Again.
         """
         user = self._get_user(user)
         scm_instance = repo.scm_instance_no_cache()
         message = safe_unicode(message)
         committer = user.full_contact
         author = safe_unicode(author) if author else committer

0 comments (0 inline, 0 general)