Mercurial > hg
view hgext/transplant.py @ 45095:8e04607023e5
procutil: ensure that procutil.std{out,err}.write() writes all bytes
Python 3 offers different kind of streams and it’s not guaranteed for all of
them that calling write() writes all bytes.
When Python is started in unbuffered mode, sys.std{out,err}.buffer are
instances of io.FileIO, whose write() can write less bytes for
platform-specific reasons (e.g. Linux has a 0x7ffff000 bytes maximum and could
write less if interrupted by a signal; when writing to Windows consoles, it’s
limited to 32767 bytes to avoid the "not enough space" error). This can lead to
silent loss of data, both when using sys.std{out,err}.buffer (which may in fact
not be a buffered stream) and when using the text streams sys.std{out,err}
(I’ve created a CPython bug report for that:
https://bugs.python.org/issue41221).
Python may fix the problem at some point. For now, we implement our own wrapper
for procutil.std{out,err} that calls the raw stream’s write() method until all
bytes have been written. We don’t use sys.std{out,err} for larger writes, so I
think it’s not worth the effort to patch them.
author | Manuel Jacob <me@manueljacob.de> |
---|---|
date | Fri, 10 Jul 2020 12:27:58 +0200 |
parents | 9d2b2df2c2ba |
children | 03726f5b6092 |
line wrap: on
line source
# Patch transplanting extension for Mercurial # # Copyright 2006, 2007 Brendan Cully <brendan@kublai.com> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. '''command to transplant changesets from another branch This extension allows you to transplant changes to another parent revision, possibly in another repository. The transplant is done using 'diff' patches. Transplanted patches are recorded in .hg/transplant/transplants, as a map from a changeset hash to its hash in the source repository. ''' from __future__ import absolute_import import os from mercurial.i18n import _ from mercurial.pycompat import open from mercurial import ( bundlerepo, cmdutil, error, exchange, hg, logcmdutil, match, merge, node as nodemod, patch, pycompat, registrar, revlog, revset, scmutil, smartset, state as statemod, util, vfs as vfsmod, ) from mercurial.utils import ( procutil, stringutil, ) class TransplantError(error.Abort): pass cmdtable = {} command = registrar.command(cmdtable) # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # be specifying the version(s) of Mercurial they are tested with, or # leave the attribute unspecified. testedwith = b'ships-with-hg-core' configtable = {} configitem = registrar.configitem(configtable) configitem( b'transplant', b'filter', default=None, ) configitem( b'transplant', b'log', default=None, ) class transplantentry(object): def __init__(self, lnode, rnode): self.lnode = lnode self.rnode = rnode class transplants(object): def __init__(self, path=None, transplantfile=None, opener=None): self.path = path self.transplantfile = transplantfile self.opener = opener if not opener: self.opener = vfsmod.vfs(self.path) self.transplants = {} self.dirty = False self.read() def read(self): abspath = os.path.join(self.path, self.transplantfile) if self.transplantfile and os.path.exists(abspath): for line in self.opener.read(self.transplantfile).splitlines(): lnode, rnode = map(revlog.bin, line.split(b':')) list = self.transplants.setdefault(rnode, []) list.append(transplantentry(lnode, rnode)) def write(self): if self.dirty and self.transplantfile: if not os.path.isdir(self.path): os.mkdir(self.path) fp = self.opener(self.transplantfile, b'w') for list in pycompat.itervalues(self.transplants): for t in list: l, r = map(nodemod.hex, (t.lnode, t.rnode)) fp.write(l + b':' + r + b'\n') fp.close() self.dirty = False def get(self, rnode): return self.transplants.get(rnode) or [] def set(self, lnode, rnode): list = self.transplants.setdefault(rnode, []) list.append(transplantentry(lnode, rnode)) self.dirty = True def remove(self, transplant): list = self.transplants.get(transplant.rnode) if list: del list[list.index(transplant)] self.dirty = True class transplanter(object): def __init__(self, ui, repo, opts): self.ui = ui self.path = repo.vfs.join(b'transplant') self.opener = vfsmod.vfs(self.path) self.transplants = transplants( self.path, b'transplants', opener=self.opener ) def getcommiteditor(): editform = cmdutil.mergeeditform(repo[None], b'transplant') return cmdutil.getcommiteditor( editform=editform, **pycompat.strkwargs(opts) ) self.getcommiteditor = getcommiteditor def applied(self, repo, node, parent): '''returns True if a node is already an ancestor of parent or is parent or has already been transplanted''' if hasnode(repo, parent): parentrev = repo.changelog.rev(parent) if hasnode(repo, node): rev = repo.changelog.rev(node) reachable = repo.changelog.ancestors( [parentrev], rev, inclusive=True ) if rev in reachable: return True for t in self.transplants.get(node): # it might have been stripped if not hasnode(repo, t.lnode): self.transplants.remove(t) return False lnoderev = repo.changelog.rev(t.lnode) if lnoderev in repo.changelog.ancestors( [parentrev], lnoderev, inclusive=True ): return True return False def apply(self, repo, source, revmap, merges, opts=None): '''apply the revisions in revmap one by one in revision order''' if opts is None: opts = {} revs = sorted(revmap) p1 = repo.dirstate.p1() pulls = [] diffopts = patch.difffeatureopts(self.ui, opts) diffopts.git = True lock = tr = None try: lock = repo.lock() tr = repo.transaction(b'transplant') for rev in revs: node = revmap[rev] revstr = b'%d:%s' % (rev, nodemod.short(node)) if self.applied(repo, node, p1): self.ui.warn( _(b'skipping already applied revision %s\n') % revstr ) continue parents = source.changelog.parents(node) if not (opts.get(b'filter') or opts.get(b'log')): # If the changeset parent is the same as the # wdir's parent, just pull it. if parents[0] == p1: pulls.append(node) p1 = node continue if pulls: if source != repo: exchange.pull(repo, source.peer(), heads=pulls) merge.update( repo, pulls[-1], branchmerge=False, force=False ) p1 = repo.dirstate.p1() pulls = [] domerge = False if node in merges: # pulling all the merge revs at once would mean we # couldn't transplant after the latest even if # transplants before them fail. domerge = True if not hasnode(repo, node): exchange.pull(repo, source.peer(), heads=[node]) skipmerge = False if parents[1] != revlog.nullid: if not opts.get(b'parent'): self.ui.note( _(b'skipping merge changeset %d:%s\n') % (rev, nodemod.short(node)) ) skipmerge = True else: parent = source.lookup(opts[b'parent']) if parent not in parents: raise error.Abort( _(b'%s is not a parent of %s') % (nodemod.short(parent), nodemod.short(node)) ) else: parent = parents[0] if skipmerge: patchfile = None else: fd, patchfile = pycompat.mkstemp(prefix=b'hg-transplant-') fp = os.fdopen(fd, 'wb') gen = patch.diff(source, parent, node, opts=diffopts) for chunk in gen: fp.write(chunk) fp.close() del revmap[rev] if patchfile or domerge: try: try: n = self.applyone( repo, node, source.changelog.read(node), patchfile, merge=domerge, log=opts.get(b'log'), filter=opts.get(b'filter'), ) except TransplantError: # Do not rollback, it is up to the user to # fix the merge or cancel everything tr.close() raise if n and domerge: self.ui.status( _(b'%s merged at %s\n') % (revstr, nodemod.short(n)) ) elif n: self.ui.status( _(b'%s transplanted to %s\n') % (nodemod.short(node), nodemod.short(n)) ) finally: if patchfile: os.unlink(patchfile) tr.close() if pulls: exchange.pull(repo, source.peer(), heads=pulls) merge.update(repo, pulls[-1], branchmerge=False, force=False) finally: self.saveseries(revmap, merges) self.transplants.write() if tr: tr.release() if lock: lock.release() def filter(self, filter, node, changelog, patchfile): '''arbitrarily rewrite changeset before applying it''' self.ui.status(_(b'filtering %s\n') % patchfile) user, date, msg = (changelog[1], changelog[2], changelog[4]) fd, headerfile = pycompat.mkstemp(prefix=b'hg-transplant-') fp = os.fdopen(fd, 'wb') fp.write(b"# HG changeset patch\n") fp.write(b"# User %s\n" % user) fp.write(b"# Date %d %d\n" % date) fp.write(msg + b'\n') fp.close() try: self.ui.system( b'%s %s %s' % ( filter, procutil.shellquote(headerfile), procutil.shellquote(patchfile), ), environ={ b'HGUSER': changelog[1], b'HGREVISION': nodemod.hex(node), }, onerr=error.Abort, errprefix=_(b'filter failed'), blockedtag=b'transplant_filter', ) user, date, msg = self.parselog(open(headerfile, b'rb'))[1:4] finally: os.unlink(headerfile) return (user, date, msg) def applyone( self, repo, node, cl, patchfile, merge=False, log=False, filter=None ): '''apply the patch in patchfile to the repository as a transplant''' (manifest, user, (time, timezone), files, message) = cl[:5] date = b"%d %d" % (time, timezone) extra = {b'transplant_source': node} if filter: (user, date, message) = self.filter(filter, node, cl, patchfile) if log: # we don't translate messages inserted into commits message += b'\n(transplanted from %s)' % nodemod.hex(node) self.ui.status(_(b'applying %s\n') % nodemod.short(node)) self.ui.note(b'%s %s\n%s\n' % (user, date, message)) if not patchfile and not merge: raise error.Abort(_(b'can only omit patchfile if merging')) if patchfile: try: files = set() patch.patch(self.ui, repo, patchfile, files=files, eolmode=None) files = list(files) except Exception as inst: seriespath = os.path.join(self.path, b'series') if os.path.exists(seriespath): os.unlink(seriespath) p1 = repo.dirstate.p1() p2 = node self.log(user, date, message, p1, p2, merge=merge) self.ui.write(stringutil.forcebytestr(inst) + b'\n') raise TransplantError( _( b'fix up the working directory and run ' b'hg transplant --continue' ) ) else: files = None if merge: p1 = repo.dirstate.p1() repo.setparents(p1, node) m = match.always() else: m = match.exact(files) n = repo.commit( message, user, date, extra=extra, match=m, editor=self.getcommiteditor(), ) if not n: self.ui.warn( _(b'skipping emptied changeset %s\n') % nodemod.short(node) ) return None if not merge: self.transplants.set(n, node) return n def canresume(self): return os.path.exists(os.path.join(self.path, b'journal')) def resume(self, repo, source, opts): '''recover last transaction and apply remaining changesets''' if os.path.exists(os.path.join(self.path, b'journal')): n, node = self.recover(repo, source, opts) if n: self.ui.status( _(b'%s transplanted as %s\n') % (nodemod.short(node), nodemod.short(n)) ) else: self.ui.status( _(b'%s skipped due to empty diff\n') % (nodemod.short(node),) ) seriespath = os.path.join(self.path, b'series') if not os.path.exists(seriespath): self.transplants.write() return nodes, merges = self.readseries() revmap = {} for n in nodes: revmap[source.changelog.rev(n)] = n os.unlink(seriespath) self.apply(repo, source, revmap, merges, opts) def recover(self, repo, source, opts): '''commit working directory using journal metadata''' node, user, date, message, parents = self.readlog() merge = False if not user or not date or not message or not parents[0]: raise error.Abort(_(b'transplant log file is corrupt')) parent = parents[0] if len(parents) > 1: if opts.get(b'parent'): parent = source.lookup(opts[b'parent']) if parent not in parents: raise error.Abort( _(b'%s is not a parent of %s') % (nodemod.short(parent), nodemod.short(node)) ) else: merge = True extra = {b'transplant_source': node} try: p1 = repo.dirstate.p1() if p1 != parent: raise error.Abort( _(b'working directory not at transplant parent %s') % nodemod.hex(parent) ) if merge: repo.setparents(p1, parents[1]) st = repo.status() modified, added, removed, deleted = ( st.modified, st.added, st.removed, st.deleted, ) if merge or modified or added or removed or deleted: n = repo.commit( message, user, date, extra=extra, editor=self.getcommiteditor(), ) if not n: raise error.Abort(_(b'commit failed')) if not merge: self.transplants.set(n, node) else: n = None self.unlog() return n, node finally: # TODO: get rid of this meaningless try/finally enclosing. # this is kept only to reduce changes in a patch. pass def stop(self, ui, repo): """logic to stop an interrupted transplant""" if self.canresume(): startctx = repo[b'.'] hg.updaterepo(repo, startctx.node(), overwrite=True) ui.status(_(b"stopped the interrupted transplant\n")) ui.status( _(b"working directory is now at %s\n") % startctx.hex()[:12] ) self.unlog() return 0 def readseries(self): nodes = [] merges = [] cur = nodes for line in self.opener.read(b'series').splitlines(): if line.startswith(b'# Merges'): cur = merges continue cur.append(revlog.bin(line)) return (nodes, merges) def saveseries(self, revmap, merges): if not revmap: return if not os.path.isdir(self.path): os.mkdir(self.path) series = self.opener(b'series', b'w') for rev in sorted(revmap): series.write(nodemod.hex(revmap[rev]) + b'\n') if merges: series.write(b'# Merges\n') for m in merges: series.write(nodemod.hex(m) + b'\n') series.close() def parselog(self, fp): parents = [] message = [] node = revlog.nullid inmsg = False user = None date = None for line in fp.read().splitlines(): if inmsg: message.append(line) elif line.startswith(b'# User '): user = line[7:] elif line.startswith(b'# Date '): date = line[7:] elif line.startswith(b'# Node ID '): node = revlog.bin(line[10:]) elif line.startswith(b'# Parent '): parents.append(revlog.bin(line[9:])) elif not line.startswith(b'# '): inmsg = True message.append(line) if None in (user, date): raise error.Abort( _(b"filter corrupted changeset (no user or date)") ) return (node, user, date, b'\n'.join(message), parents) def log(self, user, date, message, p1, p2, merge=False): '''journal changelog metadata for later recover''' if not os.path.isdir(self.path): os.mkdir(self.path) fp = self.opener(b'journal', b'w') fp.write(b'# User %s\n' % user) fp.write(b'# Date %s\n' % date) fp.write(b'# Node ID %s\n' % nodemod.hex(p2)) fp.write(b'# Parent ' + nodemod.hex(p1) + b'\n') if merge: fp.write(b'# Parent ' + nodemod.hex(p2) + b'\n') fp.write(message.rstrip() + b'\n') fp.close() def readlog(self): return self.parselog(self.opener(b'journal')) def unlog(self): '''remove changelog journal''' absdst = os.path.join(self.path, b'journal') if os.path.exists(absdst): os.unlink(absdst) def transplantfilter(self, repo, source, root): def matchfn(node): if self.applied(repo, node, root): return False if source.changelog.parents(node)[1] != revlog.nullid: return False extra = source.changelog.read(node)[5] cnode = extra.get(b'transplant_source') if cnode and self.applied(repo, cnode, root): return False return True return matchfn def hasnode(repo, node): try: return repo.changelog.rev(node) is not None except error.StorageError: return False def browserevs(ui, repo, nodes, opts): '''interactively transplant changesets''' displayer = logcmdutil.changesetdisplayer(ui, repo, opts) transplants = [] merges = [] prompt = _( b'apply changeset? [ynmpcq?]:' b'$$ &yes, transplant this changeset' b'$$ &no, skip this changeset' b'$$ &merge at this changeset' b'$$ show &patch' b'$$ &commit selected changesets' b'$$ &quit and cancel transplant' b'$$ &? (show this help)' ) for node in nodes: displayer.show(repo[node]) action = None while not action: choice = ui.promptchoice(prompt) action = b'ynmpcq?'[choice : choice + 1] if action == b'?': for c, t in ui.extractchoices(prompt)[1]: ui.write(b'%s: %s\n' % (c, t)) action = None elif action == b'p': parent = repo.changelog.parents(node)[0] for chunk in patch.diff(repo, parent, node): ui.write(chunk) action = None if action == b'y': transplants.append(node) elif action == b'm': merges.append(node) elif action == b'c': break elif action == b'q': transplants = () merges = () break displayer.close() return (transplants, merges) @command( b'transplant', [ ( b's', b'source', b'', _(b'transplant changesets from REPO'), _(b'REPO'), ), ( b'b', b'branch', [], _(b'use this source changeset as head'), _(b'REV'), ), ( b'a', b'all', None, _(b'pull all changesets up to the --branch revisions'), ), (b'p', b'prune', [], _(b'skip over REV'), _(b'REV')), (b'm', b'merge', [], _(b'merge at REV'), _(b'REV')), ( b'', b'parent', b'', _(b'parent to choose when transplanting merge'), _(b'REV'), ), (b'e', b'edit', False, _(b'invoke editor on commit messages')), (b'', b'log', None, _(b'append transplant info to log message')), (b'', b'stop', False, _(b'stop interrupted transplant')), ( b'c', b'continue', None, _(b'continue last transplant session after fixing conflicts'), ), ( b'', b'filter', b'', _(b'filter changesets through command'), _(b'CMD'), ), ], _( b'hg transplant [-s REPO] [-b BRANCH [-a]] [-p REV] ' b'[-m REV] [REV]...' ), helpcategory=command.CATEGORY_CHANGE_MANAGEMENT, ) def transplant(ui, repo, *revs, **opts): '''transplant changesets from another branch Selected changesets will be applied on top of the current working directory with the log of the original changeset. The changesets are copied and will thus appear twice in the history with different identities. Consider using the graft command if everything is inside the same repository - it will use merges and will usually give a better result. Use the rebase extension if the changesets are unpublished and you want to move them instead of copying them. If --log is specified, log messages will have a comment appended of the form:: (transplanted from CHANGESETHASH) You can rewrite the changelog message with the --filter option. Its argument will be invoked with the current changelog message as $1 and the patch as $2. --source/-s specifies another repository to use for selecting changesets, just as if it temporarily had been pulled. If --branch/-b is specified, these revisions will be used as heads when deciding which changesets to transplant, just as if only these revisions had been pulled. If --all/-a is specified, all the revisions up to the heads specified with --branch will be transplanted. Example: - transplant all changes up to REV on top of your current revision:: hg transplant --branch REV --all You can optionally mark selected transplanted changesets as merge changesets. You will not be prompted to transplant any ancestors of a merged transplant, and you can merge descendants of them normally instead of transplanting them. Merge changesets may be transplanted directly by specifying the proper parent changeset by calling :hg:`transplant --parent`. If no merges or revisions are provided, :hg:`transplant` will start an interactive changeset browser. If a changeset application fails, you can fix the merge by hand and then resume where you left off by calling :hg:`transplant --continue/-c`. ''' with repo.wlock(): return _dotransplant(ui, repo, *revs, **opts) def _dotransplant(ui, repo, *revs, **opts): def incwalk(repo, csets, match=util.always): for node in csets: if match(node): yield node def transplantwalk(repo, dest, heads, match=util.always): '''Yield all nodes that are ancestors of a head but not ancestors of dest. If no heads are specified, the heads of repo will be used.''' if not heads: heads = repo.heads() ancestors = [] ctx = repo[dest] for head in heads: ancestors.append(ctx.ancestor(repo[head]).node()) for node in repo.changelog.nodesbetween(ancestors, heads)[0]: if match(node): yield node def checkopts(opts, revs): if opts.get(b'continue'): cmdutil.check_incompatible_arguments( opts, b'continue', [b'branch', b'all', b'merge'] ) return if opts.get(b'stop'): cmdutil.check_incompatible_arguments( opts, b'stop', [b'branch', b'all', b'merge'] ) return if not ( opts.get(b'source') or revs or opts.get(b'merge') or opts.get(b'branch') ): raise error.Abort( _( b'no source URL, branch revision, or revision ' b'list provided' ) ) if opts.get(b'all'): if not opts.get(b'branch'): raise error.Abort(_(b'--all requires a branch revision')) if revs: raise error.Abort( _(b'--all is incompatible with a revision list') ) opts = pycompat.byteskwargs(opts) checkopts(opts, revs) if not opts.get(b'log'): # deprecated config: transplant.log opts[b'log'] = ui.config(b'transplant', b'log') if not opts.get(b'filter'): # deprecated config: transplant.filter opts[b'filter'] = ui.config(b'transplant', b'filter') tp = transplanter(ui, repo, opts) p1 = repo.dirstate.p1() if len(repo) > 0 and p1 == revlog.nullid: raise error.Abort(_(b'no revision checked out')) if opts.get(b'continue'): if not tp.canresume(): raise error.Abort(_(b'no transplant to continue')) elif opts.get(b'stop'): if not tp.canresume(): raise error.Abort(_(b'no interrupted transplant found')) return tp.stop(ui, repo) else: cmdutil.checkunfinished(repo) cmdutil.bailifchanged(repo) sourcerepo = opts.get(b'source') if sourcerepo: peer = hg.peer(repo, opts, ui.expandpath(sourcerepo)) heads = pycompat.maplist(peer.lookup, opts.get(b'branch', ())) target = set(heads) for r in revs: try: target.add(peer.lookup(r)) except error.RepoError: pass source, csets, cleanupfn = bundlerepo.getremotechanges( ui, repo, peer, onlyheads=sorted(target), force=True ) else: source = repo heads = pycompat.maplist(source.lookup, opts.get(b'branch', ())) cleanupfn = None try: if opts.get(b'continue'): tp.resume(repo, source, opts) return tf = tp.transplantfilter(repo, source, p1) if opts.get(b'prune'): prune = { source[r].node() for r in scmutil.revrange(source, opts.get(b'prune')) } matchfn = lambda x: tf(x) and x not in prune else: matchfn = tf merges = pycompat.maplist(source.lookup, opts.get(b'merge', ())) revmap = {} if revs: for r in scmutil.revrange(source, revs): revmap[int(r)] = source[r].node() elif opts.get(b'all') or not merges: if source != repo: alltransplants = incwalk(source, csets, match=matchfn) else: alltransplants = transplantwalk( source, p1, heads, match=matchfn ) if opts.get(b'all'): revs = alltransplants else: revs, newmerges = browserevs(ui, source, alltransplants, opts) merges.extend(newmerges) for r in revs: revmap[source.changelog.rev(r)] = r for r in merges: revmap[source.changelog.rev(r)] = r tp.apply(repo, source, revmap, merges, opts) finally: if cleanupfn: cleanupfn() def continuecmd(ui, repo): """logic to resume an interrupted transplant using 'hg continue'""" with repo.wlock(): tp = transplanter(ui, repo, {}) return tp.resume(repo, repo, {}) revsetpredicate = registrar.revsetpredicate() @revsetpredicate(b'transplanted([set])') def revsettransplanted(repo, subset, x): """Transplanted changesets in set, or all transplanted changesets. """ if x: s = revset.getset(repo, subset, x) else: s = subset return smartset.baseset( [r for r in s if repo[r].extra().get(b'transplant_source')] ) templatekeyword = registrar.templatekeyword() @templatekeyword(b'transplanted', requires={b'ctx'}) def kwtransplanted(context, mapping): """String. The node identifier of the transplanted changeset if any.""" ctx = context.resource(mapping, b'ctx') n = ctx.extra().get(b'transplant_source') return n and nodemod.hex(n) or b'' def extsetup(ui): statemod.addunfinished( b'transplant', fname=b'transplant/journal', clearable=True, continuefunc=continuecmd, statushint=_( b'To continue: hg transplant --continue\n' b'To stop: hg transplant --stop' ), cmdhint=_(b"use 'hg transplant --continue' or 'hg transplant --stop'"), ) # tell hggettext to extract docstrings from these functions: i18nfunctions = [revsettransplanted, kwtransplanted]