Mercurial Mercurial > mercurial / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
configitems: handle case were the default value is not static
authorBoris Feld <boris.feld@octobus.net>
Wed, 12 Jul 2017 23:36:10 +0200
changeset 33471 d74141ccfd8b
parent 33470 ab493a8353d1
child 33472 d0869a6e83ab
configitems: handle case were the default value is not static In some case, the default of one value is derived from other value. We add a way to register them anyway and an associated devel-warning. The registration is very naive for the moment. We might be able to have a better way for registering each of these cases but it could be done later.
mercurial/configitems.py file | annotate | diff | comparison | revisions
mercurial/ui.py file | annotate | diff | comparison | revisions
tests/test-devel-warnings.t file | annotate | diff | comparison | revisions 
--- a/mercurial/configitems.py	Fri Jul 14 16:17:37 2017 +0200
+++ b/mercurial/configitems.py	Wed Jul 12 23:36:10 2017 +0200
@@ -51,6 +51,9 @@
         raise error.ProgrammingError(msg % (item.section, item.name))
     section[item.name] = item
 
+# special value for case where the default is derived from other values
+dynamicdefault = object()
+
 # Registering actual config items
 
 def getitemregister(configtable):
--- a/mercurial/ui.py	Fri Jul 14 16:17:37 2017 +0200
+++ b/mercurial/ui.py	Wed Jul 12 23:36:10 2017 +0200
@@ -457,11 +457,17 @@
         if default is _unset:
             if item is None:
                 value = default
+            elif item.default is configitems.dynamicdefault:
+                value = None
+                msg = "config item requires an explicit default value: '%s.%s'"
+                msg %= (section, name)
+                self.develwarn(msg, 2, 'warn-config-default')
             elif callable(item.default):
                     value = item.default()
             else:
                 value = item.default
-        elif item is not None:
+        elif (item is not None
+              and item.default is not configitems.dynamicdefault):
             msg = ("specifying a default value for a registered "
                    "config item: '%s.%s' '%s'")
             msg %= (section, name, default)
--- a/tests/test-devel-warnings.t	Fri Jul 14 16:17:37 2017 +0200
+++ b/tests/test-devel-warnings.t	Wed Jul 12 23:36:10 2017 +0200
@@ -218,7 +218,7 @@
   $ cat << EOF > ${TESTTMP}/buggyconfig.py
   > """A small extension that tests our developer warnings for config"""
   > 
-  > from mercurial import registrar
+  > from mercurial import registrar, configitems
   > 
   > cmdtable = {}
   > command = registrar.command(cmdtable)
@@ -227,6 +227,7 @@
   > configitem = registrar.configitem(configtable)
   > 
   > configitem('test', 'some', default='foo')
+  > configitem('test', 'dynamic', default=configitems.dynamicdefault)
   > # overwrite a core config
   > configitem('ui', 'quiet', default=False)
   > configitem('ui', 'interactive', default=None)
@@ -236,6 +237,8 @@
   >     repo.ui.config('ui', 'quiet', False)
   >     repo.ui.config('ui', 'interactive', None)
   >     repo.ui.config('test', 'some', 'foo')
+  >     repo.ui.config('test', 'dynamic', 'some-required-default')
+  >     repo.ui.config('test', 'dynamic')
   > EOF
 
   $ hg --config "extensions.buggyconfig=${TESTTMP}/buggyconfig.py" buggyconfig
@@ -244,5 +247,6 @@
   devel-warn: specifying a default value for a registered config item: 'ui.quiet' 'False' at: $TESTTMP/buggyconfig.py:* (cmdbuggyconfig) (glob)
   devel-warn: specifying a default value for a registered config item: 'ui.interactive' 'None' at: $TESTTMP/buggyconfig.py:* (cmdbuggyconfig) (glob)
   devel-warn: specifying a default value for a registered config item: 'test.some' 'foo' at: $TESTTMP/buggyconfig.py:* (cmdbuggyconfig) (glob)
+  devel-warn: config item requires an explicit default value: 'test.dynamic' at: $TESTTMP/buggyconfig.py:* (cmdbuggyconfig) (glob)
 
   $ cd ..
mercurial