/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

https://launchpad.net/bugs/605394
Add some basic documentation in 'bzr help git'.

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
3
# Authors: Robert Collins <robert.collins@canonical.com>
4
4
#          Jelmer Vernooij <jelmer@samba.org>
26
26
 
27
27
import bzrlib
28
28
import bzrlib.api
29
 
from bzrlib import bzrdir, errors as bzr_errors
30
 
from bzrlib.foreign import foreign_vcs_registry
31
 
from bzrlib.lockable_files import TransportLock
32
 
from bzrlib.transport import register_lazy_transport
33
 
from bzrlib.commands import plugin_cmds
34
 
from bzrlib.trace import warning
35
 
 
36
 
MINIMUM_DULWICH_VERSION = (0, 1, 0)
37
 
COMPATIBLE_BZR_VERSIONS = [(1, 11, 0), (1, 12, 0)]
 
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.help_topics import (
 
54
    topic_registry,
 
55
    )
 
56
from bzrlib.lockable_files import (
 
57
    TransportLock,
 
58
    )
 
59
from bzrlib.transport import (
 
60
    register_lazy_transport,
 
61
    register_transport_proto,
 
62
    )
 
63
from bzrlib.commands import (
 
64
    plugin_cmds,
 
65
    )
 
66
from bzrlib.version_info_formats.format_rio import (
 
67
    RioVersionInfoBuilder,
 
68
    )
 
69
from bzrlib.send import (
 
70
    format_registry as send_format_registry,
 
71
    )
 
72
 
38
73
 
39
74
if getattr(sys, "frozen", None):
40
75
    # allow import additional libs from ./_lib for bzr.exe only
41
 
    sys.path.append(os.path.normpath(os.path.join(os.path.dirname(__file__), '_lib')))
 
76
    sys.path.append(os.path.normpath(
 
77
        os.path.join(os.path.dirname(__file__), '_lib')))
 
78
 
 
79
 
 
80
def import_dulwich():
 
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",
 
89
                "bzr-git: Dulwich is too old; at least %d.%d.%d is required" %
 
90
                    dulwich_minimum_version)
 
91
 
42
92
 
43
93
_versions_checked = False
44
94
def lazy_check_versions():
45
95
    global _versions_checked
46
96
    if _versions_checked:
47
97
        return
 
98
    import_dulwich()
48
99
    _versions_checked = True
49
 
    try:
50
 
        from dulwich import __version__ as dulwich_version
51
 
    except ImportError:
52
 
        raise ImportError("bzr-git: Please install dulwich, https://launchpad.net/dulwich")
53
 
    else:
54
 
        if dulwich_version < MINIMUM_DULWICH_VERSION:
55
 
            raise ImportError("bzr-git: Dulwich is too old; at least %d.%d.%d is required" % MINIMUM_DULWICH_VERSION)
56
 
 
57
 
bzrlib.api.require_any_api(bzrlib, COMPATIBLE_BZR_VERSIONS)
58
 
 
59
 
bzrdir.format_registry.register_lazy('git', 
 
100
 
 
101
bzrdir.format_registry.register_lazy('git',
60
102
    "bzrlib.plugins.git.dir", "LocalGitBzrDirFormat",
61
103
    help='GIT repository.', native=False, experimental=True,
62
104
    )
63
105
 
 
106
from bzrlib.revisionspec import revspec_registry
 
107
revspec_registry.register_lazy("git:", "bzrlib.plugins.git.revspec",
 
108
    "RevisionSpec_git")
 
109
 
64
110
try:
65
 
    from bzrlib.revisionspec import revspec_registry
66
 
    revspec_registry.register_lazy("git:", "bzrlib.plugins.git.revspec", 
67
 
        "RevisionSpec_git")
 
111
    from bzrlib.revisionspec import dwim_revspecs
68
112
except ImportError:
69
 
    lazy_check_versions()
70
 
    from bzrlib.revisionspec import SPEC_TYPES
 
113
    pass
 
114
else:
71
115
    from bzrlib.plugins.git.revspec import RevisionSpec_git
72
 
    SPEC_TYPES.append(RevisionSpec_git)
 
116
    dwim_revspecs.append(RevisionSpec_git)
 
117
 
73
118
 
74
119
class GitBzrDirFormat(bzrdir.BzrDirFormat):
 
120
 
75
121
    _lock_class = TransportLock
76
122
 
 
123
    colocated_branches = True
 
124
 
 
125
    def __eq__(self, other):
 
126
        return type(self) == type(other)
 
127
 
77
128
    def is_supported(self):
78
129
        return True
79
130
 
 
131
    def network_name(self):
 
132
        return "git"
 
133
 
80
134
 
81
135
class LocalGitBzrDirFormat(GitBzrDirFormat):
82
136
    """The .git directory control format."""
89
143
        """Open this directory.
90
144
 
91
145
        """
92
 
        import dulwich as git
93
 
        # we dont grok readonly - git isn't integrated with transport.
94
 
        url = transport.base
95
 
        if url.startswith('readonly+'):
96
 
            url = url[len('readonly+'):]
97
 
 
98
 
        try:
99
 
            gitrepo = git.repo.Repo(transport.local_abspath("."))
100
 
        except bzr_errors.NotLocalUrl:
101
 
            raise bzr_errors.NotBranchError(path=transport.base)
 
146
        lazy_check_versions()
 
147
        from bzrlib.plugins.git.transportgit import TransportRepo
 
148
        gitrepo = TransportRepo(transport)
102
149
        from bzrlib.plugins.git.dir import LocalGitDir, GitLockableFiles, GitLock
103
150
        lockfiles = GitLockableFiles(transport, GitLock())
104
151
        return LocalGitDir(transport, lockfiles, gitrepo, self)
105
152
 
106
153
    @classmethod
107
154
    def probe_transport(klass, transport):
108
 
        """Our format is present if the transport ends in '.not/'."""
109
 
        from bzrlib.transport.local import LocalTransport
110
 
 
111
 
        if not isinstance(transport, LocalTransport):
112
 
            raise bzr_errors.NotBranchError(path=transport.base)
113
 
 
114
 
        # This should quickly filter out most things that are not 
115
 
        # git repositories, saving us the trouble from loading dulwich.
116
 
        if not transport.has(".git") and not transport.has("objects"):
117
 
            raise bzr_errors.NotBranchError(path=transport.base)
118
 
 
119
 
        import dulwich as git
 
155
        try:
 
156
            if not transport.has_any(['info/refs', '.git/branches',
 
157
                                      'branches']):
 
158
                raise bzr_errors.NotBranchError(path=transport.base)
 
159
        except bzr_errors.NoSuchFile:
 
160
            raise bzr_errors.NotBranchError(path=transport.base)
 
161
        from bzrlib import urlutils
 
162
        if urlutils.split(transport.base)[1] == ".git":
 
163
            raise bzr_errors.NotBranchError(path=transport.base)
 
164
        lazy_check_versions()
 
165
        import dulwich
120
166
        format = klass()
121
167
        try:
122
168
            format.open(transport)
123
169
            return format
124
 
        except git.errors.NotGitRepository, e:
 
170
        except dulwich.errors.NotGitRepository, e:
125
171
            raise bzr_errors.NotBranchError(path=transport.base)
126
172
        raise bzr_errors.NotBranchError(path=transport.base)
127
173
 
135
181
        from bzrlib.transport.local import LocalTransport
136
182
 
137
183
        if not isinstance(transport, LocalTransport):
138
 
            raise NotImplementedError(self.initialize, 
 
184
            raise NotImplementedError(self.initialize,
139
185
                "Can't create Git Repositories/branches on "
140
186
                "non-local transports")
141
 
 
 
187
        lazy_check_versions()
142
188
        from dulwich.repo import Repo
143
 
        Repo.create(transport.local_abspath(".")) 
 
189
        Repo.init(transport.local_abspath(".").encode(osutils._fs_enc))
144
190
        return self.open(transport)
145
191
 
146
192
    def is_supported(self):
158
204
        """Open this directory.
159
205
 
160
206
        """
 
207
        # we dont grok readonly - git isn't integrated with transport.
 
208
        url = transport.base
 
209
        if url.startswith('readonly+'):
 
210
            url = url[len('readonly+'):]
 
211
        if (not url.startswith("git://") and not url.startswith("git+")):
 
212
            raise bzr_errors.NotBranchError(transport.base)
161
213
        from bzrlib.plugins.git.remote import RemoteGitDir, GitSmartTransport
162
214
        if not isinstance(transport, GitSmartTransport):
163
215
            raise bzr_errors.NotBranchError(transport.base)
164
 
        # we dont grok readonly - git isn't integrated with transport.
165
 
        url = transport.base
166
 
        if url.startswith('readonly+'):
167
 
            url = url[len('readonly+'):]
168
 
 
169
216
        from bzrlib.plugins.git.dir import GitLockableFiles, GitLock
170
217
        lockfiles = GitLockableFiles(transport, GitLock())
171
218
        return RemoteGitDir(transport, lockfiles, self)
173
220
    @classmethod
174
221
    def probe_transport(klass, transport):
175
222
        """Our format is present if the transport ends in '.not/'."""
 
223
        url = transport.base
 
224
        if url.startswith('readonly+'):
 
225
            url = url[len('readonly+'):]
 
226
        if (not url.startswith("git://") and not url.startswith("git+")):
 
227
            raise bzr_errors.NotBranchError(transport.base)
176
228
        # little ugly, but works
177
229
        format = klass()
178
230
        from bzrlib.plugins.git.remote import GitSmartTransport
179
231
        if not isinstance(transport, GitSmartTransport):
180
232
            raise bzr_errors.NotBranchError(transport.base)
181
 
        # The only way to know a path exists and contains a valid repository 
182
 
        # is to do a request against it:
183
 
        try:
184
 
            transport.fetch_pack(lambda x: [], None, lambda x: None, 
185
 
                                 lambda x: mutter("git: %s" % x))
186
 
        except errors.git_errors.GitProtocolError:
187
 
            raise bzr_errors.NotBranchError(path=transport.base)
188
 
        else:
189
 
            return format
190
 
        raise bzr_errors.NotBranchError(path=transport.base)
 
233
        return format
191
234
 
192
235
    def get_format_description(self):
193
236
        return "Remote Git Repository"
202
245
bzrdir.BzrDirFormat.register_control_format(LocalGitBzrDirFormat)
203
246
bzrdir.BzrDirFormat.register_control_format(RemoteGitBzrDirFormat)
204
247
 
 
248
register_transport_proto('git://',
 
249
        help="Access using the Git smart server protocol.")
 
250
register_transport_proto('git+ssh://',
 
251
        help="Access using the Git smart server protocol over SSH.")
 
252
 
205
253
register_lazy_transport("git://", 'bzrlib.plugins.git.remote',
206
 
                        'GitSmartTransport')
207
 
 
208
 
foreign_vcs_registry.register_lazy("git", 
209
 
                        "bzrlib.plugins.git.mapping", 
210
 
                        "foreign_git",
211
 
                        "Stupid content tracker")
212
 
 
213
 
plugin_cmds.register_lazy("cmd_git_serve", [], "bzrlib.plugins.git.commands")
 
254
                        'TCPGitSmartTransport')
 
255
register_lazy_transport("git+ssh://", 'bzrlib.plugins.git.remote',
 
256
                        'SSHGitSmartTransport')
 
257
 
 
258
foreign_vcs_registry.register_lazy("git",
 
259
    "bzrlib.plugins.git.mapping", "foreign_git", "Stupid content tracker")
 
260
 
214
261
plugin_cmds.register_lazy("cmd_git_import", [], "bzrlib.plugins.git.commands")
 
262
plugin_cmds.register_lazy("cmd_git_object", ["git-objects", "git-cat"],
 
263
    "bzrlib.plugins.git.commands")
 
264
plugin_cmds.register_lazy("cmd_git_refs", [], "bzrlib.plugins.git.commands")
 
265
plugin_cmds.register_lazy("cmd_git_apply", [], "bzrlib.plugins.git.commands")
 
266
 
 
267
def update_stanza(rev, stanza):
 
268
    mapping = getattr(rev, "mapping", None)
 
269
    if mapping is not None and mapping.revid_prefix.startswith("git-"):
 
270
        stanza.add("git-commit", rev.foreign_revid)
 
271
 
 
272
 
 
273
rio_hooks = getattr(RioVersionInfoBuilder, "hooks", None)
 
274
if rio_hooks is not None:
 
275
    rio_hooks.install_named_hook('revision', update_stanza, None)
 
276
 
 
277
 
 
278
from bzrlib.transport import transport_server_registry
 
279
transport_server_registry.register_lazy('git',
 
280
    'bzrlib.plugins.git.server',
 
281
    'serve_git',
 
282
    'Git Smart server protocol over TCP. (default port: 9418)')
 
283
 
 
284
 
 
285
from bzrlib.repository import (
 
286
    network_format_registry as repository_network_format_registry,
 
287
    )
 
288
repository_network_format_registry.register_lazy('git',
 
289
    'bzrlib.plugins.git.repository', 'GitRepositoryFormat')
 
290
 
 
291
from bzrlib.bzrdir import (
 
292
    network_format_registry as bzrdir_network_format_registry,
 
293
    )
 
294
bzrdir_network_format_registry.register('git', GitBzrDirFormat)
 
295
 
 
296
send_format_registry.register_lazy('git', 'bzrlib.plugins.git.send',
 
297
                                   'send_git', 'Git am-style diff format')
 
298
 
 
299
topic_registry.register_lazy('git',
 
300
                             'bzrlib.plugins.git.help',
 
301
                             'help_git', 'Using Bazaar with Git')
 
302
 
 
303
try:
 
304
    from bzrlib.diff import format_registry as diff_format_registry
 
305
except ImportError:
 
306
    pass
 
307
else:
 
308
    diff_format_registry.register_lazy('git', 'bzrlib.plugins.git.send',
 
309
        'GitDiffTree', 'Git am-style diff format')
215
310
 
216
311
def test_suite():
217
312
    from bzrlib.plugins.git import tests