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

comparison mercurial/hgweb/webcommands.py @ 36880:67fb0dca29bc

hgweb: always return iterable from @webcommand functions (API) We had to hack up this function to support our transition to the new response API. Now that we're done with the transition (!!), we can return to returning an iterator of content chunks from these functions. It is tempting to return a normal object and not a generator. However, as the keyword extension demonstrates, extensions may wish to wrap commands and have a try..finally block around execution. Since there is a generator producing content and that generator could be executing code, the try..finally needs to live for as long as the generator is running. That means we have to return a generator so wrappers can consume the generator inside a try..finally. .. api:: hgweb @webcommand functions must use the new response object passed in via ``web.res`` to initiate sending of a response. The hgweb WSGI application will no longer start sending the response automatically. Differential Revision: https://phab.mercurial-scm.org/D2796

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Sat, 10 Mar 2018 20:35:35 -0800
parents	97f44b0720e2
children	66f62d120ba2

comparison

equal deleted inserted replaced

-:9675147aec06
+:67fb0dca29bc
 When called, functions receive as arguments a ``requestcontext``,
 ``wsgirequest``, and a templater instance for generatoring output.
 The functions should populate the ``rctx.res`` object with details
 about the HTTP response.
-The function can return the ``requestcontext.res`` instance to signal
+The function returns a generator to be consumed by the WSGI application.
-that it wants to use this object to generate the response. If an iterable
+For most commands, this should be the result from
-is returned, the ``wsgirequest`` instance will be used and the returned
+``web.res.sendresponse()``.
-content will constitute the response body. ``True`` can be returned to
-indicate that the function already sent output and the caller doesn't
-need to do anything more to send the response.
 Usage:
 @webcommand('mycommand')
 def mycommand(web, req, tmpl):
 web.res.headers['Content-Type'] = mt
 filename = (path.rpartition('/')[-1]
 .replace('\\', '\\\\').replace('"', '\\"'))
 web.res.headers['Content-Disposition'] = 'inline; filename="%s"' % filename
 web.res.setbodybytes(text)
-return web.res
+return web.res.sendresponse()
 def _filerevision(web, req, tmpl, fctx):
 f = fctx.path()
 text = fctx.data()
 parity = paritygen(web.stripecount)
 rename=webutil.renamelink(fctx),
 permissions=fctx.manifest().flags(f),
 ishead=int(ishead),
 **pycompat.strkwargs(webutil.commonentry(web.repo, fctx))))
-return web.res
+return web.res.sendresponse()
 @webcommand('file')
 def file(web, req, tmpl):
 """
 /file/{revision}[/{path}]
 lessvars=lessvars,
 modedesc=searchfunc[1],
 showforcekw=showforcekw,
 showunforcekw=showunforcekw))
-return web.res
+return web.res.sendresponse()
 @webcommand('changelog')
 def changelog(web, req, tmpl, shortlog=False):
 """
 /changelog[/{revision}]
 revcount=revcount,
 morevars=morevars,
 lessvars=lessvars,
 query=query))
-return web.res
+return web.res.sendresponse()
 @webcommand('shortlog')
 def shortlog(web, req, tmpl):
 """
 /shortlog
 templates related to diffs may all be used to produce the output.
 """
 ctx = webutil.changectx(web.repo, req)
 web.res.setbodygen(tmpl('changeset',
 **webutil.changesetentry(web, req, tmpl, ctx)))
-return web.res
+return web.res.sendresponse()
 rev = webcommand('rev')(changeset)
 def decodepath(path):
 """Hook for mapping a path in the repository to a path in the
 fentries=filelist,
 dentries=dirlist,
 archives=web.archivelist(hex(node)),
 **pycompat.strkwargs(webutil.commonentry(web.repo, ctx))))
-return web.res
+return web.res.sendresponse()
 @webcommand('tags')
 def tags(web, req, tmpl):
 """
 /tags
 node=hex(web.repo.changelog.tip()),
 entries=lambda **x: entries(False, False, **x),
 entriesnotip=lambda **x: entries(True, False, **x),
 latestentry=lambda **x: entries(True, True, **x)))
-return web.res
+return web.res.sendresponse()
 @webcommand('bookmarks')
 def bookmarks(web, req, tmpl):
 """
 /bookmarks
 node=hex(web.repo.changelog.tip()),
 lastchange=[{'date': web.repo[latestrev].date()}],
 entries=lambda **x: entries(latestonly=False, **x),
 latestentry=lambda **x: entries(latestonly=True, **x)))
-return web.res
+return web.res.sendresponse()
 @webcommand('branches')
 def branches(web, req, tmpl):
 """
 /branches
 'branches',
 node=hex(web.repo.changelog.tip()),
 entries=entries,
 latestentry=latestentry))
-return web.res
+return web.res.sendresponse()
 @webcommand('summary')
 def summary(web, req, tmpl):
 """
 /summary
 node=tip.hex(),
 symrev='tip',
 archives=web.archivelist('tip'),
 labels=web.configlist('web', 'labels')))
-return web.res
+return web.res.sendresponse()
 @webcommand('filediff')
 def filediff(web, req, tmpl):
 """
 /diff/{revision}/{path}
 symrev=webutil.symrevorshortnode(req, ctx),
 rename=rename,
 diff=diffs,
 **pycompat.strkwargs(webutil.commonentry(web.repo, ctx))))
-return web.res
+return web.res.sendresponse()
 diff = webcommand('diff')(filediff)
 @webcommand('comparison')
 def comparison(web, req, tmpl):
 rightrev=rightrev,
 rightnode=hex(rightnode),
 comparison=comparison,
 **pycompat.strkwargs(webutil.commonentry(web.repo, ctx))))
-return web.res
+return web.res.sendresponse()
 @webcommand('annotate')
 def annotate(web, req, tmpl):
 """
 /annotate/{revision}/{path}
 permissions=fctx.manifest().flags(f),
 ishead=int(ishead),
 diffopts=diffopts,
 **pycompat.strkwargs(webutil.commonentry(web.repo, fctx))))
-return web.res
+return web.res.sendresponse()
 @webcommand('filelog')
 def filelog(web, req, tmpl):
 """
 /filelog/{revision}/{path}
 revcount=revcount,
 morevars=morevars,
 lessvars=lessvars,
 **pycompat.strkwargs(webutil.commonentry(web.repo, fctx))))
-return web.res
+return web.res.sendresponse()
 @webcommand('archive')
 def archive(web, req, tmpl):
 """
 /archive/{revision}.{format}[/{path}]
 archival.archive(web.repo, bodyfh, cnode, artype, prefix=name,
 matchfn=match,
 subrepos=web.configbool("web", "archivesubrepos"))
-return True
+return []
 @webcommand('static')
 def static(web, req, tmpl):
 fname = req.req.qsparams['file']
 # a repo owner may set web.static in .hg/hgrc to get any file
 if isinstance(tp, str):
 tp = [tp]
 static = [os.path.join(p, 'static') for p in tp]
 staticfile(static, fname, web.res)
-return web.res
+return web.res.sendresponse()
 @webcommand('graph')
 def graph(web, req, tmpl):
 """
 /graph[/{revision}]
 jsdata=lambda **x: jsdata(),
 nodes=lambda **x: nodes(),
 node=ctx.hex(),
 changenav=changenav))
-return web.res
+return web.res.sendresponse()
 def _getdoc(e):
 doc = e[0].__doc__
 if doc:
 doc = _(doc).partition('\n')[0]
 'helptopics',
 topics=topics,
 earlycommands=earlycommands,
 othercommands=othercommands,
 title='Index'))
-return web.res
+return web.res.sendresponse()
 # Render an index of sub-topics.
 if topicname in helpmod.subtopics:
 topics = []
 for entries, summary, _doc in helpmod.subtopics[topicname]:
 web.res.setbodygen(tmpl(
 'helptopics',
 topics=topics,
 title=topicname,
 subindex=True))
-return web.res
+return web.res.sendresponse()
 u = webutil.wsgiui.load()
 u.verbose = True
 # Render a page from a sub-topic.
 web.res.setbodygen(tmpl(
 'help',
 topic=topicname,
 doc=doc))
-return web.res
+return web.res.sendresponse()
 # tell hggettext to extract docstrings from these functions:
 i18nfunctions = commands.values()

Mercurial > public > mercurial-scm > hg

comparison mercurial/hgweb/webcommands.py @ 36880:67fb0dca29bc