I found it quite confusing that Fixer accessed fields that seemed like
they didn't exist.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
In D7084#104166, @pulkit wrote:Hm, IIUC this was edited in flight, not sure why.
I noticed that test-check-format.t was failing last night so I fixed it up in flight. It wanted to put the procutil import on one line.
| Path | Packages | |||
|---|---|---|---|---|
| M | hgext/fix.py (46 lines) |
| Status | Author | Revision | |
|---|---|---|---|
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz |
| import json | import json | ||||
| import os | import os | ||||
| import re | import re | ||||
| import subprocess | import subprocess | ||||
| from mercurial.i18n import _ | from mercurial.i18n import _ | ||||
| from mercurial.node import nullrev | from mercurial.node import nullrev | ||||
| from mercurial.node import wdirrev | from mercurial.node import wdirrev | ||||
| from mercurial.pycompat import setattr | |||||
| from mercurial.utils import ( | from mercurial.utils import ( | ||||
| procutil, | procutil, | ||||
| stringutil, | |||||
| ) | ) | ||||
| from mercurial import ( | from mercurial import ( | ||||
| cmdutil, | cmdutil, | ||||
| context, | context, | ||||
| copies, | copies, | ||||
| error, | error, | ||||
| mdiff, | mdiff, | ||||
| configitem = registrar.configitem(configtable) | configitem = registrar.configitem(configtable) | ||||
| # Register the suboptions allowed for each configured fixer, and default values. | # Register the suboptions allowed for each configured fixer, and default values. | ||||
| FIXER_ATTRS = { | FIXER_ATTRS = { | ||||
| b'command': None, | b'command': None, | ||||
| b'linerange': None, | b'linerange': None, | ||||
| b'pattern': None, | b'pattern': None, | ||||
| b'priority': 0, | b'priority': 0, | ||||
| b'metadata': b'false', | b'metadata': False, | ||||
| b'skipclean': b'true', | b'skipclean': True, | ||||
| b'enabled': b'true', | b'enabled': True, | ||||
| } | } | ||||
| for key, default in FIXER_ATTRS.items(): | for key, default in FIXER_ATTRS.items(): | ||||
| configitem(b'fix', b'.*:%s$' % key, default=default, generic=True) | configitem(b'fix', b'.*:%s$' % key, default=default, generic=True) | ||||
| # A good default size allows most source code files to be fixed, but avoids | # A good default size allows most source code files to be fixed, but avoids | ||||
| # letting fixer tools choke on huge inputs, which could be surprising to the | # letting fixer tools choke on huge inputs, which could be surprising to the | ||||
| # user. | # user. | ||||
| def getfixers(ui): | def getfixers(ui): | ||||
| """Returns a map of configured fixer tools indexed by their names | """Returns a map of configured fixer tools indexed by their names | ||||
| Each value is a Fixer object with methods that implement the behavior of the | Each value is a Fixer object with methods that implement the behavior of the | ||||
| fixer's config suboptions. Does not validate the config values. | fixer's config suboptions. Does not validate the config values. | ||||
| """ | """ | ||||
| fixers = {} | fixers = {} | ||||
| for name in fixernames(ui): | for name in fixernames(ui): | ||||
| fixers[name] = Fixer() | enabled = ui.configbool(b'fix', name + b':enabled') | ||||
| for key in FIXER_ATTRS: | command = ui.config(b'fix', name + b':command') | ||||
| setattr( | pattern = ui.config(b'fix', name + b':pattern') | ||||
| fixers[name], | linerange = ui.config(b'fix', name + b':linerange') | ||||
| pycompat.sysstr(b'_' + key), | priority = ui.configint(b'fix', name + b':priority') | ||||
| ui.config(b'fix', name + b':' + key), | metadata = ui.configbool(b'fix', name + b':metadata') | ||||
| ) | skipclean = ui.configbool(b'fix', name + b':skipclean') | ||||
| fixers[name]._priority = int(fixers[name]._priority) | |||||
| fixers[name]._metadata = stringutil.parsebool(fixers[name]._metadata) | |||||
| fixers[name]._skipclean = stringutil.parsebool(fixers[name]._skipclean) | |||||
| fixers[name]._enabled = stringutil.parsebool(fixers[name]._enabled) | |||||
| # Don't use a fixer if it has no pattern configured. It would be | # Don't use a fixer if it has no pattern configured. It would be | ||||
| # dangerous to let it affect all files. It would be pointless to let it | # dangerous to let it affect all files. It would be pointless to let it | ||||
| # affect no files. There is no reasonable subset of files to use as the | # affect no files. There is no reasonable subset of files to use as the | ||||
| # default. | # default. | ||||
| if fixers[name]._pattern is None: | if pattern is None: | ||||
| ui.warn( | ui.warn( | ||||
| _(b'fixer tool has no pattern configuration: %s\n') % (name,) | _(b'fixer tool has no pattern configuration: %s\n') % (name,) | ||||
| ) | ) | ||||
| del fixers[name] | elif not enabled: | ||||
| elif not fixers[name]._enabled: | |||||
| ui.debug(b'ignoring disabled fixer tool: %s\n' % (name,)) | ui.debug(b'ignoring disabled fixer tool: %s\n' % (name,)) | ||||
| del fixers[name] | else: | ||||
| fixers[name] = Fixer( | |||||
| command, pattern, linerange, priority, metadata, skipclean | |||||
| ) | |||||
| return collections.OrderedDict( | return collections.OrderedDict( | ||||
| sorted(fixers.items(), key=lambda item: item[1]._priority, reverse=True) | sorted(fixers.items(), key=lambda item: item[1]._priority, reverse=True) | ||||
| ) | ) | ||||
| def fixernames(ui): | def fixernames(ui): | ||||
| """Returns the names of [fix] config options that have suboptions""" | """Returns the names of [fix] config options that have suboptions""" | ||||
| names = set() | names = set() | ||||
| for k, v in ui.configitems(b'fix'): | for k, v in ui.configitems(b'fix'): | ||||
| if b':' in k: | if b':' in k: | ||||
| names.add(k.split(b':', 1)[0]) | names.add(k.split(b':', 1)[0]) | ||||
| return names | return names | ||||
| class Fixer(object): | class Fixer(object): | ||||
| """Wraps the raw config values for a fixer with methods""" | """Wraps the raw config values for a fixer with methods""" | ||||
| def __init__( | |||||
| self, command, pattern, linerange, priority, metadata, skipclean | |||||
| ): | |||||
| self._command = command | |||||
| self._pattern = pattern | |||||
| self._linerange = linerange | |||||
| self._priority = priority | |||||
| self._metadata = metadata | |||||
| self._skipclean = skipclean | |||||
| def affects(self, opts, fixctx, path): | def affects(self, opts, fixctx, path): | ||||
| """Should this fixer run on the file at the given path and context?""" | """Should this fixer run on the file at the given path and context?""" | ||||
| return self._pattern is not None and scmutil.match( | return self._pattern is not None and scmutil.match( | ||||
| fixctx, [self._pattern], opts | fixctx, [self._pattern], opts | ||||
| )(path) | )(path) | ||||
| def shouldoutputmetadata(self): | def shouldoutputmetadata(self): | ||||
| """Should the stdout of this fixer start with JSON and a null byte?""" | """Should the stdout of this fixer start with JSON and a null byte?""" | ||||