##// END OF EJS Templates
repository: define interface for local repositories...
repository: define interface for local repositories Per discussions on the mailing list and at the 4.4 and 4.6 sprints, we want to start defining interfaces for local repository primitives so that we a) have a better idea of what the formal interface for various types is b) can more easily introduce alternate implementations of various components (e.g. in Rust). We have previously implemented interfaces that declare the peer and wire protocol APIs using the abc module. This commit introduces a monolithic interface for the localrepository class. It uses zope.interface - not abc - for defining and declaring the interface. The newly defined "completelocalrepository" interface is objectively horrible. It is based on what is actually in localrepository and doesn't represent a reasonable interface definition IMO. There's lots of... unwanted garbage in the interface. In other words, it reflects the horrible state of the localrepository "god object." But this is fine: a goal of this commit is to get the interface defined so that we have an interface. Future commits can refactor the interface into sub-interfaces, remove unwanted public attributes, etc. I attempted to define reasonable docstrings for the various interface members. But there are so many of them and I didn't know what some are used for. So I was lazy in a number of places and didn't write docstrings or detailed usage docs. Also, the members of the interface are defined in the order they are declared in localrepo.py. This revealed that the grouping of things in localrepo.py is... odd. The localrepository class now declares that it implements our newly defined interface. Unlike abc, zope.interface doesn't check interface conformance at type creation time (abc uses __metaclass__ magic to validate interface conformance when a type is created - usually at module import time). It does provide some functions for validating class and object conformance with declared interfaces. We add these checks to test-check-interfaces.py. We /could/ validate at run-time. But we hold off for now. (I'm a bit scared of doing that because of the various ways extensions monkeypatch repo instances.) After this commit, test-check-interfaces.py will fail if the set of public attributes on the localrepository class or instances change without corresponding updates to the interface. This is by design. Differential Revision: https://phab.mercurial-scm.org/D2933

File last commit:

r37138:a8a902d7 default
r37198:0dfb5672 default
Show More
wsgicgi.py
93 lines | 2.9 KiB | text/x-python | PythonLexer
Eric Hopper
This patch make several WSGI related alterations....
r2506 # hgweb/wsgicgi.py - CGI->WSGI translator
#
# Copyright 2006 Eric Hopper <hopper@omnifarious.org>
#
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
This patch make several WSGI related alterations....
r2506 #
# This was originally copied from the public domain code at
# http://www.python.org/dev/peps/pep-0333/#the-server-gateway-side
Yuya Nishihara
hgweb: use absolute_import
r27046 from __future__ import absolute_import
from .. import (
Pulkit Goyal
py3: replace os.environ with encoding.environ (part 3 of 5)
r30636 encoding,
Yuya Nishihara
hgweb: use absolute_import
r27046 )
Yuya Nishihara
procutil: bulk-replace util.std* to point to new module
r37137 from ..utils import (
procutil,
)
Yuya Nishihara
hgweb: use absolute_import
r27046 from . import (
common,
)
Eric Hopper
This patch make several WSGI related alterations....
r2506
def launch(application):
Yuya Nishihara
procutil: bulk-replace function calls to point to new module
r37138 procutil.setbinary(procutil.stdin)
procutil.setbinary(procutil.stdout)
Eric Hopper
This patch make several WSGI related alterations....
r2506
Pulkit Goyal
py3: replace os.environ with encoding.environ (part 3 of 5)
r30636 environ = dict(encoding.environ.iteritems())
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 environ.setdefault(r'PATH_INFO', '')
if environ.get(r'SERVER_SOFTWARE', r'').startswith(r'Microsoft-IIS'):
Mads Kiilerich
fix trivial spelling errors
r17424 # IIS includes script_name in PATH_INFO
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 scriptname = environ[r'SCRIPT_NAME']
if environ[r'PATH_INFO'].startswith(scriptname):
environ[r'PATH_INFO'] = environ[r'PATH_INFO'][len(scriptname):]
Dirkjan Ochtman
hgweb: support broken IIS 5 behavior with .cgi in PATH_INFO
r7406
Yuya Nishihara
procutil: bulk-replace util.std* to point to new module
r37137 stdin = procutil.stdin
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 if environ.get(r'HTTP_EXPECT', r'').lower() == r'100-continue':
Yuya Nishihara
procutil: bulk-replace util.std* to point to new module
r37137 stdin = common.continuereader(stdin, procutil.stdout.write)
Augie Fackler
hgweb: add support for 100-continue as recommended by PEP 333.
r13570
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 environ[r'wsgi.input'] = stdin
Yuya Nishihara
procutil: bulk-replace util.std* to point to new module
r37137 environ[r'wsgi.errors'] = procutil.stderr
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 environ[r'wsgi.version'] = (1, 0)
environ[r'wsgi.multithread'] = False
environ[r'wsgi.multiprocess'] = True
environ[r'wsgi.run_once'] = True
Eric Hopper
This patch make several WSGI related alterations....
r2506
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 if environ.get(r'HTTPS', r'off').lower() in (r'on', r'1', r'yes'):
environ[r'wsgi.url_scheme'] = r'https'
Eric Hopper
This patch make several WSGI related alterations....
r2506 else:
Augie Fackler
hgweb: when constructing or adding to a wsgi environ dict, use native strs...
r34513 environ[r'wsgi.url_scheme'] = r'http'
Eric Hopper
This patch make several WSGI related alterations....
r2506
headers_set = []
headers_sent = []
Yuya Nishihara
procutil: bulk-replace util.std* to point to new module
r37137 out = procutil.stdout
Eric Hopper
This patch make several WSGI related alterations....
r2506
def write(data):
if not headers_set:
Thomas Arendsen Hein
white space and line break cleanups
r3673 raise AssertionError("write() before start_response()")
Eric Hopper
This patch make several WSGI related alterations....
r2506
elif not headers_sent:
Thomas Arendsen Hein
white space and line break cleanups
r3673 # Before the first output, send the stored headers
status, response_headers = headers_sent[:] = headers_set
out.write('Status: %s\r\n' % status)
for header in response_headers:
out.write('%s: %s\r\n' % header)
out.write('\r\n')
Eric Hopper
This patch make several WSGI related alterations....
r2506
Alexis S. L. Carvalho
hgweb: fix unbundle....
r2558 out.write(data)
out.flush()
Eric Hopper
This patch make several WSGI related alterations....
r2506
Thomas Arendsen Hein
white space and line break cleanups
r3673 def start_response(status, response_headers, exc_info=None):
Eric Hopper
This patch make several WSGI related alterations....
r2506 if exc_info:
try:
if headers_sent:
# Re-raise original exception if headers sent
Peter Ruibal
use Exception(args)-style raising consistently (py3k compatibility)
r7008 raise exc_info[0](exc_info[1], exc_info[2])
Eric Hopper
This patch make several WSGI related alterations....
r2506 finally:
exc_info = None # avoid dangling circular ref
elif headers_set:
raise AssertionError("Headers already set!")
Thomas Arendsen Hein
white space and line break cleanups
r3673 headers_set[:] = [status, response_headers]
Eric Hopper
This patch make several WSGI related alterations....
r2506 return write
Dirkjan Ochtman
hgweb: fix WSGI iterators handling in CGI adapter (issue1254)
r6922 content = application(environ, start_response)
Konstantin Zemlyak
wsgicgi: call close() on iterable to avoid resource leaks...
r10753 try:
for chunk in content:
write(chunk)
Mads Kiilerich
hgweb.cgi: fix internal WSGI emulation (issue3804)...
r18552 if not headers_sent:
write('') # send headers now if body was empty
Konstantin Zemlyak
wsgicgi: call close() on iterable to avoid resource leaks...
r10753 finally:
Alex Gaynor
style: never use a space before a colon or comma...
r34487 getattr(content, 'close', lambda: None)()