# 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,templater,util,hgfrommercurial.i18nimportgettextas_importre,shutil,sys,tempfile,time# findcmd, bail_if_changed were in commands until 0c61124ad877try:findcmd=cmdutil.findcmdbail_if_changed=cmdutil.bail_if_changedexceptAttributeError:findcmd=commands.findcmdbail_if_changed=commands.bail_if_changedcommands.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=nodekwmaps=self.ui.configitems('keywordmaps')ifkwmaps:self.templates={}fork,vinkwmaps:self.templates[k]=templater.parsestring(v,quoted=False)escaped=[re.escape(k)forkinself.templates.keys()]rawkeyword=r'\$(%s)(: [^$\n\r]*? )??\$'self.re_kw=re.compile(rawkeyword%'|'.join(escaped))ifself.t:templater.common_filters['utcdate']=utcdatetry:self.t=cmdutil.changeset_templater(self.ui,self.repo,False,'',False)exceptTypeError:# depending on hg rev changeset_templater has extra "brinfo" argself.t=cmdutil.changeset_templater(self.ui,self.repo,False,None,'',False)def_ctxnode(self,node):'''Obtains missing node from file context.'''ifnotself.node:c=context.filectx(self.repo,self.path,fileid=node)self.node=c.node()def_kwsub(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)defexpand(self,node,data):'''Returns data with keywords expanded.'''ifutil.binary(data):returndataself._ctxnode(node)returnself.re_kw.sub(self._kwsub,data)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:self._ctxnode(node)returnself.re_kw.subn(self._kwsub,data)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,kwcnt=True)data,kwfound=fp.read(man[f])ifkwfound:notify(_('overwriting %s%s keywords\n')%(f,action))try:self.repo.wwrite(f,data,man.flags(f))exceptAttributeError:# older versions want file descriptor as 3. optional argself.repo.wwrite(f,data)overwritten.append(f)ifoverwritten:try:forfinoverwritten:self.repo.dirstate.normal(f)exceptAttributeError:# older versions don't know about dirstate.normalself.repo.dirstate.update(overwritten,'n')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,kwcnt):super(kwfilelog,self).__init__(opener,path)self.kwtemplater=kwtemplaterself.kwcnt=kwcntdefread(self,node):'''Passes data through kwemplater methods for either unconditional keyword expansion or counting of keywords and substitution method set by the calling overwrite function.'''data=super(kwfilelog,self).read(node)ifnotself.kwcnt:returnself.kwtemplater.expand(node,data)returnself.kwtemplater.process(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!=textreturnsuper(kwfilelog,self).cmp(node,text)def_keywordmatcher(ui,repo):'''Collects include/exclude filename patterns for expansion candidates of current configuration. Returns filename matching function if include patterns exist, None otherwise.'''inc,exc=[],['.hg*']forpat,optinui.configitems('keyword'):ifopt!='ignore':inc.append(pat)else:exc.append(pat)ifinc:returnutil.matcher(repo.root,inc=inc,exc=exc)[1]returnNonedef_weedcandidates(man,kwfmatcher,candidates):'''Weeds out files that do not match keyword file matcher, are not tracked, or are links.'''files=man.keys()ifcandidates:return[fforfincandidatesifkwfmatcher(f)andfinfilesandnotman.linkf(f)]# kwexpand w/o args on all files in manifestreturn[fforfinfilesifkwfmatcher(f)andnotman.linkf(f)]def_overwrite(ui,repo,files,expand):'''Expands/shrinks keywords in working directory.'''wlock=lock=Nonetry:wlock=repo.wlock()lock=repo.lock()bail_if_changed(repo)ctx=repo.changectx()ifnotctx:raisehg.RepoError(_('no revision checked out'))kwfmatcher=_keywordmatcher(ui,repo)ifkwfmatcherisNone:ui.warn(_('no files configured for keyword expansion\n'))returnman=ctx.manifest()files=_weedcandidates(man,kwfmatcher,files)ifnotfiles:ui.warn(_('files not configured for expansion or untracked\n'))returncommit=Falsekwt=kwtemplater(ui,repo,expand,node=ctx.node())kwt.overwrite(files,man,commit)finally:delwlock,lockdefshrink(ui,repo,*args):'''revert expanded keywords in working directory run before changing/disabling active keywords or if you experience problems with "hg import" or "hg merge" '''expand=False_overwrite(ui,repo,args,expand)defexpand(ui,repo,*args):'''expand keywords in working directory run after (re)enabling keyword expansion '''expand=True_overwrite(ui,repo,args,expand)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 '''def_demostatus(stat):ui.status(_('\n\t%s\n')%stat)def_showitems(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)break_demostatus('config using %s keyword template maps'%kwstatus)ui.write('[extensions]\n%s\n'%extension)_showitems('keyword',ui.configitems('keyword'))_showitems('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)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']def_getcmd():# commands or cmdutil.parse(ui, sys.argv[1:])[0]# is broken before 88803a69b24a (fancyopts)# results in no output from "hg diff --rev" with older hg versionsargs=fancyopts.fancyopts(sys.argv[1:],commands.globalopts,{})ifargs:cmd=args[0]aliases,i=findcmd(ui,cmd)returnaliases[0]ifnotrepo.local()or_getcmd()innokwcommands:returnkwfmatcher=_keywordmatcher(ui,repo)ifkwfmatcherisNone:returnclasskwrepo(repo.__class__):deffile(self,f,kwexp=True,kwcnt=False):iff[0]=='/':f=f[1:]ifkwfmatcher(f):kwt=kwtemplater(ui,self,kwexp,path=f)returnkwfilelog(self.sopener,f,kwt,kwcnt)returnfilelog.filelog(self.sopener,f)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={}):try:kwlock=lockkwwlock=wlockdelwlock,lockexceptNameError:# (w)lock arguments removed in recent Hg versionskwwlock=kwlock=Nonetry:ifnotkwwlock:kwwlock=self.wlock()ifnotkwlock:kwlock=self.lock()try:removed=self.status(node1=p1,node2=p2,files=files,match=match,wlock=kwwlock)[2]node=super(kwrepo,self).commit(files=files,text=text,user=user,date=date,match=match,force=force,lock=kwlock,wlock=kwwlock,force_editor=force_editor,p1=p1,p2=p2,extra=extra)exceptTypeError:removed=self.status(node1=p1,node2=p2,files=files,match=match)[2]node=super(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)ifnodeisnotNone:cl=self.changelog.read(node)mn=self.manifest.read(cl[0])candidates=_weedcandidates(mn,kwfmatcher,cl[3])ifcandidates:expand=commit=Truekwt=kwtemplater(ui,self,expand,node=node)kwt.overwrite(candidates,mn,commit)returnnodefinally:delkwwlock,kwlockrepo.__class__=kwrepocmdtable={'kwdemo':(demo,[('d','default',None,_('show default keyword template maps')),('f','rcfile',[],_('read maps from RCFILE'))],_('hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP ...]')),'kwshrink':(shrink,[],_('hg kwshrink [NAME] ...')),'kwexpand':(expand,[],_('hg kwexpand [NAME] ...')),}