| pulkit |
| hg-reviewers |
I *thought* these needed to be byte strings, but didn't remember and had to
search out examples.
| No Linters Available |
| No Unit Test Coverage |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/registrar.py (16 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| e19b5dadac08 | f4304891195c | Matt Harbison | Nov 28 2020, 4:59 PM |
| class keyword(_funcregistrarbase): | class keyword(_funcregistrarbase): | ||||
| _docformat = ":%s: %s" | _docformat = ":%s: %s" | ||||
| This should be used as below: | This should be used as below: | ||||
| keyword = registrar.keyword() | keyword = registrar.keyword() | ||||
| @keyword('bar') | @keyword(b'bar') | ||||
| def barfunc(*args, **kwargs): | def barfunc(*args, **kwargs): | ||||
| '''Explanation of bar keyword .... | '''Explanation of bar keyword .... | ||||
| ''' | ''' | ||||
| pass | pass | ||||
| In this case: | In this case: | ||||
| - 'barfunc' is stored as 'bar' in '_table' of an instance 'keyword' above | - 'barfunc' is stored as 'bar' in '_table' of an instance 'keyword' above | ||||
| class revsetpredicate(_funcregistrarbase): | class revsetpredicate(_funcregistrarbase): | ||||
| """Decorator to register revset predicate | """Decorator to register revset predicate | ||||
| Usage:: | Usage:: | ||||
| revsetpredicate = registrar.revsetpredicate() | revsetpredicate = registrar.revsetpredicate() | ||||
| @revsetpredicate('mypredicate(arg1, arg2[, arg3])') | @revsetpredicate(b'mypredicate(arg1, arg2[, arg3])') | ||||
| def mypredicatefunc(repo, subset, x): | def mypredicatefunc(repo, subset, x): | ||||
| '''Explanation of this revset predicate .... | '''Explanation of this revset predicate .... | ||||
| ''' | ''' | ||||
| pass | pass | ||||
| The first string argument is used also in online help. | The first string argument is used also in online help. | ||||
| Optional argument 'safe' indicates whether a predicate is safe for | Optional argument 'safe' indicates whether a predicate is safe for | ||||
| class filesetpredicate(_funcregistrarbase): | class filesetpredicate(_funcregistrarbase): | ||||
| """Decorator to register fileset predicate | """Decorator to register fileset predicate | ||||
| Usage:: | Usage:: | ||||
| filesetpredicate = registrar.filesetpredicate() | filesetpredicate = registrar.filesetpredicate() | ||||
| @filesetpredicate('mypredicate()') | @filesetpredicate(b'mypredicate()') | ||||
| def mypredicatefunc(mctx, x): | def mypredicatefunc(mctx, x): | ||||
| '''Explanation of this fileset predicate .... | '''Explanation of this fileset predicate .... | ||||
| ''' | ''' | ||||
| pass | pass | ||||
| The first string argument is used also in online help. | The first string argument is used also in online help. | ||||
| Optional argument 'callstatus' indicates whether a predicate | Optional argument 'callstatus' indicates whether a predicate | ||||
| class templatekeyword(_templateregistrarbase): | class templatekeyword(_templateregistrarbase): | ||||
| """Decorator to register template keyword | """Decorator to register template keyword | ||||
| Usage:: | Usage:: | ||||
| templatekeyword = registrar.templatekeyword() | templatekeyword = registrar.templatekeyword() | ||||
| # new API (since Mercurial 4.6) | # new API (since Mercurial 4.6) | ||||
| @templatekeyword('mykeyword', requires={'repo', 'ctx'}) | @templatekeyword(b'mykeyword', requires={b'repo', b'ctx'}) | ||||
| def mykeywordfunc(context, mapping): | def mykeywordfunc(context, mapping): | ||||
| '''Explanation of this template keyword .... | '''Explanation of this template keyword .... | ||||
| ''' | ''' | ||||
| pass | pass | ||||
| The first string argument is used also in online help. | The first string argument is used also in online help. | ||||
| Optional argument 'requires' should be a collection of resource names | Optional argument 'requires' should be a collection of resource names | ||||
| class templatefilter(_templateregistrarbase): | class templatefilter(_templateregistrarbase): | ||||
| """Decorator to register template filer | """Decorator to register template filer | ||||
| Usage:: | Usage:: | ||||
| templatefilter = registrar.templatefilter() | templatefilter = registrar.templatefilter() | ||||
| @templatefilter('myfilter', intype=bytes) | @templatefilter(b'myfilter', intype=bytes) | ||||
| def myfilterfunc(text): | def myfilterfunc(text): | ||||
| '''Explanation of this template filter .... | '''Explanation of this template filter .... | ||||
| ''' | ''' | ||||
| pass | pass | ||||
| The first string argument is used also in online help. | The first string argument is used also in online help. | ||||
| Optional argument 'intype' defines the type of the input argument, | Optional argument 'intype' defines the type of the input argument, | ||||
| class templatefunc(_templateregistrarbase): | class templatefunc(_templateregistrarbase): | ||||
| """Decorator to register template function | """Decorator to register template function | ||||
| Usage:: | Usage:: | ||||
| templatefunc = registrar.templatefunc() | templatefunc = registrar.templatefunc() | ||||
| @templatefunc('myfunc(arg1, arg2[, arg3])', argspec='arg1 arg2 arg3', | @templatefunc(b'myfunc(arg1, arg2[, arg3])', argspec=b'arg1 arg2 arg3', | ||||
| requires={'ctx'}) | requires={b'ctx'}) | ||||
| def myfuncfunc(context, mapping, args): | def myfuncfunc(context, mapping, args): | ||||
| '''Explanation of this template function .... | '''Explanation of this template function .... | ||||
| ''' | ''' | ||||
| pass | pass | ||||
| The first string argument is used also in online help. | The first string argument is used also in online help. | ||||
| If optional 'argspec' is defined, the function will receive 'args' as | If optional 'argspec' is defined, the function will receive 'args' as | ||||
| class internalmerge(_funcregistrarbase): | class internalmerge(_funcregistrarbase): | ||||
| """Decorator to register in-process merge tool | """Decorator to register in-process merge tool | ||||
| Usage:: | Usage:: | ||||
| internalmerge = registrar.internalmerge() | internalmerge = registrar.internalmerge() | ||||
| @internalmerge('mymerge', internalmerge.mergeonly, | @internalmerge(b'mymerge', internalmerge.mergeonly, | ||||
| onfailure=None, precheck=None, | onfailure=None, precheck=None, | ||||
| binary=False, symlink=False): | binary=False, symlink=False): | ||||
| def mymergefunc(repo, mynode, orig, fcd, fco, fca, | def mymergefunc(repo, mynode, orig, fcd, fco, fca, | ||||
| toolconf, files, labels=None): | toolconf, files, labels=None): | ||||
| '''Explanation of this internal merge tool .... | '''Explanation of this internal merge tool .... | ||||
| ''' | ''' | ||||
| return 1, False # means "conflicted", "no deletion needed" | return 1, False # means "conflicted", "no deletion needed" | ||||