mercurial-scm/hg-stable: mercurial/exthelper.py comparison

comparison mercurial/exthelper.py @ 46871:887f89b100ac

exthelper: improve docs to indicate what module vars are needed I recently tried creating an extension "from scratch" using exthelper, and it wasn't obvious that you needed these. I believe that a careful reading of one of the comments would tell you that they were required, but it's easy to miss and having the examples be "complete" is helpful. Differential Revision: https://phab.mercurial-scm.org/D10295

author	Kyle Lippincott <spectral@google.com>
date	Tue, 30 Mar 2021 13:05:22 -0700
parents	bd22900e26ac
children	6000f5b25c9b

comparison

equal deleted inserted replaced

-:41d43d12c2c4
+:887f89b100ac
 example::
 # ext.py
 eh = exthelper.exthelper()
-# As needed:
+# As needed (failure to do this will mean your registration will not
+# happen):
 cmdtable = eh.cmdtable
 configtable = eh.configtable
 filesetpredicate = eh.filesetpredicate
 revsetpredicate = eh.revsetpredicate
 templatekeyword = eh.templatekeyword
+# As needed (failure to do this will mean your eh.wrap*-decorated
+# functions will not wrap, and/or your eh.*setup-decorated functions
+# will not execute):
+uisetup = eh.finaluisetup
+extsetup = eh.finalextsetup
+reposetup = eh.finalreposetup
+uipopulate = eh.finaluipopulate
 @eh.command(b'mynewcommand',
 [(b'r', b'rev', [], _(b'operate on these revisions'))],
 _(b'-r REV...'),
 helpcategory=command.CATEGORY_XXX)
 """
 for c in self._uipopulatecallables:
 c(ui)
 def finalextsetup(self, ui):
-"""Method to be used as a the extension extsetup
+"""Method to be used as the extension extsetup
 The following operations belong here:
 - Changes depending on the status of other extensions. (if
 extensions.find(b'mq'))
 def uisetup(self, call):
 """Decorated function will be executed during uisetup
 example::
+# Required, otherwise your uisetup function(s) will not execute.
+uisetup = eh.finaluisetup
 @eh.uisetup
 def setupbabar(ui):
 print('this is uisetup!')
 """
 self._uicallables.append(call)
 def uipopulate(self, call):
 """Decorated function will be executed during uipopulate
 example::
+# Required, otherwise your uipopulate function(s) will not execute.
+uipopulate = eh.finaluipopulate
 @eh.uipopulate
 def setupfoo(ui):
 print('this is uipopulate!')
 """
 self._uipopulatecallables.append(call)
 def extsetup(self, call):
 """Decorated function will be executed during extsetup
 example::
+# Required, otherwise your extsetup function(s) will not execute.
+extsetup = eh.finalextsetup
 @eh.extsetup
 def setupcelestine(ui):
 print('this is extsetup!')
 """
 self._extcallables.append(call)
 def reposetup(self, call):
 """Decorated function will be executed during reposetup
 example::
+# Required, otherwise your reposetup function(s) will not execute.
+reposetup = eh.finalreposetup
 @eh.reposetup
 def setupzephir(ui, repo):
 print('this is reposetup!')
 """
 string that will be searched using `extension.find` if not found and
 Abort error is raised. If the wrapping applies to an extension, it is
 installed during `extsetup`.
 example::
+# Required if `extension` is not provided
+uisetup = eh.finaluisetup
+# Required if `extension` is provided
+extsetup = eh.finalextsetup
 @eh.wrapcommand(b'summary')
 def wrapsummary(orig, ui, repo, *args, **kwargs):
 ui.note(b'Barry!')
 return orig(ui, repo, *args, **kwargs)
 function to wrap. The wrapping is performed during `uisetup`.
 (there is no extension support)
 example::
-@eh.function(discovery, b'checkheads')
+# Required, otherwise the function will not be wrapped
-def wrapfunction(orig, *args, **kwargs):
+uisetup = eh.finaluisetup
+@eh.wrapfunction(discovery, b'checkheads')
+def wrapcheckheads(orig, *args, **kwargs):
 ui.note(b'His head smashed in and his heart cut out')
 return orig(*args, **kwargs)
 """
 def dec(wrapper):

Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/exthelper.py @ 46871:887f89b100ac