/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to __init__.py

Add docstring.

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2009 Canonical Ltd
 
2
 
2
3
# Authors: Robert Collins <robert.collins@canonical.com>
 
4
#          Jelmer Vernooij <jelmer@samba.org>
 
5
#          John Carr <john.carr@unrouted.co.uk>
3
6
#
4
7
# This program is free software; you can redistribute it and/or modify
5
8
# it under the terms of the GNU General Public License as published by
18
21
 
19
22
"""A GIT branch and repository format implementation for bzr."""
20
23
 
 
24
import os
 
25
import sys
 
26
 
 
27
import bzrlib
 
28
import bzrlib.api
 
29
 
 
30
from info import (
 
31
    bzr_compatible_versions,
 
32
    bzr_plugin_version as version_info,
 
33
    dulwich_minimum_version,
 
34
    )
 
35
 
 
36
if version_info[3] == 'final':
 
37
    version_string = '%d.%d.%d' % version_info[:3]
 
38
else:
 
39
    version_string = '%d.%d.%d%s%d' % version_info
 
40
__version__ = version_string
 
41
 
 
42
bzrlib.api.require_any_api(bzrlib, bzr_compatible_versions)
 
43
 
 
44
 
 
45
from bzrlib import (
 
46
    bzrdir,
 
47
    errors as bzr_errors,
 
48
    osutils,
 
49
    )
 
50
from bzrlib.foreign import (
 
51
    foreign_vcs_registry,
 
52
    )
 
53
from bzrlib.lockable_files import (
 
54
    TransportLock,
 
55
    )
 
56
from bzrlib.transport import (
 
57
    register_lazy_transport,
 
58
    register_transport_proto,
 
59
    )
 
60
from bzrlib.commands import (
 
61
    plugin_cmds,
 
62
    )
 
63
from bzrlib.version_info_formats.format_rio import (
 
64
    RioVersionInfoBuilder,
 
65
    )
 
66
from bzrlib.send import (
 
67
    format_registry as send_format_registry,
 
68
    )
 
69
 
 
70
 
 
71
if getattr(sys, "frozen", None):
 
72
    # allow import additional libs from ./_lib for bzr.exe only
 
73
    sys.path.append(os.path.normpath(os.path.join(os.path.dirname(__file__), '_lib')))
 
74
 
 
75
_versions_checked = False
 
76
def lazy_check_versions():
 
77
    global _versions_checked
 
78
    if _versions_checked:
 
79
        return
 
80
    _versions_checked = True
 
81
    try:
 
82
        from dulwich import __version__ as dulwich_version
 
83
    except ImportError:
 
84
        raise bzr_errors.DependencyNotPresent("dulwich",
 
85
            "bzr-git: Please install dulwich, https://launchpad.net/dulwich")
 
86
    else:
 
87
        if dulwich_version < dulwich_minimum_version:
 
88
            raise bzr_errors.DependencyNotPresent("dulwich", "bzr-git: Dulwich is too old; at least %d.%d.%d is required" % dulwich_minimum_version)
 
89
 
 
90
bzrdir.format_registry.register_lazy('git',
 
91
    "bzrlib.plugins.git.dir", "LocalGitBzrDirFormat",
 
92
    help='GIT repository.', native=False, experimental=True,
 
93
    )
 
94
 
 
95
from bzrlib.revisionspec import revspec_registry
 
96
revspec_registry.register_lazy("git:", "bzrlib.plugins.git.revspec",
 
97
    "RevisionSpec_git")
 
98
 
21
99
try:
22
 
    import dulwich as git
 
100
    from bzrlib.revisionspec import dwim_revspecs
23
101
except ImportError:
24
 
    import os, sys
25
 
    sys.path.insert(0, os.path.join(os.path.dirname(__file__), "dulwich"))
26
 
    import dulwich as git
27
 
from bzrlib import bzrdir
28
 
from bzrlib.foreign import ForeignVcs, VcsMappingRegistry, foreign_vcs_registry
29
 
from bzrlib.plugins.git.dir import LocalGitBzrDirFormat, RemoteGitBzrDirFormat
30
 
from bzrlib.transport import register_lazy_transport
31
 
from bzrlib.commands import Command, register_command
32
 
from bzrlib.option import Option
33
 
 
34
 
bzrdir.format_registry.register(
35
 
    'git', LocalGitBzrDirFormat,
36
 
    help='GIT repository.', 
37
 
    native=False, experimental=True,
38
 
    )
 
102
    pass
 
103
else:
 
104
    from bzrlib.plugins.git.revspec import RevisionSpec_git
 
105
    dwim_revspecs.append(RevisionSpec_git)
 
106
 
 
107
 
 
108
class GitBzrDirFormat(bzrdir.BzrDirFormat):
 
109
 
 
110
    _lock_class = TransportLock
 
111
 
 
112
    def is_supported(self):
 
113
        return True
 
114
 
 
115
    def network_name(self):
 
116
        return "git"
 
117
 
 
118
 
 
119
class LocalGitBzrDirFormat(GitBzrDirFormat):
 
120
    """The .git directory control format."""
 
121
 
 
122
    @classmethod
 
123
    def _known_formats(self):
 
124
        return set([LocalGitBzrDirFormat()])
 
125
 
 
126
    def open(self, transport, _found=None):
 
127
        """Open this directory.
 
128
 
 
129
        """
 
130
        lazy_check_versions()
 
131
        # we dont grok readonly - git isn't integrated with transport.
 
132
        from bzrlib.transport.local import LocalTransport
 
133
        if isinstance(transport, LocalTransport):
 
134
            import dulwich
 
135
            gitrepo = dulwich.repo.Repo(transport.local_abspath(".").encode(osutils._fs_enc))
 
136
        else:
 
137
            from bzrlib.plugins.git.transportgit import TransportRepo
 
138
            gitrepo = TransportRepo(transport)
 
139
        from bzrlib.plugins.git.dir import LocalGitDir, GitLockableFiles, GitLock
 
140
        lockfiles = GitLockableFiles(transport, GitLock())
 
141
        return LocalGitDir(transport, lockfiles, gitrepo, self)
 
142
 
 
143
    @classmethod
 
144
    def probe_transport(klass, transport):
 
145
        try:
 
146
            if not (transport.has('info/refs') or transport.has('.git/branches') or 
 
147
                    transport.has('branches')):
 
148
                raise bzr_errors.NotBranchError(path=transport.base)
 
149
        except bzr_errors.NoSuchFile:
 
150
            raise bzr_errors.NotBranchError(path=transport.base)
 
151
        from bzrlib import urlutils
 
152
        if urlutils.split(transport.base)[1] == ".git":
 
153
            raise bzr_errors.NotBranchError(path=transport.base)
 
154
        lazy_check_versions()
 
155
        import dulwich
 
156
        format = klass()
 
157
        try:
 
158
            format.open(transport)
 
159
            return format
 
160
        except dulwich.errors.NotGitRepository, e:
 
161
            raise bzr_errors.NotBranchError(path=transport.base)
 
162
        raise bzr_errors.NotBranchError(path=transport.base)
 
163
 
 
164
    def get_format_description(self):
 
165
        return "Local Git Repository"
 
166
 
 
167
    def get_format_string(self):
 
168
        return "Local Git Repository"
 
169
 
 
170
    def initialize_on_transport(self, transport):
 
171
        from bzrlib.transport.local import LocalTransport
 
172
 
 
173
        if not isinstance(transport, LocalTransport):
 
174
            raise NotImplementedError(self.initialize,
 
175
                "Can't create Git Repositories/branches on "
 
176
                "non-local transports")
 
177
        lazy_check_versions()
 
178
        from dulwich.repo import Repo
 
179
        Repo.create(transport.local_abspath(".").encode(osutils._fs_enc))
 
180
        return self.open(transport)
 
181
 
 
182
    def is_supported(self):
 
183
        return True
 
184
 
 
185
 
 
186
class RemoteGitBzrDirFormat(GitBzrDirFormat):
 
187
    """The .git directory control format."""
 
188
 
 
189
    @classmethod
 
190
    def _known_formats(self):
 
191
        return set([RemoteGitBzrDirFormat()])
 
192
 
 
193
    def open(self, transport, _found=None):
 
194
        """Open this directory.
 
195
 
 
196
        """
 
197
        # we dont grok readonly - git isn't integrated with transport.
 
198
        url = transport.base
 
199
        if url.startswith('readonly+'):
 
200
            url = url[len('readonly+'):]
 
201
        if (not url.startswith("git://") and not url.startswith("git+")):
 
202
            raise bzr_errors.NotBranchError(transport.base)
 
203
        from bzrlib.plugins.git.remote import RemoteGitDir, GitSmartTransport
 
204
        if not isinstance(transport, GitSmartTransport):
 
205
            raise bzr_errors.NotBranchError(transport.base)
 
206
        from bzrlib.plugins.git.dir import GitLockableFiles, GitLock
 
207
        lockfiles = GitLockableFiles(transport, GitLock())
 
208
        return RemoteGitDir(transport, lockfiles, self)
 
209
 
 
210
    @classmethod
 
211
    def probe_transport(klass, transport):
 
212
        """Our format is present if the transport ends in '.not/'."""
 
213
        url = transport.base
 
214
        if url.startswith('readonly+'):
 
215
            url = url[len('readonly+'):]
 
216
        if (not url.startswith("git://") and not url.startswith("git+")):
 
217
            raise bzr_errors.NotBranchError(transport.base)
 
218
        # little ugly, but works
 
219
        format = klass()
 
220
        from bzrlib.plugins.git.remote import GitSmartTransport
 
221
        if not isinstance(transport, GitSmartTransport):
 
222
            raise bzr_errors.NotBranchError(transport.base)
 
223
        return format
 
224
 
 
225
    def get_format_description(self):
 
226
        return "Remote Git Repository"
 
227
 
 
228
    def get_format_string(self):
 
229
        return "Remote Git Repository"
 
230
 
 
231
    def initialize_on_transport(self, transport):
 
232
        raise bzr_errors.UninitializableFormat(self)
 
233
 
39
234
 
40
235
bzrdir.BzrDirFormat.register_control_format(LocalGitBzrDirFormat)
41
236
bzrdir.BzrDirFormat.register_control_format(RemoteGitBzrDirFormat)
42
237
 
 
238
register_transport_proto('git://',
 
239
        help="Access using the Git smart server protocol.")
 
240
register_transport_proto('git+ssh://',
 
241
        help="Access using the Git smart server protocol over SSH.")
 
242
 
43
243
register_lazy_transport("git://", 'bzrlib.plugins.git.remote',
44
 
                        'GitSmartTransport')
45
 
 
46
 
 
47
 
class ForeignGit(ForeignVcs):
48
 
    """Foreign Git."""
49
 
 
50
 
 
51
 
git_mapping_registry = VcsMappingRegistry()
52
 
git_mapping_registry.register_lazy('git-experimental', "bzrlib.plugins.git.mapping",
53
 
                                   "BzrGitMappingExperimental")
54
 
foreign_vcs_registry.register("git", ForeignGit(git_mapping_registry), 
55
 
                                      "Stupid content tracker")
56
 
 
57
 
 
58
 
class cmd_git_serve(Command):
59
 
    """Provide access to a Bazaar branch using the git protocol.
60
 
 
61
 
    This command is experimental and doesn't do much yet.
62
 
    """
63
 
    takes_options = [
64
 
        Option('inet',
65
 
               help='serve on stdin/out for use from inetd or sshd'),
66
 
        Option('directory',
67
 
               help='serve contents of directory',
68
 
               type=unicode)
69
 
    ]
70
 
 
71
 
    def run(self, inet=None, port=None, directory=None):
72
 
        from dulwich.server import TCPGitServer
73
 
        from bzrlib.plugins.git.server import BzrBackend
74
 
        from bzrlib.trace import warning
75
 
        import os
76
 
 
77
 
        warning("server support in bzr-git is experimental.")
78
 
 
79
 
        if directory is None:
80
 
            directory = os.getcwd()
81
 
 
82
 
        backend = BzrBackend(directory)
83
 
 
84
 
        if inet:
85
 
            #def send_fn(data):
86
 
            #    sys.stdout.write(data)
87
 
            #    sys.stdout.flush()
88
 
            #server = GitServer(sys.stdin.read, send_fn)
89
 
            raise NotImplementedError
90
 
        else:
91
 
            server = TCPGitServer(backend, 'localhost')
92
 
            server.serve_forever()
93
 
 
94
 
register_command(cmd_git_serve)
95
 
 
 
244
                        'TCPGitSmartTransport')
 
245
register_lazy_transport("git+ssh://", 'bzrlib.plugins.git.remote',
 
246
                        'SSHGitSmartTransport')
 
247
 
 
248
foreign_vcs_registry.register_lazy("git",
 
249
    "bzrlib.plugins.git.mapping", "foreign_git", "Stupid content tracker")
 
250
 
 
251
plugin_cmds.register_lazy("cmd_git_import", [], "bzrlib.plugins.git.commands")
 
252
plugin_cmds.register_lazy("cmd_git_object", ["git-objects", "git-cat"],
 
253
    "bzrlib.plugins.git.commands")
 
254
 
 
255
def update_stanza(rev, stanza):
 
256
    mapping = getattr(rev, "mapping", None)
 
257
    if mapping is not None and mapping.revid_prefix.startswith("git-"):
 
258
        stanza.add("git-commit", rev.foreign_revid)
 
259
 
 
260
 
 
261
rio_hooks = getattr(RioVersionInfoBuilder, "hooks", None)
 
262
if rio_hooks is not None:
 
263
    rio_hooks.install_named_hook('revision', update_stanza, None)
 
264
 
 
265
 
 
266
from bzrlib.transport import transport_server_registry
 
267
transport_server_registry.register_lazy('git',
 
268
    'bzrlib.plugins.git.server',
 
269
    'serve_git',
 
270
    'Git Smart server protocol over TCP. (default port: 9418)')
 
271
 
 
272
 
 
273
from bzrlib.repository import network_format_registry as repository_network_format_registry
 
274
repository_network_format_registry.register_lazy('git',
 
275
    'bzrlib.plugins.git.repository', 'GitRepositoryFormat')
 
276
 
 
277
from bzrlib.bzrdir import network_format_registry as bzrdir_network_format_registry
 
278
bzrdir_network_format_registry.register('git', GitBzrDirFormat)
 
279
 
 
280
 
 
281
def get_rich_root_format(stacked=False):
 
282
    if stacked:
 
283
        return bzrdir.format_registry.make_bzrdir("1.9-rich-root")
 
284
    else:
 
285
        return bzrdir.format_registry.make_bzrdir("default-rich-root")
 
286
 
 
287
send_format_registry.register_lazy('git', 'bzrlib.plugins.git.send',
 
288
                                   'send_git', 'Git am-style diff format')
96
289
 
97
290
def test_suite():
98
291
    from bzrlib.plugins.git import tests