← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Martin Pool
  • Date: 2010-01-29 10:36:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129103623-hywka5hymo5z13jw
Change url to canonical.com or wiki, plus some doc improvements in passing

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/info.py
1
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
# 
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
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, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
__all__ = ['show_bzrdir_info']
18
18
 
 
19
from cStringIO import StringIO
 
20
import os
19
21
import time
20
 
 
 
22
import sys
21
23
 
22
24
from bzrlib import (
 
25
    bzrdir,
23
26
    diff,
 
27
    errors,
 
28
    hooks as _mod_hooks,
24
29
    osutils,
25
30
    urlutils,
26
31
    )
27
32
from bzrlib.errors import (NoWorkingTree, NotBranchError,
28
33
                           NoRepositoryPresent, NotLocalUrl)
29
34
from bzrlib.missing import find_unmerged
30
 
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        zero_eight)
32
35
 
33
36
 
34
37
def plural(n, base='', pl=None):
40
43
        return 's'
41
44
 
42
45
 
43
 
def _repo_rel_url(repo_url, inner_url):
44
 
    """Return path with common prefix of repository path removed.
45
 
 
46
 
    If path is not part of the repository, the original path is returned.
47
 
    If path is equal to the repository, the current directory marker '.' is
48
 
    returned.
49
 
    Otherwise, a relative path is returned, with trailing '/' stripped.
50
 
    """
51
 
    inner_url = urlutils.normalize_url(inner_url)
52
 
    repo_url = urlutils.normalize_url(repo_url)
53
 
    if inner_url == repo_url:
54
 
        return '.'
55
 
    result = urlutils.relative_url(repo_url, inner_url)
56
 
    if result != inner_url:
57
 
        result = result.rstrip('/')
58
 
    return result
59
 
 
60
 
 
61
 
def _show_location_info(repository, branch=None, working=None):
62
 
    """Show known locations for working, branch and repository."""
 
46
class LocationList(object):
 
47
 
 
48
    def __init__(self, base_path):
 
49
        self.locs = []
 
50
        self.base_path = base_path
 
51
 
 
52
    def add_url(self, label, url):
 
53
        """Add a URL to the list, converting it to a path if possible"""
 
54
        if url is None:
 
55
            return
 
56
        try:
 
57
            path = urlutils.local_path_from_url(url)
 
58
        except errors.InvalidURL:
 
59
            self.locs.append((label, url))
 
60
        else:
 
61
            self.add_path(label, path)
 
62
 
 
63
    def add_path(self, label, path):
 
64
        """Add a path, converting it to a relative path if possible"""
 
65
        try:
 
66
            path = osutils.relpath(self.base_path, path)
 
67
        except errors.PathNotChild:
 
68
            pass
 
69
        else:
 
70
            if path == '':
 
71
                path = '.'
 
72
        if path != '/':
 
73
            path = path.rstrip('/')
 
74
        self.locs.append((label, path))
 
75
 
 
76
    def get_lines(self):
 
77
        max_len = max(len(l) for l, u in self.locs)
 
78
        return ["  %*s: %s\n" % (max_len, l, u) for l, u in self.locs ]
 
79
 
 
80
 
 
81
def gather_location_info(repository, branch=None, working=None):
 
82
    locs = {}
63
83
    repository_path = repository.bzrdir.root_transport.base
64
 
    print 'Location:'
65
 
    if working and branch:
 
84
    if branch is not None:
 
85
        branch_path = branch.bzrdir.root_transport.base
 
86
        master_path = branch.get_bound_location()
 
87
        if master_path is None:
 
88
            master_path = branch_path
 
89
    else:
 
90
        branch_path = None
 
91
        master_path = None
 
92
    if working:
66
93
        working_path = working.bzrdir.root_transport.base
67
 
        branch_path = branch.bzrdir.root_transport.base
68
94
        if working_path != branch_path:
69
 
            # lightweight checkout
70
 
            print ' light checkout root: %s' % working_path
 
95
            locs['light checkout root'] = working_path
 
96
        if master_path != branch_path:
71
97
            if repository.is_shared():
72
 
                # lightweight checkout of branch in shared repository
73
 
                print '   shared repository: %s' % repository_path
74
 
                print '   repository branch: %s' % (
75
 
                    _repo_rel_url(repository_path, branch_path))
 
98
                locs['repository checkout root'] = branch_path
76
99
            else:
77
 
                # lightweight checkout of standalone branch
78
 
                print '  checkout of branch: %s' % branch_path
 
100
                locs['checkout root'] = branch_path
 
101
        if working_path != master_path:
 
102
            locs['checkout of branch'] = master_path
79
103
        elif repository.is_shared():
80
 
            # branch with tree inside shared repository
81
 
            print '    shared repository: %s' % repository_path
82
 
            print '  repository checkout: %s' % (
83
 
                _repo_rel_url(repository_path, branch_path))
84
 
        elif branch.get_bound_location():
85
 
            # normal checkout
86
 
            print '       checkout root: %s' % working_path
87
 
            print '  checkout of branch: %s' % branch.get_bound_location()
88
 
        else:
 
104
            locs['repository branch'] = branch_path
 
105
        elif branch_path is not None:
89
106
            # standalone
90
 
            print '  branch root: %s' % working_path
91
 
    elif branch:
92
 
        branch_path = branch.bzrdir.root_transport.base
 
107
            locs['branch root'] = branch_path
 
108
    else:
 
109
        working_path = None
93
110
        if repository.is_shared():
94
 
            # branch is part of shared repository
95
 
            print '  shared repository: %s' % repository_path
96
 
            print '  repository branch: %s' % (
97
 
                _repo_rel_url(repository_path, branch_path))
 
111
            # lightweight checkout of branch in shared repository
 
112
            if branch_path is not None:
 
113
                locs['repository branch'] = branch_path
 
114
        elif branch_path is not None:
 
115
            # standalone
 
116
            locs['branch root'] = branch_path
 
117
            if master_path != branch_path:
 
118
                locs['bound to branch'] = master_path
98
119
        else:
99
 
            # standalone branch
100
 
            print '  branch root: %s' % branch_path
101
 
    else:
102
 
        # shared repository
103
 
        assert repository.is_shared()
104
 
        print '  shared repository: %s' % repository_path
105
 
 
106
 
 
107
 
def _show_related_info(branch):
 
120
            locs['repository'] = repository_path
 
121
    if repository.is_shared():
 
122
        # lightweight checkout of branch in shared repository
 
123
        locs['shared repository'] = repository_path
 
124
    order = ['light checkout root', 'repository checkout root',
 
125
             'checkout root', 'checkout of branch', 'shared repository',
 
126
             'repository', 'repository branch', 'branch root',
 
127
             'bound to branch']
 
128
    return [(n, locs[n]) for n in order if n in locs]
 
129
 
 
130
 
 
131
def _show_location_info(locs, outfile):
 
132
    """Show known locations for working, branch and repository."""
 
133
    outfile.write('Location:\n')
 
134
    path_list = LocationList(osutils.getcwd())
 
135
    for name, loc in locs:
 
136
        path_list.add_url(name, loc)
 
137
    outfile.writelines(path_list.get_lines())
 
138
 
 
139
 
 
140
def _gather_related_branches(branch):
 
141
    locs = LocationList(osutils.getcwd())
 
142
    locs.add_url('public branch', branch.get_public_branch())
 
143
    locs.add_url('push branch', branch.get_push_location())
 
144
    locs.add_url('parent branch', branch.get_parent())
 
145
    locs.add_url('submit branch', branch.get_submit_branch())
 
146
    try:
 
147
        locs.add_url('stacked on', branch.get_stacked_on_url())
 
148
    except (errors.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
 
149
        errors.NotStacked):
 
150
        pass
 
151
    return locs
 
152
 
 
153
 
 
154
def _show_related_info(branch, outfile):
108
155
    """Show parent and push location of branch."""
109
 
    if branch.get_parent() or branch.get_push_location():
110
 
        print
111
 
        print 'Related branches:'
112
 
        if branch.get_parent():
113
 
            if branch.get_push_location():
114
 
                print '      parent branch: %s' % branch.get_parent()
115
 
            else:
116
 
                print '  parent branch: %s' % branch.get_parent()
117
 
        if branch.get_push_location():
118
 
            print '  publish to branch: %s' % branch.get_push_location()
119
 
 
120
 
 
121
 
def _show_format_info(control=None, repository=None, branch=None, working=None):
 
156
    locs = _gather_related_branches(branch)
 
157
    if len(locs.locs) > 0:
 
158
        outfile.write('\n')
 
159
        outfile.write('Related branches:\n')
 
160
        outfile.writelines(locs.get_lines())
 
161
 
 
162
 
 
163
def _show_format_info(control=None, repository=None, branch=None,
 
164
                      working=None, outfile=None):
122
165
    """Show known formats for control, working, branch and repository."""
123
 
    print
124
 
    print 'Format:'
 
166
    outfile.write('\n')
 
167
    outfile.write('Format:\n')
125
168
    if control:
126
 
        print '       control: %s' % control._format.get_format_description()
 
169
        outfile.write('       control: %s\n' %
 
170
            control._format.get_format_description())
127
171
    if working:
128
 
        print '  working tree: %s' % working._format.get_format_description()
 
172
        outfile.write('  working tree: %s\n' %
 
173
            working._format.get_format_description())
129
174
    if branch:
130
 
        print '        branch: %s' % branch._format.get_format_description()
 
175
        outfile.write('        branch: %s\n' %
 
176
            branch._format.get_format_description())
131
177
    if repository:
132
 
        print '    repository: %s' % repository._format.get_format_description()
133
 
 
134
 
 
135
 
def _show_locking_info(repository, branch=None, working=None):
 
178
        outfile.write('    repository: %s\n' %
 
179
            repository._format.get_format_description())
 
180
 
 
181
 
 
182
def _show_locking_info(repository, branch=None, working=None, outfile=None):
136
183
    """Show locking status of working, branch and repository."""
137
184
    if (repository.get_physical_lock_status() or
138
185
        (branch and branch.get_physical_lock_status()) or
139
186
        (working and working.get_physical_lock_status())):
140
 
        print
141
 
        print 'Lock status:'
 
187
        outfile.write('\n')
 
188
        outfile.write('Lock status:\n')
142
189
        if working:
143
190
            if working.get_physical_lock_status():
144
191
                status = 'locked'
145
192
            else:
146
193
                status = 'unlocked'
147
 
            print '  working tree: %s' % status
 
194
            outfile.write('  working tree: %s\n' % status)
148
195
        if branch:
149
196
            if branch.get_physical_lock_status():
150
197
                status = 'locked'
151
198
            else:
152
199
                status = 'unlocked'
153
 
            print '        branch: %s' % status
 
200
            outfile.write('        branch: %s\n' % status)
154
201
        if repository:
155
202
            if repository.get_physical_lock_status():
156
203
                status = 'locked'
157
204
            else:
158
205
                status = 'unlocked'
159
 
            print '    repository: %s' % status
160
 
 
161
 
 
162
 
def _show_missing_revisions_branch(branch):
 
206
            outfile.write('    repository: %s\n' % status)
 
207
 
 
208
 
 
209
def _show_missing_revisions_branch(branch, outfile):
163
210
    """Show missing master revisions in branch."""
164
211
    # Try with inaccessible branch ?
165
212
    master = branch.get_master_branch()
166
213
    if master:
167
214
        local_extra, remote_extra = find_unmerged(branch, master)
168
215
        if remote_extra:
169
 
            print
170
 
            print 'Branch is out of date: missing %d revision%s.' % (
171
 
                len(remote_extra), plural(len(remote_extra)))
172
 
 
173
 
 
174
 
def _show_missing_revisions_working(working):
 
216
            outfile.write('\n')
 
217
            outfile.write(('Branch is out of date: missing %d '
 
218
                'revision%s.\n') % (len(remote_extra),
 
219
                plural(len(remote_extra))))
 
220
 
 
221
 
 
222
def _show_missing_revisions_working(working, outfile):
175
223
    """Show missing revisions in working tree."""
176
224
    branch = working.branch
177
225
    basis = working.basis_tree()
185
233
    if branch_revno and tree_last_id != branch_last_revision:
186
234
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
187
235
        missing_count = branch_revno - tree_last_revno
188
 
        print
189
 
        print 'Working tree is out of date: missing %d revision%s.' % (
190
 
            missing_count, plural(missing_count))
191
 
 
192
 
 
193
 
def _show_working_stats(working):
 
236
        outfile.write('\n')
 
237
        outfile.write(('Working tree is out of date: missing %d '
 
238
            'revision%s.\n') % (missing_count, plural(missing_count)))
 
239
 
 
240
 
 
241
def _show_working_stats(working, outfile):
194
242
    """Show statistics about a working tree."""
195
243
    basis = working.basis_tree()
196
244
    work_inv = working.inventory
197
245
    delta = working.changes_from(basis, want_unchanged=True)
198
246
 
199
 
    print
200
 
    print 'In the working tree:'
201
 
    print '  %8s unchanged' % len(delta.unchanged)
202
 
    print '  %8d modified' % len(delta.modified)
203
 
    print '  %8d added' % len(delta.added)
204
 
    print '  %8d removed' % len(delta.removed)
205
 
    print '  %8d renamed' % len(delta.renamed)
 
247
    outfile.write('\n')
 
248
    outfile.write('In the working tree:\n')
 
249
    outfile.write('  %8s unchanged\n' % len(delta.unchanged))
 
250
    outfile.write('  %8d modified\n' % len(delta.modified))
 
251
    outfile.write('  %8d added\n' % len(delta.added))
 
252
    outfile.write('  %8d removed\n' % len(delta.removed))
 
253
    outfile.write('  %8d renamed\n' % len(delta.renamed))
206
254
 
207
255
    ignore_cnt = unknown_cnt = 0
208
256
    for path in working.extras():
210
258
            ignore_cnt += 1
211
259
        else:
212
260
            unknown_cnt += 1
213
 
    print '  %8d unknown' % unknown_cnt
214
 
    print '  %8d ignored' % ignore_cnt
 
261
    outfile.write('  %8d unknown\n' % unknown_cnt)
 
262
    outfile.write('  %8d ignored\n' % ignore_cnt)
215
263
 
216
264
    dir_cnt = 0
217
265
    for file_id in work_inv:
218
 
        if (work_inv.get_file_kind(file_id) == 'directory' and 
 
266
        if (work_inv.get_file_kind(file_id) == 'directory' and
219
267
            not work_inv.is_root(file_id)):
220
268
            dir_cnt += 1
221
 
    print '  %8d versioned %s' \
222
 
          % (dir_cnt,
223
 
             plural(dir_cnt, 'subdirectory', 'subdirectories'))
224
 
 
225
 
 
226
 
def _show_branch_stats(branch, verbose):
 
269
    outfile.write('  %8d versioned %s\n' % (dir_cnt,
 
270
        plural(dir_cnt, 'subdirectory', 'subdirectories')))
 
271
 
 
272
 
 
273
def _show_branch_stats(branch, verbose, outfile):
227
274
    """Show statistics about a branch."""
228
275
    revno, head = branch.last_revision_info()
229
 
    print
230
 
    print 'Branch history:'
231
 
    print '  %8d revision%s' % (revno, plural(revno))
 
276
    outfile.write('\n')
 
277
    outfile.write('Branch history:\n')
 
278
    outfile.write('  %8d revision%s\n' % (revno, plural(revno)))
232
279
    stats = branch.repository.gather_stats(head, committers=verbose)
233
280
    if verbose:
234
281
        committers = stats['committers']
235
 
        print '  %8d committer%s' % (committers, plural(committers))
 
282
        outfile.write('  %8d committer%s\n' % (committers,
 
283
            plural(committers)))
236
284
    if revno:
237
285
        timestamp, timezone = stats['firstrev']
238
286
        age = int((time.time() - timestamp) / 3600 / 24)
239
 
        print '  %8d day%s old' % (age, plural(age))
240
 
        print '   first revision: %s' % osutils.format_date(timestamp,
241
 
            timezone)
 
287
        outfile.write('  %8d day%s old\n' % (age, plural(age)))
 
288
        outfile.write('   first revision: %s\n' %
 
289
            osutils.format_date(timestamp, timezone))
242
290
        timestamp, timezone = stats['latestrev']
243
 
        print '  latest revision: %s' % osutils.format_date(timestamp,
244
 
            timezone)
 
291
        outfile.write('  latest revision: %s\n' %
 
292
            osutils.format_date(timestamp, timezone))
245
293
    return stats
246
294
 
247
295
 
248
 
def _show_repository_info(repository):
 
296
def _show_repository_info(repository, outfile):
249
297
    """Show settings of a repository."""
250
298
    if repository.make_working_trees():
251
 
        print
252
 
        print 'Create working tree for new branches inside the repository.'
253
 
 
254
 
 
255
 
def _show_repository_stats(stats):
 
299
        outfile.write('\n')
 
300
        outfile.write('Create working tree for new branches inside '
 
301
            'the repository.\n')
 
302
 
 
303
 
 
304
def _show_repository_stats(repository, stats, outfile):
256
305
    """Show statistics about a repository."""
257
 
    if 'revisions' in stats or 'size' in stats:
258
 
        print
259
 
        print 'Repository:'
 
306
    f = StringIO()
260
307
    if 'revisions' in stats:
261
308
        revisions = stats['revisions']
262
 
        print '  %8d revision%s' % (revisions, plural(revisions))
 
309
        f.write('  %8d revision%s\n' % (revisions, plural(revisions)))
263
310
    if 'size' in stats:
264
 
        print '  %8d KiB' % (stats['size']/1024)
265
 
 
266
 
 
267
 
@deprecated_function(zero_eight)
268
 
def show_info(b):
269
 
    """Please see show_bzrdir_info."""
270
 
    return show_bzrdir_info(b.bzrdir)
271
 
 
272
 
 
273
 
def show_bzrdir_info(a_bzrdir, verbose=False):
 
311
        f.write('  %8d KiB\n' % (stats['size']/1024))
 
312
    for hook in hooks['repository']:
 
313
        hook(repository, stats, f)
 
314
    if f.getvalue() != "":
 
315
        outfile.write('\n')
 
316
        outfile.write('Repository:\n')
 
317
        outfile.write(f.getvalue())
 
318
 
 
319
 
 
320
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
274
321
    """Output to stdout the 'info' for a_bzrdir."""
 
322
    if outfile is None:
 
323
        outfile = sys.stdout
275
324
    try:
276
 
        working = a_bzrdir.open_workingtree(
 
325
        tree = a_bzrdir.open_workingtree(
277
326
            recommend_upgrade=False)
278
 
        working.lock_read()
279
 
        try:
280
 
            show_tree_info(working, verbose)
281
 
        finally:
282
 
            working.unlock()
283
 
        return
284
327
    except (NoWorkingTree, NotLocalUrl):
285
 
        pass
286
 
 
287
 
    try:
288
 
        branch = a_bzrdir.open_branch()
289
 
        branch.lock_read()
290
 
        try:
291
 
            show_branch_info(branch, verbose)
292
 
        finally:
293
 
            branch.unlock()
294
 
        return
295
 
    except NotBranchError:
296
 
        pass
297
 
 
298
 
    try:
299
 
        repository = a_bzrdir.open_repository()
300
 
        repository.lock_read()
301
 
        try:
302
 
            show_repository_info(repository, verbose)
303
 
        finally:
304
 
            repository.unlock()
305
 
        return
306
 
    except NoRepositoryPresent:
307
 
        pass
308
 
 
309
 
    # Return silently, cmd_info already returned NotBranchError if no bzrdir
310
 
    # could be opened.
311
 
 
312
 
 
313
 
def show_tree_info(working, verbose):
314
 
    """Output to stdout the 'info' for working."""
315
 
    branch = working.branch
316
 
    repository = branch.repository
317
 
    control = working.bzrdir
318
 
 
319
 
    _show_location_info(repository, branch, working)
320
 
    _show_related_info(branch)
321
 
    _show_format_info(control, repository, branch, working)
322
 
    _show_locking_info(repository, branch, working)
323
 
    _show_missing_revisions_branch(branch)
324
 
    _show_missing_revisions_working(working)
325
 
    _show_working_stats(working)
326
 
    stats = _show_branch_stats(branch, verbose)
327
 
    _show_repository_stats(stats)
328
 
 
329
 
 
330
 
def show_branch_info(branch, verbose):
331
 
    """Output to stdout the 'info' for branch."""
332
 
    repository = branch.repository
333
 
    control = branch.bzrdir
334
 
 
335
 
    _show_location_info(repository, branch)
336
 
    _show_related_info(branch)
337
 
    _show_format_info(control, repository, branch)
338
 
    _show_locking_info(repository, branch)
339
 
    _show_missing_revisions_branch(branch)
340
 
    stats = _show_branch_stats(branch, verbose)
341
 
    _show_repository_stats(stats)
342
 
 
343
 
 
344
 
def show_repository_info(repository, verbose):
345
 
    """Output to stdout the 'info' for repository."""
346
 
    control = repository.bzrdir
347
 
 
348
 
    _show_location_info(repository)
349
 
    _show_format_info(control, repository)
350
 
    _show_locking_info(repository)
351
 
    _show_repository_info(repository)
352
 
    stats = repository.gather_stats()
353
 
    _show_repository_stats(stats)
 
328
        tree = None
 
329
        try:
 
330
            branch = a_bzrdir.open_branch()
 
331
        except NotBranchError:
 
332
            branch = None
 
333
            try:
 
334
                repository = a_bzrdir.open_repository()
 
335
            except NoRepositoryPresent:
 
336
                # Return silently; cmd_info already returned NotBranchError
 
337
                # if no bzrdir could be opened.
 
338
                return
 
339
            else:
 
340
                lockable = repository
 
341
        else:
 
342
            repository = branch.repository
 
343
            lockable = branch
 
344
    else:
 
345
        branch = tree.branch
 
346
        repository = branch.repository
 
347
        lockable = tree
 
348
 
 
349
    lockable.lock_read()
 
350
    try:
 
351
        show_component_info(a_bzrdir, repository, branch, tree, verbose,
 
352
                            outfile)
 
353
    finally:
 
354
        lockable.unlock()
 
355
 
 
356
 
 
357
def show_component_info(control, repository, branch=None, working=None,
 
358
    verbose=1, outfile=None):
 
359
    """Write info about all bzrdir components to stdout"""
 
360
    if outfile is None:
 
361
        outfile = sys.stdout
 
362
    if verbose is False:
 
363
        verbose = 1
 
364
    if verbose is True:
 
365
        verbose = 2
 
366
    layout = describe_layout(repository, branch, working)
 
367
    format = describe_format(control, repository, branch, working)
 
368
    outfile.write("%s (format: %s)\n" % (layout, format))
 
369
    _show_location_info(gather_location_info(repository, branch, working),
 
370
                        outfile)
 
371
    if branch is not None:
 
372
        _show_related_info(branch, outfile)
 
373
    if verbose == 0:
 
374
        return
 
375
    _show_format_info(control, repository, branch, working, outfile)
 
376
    _show_locking_info(repository, branch, working, outfile)
 
377
    if branch is not None:
 
378
        _show_missing_revisions_branch(branch, outfile)
 
379
    if working is not None:
 
380
        _show_missing_revisions_working(working, outfile)
 
381
        _show_working_stats(working, outfile)
 
382
    elif branch is not None:
 
383
        _show_missing_revisions_branch(branch, outfile)
 
384
    if branch is not None:
 
385
        show_committers = verbose >= 2
 
386
        stats = _show_branch_stats(branch, show_committers, outfile)
 
387
    else:
 
388
        stats = repository.gather_stats()
 
389
    if branch is None and working is None:
 
390
        _show_repository_info(repository, outfile)
 
391
    _show_repository_stats(repository, stats, outfile)
 
392
 
 
393
 
 
394
def describe_layout(repository=None, branch=None, tree=None):
 
395
    """Convert a control directory layout into a user-understandable term
 
396
 
 
397
    Common outputs include "Standalone tree", "Repository branch" and
 
398
    "Checkout".  Uncommon outputs include "Unshared repository with trees"
 
399
    and "Empty control directory"
 
400
    """
 
401
    if repository is None:
 
402
        return 'Empty control directory'
 
403
    if branch is None and tree is None:
 
404
        if repository.is_shared():
 
405
            phrase = 'Shared repository'
 
406
        else:
 
407
            phrase = 'Unshared repository'
 
408
        if repository.make_working_trees():
 
409
            phrase += ' with trees'
 
410
        return phrase
 
411
    else:
 
412
        if repository.is_shared():
 
413
            independence = "Repository "
 
414
        else:
 
415
            independence = "Standalone "
 
416
        if tree is not None:
 
417
            phrase = "tree"
 
418
        else:
 
419
            phrase = "branch"
 
420
        if branch is None and tree is not None:
 
421
            phrase = "branchless tree"
 
422
        else:
 
423
            if (tree is not None and tree.bzrdir.root_transport.base !=
 
424
                branch.bzrdir.root_transport.base):
 
425
                independence = ''
 
426
                phrase = "Lightweight checkout"
 
427
            elif branch.get_bound_location() is not None:
 
428
                if independence == 'Standalone ':
 
429
                    independence = ''
 
430
                if tree is None:
 
431
                    phrase = "Bound branch"
 
432
                else:
 
433
                    phrase = "Checkout"
 
434
        if independence != "":
 
435
            phrase = phrase.lower()
 
436
        return "%s%s" % (independence, phrase)
 
437
 
 
438
 
 
439
def describe_format(control, repository, branch, tree):
 
440
    """Determine the format of an existing control directory
 
441
 
 
442
    Several candidates may be found.  If so, the names are returned as a
 
443
    single string, separated by ' or '.
 
444
 
 
445
    If no matching candidate is found, "unnamed" is returned.
 
446
    """
 
447
    candidates  = []
 
448
    if (branch is not None and tree is not None and
 
449
        branch.bzrdir.root_transport.base !=
 
450
        tree.bzrdir.root_transport.base):
 
451
        branch = None
 
452
        repository = None
 
453
    non_aliases = set(bzrdir.format_registry.keys())
 
454
    non_aliases.difference_update(bzrdir.format_registry.aliases())
 
455
    for key in non_aliases:
 
456
        format = bzrdir.format_registry.make_bzrdir(key)
 
457
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
 
458
            if (tree and format.workingtree_format !=
 
459
                tree._format):
 
460
                continue
 
461
            if (branch and format.get_branch_format() !=
 
462
                branch._format):
 
463
                continue
 
464
            if (repository and format.repository_format !=
 
465
                repository._format):
 
466
                continue
 
467
        if format.__class__ is not control._format.__class__:
 
468
            continue
 
469
        candidates.append(key)
 
470
    if len(candidates) == 0:
 
471
        return 'unnamed'
 
472
    candidates.sort()
 
473
    new_candidates = [c for c in candidates if not
 
474
        bzrdir.format_registry.get_info(c).hidden]
 
475
    if len(new_candidates) > 0:
 
476
        # If there are any non-hidden formats that match, only return those to
 
477
        # avoid listing hidden formats except when only a hidden format will
 
478
        # do.
 
479
        candidates = new_candidates
 
480
    return ' or '.join(candidates)
 
481
 
 
482
 
 
483
class InfoHooks(_mod_hooks.Hooks):
 
484
    """Hooks for the info command."""
 
485
 
 
486
    def __init__(self):
 
487
        super(InfoHooks, self).__init__()
 
488
        self.create_hook(_mod_hooks.HookPoint('repository',
 
489
            "Invoked when displaying the statistics for a repository. "
 
490
            "repository is called with a statistics dictionary as returned "
 
491
            "by the repository and a file-like object to write to.", (1, 15), 
 
492
            None))
 
493
 
 
494
 
 
495
hooks = InfoHooks()