##// END OF EJS Templates
localrepo: iteratively derive local repository type...
localrepo: iteratively derive local repository type This commit implements the dynamic local repository type derivation that was explained in the recent commit bfeab472e3c0 "localrepo: create new function for instantiating a local repo object." Instead of a static localrepository class/type which must be customized after construction, we now dynamically construct a type by building up base classes/types to represent specific repository interfaces. Conceptually, the end state is similar to what was happening when various extensions would monkeypatch the __class__ of newly-constructed repo instances. However, the approach is inverted. Instead of making the instance then customizing it, we do the customization up front by influencing the behavior of the type then we instantiate that custom type. This approach gives us much more flexibility. For example, we can use completely separate classes for implementing different aspects of the repository. For example, we could have one class representing revlog-based file storage and another representing non-revlog based file storage. When then choose which implementation to use based on the presence of repo requirements. A concern with this approach is that it creates a lot more types and complexity and that complexity adds overhead. Yes, it is true that this approach will result in more types being created. Yes, this is more complicated than traditional "instantiate a static type." However, I believe the alternatives to supporting alternate storage backends are just as complicated. (Before I arrived at this solution, I had patches storing factory functions on local repo instances for e.g. constructing a file storage instance. We ended up having a handful of these. And this was logically identical to assigning custom methods. Since we were logically changing the type of the instance, I figured it would be better to just use specialized types instead of introducing levels of abstraction at run-time.) On the performance front, I don't believe that having N base classes has any significant performance overhead compared to just a single base class. Intuition says that Python will need to iterate the base classes to find an attribute. However, CPython caches method lookups: as long as the __class__ or MRO isn't changing, method attribute lookup should be constant time after first access. And non-method attributes are stored in __dict__, of which there is only 1 per object, so the number of base classes for __dict__ is irrelevant. Anyway, this commit splits up the monolithic completelocalrepository interface into sub-interfaces: 1 for file storage and 1 representing everything else. We've taught ``makelocalrepository()`` to call a series of factory functions which will produce types implementing specific interfaces. It then calls type() to create a new type from the built-up list of base types. This commit should be considered a start and not the end state. I suspect we'll hit a number of problems as we start to implement alternate storage backends: * Passing custom arguments to __init__ and setting custom attributes on __dict__. * Customizing the set of interfaces that are needed. e.g. the "readonly" intent could translate to not requesting an interface providing methods related to writing. * More ergonomic way for extensions to insert themselves so their callbacks aren't unconditionally called. * Wanting to modify vfs instances, other arguments passed to __init__. That being said, this code is usable in its current state and I'm convinced future commits will demonstrate the value in this approach. Differential Revision: https://phab.mercurial-scm.org/D4642

File last commit:

r38196:aea29e81 default
r39800:e4e88157 default
Show More
__init__.py
107 lines | 3.0 KiB | text/x-python | PythonLexer
Eric Hopper
Fixing up comment headers for split up code.
r2391 # hgweb/__init__.py - web interface to a mercurial repository
Eric Hopper
Moving hgweb.py into it's own module in preparation for breaking it up.
r2311 #
# Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
# Copyright 2005 Matt Mackall <mpm@selenic.com>
#
Martin Geisler
updated license to be explicit about GPL version 2
r8225 # This software may be used and distributed according to the terms of the
Matt Mackall
Update license to GPLv2+
r10263 # GNU General Public License version 2 or any later version.
Eric Hopper
Moving hgweb.py into it's own module in preparation for breaking it up.
r2311
Yuya Nishihara
hgweb: use absolute_import
r27046 from __future__ import absolute_import
Matt Mackall
hgweb: make hgweb.hgweb a unified interface to hgweb/hgwebdir
r10996 import os
Yuya Nishihara
hgweb: use absolute_import
r27046
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 from ..i18n import _
from .. import (
Yuya Nishihara
hgweb: extract factory function of httpservice object...
r27139 error,
Augie Fackler
hgweb: rewrite most obviously-native-strings to be native strings...
r34705 pycompat,
Yuya Nishihara
procutil: bulk-replace function calls to point to new module
r37138 )
from ..utils import (
procutil,
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 )
Yuya Nishihara
hgweb: use absolute_import
r27046 from . import (
hgweb_mod,
hgwebdir_mod,
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 server,
Yuya Nishihara
hgweb: use absolute_import
r27046 )
Matt Mackall
Replace demandload with new demandimport
r3877
Matt Mackall
hgweb: make hgweb.hgweb a unified interface to hgweb/hgwebdir
r10996 def hgweb(config, name=None, baseui=None):
'''create an hgweb wsgi object
config can be one of:
- repo object (single repo view)
- path to repo (single repo view)
- path to config file (multi-repo view)
- dict of virtual:real pairs (multi-repo view)
- list of virtual:real tuples (multi-repo view)
'''
Augie Fackler
hgweb: inform hgweb.hgweb() entrypoint that paths should be bytes...
r37763 if ((isinstance(config, bytes) and not os.path.isdir(config)) or
Matt Mackall
hgweb: make hgweb.hgweb a unified interface to hgweb/hgwebdir
r10996 isinstance(config, dict) or isinstance(config, list)):
# create a multi-dir interface
return hgwebdir_mod.hgwebdir(config, baseui=baseui)
return hgweb_mod.hgweb(config, name=name, baseui=baseui)
Matt Mackall
Replace demandload with new demandimport
r3877
Matt Mackall
hgweb: make top-level prototypes mirror their callees
r10992 def hgwebdir(config, baseui=None):
return hgwebdir_mod.hgwebdir(config, baseui=baseui)
Matt Mackall
Replace demandload with new demandimport
r3877
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 class httpservice(object):
def __init__(self, ui, app, opts):
self.ui = ui
self.app = app
self.opts = opts
def init(self):
Yuya Nishihara
procutil: bulk-replace function calls to point to new module
r37138 procutil.setsignalhandler()
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 self.httpd = server.create_server(self.ui, self.app)
Nicola Spanti
serve: add option print-url...
r38196 if (self.opts['port'] and
not self.ui.verbose and
not self.opts['print_url']):
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 return
if self.httpd.prefix:
prefix = self.httpd.prefix.strip('/') + '/'
else:
prefix = ''
Augie Fackler
hgweb: rewrite most obviously-native-strings to be native strings...
r34705 port = r':%d' % self.httpd.port
if port == r':80':
port = r''
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138
bindaddr = self.httpd.addr
Augie Fackler
hgweb: rewrite most obviously-native-strings to be native strings...
r34705 if bindaddr == r'0.0.0.0':
bindaddr = r'*'
elif r':' in bindaddr: # IPv6
bindaddr = r'[%s]' % bindaddr
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138
fqaddr = self.httpd.fqaddr
Augie Fackler
hgweb: rewrite most obviously-native-strings to be native strings...
r34705 if r':' in fqaddr:
fqaddr = r'[%s]' % fqaddr
Nicola Spanti
serve: add option print-url...
r38196
url = 'http://%s%s/%s' % (
pycompat.sysbytes(fqaddr), pycompat.sysbytes(port), prefix)
if self.opts['print_url']:
self.ui.write('%s\n' % url)
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 else:
Nicola Spanti
serve: add option print-url...
r38196 if self.opts['port']:
write = self.ui.status
else:
write = self.ui.write
write(_('listening at %s (bound to %s:%d)\n') %
(url, pycompat.sysbytes(bindaddr), self.httpd.port))
Yuya Nishihara
hgweb: move httpservice object from commands module...
r27138 self.ui.flush() # avoid buffering of status message
def run(self):
self.httpd.serve_forever()
Yuya Nishihara
hgweb: extract factory function of httpservice object...
r27139
Yuya Nishihara
hgweb: extract app factory...
r30508 def createapp(baseui, repo, webconf):
Yuya Nishihara
hgweb: eliminate duck-typing to select hgweb or hgwebdir by command option...
r27181 if webconf:
Yuya Nishihara
hgweb: extract app factory...
r30508 return hgwebdir_mod.hgwebdir(webconf, baseui=baseui)
Yuya Nishihara
hgweb: eliminate duck-typing to select hgweb or hgwebdir by command option...
r27181 else:
Yuya Nishihara
hgweb: extract factory function of httpservice object...
r27139 if not repo:
raise error.RepoError(_("there is no Mercurial repository"
" here (.hg not found)"))
Yuya Nishihara
hgweb: extract app factory...
r30508 return hgweb_mod.hgweb(repo, baseui=baseui)