This is an archive of the discontinued Mercurial Phabricator instance.

Differential D736

registrar: add support for storing the type of command in func object
ClosedPublic

Authored by pulkit on Sep 19 2017, 9:36 PM.

Details

Reviewers
durham
durin42
Group Reviewers
hg-reviewers
Commits
rHGfe987d0b9e1e: registrar: add support for storing the type of command in func object
rHG18507697d917: registrar: add support for storing the type of command in func object
Summary

This patch adds support for storing the type of command which is going to run in
the func object. For this it does the following:

  1. Add three possible values as attributes to the registrar.command class
  2. Add a new argument to registrar.command._doregister function
  3. Add a new attribute cmdtype to the func object

The type of command will be helpful in deciding what level of access on hidden
commits it can has.

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

pulkit created this revision.Sep 19 2017, 9:36 PM
durham accepted this revision.Sep 26 2017, 8:12 AM
durham added a subscriber: durham.

Minor comments, but lgtm

mercurial/registrar.py
148

Might be worth a comment describing what these mean, since it's not obvious without context.

155

These should probably refer to the class constants instead of hard coding duplicate strings.

pulkit planned changes to this revision.Oct 10 2017, 5:34 PM
pulkit edited the summary of this revision. (Show Details)Oct 11 2017, 3:10 PM
pulkit retitled this revision from directaccess: add support for storing the type of command in func object to registrar: add support for storing the type of command in func object.
pulkit added a child revision: D1013: dispatch: filter the repository depending on func.cmdtype.
pulkit updated this revision to Diff 2595.
durin42 accepted this revision.Oct 16 2017, 9:11 PM
This revision is now accepted and ready to land.Oct 16 2017, 9:11 PM
Closed by commit rHG18507697d917: registrar: add support for storing the type of command in func object (authored by pulkit). · Explain WhyOct 16 2017, 9:46 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/dispatch.py (5 lines)
Mmercurial/registrar.py (25 lines)

Diff 2861

mercurial/dispatch.py

error, error,
extensions, extensions,
fancyopts, fancyopts,
help, help,
hg, hg,
hook, hook,
profiling, profiling,
pycompat, pycompat,
registrar,
scmutil, scmutil,
ui as uimod, ui as uimod,
util, util,
) )
unrecoverablewrite = registrar.command.unrecoverablewrite
class request(object): class request(object):
def __init__(self, args, ui=None, repo=None, fin=None, fout=None, def __init__(self, args, ui=None, repo=None, fin=None, fout=None,
ferr=None, prereposetups=None): ferr=None, prereposetups=None):
self.args = args self.args = args
self.ui = ui self.ui = ui
self.repo = repo self.repo = repo
# input/output/error streams # input/output/error streams
% (self.name, cmd)) % (self.name, cmd))
@property @property
def args(self): def args(self):
args = pycompat.maplist(util.expandpath, self.givenargs) args = pycompat.maplist(util.expandpath, self.givenargs)
return aliasargs(self.fn, args) return aliasargs(self.fn, args)
def __getattr__(self, name): def __getattr__(self, name):
adefaults = {r'norepo': True, adefaults = {r'norepo': True, r'cmdtype': unrecoverablewrite,
r'optionalrepo': False, r'inferrepo': False} r'optionalrepo': False, r'inferrepo': False}
if name not in adefaults: if name not in adefaults:
raise AttributeError(name) raise AttributeError(name)
if self.badalias or util.safehasattr(self, 'shell'): if self.badalias or util.safehasattr(self, 'shell'):
return adefaults[name] return adefaults[name]
return getattr(self.fn, name) return getattr(self.fn, name)
def __call__(self, ui, *args, **opts): def __call__(self, ui, *args, **opts):

mercurial/registrar.py

# registrar.py - utilities to register function for specific purpose # registrar.py - utilities to register function for specific purpose
# #
# Copyright FUJIWARA Katsunori <foozy@lares.dti.ne.jp> and others # Copyright FUJIWARA Katsunori <foozy@lares.dti.ne.jp> and others
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
from .i18n import _
from . import ( from . import (
configitems, configitems,
error, error,
pycompat, pycompat,
util, util,
) )
# unlike the other registered items, config options are neither functions or # unlike the other registered items, config options are neither functions or
The optionalrepo argument defines whether the command optionally requires The optionalrepo argument defines whether the command optionally requires
a local repository. a local repository.
The inferrepo argument defines whether to try to find a repository from the The inferrepo argument defines whether to try to find a repository from the
command line arguments. If True, arguments will be examined for potential command line arguments. If True, arguments will be examined for potential
repository locations. See ``findrepo()``. If a repository is found, it repository locations. See ``findrepo()``. If a repository is found, it
will be used. will be used.
There are three constants in the class which tells what type of the command
that is. That information will be helpful at various places. It will be also
be used to decide what level of access the command has on hidden commits.
The constants are:
unrecoverablewrite is for those write commands which can't be recovered like
push.
recoverablewrite is for write commands which can be recovered like commit.
readonly is for commands which are read only.
""" """
unrecoverablewrite = "unrecoverable"
recoverablewrite = "recoverable"
durhamUnsubmitted
Not Done

Might be worth a comment describing what these mean, since it's not obvious without context.

durham: Might be worth a comment describing what these mean, since it's not obvious without context.
readonly = "readonly"
def _doregister(self, func, name, options=(), synopsis=None, def _doregister(self, func, name, options=(), synopsis=None,
norepo=False, optionalrepo=False, inferrepo=False): norepo=False, optionalrepo=False, inferrepo=False,
cmdtype=unrecoverablewrite):
possiblecmdtypes = set([self.unrecoverablewrite, self.recoverablewrite,
durhamUnsubmitted
Not Done

These should probably refer to the class constants instead of hard coding duplicate strings.

durham: These should probably refer to the class constants instead of hard coding duplicate strings.
self.readonly])
if cmdtype not in possiblecmdtypes:
raise error.ProgrammingError(_("unknown cmdtype value '%s' for "
"'%s' command") % (cmdtype, name))
func.norepo = norepo func.norepo = norepo
func.optionalrepo = optionalrepo func.optionalrepo = optionalrepo
func.inferrepo = inferrepo func.inferrepo = inferrepo
func.cmdtype = cmdtype
if synopsis: if synopsis:
self._table[name] = func, list(options), synopsis self._table[name] = func, list(options), synopsis
else: else:
self._table[name] = func, list(options) self._table[name] = func, list(options)
return func return func
class revsetpredicate(_funcregistrarbase): class revsetpredicate(_funcregistrarbase):
"""Decorator to register revset predicate """Decorator to register revset predicate