Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias alias FunctionDef arguments args defaults body Expr Str ImportFrom alias identifier ImportFrom alias identifier ImportFrom alias identifier Assign NameStore Call NameLoad Str keyword NameLoad If AttributeLoad NameLoad attr body Assign NameStore Call NameLoad If CompareEq NameLoad Str body Expr Call NameLoad Str orelse If CompareEq NameLoad Str body Expr Call NameLoad Str orelse If CompareEq NameLoad Str body Expr Call NameLoad Str orelse Raise Call NameLoad keyword ListLoad Str Str Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad Str NameLoad NameLoad NameLoad body Expr Str Expr Call NameLoad If CompareIs NameLoad NameLoad body Assign NameStore SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num If Call NameLoad NameLoad keyword NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad keyword NameLoad keyword NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad orelse If UnaryOpNot Call NameLoad NameLoad keyword NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Expr Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad orelse Raise Call NameLoad Str decorator_list
N/A N/A 
Mercurial
=========

This module provides high-level tools for managing `Mercurial`_ repositories.

.. _Mercurial: http://mercurial.selenic.com/

 fabric.api run fabtools mercurial fabtools.files is_dir fabtools.system UnsupportedFamily distrib_family command N/A N/A N/A N/A N/A 
    Require the ``hg`` command-line tool.

    Example::

        from fabric.api import run
        from fabtools import require

        require.mercurial.command()
        run('hg --help')

     fabtools.require.deb package require_deb_package fabtools.require.rpm package require_rpm_package fabtools.require.portage package require_portage_package N/A res N/A run hg --version quiet True N/A N/A res failed N/A N/A family N/A distrib_family N/A N/A family debian N/A N/A N/A require_deb_package mercurial N/A N/A N/A family gentoo N/A N/A N/A require_portage_package mercurial N/A N/A N/A family redhat N/A N/A N/A require_rpm_package mercurial N/A N/A N/A UnsupportedFamily supported N/A debian redhat gentoo N/A working_copy N/A N/A remote_url path branch update use_sudo user N/A None default True False None N/A N/A 
    Require a working copy of the repository from the ``remote_url``.

    The ``path`` is optional, and defaults to the last segment of the
    remote repository URL.

    If the ``path`` does not exist, this will clone the remote
    repository and check out the specified branch.

    If the ``path`` exists and ``update`` is ``True``, it will pull
    changes from the remote repository, check out the specified branch,
    then update the working copy.

    If the ``path`` exists and ``update`` is ``False``, it will only
    check out the specified branch, without pulling remote changesets.

    :param remote_url: URL of the remote repository
    :type remote_url: str

    :param path: Absolute or relative path of the working copy on the
                 filesystem.  If this directory doesn't exist yet, a new
                 working copy is created through ``hg clone``.  If the
                 directory does exist *and* ``update == True``, a
                 ``hg pull && hg up`` is issued.  If ``path is None`` the
                 ``hg clone`` is issued in the current working directory and
                 the directory name of the working copy is created by ``hg``.
    :type path: str

    :param branch: Branch or tag to check out.  If the given value is a tag
                   name, update must be ``False`` or consecutive calls will
                   fail.
    :type branch: str

    :param update: Whether or not to pull and update remote changesets.
    :type update: bool

    :param use_sudo: If ``True`` execute ``hg`` with
                     :func:`fabric.operations.sudo`, else with
                     :func:`fabric.operations.run`.
    :type use_sudo: bool

    :param user: If ``use_sudo is True``, run :func:`fabric.operations.sudo`
                 with the given user.  If ``use_sudo is False`` this parameter
                 has no effect.
    :type user: str
     N/A N/A command N/A N/A path None N/A N/A path N/A N/A N/A remote_url split / N/A -1 N/A N/A is_dir path use_sudo use_sudo N/A N/A N/A N/A mercurial pull path use_sudo use_sudo user user N/A update N/A N/A N/A N/A mercurial update path path branch branch use_sudo use_sudo user user N/A N/A N/A N/A is_dir path use_sudo use_sudo N/A N/A N/A N/A mercurial clone remote_url path path use_sudo use_sudo user user N/A N/A N/A mercurial update path path branch branch use_sudo use_sudo user user N/A N/A N/A ValueError Invalid combination of parameters. N/A