clone: move code into hg module. make doc better.
authorVadim Gelfer <vadim.gelfer@gmail.com>
Tue, 11 Jul 2006 16:18:53 -0700
changeset 2597 5ba8be56fa8f
parent 2596 e3258cc3ed63
child 2598 b898afee9d0d
clone: move code into hg module. make doc better. api in commands module is still same, but version in hg is best for calling within python now.
mercurial/commands.py
mercurial/hg.py
--- a/mercurial/commands.py	Tue Jul 11 15:52:56 2006 -0700
+++ b/mercurial/commands.py	Tue Jul 11 16:18:53 2006 -0700
@@ -956,107 +956,15 @@
     .hg/hgrc will be created on the remote side. Look at the help text
     for the pull command for important details about ssh:// URLs.
     """
-    if dest is None:
-        dest = os.path.basename(os.path.normpath(source))
-
-    if os.path.exists(dest):
-        raise util.Abort(_("destination '%s' already exists"), dest)
-
-    class Dircleanup(object):
-        def __init__(self, dir_):
-            self.rmtree = shutil.rmtree
-            self.dir_ = dir_
-        def close(self):
-            self.dir_ = None
-        def __del__(self):
-            if self.dir_:
-                self.rmtree(self.dir_, True)
-
     if opts['ssh']:
         ui.setconfig("ui", "ssh", opts['ssh'])
     if opts['remotecmd']:
         ui.setconfig("ui", "remotecmd", opts['remotecmd'])
 
-    source = ui.expandpath(source)
-    src_repo = hg.repository(ui, source)
-
-    dest_repo = None
-    try:
-        dest_repo = hg.repository(ui, dest)
-        raise util.Abort(_("destination '%s' already exists." % dest))
-    except hg.RepoError:
-        dest_repo = hg.repository(ui, dest, create=1)
-
-    dest_path = None
-    d = None
-    if dest_repo.local():
-        dest_path = os.path.realpath(dest)
-        d = Dircleanup(dest_path)
-
-    abspath = source
-    copy = False
-    if src_repo.local() and dest_repo.local():
-        abspath = os.path.abspath(source)
-        if not opts['pull'] and not opts['rev']:
-            copy = True
-
-    if copy:
-        try:
-            # we use a lock here because if we race with commit, we
-            # can end up with extra data in the cloned revlogs that's
-            # not pointed to by changesets, thus causing verify to
-            # fail
-            l1 = src_repo.lock()
-        except lock.LockException:
-            copy = False
-
-    if copy:
-        # we lock here to avoid premature writing to the target
-        l2 = lock.lock(os.path.join(dest_path, ".hg", "lock"))
-
-	# we need to remove the (empty) data dir in dest so copyfiles can do it's work
-	os.rmdir( os.path.join(dest_path, ".hg", "data") )
-        files = "data 00manifest.d 00manifest.i 00changelog.d 00changelog.i"
-        for f in files.split():
-            src = os.path.join(source, ".hg", f)
-            dst = os.path.join(dest_path, ".hg", f)
-            try:
-                util.copyfiles(src, dst)
-            except OSError, inst:
-                if inst.errno != errno.ENOENT:
-                    raise
-
-	# we need to re-init the repo after manually copying the data into it
-        dest_repo = hg.repository(ui, dest)
-
-    else:
-        revs = None
-        if opts['rev']:
-            if not src_repo.local():
-                error = _("clone -r not supported yet for remote repositories.")
-                raise util.Abort(error)
-            else:
-                revs = [src_repo.lookup(rev) for rev in opts['rev']]
-
-        if dest_repo.local():
-            dest_repo.pull(src_repo, heads = revs)
-        elif src_repo.local():
-            src_repo.push(dest_repo, revs = revs)
-        else:
-            error = _("clone from remote to remote not supported.")
-            raise util.Abort(error)
-
-    if dest_repo.local():
-        f = dest_repo.opener("hgrc", "w", text=True)
-        f.write("[paths]\n")
-        f.write("default = %s\n" % abspath)
-        f.close()
-
-        if not opts['noupdate']:
-            doupdate(dest_repo.ui, dest_repo)
-
-    if d:
-        d.close()
+    hg.clone(ui, ui.expandpath(source), dest,
+             pull=opts['pull'],
+             rev=opts['rev'],
+             update=not opts['noupdate'])
 
 def commit(ui, repo, *pats, **opts):
     """commit the specified files or all outstanding changes
--- a/mercurial/hg.py	Tue Jul 11 15:52:56 2006 -0700
+++ b/mercurial/hg.py	Tue Jul 11 16:18:53 2006 -0700
@@ -10,7 +10,7 @@
 from demandload import *
 from i18n import gettext as _
 demandload(globals(), "localrepo bundlerepo httprepo sshrepo statichttprepo")
-demandload(globals(), "os util")
+demandload(globals(), "errno lock os shutil util")
 
 def bundle(ui, path):
     if path.startswith('bundle://'):
@@ -73,3 +73,133 @@
             raise util.Abort(_('cannot create new repository over "%s" protocol') %
                              scheme)
     return ctor(ui, path)
+
+def clone(ui, source, dest=None, pull=False, rev=None, update=True):
+    """Make a copy of an existing repository.
+
+    Create a copy of an existing repository in a new directory.  The
+    source and destination are URLs, as passed to the repository
+    function.  Returns a pair of repository objects, the source and
+    newly created destination.
+
+    The location of the source is added to the new repository's
+    .hg/hgrc file, as the default to be used for future pulls and
+    pushes.
+
+    If an exception is raised, the partly cloned/updated destination
+    repository will be deleted.
+    
+    Keyword arguments:
+
+    dest: URL of destination repository to create (defaults to base
+    name of source repository)
+
+    pull: always pull from source repository, even in local case
+
+    rev: revision to clone up to (implies pull=True)
+
+    update: update working directory after clone completes, if
+    destination is local repository
+    """
+    if dest is None:
+        dest = os.path.basename(os.path.normpath(source))
+
+    if os.path.exists(dest):
+        raise util.Abort(_("destination '%s' already exists"), dest)
+
+    class DirCleanup(object):
+        def __init__(self, dir_):
+            self.rmtree = shutil.rmtree
+            self.dir_ = dir_
+        def close(self):
+            self.dir_ = None
+        def __del__(self):
+            if self.dir_:
+                self.rmtree(self.dir_, True)
+
+    src_repo = repository(ui, source)
+
+    dest_repo = None
+    try:
+        dest_repo = repository(ui, dest)
+        raise util.Abort(_("destination '%s' already exists." % dest))
+    except RepoError:
+        dest_repo = repository(ui, dest, create=True)
+
+    dest_path = None
+    dir_cleanup = None
+    if dest_repo.local():
+        dest_path = os.path.realpath(dest)
+        dir_cleanup = DirCleanup(dest_path)
+
+    abspath = source
+    copy = False
+    if src_repo.local() and dest_repo.local():
+        abspath = os.path.abspath(source)
+        copy = not pull and not rev
+
+    src_lock, dest_lock = None, None
+    if copy:
+        try:
+            # we use a lock here because if we race with commit, we
+            # can end up with extra data in the cloned revlogs that's
+            # not pointed to by changesets, thus causing verify to
+            # fail
+            src_lock = src_repo.lock()
+        except lock.LockException:
+            copy = False
+
+    if copy:
+        # we lock here to avoid premature writing to the target
+        dest_lock = lock.lock(os.path.join(dest_path, ".hg", "lock"))
+
+	# we need to remove the (empty) data dir in dest so copyfiles
+	# can do its work
+	os.rmdir(os.path.join(dest_path, ".hg", "data"))
+        files = "data 00manifest.d 00manifest.i 00changelog.d 00changelog.i"
+        for f in files.split():
+            src = os.path.join(source, ".hg", f)
+            dst = os.path.join(dest_path, ".hg", f)
+            try:
+                util.copyfiles(src, dst)
+            except OSError, inst:
+                if inst.errno != errno.ENOENT:
+                    raise
+
+	# we need to re-init the repo after manually copying the data
+	# into it
+        dest_repo = repository(ui, dest)
+
+    else:
+        revs = None
+        if rev:
+            if not src_repo.local():
+                raise util.Abort(_("clone by revision not supported yet "
+                                   "for remote repositories"))
+            revs = [src_repo.lookup(r) for r in rev]
+
+        if dest_repo.local():
+            dest_repo.pull(src_repo, heads=revs)
+        elif src_repo.local():
+            src_repo.push(dest_repo, revs=revs)
+        else:
+            raise util.Abort(_("clone from remote to remote not supported"))
+
+    if src_lock:
+        src_lock.release()
+
+    if dest_repo.local():
+        fp = dest_repo.opener("hgrc", "w", text=True)
+        fp.write("[paths]\n")
+        fp.write("default = %s\n" % abspath)
+        fp.close()
+
+        if dest_lock:
+            dest_lock.release()
+
+        if update:
+            dest_repo.update(dest_repo.changelog.tip())
+    if dir_cleanup:
+        dir_cleanup.close()
+
+    return src_repo, dest_repo