/loggerhead/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/loggerhead/trunk

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Ubuntu One Auto Copilot
  • Author(s): Jelmer Vernooij
  • Date: 2023-02-01 10:38:17 UTC
  • mfrom: (543.2.1 lp:loggerhead)
  • Revision ID: otto-copilot@canonical.com-20230201103817-h68q8zmdvm7u1vv4
Sort Python import definitions

Merged from https://code.launchpad.net/~jelmer/loggerhead/isort/+merge/436635

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335  USA
16
16
 
17
17
 
18
18
# This file allows loggerhead to be treated as a plugin for bzr.
19
19
#
20
20
# XXX: Because loggerhead already contains a loggerhead directory, much of the
21
 
# code is going to appear loaded at bzrlib.plugins.loggerhead.loggerhead.
22
 
# This seems like the easiest thing, because bzrlib wants the top-level plugin
 
21
# code is going to appear loaded at breezy.plugins.loggerhead.loggerhead.
 
22
# This seems like the easiest thing, because breezy wants the top-level plugin
23
23
# directory to be the module, but when it's used as a library people expect
24
24
# the source directory to contain a directory called loggerhead.  -- mbp
25
25
# 20090123
30
30
starts a web server to browse the contents of a branch.
31
31
"""
32
32
 
33
 
from info import (
34
 
    bzr_plugin_version as version_info,
35
 
    bzr_compatible_versions,
36
 
    )
37
 
 
38
 
if __name__ == 'bzrlib.plugins.loggerhead':
39
 
    import bzrlib
40
 
    from bzrlib.api import require_any_api
41
 
    from bzrlib import commands
42
 
 
43
 
    require_any_api(bzrlib, bzr_compatible_versions)
44
 
 
45
 
    # NB: Normally plugins should lazily load almost everything, but this
46
 
    # seems reasonable to have in-line here: bzrlib.commands and options are
47
 
    # normally loaded, and the rest of loggerhead won't be loaded until serve
48
 
    # --http is run.
49
 
 
50
 
    # transport_server_registry was added in bzr 1.16. When we drop support for
51
 
    # older releases, we can remove the code to override cmd_serve.
 
33
try:
 
34
    import importlib.metadata as importlib_metadata
 
35
except ImportError:
 
36
    import importlib_metadata
 
37
 
 
38
import sys
 
39
 
 
40
from packaging.version import Version
 
41
 
 
42
try:
 
43
    version_info = Version(importlib_metadata.version("loggerhead")).release
 
44
except importlib_metadata.PackageNotFoundError:
 
45
    # Support running tests from the build tree without installation.
 
46
    version_info = None
 
47
 
 
48
import breezy
 
49
from breezy import commands
 
50
from breezy.transport import transport_server_registry
 
51
 
 
52
DEFAULT_HOST = '0.0.0.0'
 
53
DEFAULT_PORT = 8080
 
54
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
 
55
        (DEFAULT_PORT,))
 
56
 
 
57
 
 
58
def serve_http(transport, host=None, port=None, inet=None, client_timeout=None):
 
59
    # TODO: if we supported inet to pass requests in and respond to them,
 
60
    #       then it would be easier to test the full stack, but it probably
 
61
    #       means routing around paste.httpserver.serve which probably
 
62
    #       isn't testing the full stack
 
63
    from paste.httpexceptions import HTTPExceptionHandler
 
64
    from paste.httpserver import serve
52
65
 
53
66
    try:
54
 
        from bzrlib.transport import transport_server_registry
 
67
        from .loggerhead.apps.http_head import HeadMiddleware
 
68
        from .loggerhead.apps.transport import BranchesFromTransportRoot
 
69
        from .loggerhead.config import LoggerheadConfig
 
70
        from .loggerhead.__main__ import setup_logging
55
71
    except ImportError:
56
 
        transport_server_registry = None
57
 
 
58
 
    DEFAULT_HOST = '0.0.0.0'
59
 
    DEFAULT_PORT = 8080
60
 
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
61
 
            (DEFAULT_PORT,))
62
 
 
63
 
    def setup_logging(config):
64
 
        import logging
65
 
        import sys
66
 
 
67
 
        logger = logging.getLogger('loggerhead')
68
 
        handler = logging.StreamHandler(sys.stderr)
69
 
        handler.setLevel(logging.DEBUG)
70
 
        logger.addHandler(handler)
71
 
        logging.getLogger('simpleTAL').addHandler(handler)
72
 
        logging.getLogger('simpleTALES').addHandler(handler)
73
 
 
74
 
 
75
 
    def _ensure_loggerhead_path():
76
 
        """Ensure that you can 'import loggerhead' and get the root."""
77
 
        # loggerhead internal code will try to 'import loggerhead', so
78
 
        # let's put it on the path if we can't find it in the existing path
 
72
        from loggerhead.apps.http_head import HeadMiddleware
 
73
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
74
        from loggerhead.config import LoggerheadConfig
 
75
        from loggerhead.__main__ import setup_logging
 
76
 
 
77
    if host is None:
 
78
        host = DEFAULT_HOST
 
79
    if port is None:
 
80
        port = DEFAULT_PORT
 
81
    argv = ['--host', host, '--port', str(port), '--', transport.base]
 
82
    if not transport.is_readonly():
 
83
        argv.insert(0, '--allow-writes')
 
84
    config = LoggerheadConfig(argv)
 
85
    setup_logging(config, init_logging=False, log_file=sys.stderr)
 
86
    app = BranchesFromTransportRoot(transport.base, config)
 
87
    # Bug #758618, HeadMiddleware seems to break HTTPExceptionHandler from
 
88
    # actually sending appropriate return codes to the client. Since nobody
 
89
    # desperately needs HeadMiddleware right now, just ignoring it.
 
90
    # app = HeadMiddleware(app)
 
91
    app = HTTPExceptionHandler(app)
 
92
    serve(app, host=host, port=port)
 
93
 
 
94
transport_server_registry.register('http', serve_http, help=HELP)
 
95
 
 
96
class cmd_load_test_loggerhead(commands.Command):
 
97
    """Run a load test against a live loggerhead instance.
 
98
 
 
99
    Pass in the name of a script file to run. See loggerhead/load_test.py
 
100
    for a description of the file format.
 
101
    """
 
102
 
 
103
    hidden = True
 
104
    takes_args = ["filename"]
 
105
 
 
106
    def run(self, filename):
79
107
        try:
80
 
            import loggerhead.apps.transport
 
108
            from .loggerhead.loggerhead import load_test
81
109
        except ImportError:
82
 
            import os.path, sys
83
 
            sys.path.append(os.path.dirname(__file__))
84
 
 
85
 
    def serve_http(transport, host=None, port=None, inet=None):
86
 
        from paste.httpexceptions import HTTPExceptionHandler
87
 
        from paste.httpserver import serve
88
 
 
89
 
        _ensure_loggerhead_path()
90
 
 
91
 
        from loggerhead.apps.transport import BranchesFromTransportRoot
92
 
        from loggerhead.config import LoggerheadConfig
93
 
 
94
 
        if host is None:
95
 
            host = DEFAULT_HOST
96
 
        if port is None:
97
 
            port = DEFAULT_PORT
98
 
        argv = ['--host', host, '--port', str(port), '--', transport.base]
99
 
        if not transport.is_readonly():
100
 
            argv.insert(0, '--allow-writes')
101
 
        config = LoggerheadConfig(argv)
102
 
        setup_logging(config)
103
 
        app = BranchesFromTransportRoot(transport.base, config)
104
 
        app = HTTPExceptionHandler(app)
105
 
        serve(app, host=host, port=port)
106
 
 
107
 
    if transport_server_registry is not None:
108
 
        transport_server_registry.register('http', serve_http, help=HELP)
 
110
            from loggerhead.loggerhead import load_test
 
111
        script = load_test.run_script(filename)
 
112
        for thread_id in sorted(script._threads):
 
113
            worker = script._threads[thread_id][0]
 
114
            for url, success, time in worker.stats:
 
115
                self.outf.write(' %5.3fs %s %s\n'
 
116
                                % (time, str(success)[0], url))
 
117
 
 
118
commands.register_command(cmd_load_test_loggerhead)
 
119
 
 
120
def load_tests(loader, basic_tests, pattern):
 
121
    try:
 
122
        from .loggerhead.tests import test_suite
 
123
    except ImportError:
 
124
        from breezy.trace import mutter
 
125
        mutter(
 
126
            'loggerhead tests not installed, not registering tests')
109
127
    else:
110
 
        import bzrlib.builtins
111
 
        from bzrlib.option import Option
112
 
 
113
 
        _original_command = commands.get_cmd_object('serve')
114
 
 
115
 
        class cmd_serve(bzrlib.builtins.cmd_serve):
116
 
            __doc__ = _original_command.__doc__
117
 
 
118
 
            takes_options = _original_command.takes_options + [
119
 
                Option('http', help=HELP)]
120
 
 
121
 
            def run(self, *args, **kw):
122
 
                if 'http' in kw:
123
 
                    from bzrlib.transport import get_transport
124
 
                    allow_writes = kw.get('allow_writes', False)
125
 
                    path = kw.get('directory', '.')
126
 
                    port = kw.get('port', DEFAULT_PORT)
127
 
                    # port might be an int already...
128
 
                    if isinstance(port, basestring) and ':' in port:
129
 
                        host, port = port.split(':')
130
 
                    else:
131
 
                        host = DEFAULT_HOST
132
 
                    if allow_writes:
133
 
                        transport = get_transport(path)
134
 
                    else:
135
 
                        transport = get_transport('readonly+' + path)
136
 
                    serve_http(transport, host, port)
137
 
                else:
138
 
                    super(cmd_serve, self).run(*args, **kw)
139
 
 
140
 
        commands.register_command(cmd_serve)
141
 
 
142
 
    class cmd_load_test_loggerhead(commands.Command):
143
 
        """Run a load test against a live loggerhead instance.
144
 
 
145
 
        Pass in the name of a script file to run. See loggerhead/load_test.py
146
 
        for a description of the file format.
147
 
        """
148
 
 
149
 
        takes_args = ["filename"]
150
 
 
151
 
        def run(self, filename):
152
 
            from bzrlib.plugins.loggerhead.loggerhead import load_test
153
 
            script = load_test.run_script(filename)
154
 
            for thread_id in sorted(script._threads):
155
 
                worker = script._threads[thread_id][0]
156
 
                for url, success, time in worker.stats:
157
 
                    self.outf.write(' %5.3fs %s %s\n'
158
 
                                    % (time, str(success)[0], url))
159
 
 
160
 
    commands.register_command(cmd_load_test_loggerhead)
161
 
 
162
 
    def load_tests(standard_tests, module, loader):
163
 
        _ensure_loggerhead_path()
164
 
        standard_tests.addTests(loader.loadTestsFromModuleNames(
165
 
            ['bzrlib.plugins.loggerhead.loggerhead.tests']))
166
 
        return standard_tests
 
128
        basic_tests.addTest(test_suite())
 
129
    return basic_tests