← 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: 2007-06-25 05:12:57 UTC
  • mto: This revision was merged to the branch mainline in revision 2546.
  • Revision ID: mbp@sourcefrog.net-20070625051257-fpzcv067ye6a341c
Fix typo and remove version number from README

Show diffs side-by-side

added added

removed removed

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