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

comparison mercurial/ui.py @ 27266:4dccc37b87bd

ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Sat, 05 Dec 2015 21:11:04 -0800
parents	47539ea08bdb
children	82910fdc216f

comparison

equal deleted inserted replaced

-:47539ea08bdb
+:4dccc37b87bd
 loaded.
 """
 def __init__(self, ui):
 dict.__init__(self)
-for name, loc in ui.configitems('paths'):
+for name, loc in ui.configitems('paths', ignoresub=True):
 # No location is the same as not existing.
 if not loc:
 continue
 # TODO ignore default-push once all consumers stop referencing it
 # since it is handled specifically below.
-self[name] = path(ui, name, rawloc=loc)
+loc, sub = ui.configsuboptions('paths', name)
+self[name] = path(ui, name, rawloc=loc, suboptions=sub)
 # Handle default-push, which is a one-off that defines the push URL for
 # the "default" path.
 defaultpush = ui.config('paths', 'default-push')
 if defaultpush:
 raise error.RepoError(_('repository %s does not exist') %
 name)
 assert False
+_pathsuboptions = {}
+def pathsuboption(option, attr):
+"""Decorator used to declare a path sub-option.
+Arguments are the sub-option name and the attribute it should set on
+``path`` instances.
+The decorated function will receive as arguments a ``ui`` instance,
+``path`` instance, and the string value of this option from the config.
+The function should return the value that will be set on the ``path``
+instance.
+This decorator can be used to perform additional verification of
+sub-options and to change the type of sub-options.
+"""
+def register(func):
+_pathsuboptions[option] = (attr, func)
+return func
+return register
+@pathsuboption('pushurl', 'pushloc')
+def pushurlpathoption(ui, path, value):
+u = util.url(value)
+# Actually require a URL.
+if not u.scheme:
+ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
+return None
+# Don't support the #foo syntax in the push URL to declare branch to
+# push.
+if u.fragment:
+ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
+'ignoring)\n') % path.name)
+u.fragment = None
+return str(u)
 class path(object):
 """Represents an individual path and its configuration."""
-def __init__(self, ui, name, rawloc=None, pushloc=None):
+def __init__(self, ui, name, rawloc=None, suboptions=None):
 """Construct a path from its config options.
 ``ui`` is the ``ui`` instance the path is coming from.
 ``name`` is the symbolic name of the path.
 ``rawloc`` is the raw location, as defined in the config.
 self.branch = branch
 self.name = name
 self.rawloc = rawloc
 self.loc = str(u)
-self.pushloc = pushloc
 # When given a raw location but not a symbolic name, validate the
 # location is valid.
 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
 raise ValueError('location is not a URL or path to a local '
 'repo: %s' % rawloc)
+suboptions = suboptions or {}
+# Now process the sub-options. If a sub-option is registered, its
+# attribute will always be present. The value will be None if there
+# was no valid sub-option.
+for suboption, (attr, func) in _pathsuboptions.iteritems():
+if suboption not in suboptions:
+setattr(self, attr, None)
+continue
+value = func(ui, self, suboptions[suboption])
+setattr(self, attr, value)
 def _isvalidlocalpath(self, path):
 """Returns True if the given path is a potentially valid repository.
 This is its own function so that extensions can change the definition of
 'valid' in this case (like when pulling from a git repo into a hg
 one)."""
 return os.path.isdir(os.path.join(path, '.hg'))
+@property
+def suboptions(self):
+"""Return sub-options and their values for this path.
+This is intended to be used for presentation purposes.
+"""
+d = {}
+for subopt, (attr, _func) in _pathsuboptions.iteritems():
+value = getattr(self, attr)
+if value is not None:
+d[subopt] = value
+return d
 # we instantiate one globally shared progress bar to avoid
 # competing progress bars when multiple UI objects get created
 _progresssingleton = None

Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/ui.py @ 27266:4dccc37b87bd