mercurial-scm/hg: mercurial/hgweb/webcommands.py comparison

comparison mercurial/hgweb/webcommands.py @ 36887:4daa22071d5d

hgweb: stop passing req and tmpl into @webcommand functions (API) We have effectively removed all consumers of the old wsgirequest type. The templater can be accessed on the requestcontext passed into the @webcommand function. For the most part, these arguments are unused. They only exist to provide backwards compatibility. And in the case of wsgirequest, use of that object could actively interfere with the new request object. So let's stop passing these objects to @webcommand functions. With this commit, wsgirequest is practically dead from the hgweb WSGI application. There are still some uses in hgwebdir though... .. api:: @webcommand functions now only receive a single argument. The request and templater instances can be accessed via the ``req`` and ``templater`` attributes of the first argument. Note that the request object is different from previous Mercurial releases and consumers of the previous ``req`` 2nd argument will need updating to use the new API. Differential Revision: https://phab.mercurial-scm.org/D2803

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Sat, 10 Mar 2018 20:51:46 -0800
parents	563fd95a6efb
children	a82fc3922446

comparison

equal deleted inserted replaced

-:563fd95a6efb
+:4daa22071d5d
 to render a template.
 Usage:
 @webcommand('mycommand')
-def mycommand(web, req, tmpl):
+def mycommand(web):
 pass
 """
 def __init__(self, name):
 self.name = name
 __all__.append(self.name)
 commands[self.name] = func
 return func
 @webcommand('log')
-def log(web, req, tmpl):
+def log(web):
 """
 /log[/{revision}[/{path}]]
 --------------------------
 Show repository or file history.
 For URLs of the form ``/log/{revision}/{file}``, the history for a specific
 file will be shown. This form is equivalent to the ``filelog`` handler.
 """
 if web.req.qsparams.get('file'):
-return filelog(web, req, None)
+return filelog(web)
 else:
-return changelog(web, req, None)
+return changelog(web)
 @webcommand('rawfile')
-def rawfile(web, req, tmpl):
+def rawfile(web):
 guessmime = web.configbool('web', 'guessmime')
 path = webutil.cleanpath(web.repo, web.req.qsparams.get('file', ''))
 if not path:
-return manifest(web, req, None)
+return manifest(web)
 try:
 fctx = webutil.filectx(web.repo, web.req)
 except error.LookupError as inst:
 try:
-return manifest(web, req, None)
+return manifest(web)
 except ErrorResponse:
 raise inst
 path = fctx.path()
 text = fctx.data()
 .replace('\\', '\\\\').replace('"', '\\"'))
 web.res.headers['Content-Disposition'] = 'inline; filename="%s"' % filename
 web.res.setbodybytes(text)
 return web.res.sendresponse()
-def _filerevision(web, req, fctx):
+def _filerevision(web, fctx):
 f = fctx.path()
 text = fctx.data()
 parity = paritygen(web.stripecount)
 ishead = fctx.filerev() in fctx.filelog().headrevs()
 permissions=fctx.manifest().flags(f),
 ishead=int(ishead),
 **pycompat.strkwargs(webutil.commonentry(web.repo, fctx)))
 @webcommand('file')
-def file(web, req, tmpl):
+def file(web):
 """
 /file/{revision}[/{path}]
 -------------------------
 Show information about a directory or file in the repository.
 If ``path`` is not defined, information about the root directory will
 be rendered.
 """
 if web.req.qsparams.get('style') == 'raw':
-return rawfile(web, req, None)
+return rawfile(web)
 path = webutil.cleanpath(web.repo, web.req.qsparams.get('file', ''))
 if not path:
-return manifest(web, req, None)
+return manifest(web)
 try:
-return _filerevision(web, req, webutil.filectx(web.repo, web.req))
+return _filerevision(web, webutil.filectx(web.repo, web.req))
 except error.LookupError as inst:
 try:
-return manifest(web, req, None)
+return manifest(web)
 except ErrorResponse:
 raise inst
 def _search(web):
 MODE_REVISION = 'rev'
 modedesc=searchfunc[1],
 showforcekw=showforcekw,
 showunforcekw=showunforcekw)
 @webcommand('changelog')
-def changelog(web, req, tmpl, shortlog=False):
+def changelog(web, shortlog=False):
 """
 /changelog[/{revision}]
 -----------------------
 Show information about multiple changesets.
 morevars=morevars,
 lessvars=lessvars,
 query=query)
 @webcommand('shortlog')
-def shortlog(web, req, tmpl):
+def shortlog(web):
 """
 /shortlog
 ---------
 Show basic information about a set of changesets.
 This accepts the same parameters as the ``changelog`` handler. The only
 difference is the ``shortlog`` template will be rendered instead of the
 ``changelog`` template.
 """
-return changelog(web, req, None, shortlog=True)
+return changelog(web, shortlog=True)
 @webcommand('changeset')
-def changeset(web, req, tmpl):
+def changeset(web):
 """
 /changeset[/{revision}]
 -----------------------
 Show information about a single changeset.
 Extensions (e.g., largefiles) can override this to remap files in
 the virtual file system presented by the manifest command below."""
 return path
 @webcommand('manifest')
-def manifest(web, req, tmpl):
+def manifest(web):
 """
 /manifest[/{revision}[/{path}]]
 -------------------------------
 Show information about a directory.
 dentries=dirlist,
 archives=web.archivelist(hex(node)),
 **pycompat.strkwargs(webutil.commonentry(web.repo, ctx)))
 @webcommand('tags')
-def tags(web, req, tmpl):
+def tags(web):
 """
 /tags
 -----
 Show information about tags.
 entries=lambda **x: entries(False, False, **x),
 entriesnotip=lambda **x: entries(True, False, **x),
 latestentry=lambda **x: entries(True, True, **x))
 @webcommand('bookmarks')
-def bookmarks(web, req, tmpl):
+def bookmarks(web):
 """
 /bookmarks
 ----------
 Show information about bookmarks.
 lastchange=[{'date': web.repo[latestrev].date()}],
 entries=lambda **x: entries(latestonly=False, **x),
 latestentry=lambda **x: entries(latestonly=True, **x))
 @webcommand('branches')
-def branches(web, req, tmpl):
+def branches(web):
 """
 /branches
 ---------
 Show information about branches.
 node=hex(web.repo.changelog.tip()),
 entries=entries,
 latestentry=latestentry)
 @webcommand('summary')
-def summary(web, req, tmpl):
+def summary(web):
 """
 /summary
 --------
 Show a summary of repository state.
 symrev='tip',
 archives=web.archivelist('tip'),
 labels=web.configlist('web', 'labels'))
 @webcommand('filediff')
-def filediff(web, req, tmpl):
+def filediff(web):
 """
 /diff/{revision}/{path}
 -----------------------
 Show how a file changed in a particular commit.
 **pycompat.strkwargs(webutil.commonentry(web.repo, ctx)))
 diff = webcommand('diff')(filediff)
 @webcommand('comparison')
-def comparison(web, req, tmpl):
+def comparison(web):
 """
 /comparison/{revision}/{path}
 -----------------------------
 Show a comparison between the old and new versions of a file from changes
 rightnode=hex(rightnode),
 comparison=comparison,
 **pycompat.strkwargs(webutil.commonentry(web.repo, ctx)))
 @webcommand('annotate')
-def annotate(web, req, tmpl):
+def annotate(web):
 """
 /annotate/{revision}/{path}
 ---------------------------
 Show changeset information for each line in a file.
 ishead=int(ishead),
 diffopts=diffopts,
 **pycompat.strkwargs(webutil.commonentry(web.repo, fctx)))
 @webcommand('filelog')
-def filelog(web, req, tmpl):
+def filelog(web):
 """
 /filelog/{revision}/{path}
 --------------------------
 Show information about the history of a file in the repository.
 morevars=morevars,
 lessvars=lessvars,
 **pycompat.strkwargs(webutil.commonentry(web.repo, fctx)))
 @webcommand('archive')
-def archive(web, req, tmpl):
+def archive(web):
 """
 /archive/{revision}.{format}[/{path}]
 -------------------------------------
 Obtain an archive of repository content.
 subrepos=web.configbool("web", "archivesubrepos"))
 return []
 @webcommand('static')
-def static(web, req, tmpl):
+def static(web):
 fname = web.req.qsparams['file']
 # a repo owner may set web.static in .hg/hgrc to get any file
 # readable by the user running the CGI script
 static = web.config("web", "static", None, untrusted=False)
 if not static:
 staticfile(static, fname, web.res)
 return web.res.sendresponse()
 @webcommand('graph')
-def graph(web, req, tmpl):
+def graph(web):
 """
 /graph[/{revision}]
 -------------------
 Show information about the graphical topology of the repository.
 else:
 doc = _('(no help text available)')
 return doc
 @webcommand('help')
-def help(web, req, tmpl):
+def help(web):
 """
 /help[/{topic}]
 ---------------
 Render help documentation.

Mercurial > public > mercurial-scm > hg

comparison mercurial/hgweb/webcommands.py @ 36887:4daa22071d5d