Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Assign NameStore BinOpMod Str NameLoad If CompareIsNot NameLoad NameLoad body Assign NameStore BinOpAdd NameLoad BinOpMod Str NameLoad If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults Str NameLoad NameLoad NameLoad body Expr Str Assign NameStore BinOpMod Str NameLoad With Call NameLoad NameLoad body If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str If UnaryOpNot NameLoad body Raise Call NameLoad Str Assign NameStore Str With Call NameLoad NameLoad body If BoolOpAnd NameLoad CompareIs NameLoad NameLoad body Expr Call NameLoad NameLoad orelse If NameLoad body Expr Call NameLoad NameLoad keyword NameLoad orelse Expr Call NameLoad NameLoad decorator_list
N/A N/A 
Mercurial
=========

This module provides low-level tools for managing `Mercurial`_ repositories.
You should normally not use them directly but rather use the high-level wrapper
:func:`fabtools.require.mercurial.working_copy` instead.

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

 fabric.api run fabric.api sudo fabric.context_managers cd fabtools.utils run_as_root clone N/A N/A remote_url path use_sudo user N/A None False None N/A N/A 
    Clone a remote Mercurial repository into a new directory.

    :param remote_url: URL of the remote repository to clone.
    :type remote_url: str

    :param path: Path of the working copy directory.  Must not exist yet.
    :type path: str

    :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 cmd N/A hg --quiet clone %s remote_url N/A N/A path None N/A N/A cmd N/A cmd N/A  %s path N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A update N/A N/A path branch use_sudo user force N/A default False None False N/A N/A 
    Merge changes to a working copy and/or switch branches.

    :param path: Path of the working copy directory.  This directory must exist
                 and be a Mercurial working copy.
    :type path: str

    :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 cmd N/A hg up %s branch N/A N/A cd path N/A N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A pull N/A N/A path use_sudo user N/A False None N/A N/A 
    Pull changes from the default remote repository.

    :param path: Path of the working copy directory.  This directory must exist
                 and be a Mercurial working copy with a default remote to pull
                 from.
    :type path: str

    :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 path N/A N/A N/A ValueError Path to the working copy is needed to pull from a remote repository. N/A cmd hg pull N/A N/A cd path N/A N/A N/A use_sudo N/A user None N/A N/A N/A run_as_root cmd N/A N/A use_sudo N/A N/A N/A sudo cmd user user N/A N/A N/A run cmd N/A