WritingExtensions

Mercurial features an extension mechanism for adding new commands. It allows you to create new features and use them directly from the main hg command line. The contrib directory includes an extension to mimic some git commands under Mercurial. This is named hgit, and will be used as an example here.

To load an extension, you add it to your .hgrc file. You can either specify an absolute path:

[extensions]
hgit=/usr/local/lib/hgit

Mercurial can also scan the default python library path for a file named 'hgit':

[extensions]
hgit=

hg help will now show the new commands provided by the hgit extension.

To write your own extension, your python module needs to provide a dict with entries describing each command, and a callback named reposetup. reposetup is called after the main Mercurial repository initialization, and can be used to setup any local state the extension might need. Below is an example extension to help demonstrate how things work:

from mercurial import hg

# every command must take a ui and and repo as arguments.
# opts is a dict where you can find other command line flags
#
# Other parameters are taken in order from items on the command line that
# don't start with a dash.  If no default value is given in the parameter list,
# they are required.
def print_parents(ui, repo, node, **opts):
    # The doc string below will show up in hg help
    """Print parent information"""

    # repo.lookup can lookup based on tags, an sha1, or a revision number
    node = repo.lookup(node)
    parents = repo.changelog.parents(node)

    if opts['short']:
        # hg.short will return a smaller portion of the sha1
        print "short %s %s" % (hg.short(parents[0]), hg.short(parents[1]))
    elif opts['long']:
        # hg.hex will return the full sha1 
        print "long %s %s" % (hg.hex(parents[0]), hg.hex(parents[1]))
    else:
        print "default %s %s" % (hg.short(parents[0]), hg.short(parents[1]))

cmdtable = {
    # cmd name        function call
    "print-parents": (print_parents, 
                     # see mercurial/fancyopts.py for all of the command
                     # flag options.
                     [('s', 'short', None, 'print short form'),
                      ('l', 'long', None, 'print long form')],
                     "hg print-parents [options] node")
}

def reposetup(ui, repo):
    pass
    # extension specific setup can go here