_overwrite method for kwrepo.commit, kwexpand, kwshrink
File selection (kwexpand/kwshrink) in _kwfwrite method.
# keyword.py - $Keyword$ expansion for Mercurial## Copyright 2007 Christian Ebert <blacktrash@gmx.net>## This software may be used and distributed according to the terms# of the GNU General Public License, incorporated herein by reference.## $Id$## Keyword expansion hack against the grain of a DSCM## There are many good reasons why this is not needed in a distributed# SCM, still it may be useful in very small projects based on single# files (like LaTeX packages), that are mostly addressed to an audience# not running a version control system.## For in-depth discussion refer to# <http://www.selenic.com/mercurial/wiki/index.cgi/KeywordPlan>.## Keyword expansion is based on Mercurial's changeset template mappings.## Binary files are not touched.## Setup in hgrc:## [extensions]# # enable extension# keyword = /full/path/to/hgkw/keyword.py# # or, if script in canonical hgext folder:# # hgext.keyword =## Files to act upon/ignore are specified in the [keyword] section.# Customized keyword template mappings in the [keywordmaps] section.## Run "hg help keyword" and "hg kwdemo" to get info on configuration.'''keyword expansion in local repositoriesThis extension expands RCS/CVS-like or self-customized $Keywords$in tracked text files selected by your configuration.Keywords are only expanded in local repositories and not stored inthe change history. The mechanism can be regarded as a conveniencefor the current user or for archive distribution.Configuration is done in the [keyword] and [keywordmaps] sectionsof hgrc files.Example: [keyword] # expand keywords in every python file except those matching "x*" **.py = x* = ignoreNote: the more specific you are in your filename patterns the less you lose speed in huge repos.For [keywordmaps] template mapping and expansion demonstration andcontrol run "hg kwdemo".An additional date template filter {date|utcdate} is provided.The default template mappings (view with "hg kwdemo -d") can be replacedwith customized keywords and templates.Again, run "hg kwdemo" to control the results of your config changes.Before changing/disabling active keywords, run "hg kwshrink" to avoidthe risk of inadvertedly storing expanded keywords in the change history.To force expansion after enabling it, or a configuration change, run"hg kwexpand".Expansions spanning more than one line and incremental expansions,like CVS' $Log$, are not supported. A keyword template map"Log = {desc}" expands to the first line of the changeset description.Caveat: "hg import" fails if the patch context contains an active keyword. In that case run "hg kwshrink", and then reimport. Or, better, use bundle/unbundle to share changes.'''frommercurialimportcommands,cmdutil,context,fancyoptsfrommercurialimportfilelog,localrepo,revlog,templater,utilfrommercurial.i18nimportgettextas_importgetopt,os.path,re,shutil,sys,tempfile,time# backwards compatibility hackstry:# cmdutil.parse moves to dispatch._parse in 18a9fbb5cd78frommercurialimportdispatch_parse=dispatch._parseexceptImportError:try:# commands.parse moves to cmdutil.parse in 0c61124ad877_parse=cmdutil.parseexceptAttributeError:_parse=commands.parsetry:# bail_if_changed moves from commands to cmdutil in 0c61124ad877bail_if_changed=cmdutil.bail_if_changedexceptAttributeError:bail_if_changed=commands.bail_if_changeddef_pathto(repo,cwd,f):'''kwfiles behaves similar to status, using pathto since 78b6add1f966.'''try:returnrepo.pathto(f,cwd)exceptAttributeError:returnf# commands.parse/cmdutil.parse returned nothing for# "hg diff --rev" before 88803a69b24a due to bug in fancyoptsdef_fancyopts(args,options,state):'''Fixed fancyopts from 88803a69b24a.'''long=[]short=''map={}dt={}fors,l,d,cinoptions:pl=l.replace('-','_')map['-'+s]=map['--'+l]=plifisinstance(d,list):state[pl]=d[:]else:state[pl]=ddt[pl]=type(d)if(disnotNoneanddisnotTrueanddisnotFalseandnotcallable(d)):ifs:s+=':'ifl:l+='='ifs:short=short+sifl:long.append(l)opts,args=getopt.getopt(args,short,long)foropt,arginopts:ifdt[map[opt]]istype(fancyopts):state[map[opt]](state,map[opt],arg)elifdt[map[opt]]istype(1):state[map[opt]]=int(arg)elifdt[map[opt]]istype(''):state[map[opt]]=argelifdt[map[opt]]istype([]):state[map[opt]].append(arg)elifdt[map[opt]]istype(None):state[map[opt]]=Trueelifdt[map[opt]]istype(False):state[map[opt]]=Truereturnargsfancyopts.fancyopts=_fancyoptscommands.optionalrepo+=' kwdemo'defutcdate(date):'''Returns hgdate in cvs-like UTC format.'''returntime.strftime('%Y/%m/%d %H:%M:%S',time.gmtime(date[0]))classkwtemplater(object):''' Sets up keyword templates, corresponding keyword regex, and provides keyword substitution functions. '''templates={'Revision':'{node|short}','Author':'{author|user}','Date':'{date|utcdate}','RCSFile':'{file|basename},v','Source':'{root}/{file},v','Id':'{file|basename},v {node|short} {date|utcdate} {author|user}','Header':'{root}/{file},v {node|short} {date|utcdate} {author|user}',}def__init__(self,ui,repo,expand,path='',node=None):self.ui=uiself.repo=repoself.t=expandorNoneself.path=pathself.node=nodeself.debug=self.ui.debugflagkwmaps=self.ui.configitems('keywordmaps')ifkwmaps:# override default templateskwmaps=[(k,templater.parsestring(v,quoted=False))for(k,v)inkwmaps]self.templates=dict(kwmaps)escaped=map(re.escape,self.templates.keys())kwpat=r'\$(%s)(: [^$\n\r]*? )??\$'%'|'.join(escaped)self.re_kw=re.compile(kwpat)ifself.t:templater.common_filters['utcdate']=utcdateself.t=self._changeset_templater()def_changeset_templater(self):'''Backwards compatible cmdutil.changeset_templater.'''# before 1e0b94cfba0e there was an extra "brinfo" argumenttry:returncmdutil.changeset_templater(self.ui,self.repo,False,'',False)exceptTypeError:returncmdutil.changeset_templater(self.ui,self.repo,False,None,'',False)def_wwrite(self,f,data,man):'''Makes repo.wwrite backwards compatible.'''# 656e06eebda7 removed file descriptor argument# 67982d3ee76c added flags argumenttry:self.repo.wwrite(f,data,man.flags(f))except(AttributeError,TypeError):self.repo.wwrite(f,data)def_normal(self,files):'''Backwards compatible repo.dirstate.normal/update.'''# 6fd953d5faea introduced dirstate.normal()try:forfinfiles:self.repo.dirstate.normal(f)exceptAttributeError:self.repo.dirstate.update(files,'n')defkwsub(self,mobj):'''Substitutes keyword using corresponding template.'''kw=mobj.group(1)self.t.use_template(self.templates[kw])self.ui.pushbuffer()self.t.show(changenode=self.node,root=self.repo.root,file=self.path)keywordsub=templater.firstline(self.ui.popbuffer())return'$%s: %s $'%(kw,keywordsub)defsubstitute(self,node,data,subfunc):'''Obtains node if missing. Ensures consistent templates regardless of ui.debugflag. Calls given substitution function.'''ifnotself.node:c=context.filectx(self.repo,self.path,fileid=node)self.node=c.node()self.ui.debugflag=Falseresult=subfunc(self.kwsub,data)self.ui.debugflag=self.debugreturnresultdefexpand(self,node,data):'''Returns data with keywords expanded.'''ifutil.binary(data):returndatareturnself.substitute(node,data,self.re_kw.sub)defprocess(self,node,data):'''Returns a tuple: data, count. Count is number of keywords/keyword substitutions. Keywords in data are expanded, if templater was initialized.'''ifutil.binary(data):returndata,Noneifself.t:returnself.substitute(node,data,self.re_kw.subn)returndata,self.re_kw.search(data)defshrink(self,text):'''Returns text with all keyword substitutions removed.'''ifutil.binary(text):returntextreturnself.re_kw.sub(r'$\1$',text)defoverwrite(self,candidates,man,commit):'''Overwrites files in working directory if keywords are detected. Keywords are expanded if keyword templater is initialized, otherwise their substitution is removed.'''expand=self.tisnotNoneaction=('shrinking','expanding')[expand]notify=(self.ui.note,self.ui.debug)[commit]overwritten=[]forfincandidates:fp=self.repo.file(f,kwexp=expand,kwmatch=True)data,kwfound=fp.kwctread(man[f])ifkwfound:notify(_('overwriting %s%s keywords\n')%(f,action))self._wwrite(f,data,man)overwritten.append(f)self._normal(overwritten)classkwfilelog(filelog.filelog):''' Subclass of filelog to hook into its read, add, cmp methods. Keywords are "stored" unexpanded, and processed on reading. '''def__init__(self,opener,path,kwtemplater):super(kwfilelog,self).__init__(opener,path)self.kwtemplater=kwtemplaterdefkwctread(self,node):'''Reads expanding and counting keywords (only called from kwtemplater.overwrite).'''data=super(kwfilelog,self).read(node)returnself.kwtemplater.process(node,data)defread(self,node):'''Expands keywords when reading filelog.'''data=super(kwfilelog,self).read(node)returnself.kwtemplater.expand(node,data)defadd(self,text,meta,tr,link,p1=None,p2=None):'''Removes keyword substitutions when adding to filelog.'''text=self.kwtemplater.shrink(text)returnsuper(kwfilelog,self).add(text,meta,tr,link,p1=p1,p2=p2)defcmp(self,node,text):'''Removes keyword substitutions for comparison.'''text=self.kwtemplater.shrink(text)ifself.renamed(node):t2=super(kwfilelog,self).read(node)returnt2!=textreturnrevlog.revlog.cmp(self,node,text)def_bail_if_nokwconf(ui):ifhasattr(ui,'kwfmatcher'):returnifui.configitems('keyword'):raiseutil.Abort(_('[keyword] patterns cannot match'))raiseutil.Abort(_('no [keyword] patterns configured'))def_iskwfile(ui,man,f):returnnotman.linkf(f)andui.kwfmatcher(f)def_overwrite(ui,repo,files,node,man,expand,commit):'''Passes given files to kwtemplater for overwriting.'''iffiles:files.sort()kwt=kwtemplater(ui,repo,expand,node=node)kwt.overwrite(files,man,commit)def_kwfwrite(ui,repo,expand,*pats,**opts):'''Selects files and passes them to _overwrite.'''_bail_if_nokwconf(ui)bail_if_changed(repo)wlock=lock=Nonetry:wlock=repo.wlock()lock=repo.lock()files,match,anypats=cmdutil.matchpats(repo,pats,opts)fdict=dict.fromkeys(files)fdict.pop('.',None)ctx=repo.changectx()man=ctx.manifest()mfiles=man.keys()mfiles.sort()files=[]forfinmfiles:forffinfdict:ifff==forff.startswith('%s/'%f):if_iskwfile(ui,man,ff):files.append(ff)delfdict[ff]breakifnotfinfilesandmatch(f)and_iskwfile(ui,man,f):files.append(f)# 7th argument sets commit to False_overwrite(ui,repo,files,ctx.node(),man,expand,False)finally:delwlock,lockdefshrink(ui,repo,*pats,**opts):'''revert expanded keywords in working directory Run before changing/disabling active keywords or if you experience problems with "hg import" or "hg merge". '''# 3rd argument sets expansion to False_kwfwrite(ui,repo,False,*pats,**opts)defexpand(ui,repo,*pats,**opts):'''expand keywords in working directory Run after (re)enabling keyword expansion. '''# 3rd argument sets expansion to True_kwfwrite(ui,repo,True,*pats,**opts)deffiles(ui,repo,*pats,**opts):'''print files currently configured for keyword expansion Crosscheck which files in working directory are potential targets for keyword expansion. That is, files matched by [keyword] config patterns but not symlinks. '''_bail_if_nokwconf(ui)files,match,anypats=cmdutil.matchpats(repo,pats,opts)status=repo.status(files=files,match=match,list_clean=True)modified,added,removed,deleted,unknown,ignored,clean=statusifopts['untracked']:files=modified+added+unknown+cleanelse:files=modified+added+cleanfiles.sort()# use the full definition of repo._link for backwards compatibilitykwfiles=[fforfinfilesifui.kwfmatcher(f)andnotos.path.islink(repo.wjoin(f))]cwd=patsandrepo.getcwd()or''allf=opts['all']ignore=opts['ignore']flag=(allforui.verbose)and1or0ifnotignore:format=('%s\n','K %s\n')[flag]forkinkwfiles:ui.write(format%_pathto(repo,cwd,k))ifallforignore:format=('%s\n','I %s\n')[flag]foriin[fforfinfilesiffnotinkwfiles]:ui.write(format%_pathto(repo,cwd,i))defdemo(ui,repo,*args,**opts):'''print [keywordmaps] configuration and an expansion example Show current, custom, or default keyword template maps and their expansion. Extend current configuration by specifying maps as arguments and optionally by reading from an additional hgrc file. Override current keyword template maps with "default" option. '''defdemostatus(stat):ui.status(_('\n\t%s\n')%stat)defdemoitems(section,items):ui.write('[%s]\n'%section)fork,vinitems:ui.write('%s = %s\n'%(k,v))msg='hg keyword config and expansion example'kwstatus='current'fn='demo.txt'branchname='demobranch'tmpdir=tempfile.mkdtemp('','kwdemo.')ui.note(_('creating temporary repo at %s\n')%tmpdir)repo=localrepo.localrepository(ui,path=tmpdir,create=True)ui.setconfig('keyword',fn,'')ifargsoropts['rcfile']:kwstatus='custom'ifopts['rcfile']:ui.readconfig(opts['rcfile'])ifopts['default']:kwstatus='default'kwmaps=kwtemplater.templatesifui.configitems('keywordmaps'):# override maps from optional rcfilefork,vinkwmaps.items():ui.setconfig('keywordmaps',k,v)elifargs:# simulate hgrc parsingrcmaps=['[keywordmaps]\n']+[a+'\n'forainargs]fp=repo.opener('hgrc','w')fp.writelines(rcmaps)fp.close()ui.readconfig(repo.join('hgrc'))ifnotopts['default']:kwmaps=dict(ui.configitems('keywordmaps'))orkwtemplater.templatesreposetup(ui,repo)fork,vinui.configitems('extensions'):ifk.endswith('keyword'):extension='%s = %s'%(k,v)breakdemostatus('config using %s keyword template maps'%kwstatus)ui.write('[extensions]\n%s\n'%extension)demoitems('keyword',ui.configitems('keyword'))demoitems('keywordmaps',kwmaps.items())keywords='$'+'$\n$'.join(kwmaps.keys())+'$\n'repo.wopener(fn,'w').write(keywords)repo.add([fn])path=repo.wjoin(fn)ui.note(_('\n%s keywords written to %s:\n')%(kwstatus,path))ui.note(keywords)ui.note('\nhg -R "%s" branch "%s"\n'%(tmpdir,branchname))# silence branch command if not verbosequiet=ui.quietverbose=ui.verboseui.quiet=notverbosecommands.branch(ui,repo,branchname)ui.quiet=quietui.note('hg -R "%s" ci -m "%s"\n'%(tmpdir,msg))repo.commit(text=msg)pathinfo=('',' in %s'%path)[ui.verbose]demostatus('%s keywords expanded%s'%(kwstatus,pathinfo))ui.write(repo.wread(fn))ui.debug(_('\nremoving temporary repo %s\n')%tmpdir)shutil.rmtree(tmpdir,ignore_errors=True)defreposetup(ui,repo):'''Sets up repo as kwrepo for keyword substitution. Overrides file method to return kwfilelog instead of filelog if file matches user configuration. Wraps commit to overwrite configured files with updated keyword substitutions. This is done for local repos only, and only if there are files configured at all for keyword substitution.'''nokwcommands=['add','addremove','bundle','clone','copy','export','grep','identify','incoming','init','outgoing','push','remove','rename','rollback']ifnotrepo.local()or_parse(ui,sys.argv[1:])[0]innokwcommands:returninc,exc=[],['.hgtags']forpat,optinui.configitems('keyword'):ifopt!='ignore':inc.append(pat)else:exc.append(pat)ifnotinc:returnui.kwfmatcher=util.matcher(repo.root,inc=inc,exc=exc)[1]classkwrepo(repo.__class__):deffile(self,f,kwexp=True,kwmatch=False):iff[0]=='/':f=f[1:]ifkwmatchorui.kwfmatcher(f):kwt=kwtemplater(ui,self,kwexp,path=f)returnkwfilelog(self.sopener,f,kwt)returnfilelog.filelog(self.sopener,f)def_commit(self,files,text,user,date,match,force,lock,wlock,force_editor,p1,p2,extra):'''Private commit wrapper for backwards compatibility.'''try:returnsuper(kwrepo,self).commit(files=files,text=text,user=user,date=date,match=match,force=force,lock=lock,wlock=wlock,force_editor=force_editor,p1=p1,p2=p2,extra=extra)exceptTypeError:returnsuper(kwrepo,self).commit(files=files,text=text,user=user,date=date,match=match,force=force,force_editor=force_editor,p1=p1,p2=p2,extra=extra)defcommit(self,files=None,text='',user=None,date=None,match=util.always,force=False,lock=None,wlock=None,force_editor=False,p1=None,p2=None,extra={}):# (w)lock arguments removed in 126f527b3ba3# so they are None or what was passed to commit# use private _(w)lock for deletion_lock=lock_wlock=wlockdelwlock,locktry:ifnot_wlock:_wlock=self.wlock()ifnot_lock:_lock=self.lock()node=self._commit(files,text,user,date,match,force,_lock,_wlock,force_editor,p1,p2,extra)ifnodeisnotNone:cl=self.changelog.read(node)mn=self.manifest.read(cl[0])candidates=[fforfincl[3]ifmn.has_key(f)and_iskwfile(ui,mn,f)]# 6th, 7th arguments set expansion, commit to True_overwrite(ui,self,candidates,node,mn,True,True)returnnodefinally:del_wlock,_lockrepo.__class__=kwrepocmdtable={'kwdemo':(demo,[('d','default',None,_('show default keyword template maps')),('f','rcfile',[],_('read maps from RCFILE'))],_('hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP ...]')),'kwfiles':(files,[('a','all',None,_('show keyword status flags of all files')),('i','ignore',None,_('show files excluded from expansion')),('u','untracked',None,_('additionally show untracked files')),]+commands.walkopts,_('hg kwfiles [OPTION]... [FILE]...')),'kwshrink':(shrink,commands.walkopts,_('hg kwshrink [OPTION]... [FILE]...')),'kwexpand':(expand,commands.walkopts,_('hg kwexpand [OPTION]... [FILE]...')),}