Add grep, init to nokwcommands; make variables, getcmd local
Remove checking of ParseError - was done before, and might be in cmdutil.
nokwcommands as list, can be appended to.
# 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.# The extension provides an additional UTC-date filter ({date|utcdate}).## Expansions spanning more than one line are truncated to their first line.# Incremental expansion (like CVS' $Log$) is not supported.## Binary files are not touched.## Setup in hgrc:## # enable extension# keyword = /full/path/to/keyword.py# # or, if script in hgext folder:# # hgext.keyword ='''keyword expansion in local repositoriesThis extension expands RCS/CVS-like or self-customized $Keywords$in the text files selected by your configuration.Keywords are only expanded in local repositories and not logged byMercurial internally. The mechanism can be regarded as a conveniencefor the current user or archive distribution.Configuration is done in the [keyword] and [keywordmaps] sections ofhgrc files.Example: [extensions] hgext.keyword = [keyword] # expand keywords in every python file except those matching "x*" **.py = x* = ignoreNote: the more specific you are in your [keyword] filename patterns the less you lose speed in huge repos.For a [keywordmaps] template mapping and expansion demonstrationrun "hg kwdemo".An additional date template filter {date|utcdate} is provided.You can replace the default template mappings with customized keywordsand templates of your choice.Again, run "hg kwdemo" to control the results of your config changes.When you change keyword configuration, especially the active keywords,and do not want to store expanded keywords in change history, run"hg kwshrink", and then change configuration.Expansions spanning more than one line and incremental exapansions(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", reimport, and then "hg kwexpand". Or, better, use bundle/unbundle to share changes.'''frommercurialimportcommands,cmdutil,context,fancyoptsfrommercurialimportfilelog,localrepo,templater,util,hgfrommercurial.i18nimportgettextas_importos,re,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]))defkeywordmatcher(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)ifnotinc:returnNonereturnutil.matcher(repo.root,inc=inc,exc=exc)[1]classkwtemplater(object):''' Sets up keyword templates, corresponding keyword regex, and provides keyword substitution functions. '''deftemplates={'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,path='',node=None,expand=True):self.ui=uiself.repo=repoself.path=pathself.node=nodeself.t=expandorNonetemplates=dict(ui.configitems('keywordmaps'))iftemplates:forkintemplates.keys():templates[k]=templater.parsestring(templates[k],quoted=False)self.templates=templatesorself.deftemplatesescaped=[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)defctxnode(self,node):'''Obtains missing node from file context.'''ifnotself.node:c=context.filectx(self.repo,self.path,fileid=node)self.node=c.node()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)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=True):'''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]files=[]forfincandidates:fp=self.repo.file(f,kwcnt=True,kwexp=expand)data,cnt=fp.read(man[f])ifcnt: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)files.append(f)iffiles:self.repo.dirstate.update(files,'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)defoverwrite(ui,repo,files=None,expand=True):'''Expands/shrinks keywords in working directory.'''wlock=repo.wlock()try: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'))returnm=ctx.manifest()iffiles:files=[fforfinfilesiffinm.keys()]else:files=m.keys()files=[fforfinfilesifkwfmatcher(f)andnotos.path.islink(f)]ifnotfiles:ui.warn(_('files not configured for expansion or untracked\n'))returnkwt=kwtemplater(ui,repo,node=ctx.node(),expand=expand)kwt.overwrite(files,m,commit=False)finally:wlock.release()defshrink(ui,repo,*args):'''revert expanded keywords in working directory run before: disabling keyword expansion changing keyword expansion configuration or if you experience problems with "hg import" '''overwrite(ui,repo,files=args,expand=False)defexpand(ui,repo,*args):'''expand keywords in working directory run after (re)enabling keyword expansion '''overwrite(ui,repo,files=args)defdemo(ui,repo,*args,**opts):'''print [keywordmaps] configuration and an expansion example show current, custom, or default keyword template maps and their expansion '''msg='hg keyword config and expansion example'kwstatus='current'fn='demo.txt'tmpdir=tempfile.mkdtemp('','kwdemo.')ui.note(_('creating temporary repo at %s\n')%tmpdir)_repo=localrepo.localrepository(ui,path=tmpdir,create=True)# for backwards compatibilityui=_repo.uiui.setconfig('keyword',fn,'')ifopts['default']:kwstatus='default'kwmaps=kwtemplater.deftemplateselse:ifargsoropts['rcfile']:kwstatus='custom'fortmapinargs:k,v=tmap.split('=',1)ui.setconfig('keywordmaps',k.strip(),v.strip())ifopts['rcfile']:ui.readconfig(opts['rcfile'])kwmaps=(dict(ui.configitems('keywordmaps'))orkwtemplater.deftemplates)ifui.configitems('keywordmaps'):fork,vinkwmaps.items():ui.setconfig('keywordmaps',k,v)reposetup(ui,_repo)ui.status(_('config with %s keyword template maps:\n')%kwstatus)ui.write('[keyword]\n%s =\n[keywordmaps]\n'%fn)fork,vinkwmaps.items():ui.write('%s = %s\n'%(k,v))path=_repo.wjoin(fn)keywords='$'+'$\n$'.join(kwmaps.keys())+'$\n'_repo.wopener(fn,'w').write(keywords)_repo.add([fn])ui.note(_('\n%s keywords written to %s:\n')%(kwstatus,path))ui.note(keywords)ui.note(_("\nhg --repository '%s' commit\n")%tmpdir)_repo.commit(text=msg)pathinfo=('',' in %s'%path)[ui.verbose]ui.status(_('\n%s keywords expanded%s:\n')%(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']# for backwards compatibilityui=repo.uidefgetcmd():# cmdutil.parse(ui, sys.argv[1:])[0] doesn't work for "hg diff -r"args=fancyopts.fancyopts(sys.argv[1:],commands.globalopts,{})ifargs:cmd=args[0]aliases,i=findcmd(ui,cmd)returnaliases[0]ifnotrepo.local()orgetcmd()innokwcommands:returnkwfmatcher=keywordmatcher(ui,repo)ifkwfmatcherisNone:returnclasskwrepo(repo.__class__):deffile(self,f,kwcnt=False,kwexp=True):iff[0]=='/':f=f[1:]ifkwfmatcher(f):kwt=kwtemplater(ui,self,path=f,expand=kwexp)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={}):wrelease=Falseifnotwlock:wlock=self.wlock()wrelease=Truetry:removed=self.status(node1=p1,node2=p2,files=files,match=match,wlock=wlock)[2]node=super(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)ifnodeisNone:returnnodecl=self.changelog.read(node)candidates=[fforfincl[3]ifkwfmatcher(f)andfnotinremovedandnotos.path.islink(self.wjoin(f))]ifcandidates:m=self.manifest.read(cl[0])kwt=kwtemplater(ui,self,node=node)kwt.overwrite(candidates,m)returnnodefinally:ifwrelease:wlock.release()repo.__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] ...')),}