( )⚙ D6704 config: add defaultvalue template keyword

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6704

config: add defaultvalue template keyword
ClosedPublic

Authored by navaneeth.suresh on Aug 1 2019, 1:42 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG51a2e3102db2: config: add defaultvalue template keyword
Summary

This patch tries to fix one of the issues mentioned in issue6014.
This adds a new defaultvalue template keyword to be used with
hg showconfig to get the default value of the config item.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

durin42 added a subscriber: durin42.Aug 1 2019, 2:38 PM

I like the feature, I'll go ahead and queue it with the str/bytestr thing fixed in flight. Thanks!

mercurial/commands.py
1875

you almost certainly want pycompat.bytestr() here and not str() for py3 compat reasons

navaneeth.suresh added a commit: rHG51a2e3102db2: config: add defaultvalue template keyword.Aug 1 2019, 2:45 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG51a2e3102db2: config: add defaultvalue template keyword (authored by navaneeth.suresh). · Explain Why
This revision was automatically updated to reflect the committed changes.
navaneeth.suresh marked an inline comment as done.Aug 2 2019, 4:12 AM
navaneeth.suresh added inline comments.
mercurial/commands.py
1875

thanks for the fix and queuing @durin42.

navaneeth.suresh marked an inline comment as done.Aug 2 2019, 4:26 AM
yuja added a subscriber: yuja.Aug 2 2019, 9:37 AM

+ def configdefault(self, section, name):
+ """returns the default value of the config item"""
+ item = self._knownconfig.get(section, {}).get(name)
+ itemdefault = None
+ if item is not None:
+ if callable(item.default):
+ itemdefault = item.default()
+ else:
+ itemdefault = item.default
+ return itemdefault

Need to handle configitems.dynamicdefault.

diff --git a/mercurial/commands.py b/mercurial/commands.py

  • a/mercurial/commands.py

+++ b/mercurial/commands.py
@@ -1872,6 +1872,7 @@

for section, name, value in ui.walkconfig(untrusted=untrusted):
    source = ui.configsource(section, name, untrusted)
    value = pycompat.bytestr(value)

+ defaultvalue = pycompat.bytestr(ui.configdefault(section, name))

We'll probably want to keep None as itself. It's useless if an empty
default were mapped to truthy value, "None".

@@ -1881,7 +1882,7 @@

fm.startitem()
fm.condwrite(ui.debugflag, 'source', '%s: ', source)
if uniquesel:
  • fm.data(name=entryname)

+ fm.data(name=entryname, defaultvalue=defaultvalue)

    fm.write('value', '%s\n', value)
else:
    fm.write('name value', '%s=%s\n', entryname, value)

Missed fm.data() for the else case. fm.data(defaultvalue=...) can be moved
out of the if block.

navaneeth.suresh added a comment.Aug 3 2019, 2:01 AM

@yuja Thanks for the review. Will send a follow-up soon.

martinvonz added a subscriber: martinvonz.Aug 25 2019, 6:12 PM

hg config -T '{defaultvalue}' shows a bunch of entries like <object object at 0x7fc4295c00f0>, which is clearly not something we want to show the user. Also hg config -T json crashes for a similar reason (mercurial.error.ProgrammingError: cannot encode <object object at 0x7fdd1a6a20f0>).

yuja added a comment.Aug 25 2019, 7:38 PM
`hg config -T '{defaultvalue}'` shows a bunch of entries like `<object object at 0x7fc4295c00f0>`, which is clearly not something we want to show the user. Also `hg config -T json` crashes for a similar reason (`mercurial.error.ProgrammingError: cannot encode <object object at 0x7fdd1a6a20f0>`).

Yup. That's mostly because of configitems.dynamicdefault.

ryancoop987 added a subscriber: ryancoop987.Oct 21 2021, 3:44 AM

Really nice post here getting how to get robux for free hope you guys like it fun here

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (3 lines)
Mmercurial/ui.py (11 lines)
Mtests/test-config.t (2 lines)

Diff 16103

mercurial/commands.py

uniquesel = (len(selentries) == 1 and not selsections) uniquesel = (len(selentries) == 1 and not selsections)
selsections = set(selsections) selsections = set(selsections)
selentries = set(selentries) selentries = set(selentries)
matched = False matched = False
for section, name, value in ui.walkconfig(untrusted=untrusted): for section, name, value in ui.walkconfig(untrusted=untrusted):
source = ui.configsource(section, name, untrusted) source = ui.configsource(section, name, untrusted)
value = pycompat.bytestr(value) value = pycompat.bytestr(value)
defaultvalue = pycompat.bytestr(ui.configdefault(section, name))
durin42Unsubmitted
Done

you almost certainly want pycompat.bytestr() here and not str() for py3 compat reasons

durin42: you almost certainly want `pycompat.bytestr()` here and not `str()` for py3 compat reasons
navaneeth.sureshAuthorUnsubmitted
Done

thanks for the fix and queuing @durin42.

navaneeth.suresh: thanks for the fix and queuing @durin42.
if fm.isplain(): if fm.isplain():
source = source or 'none' source = source or 'none'
value = value.replace('\n', '\\n') value = value.replace('\n', '\\n')
entryname = section + '.' + name entryname = section + '.' + name
if values and not (section in selsections or entryname in selentries): if values and not (section in selsections or entryname in selentries):
continue continue
fm.startitem() fm.startitem()
fm.condwrite(ui.debugflag, 'source', '%s: ', source) fm.condwrite(ui.debugflag, 'source', '%s: ', source)
if uniquesel: if uniquesel:
fm.data(name=entryname) fm.data(name=entryname, defaultvalue=defaultvalue)
fm.write('value', '%s\n', value) fm.write('value', '%s\n', value)
else: else:
fm.write('name value', '%s=%s\n', entryname, value) fm.write('name value', '%s=%s\n', entryname, value)
matched = True matched = True
fm.end() fm.end()
if matched: if matched:
return 0 return 0
return 1 return 1

mercurial/ui.py

""" """
if self.config(section, name, default, untrusted): if self.config(section, name, default, untrusted):
return self.configwith(dateutil.parsedate, section, name, default, return self.configwith(dateutil.parsedate, section, name, default,
'date', untrusted) 'date', untrusted)
if default is _unset: if default is _unset:
return None return None
return default return default
def configdefault(self, section, name):
"""returns the default value of the config item"""
item = self._knownconfig.get(section, {}).get(name)
itemdefault = None
if item is not None:
if callable(item.default):
itemdefault = item.default()
else:
itemdefault = item.default
return itemdefault
def hasconfig(self, section, name, untrusted=False): def hasconfig(self, section, name, untrusted=False):
return self._data(untrusted).hasitem(section, name) return self._data(untrusted).hasitem(section, name)
def has_section(self, section, untrusted=False): def has_section(self, section, untrusted=False):
'''tell whether section exists in config.''' '''tell whether section exists in config.'''
return section in self._data(untrusted) return section in self._data(untrusted)
def configitems(self, section, untrusted=False, ignoresub=False): def configitems(self, section, untrusted=False, ignoresub=False):

tests/test-config.t

"name": "Section.key", "name": "Section.key",
"source": "*.hgrc:*", (glob) "source": "*.hgrc:*", (glob)
"value": "lower case" "value": "lower case"
} }
] ]
$ hg showconfig Section.KeY -Tjson $ hg showconfig Section.KeY -Tjson
[ [
{ {
"defaultvalue": "None",
"name": "Section.KeY", "name": "Section.KeY",
"source": "*.hgrc:*", (glob) "source": "*.hgrc:*", (glob)
"value": "Case Sensitive" "value": "Case Sensitive"
} }
] ]
$ hg showconfig -Tjson | tail -7 $ hg showconfig -Tjson | tail -7
}, },
{ {
> EOF > EOF
$ hg config --debug empty.source $ hg config --debug empty.source
read config from: * (glob) read config from: * (glob)
none: value none: value
$ hg config empty.source -Tjson $ hg config empty.source -Tjson
[ [
{ {
"defaultvalue": "None",
"name": "empty.source", "name": "empty.source",
"source": "", "source": "",
"value": "value" "value": "value"
} }
] ]
$ cp .hg/hgrc.orig .hg/hgrc $ cp .hg/hgrc.orig .hg/hgrc