view contrib/python-hook-examples.py @ 46059:7740d5102760

hg: add user-site to `sys.path` on Windows to allow pip-installed extensions

This has been in the TortoiseHg builds for several cycles now on Windows, and
even longer on macOS.  It allows an extension to be configured with `ext =`
syntax, instead of requiring the full path to be specified.  It's confusing for
a user to be hit with messages about not being able to load extensions, based
solely on which `hg.exe` is being run.

This only applies to py2exe binaries, since wrapper.exe already sees into the
user site area.  There are no frozen binaries on other platforms (that I'm aware
of), and an equivalent change will need to be made to `dispatch.py` in order to
work with PyOxidizer, since it bypasses this module completely.  (It also has
the ability to use the `site` module, so it will look completely different.)

Differential Revision: https://phab.mercurial-scm.org/D9531

'''
Examples of useful python hooks for Mercurial.
'''
from __future__ import absolute_import
from mercurial import (
    patch,
    util,
)


def diffstat(ui, repo, **kwargs):
    """Example usage:

    [hooks]
    commit.diffstat = python:/path/to/this/file.py:diffstat
    changegroup.diffstat = python:/path/to/this/file.py:diffstat
    """
    if kwargs.get('parent2'):
        return
    node = kwargs['node']
    first = repo[node].p1().node()
    if 'url' in kwargs:
        last = repo.changelog.tip()
    else:
        last = node
    diff = patch.diff(repo, first, last)
    ui.write(patch.diffstat(util.iterlines(diff)))