← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Aaron Bentley
  • Date: 2007-06-21 23:43:17 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070621234317-5w3h8h36oe90sups
Implement new merge directive format

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
 
import os
21
19
import time
22
 
import sys
 
20
 
23
21
 
24
22
from bzrlib import (
25
23
    bzrdir,
26
24
    diff,
27
 
    errors,
28
 
    hooks as _mod_hooks,
29
25
    osutils,
30
26
    urlutils,
31
27
    )
32
28
from bzrlib.errors import (NoWorkingTree, NotBranchError,
33
29
                           NoRepositoryPresent, NotLocalUrl)
34
30
from bzrlib.missing import find_unmerged
 
31
from bzrlib.symbol_versioning import (deprecated_function,
 
32
        zero_eight, zero_eighteen)
35
33
 
36
34
 
37
35
def plural(n, base='', pl=None):
43
41
        return 's'
44
42
 
45
43
 
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)
 
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)
62
71
 
63
72
    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))
 
73
        self.urls.append((label, path))
75
74
 
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 ]
 
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)
79
79
 
80
80
 
81
81
def gather_location_info(repository, branch=None, working=None):
101
101
        if working_path != master_path:
102
102
            locs['checkout of branch'] = master_path
103
103
        elif repository.is_shared():
104
 
            locs['repository branch'] = branch_path
 
104
            locs['repository branch'] = _repo_rel_url(repository_path,
 
105
                branch_path)
105
106
        elif branch_path is not None:
106
107
            # standalone
107
108
            locs['branch root'] = branch_path
110
111
        if repository.is_shared():
111
112
            # lightweight checkout of branch in shared repository
112
113
            if branch_path is not None:
113
 
                locs['repository branch'] = branch_path
 
114
                locs['repository branch'] = _repo_rel_url(repository_path,
 
115
                                                          branch_path)
114
116
        elif branch_path is not None:
115
117
            # standalone
116
118
            locs['branch root'] = branch_path
128
130
    return [(n, locs[n]) for n in order if n in locs]
129
131
 
130
132
 
131
 
def _show_location_info(locs, outfile):
 
133
def _show_location_info(locs):
132
134
    """Show known locations for working, branch and repository."""
133
 
    outfile.write('Location:\n')
134
 
    path_list = LocationList(osutils.getcwd())
 
135
    print 'Location:'
 
136
    path_list = _UrlList()
135
137
    for name, loc in locs:
136
138
        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):
 
139
    path_list.print_lines()
 
140
 
 
141
 
 
142
def _show_related_info(branch):
155
143
    """Show parent and push location of branch."""
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):
 
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):
165
157
    """Show known formats for control, working, branch and repository."""
166
 
    outfile.write('\n')
167
 
    outfile.write('Format:\n')
 
158
    print
 
159
    print 'Format:'
168
160
    if control:
169
 
        outfile.write('       control: %s\n' %
170
 
            control._format.get_format_description())
 
161
        print '       control: %s' % control._format.get_format_description()
171
162
    if working:
172
 
        outfile.write('  working tree: %s\n' %
173
 
            working._format.get_format_description())
 
163
        print '  working tree: %s' % working._format.get_format_description()
174
164
    if branch:
175
 
        outfile.write('        branch: %s\n' %
176
 
            branch._format.get_format_description())
 
165
        print '        branch: %s' % branch._format.get_format_description()
177
166
    if repository:
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):
 
167
        print '    repository: %s' % repository._format.get_format_description()
 
168
 
 
169
 
 
170
def _show_locking_info(repository, branch=None, working=None):
183
171
    """Show locking status of working, branch and repository."""
184
172
    if (repository.get_physical_lock_status() or
185
173
        (branch and branch.get_physical_lock_status()) or
186
174
        (working and working.get_physical_lock_status())):
187
 
        outfile.write('\n')
188
 
        outfile.write('Lock status:\n')
 
175
        print
 
176
        print 'Lock status:'
189
177
        if working:
190
178
            if working.get_physical_lock_status():
191
179
                status = 'locked'
192
180
            else:
193
181
                status = 'unlocked'
194
 
            outfile.write('  working tree: %s\n' % status)
 
182
            print '  working tree: %s' % status
195
183
        if branch:
196
184
            if branch.get_physical_lock_status():
197
185
                status = 'locked'
198
186
            else:
199
187
                status = 'unlocked'
200
 
            outfile.write('        branch: %s\n' % status)
 
188
            print '        branch: %s' % status
201
189
        if repository:
202
190
            if repository.get_physical_lock_status():
203
191
                status = 'locked'
204
192
            else:
205
193
                status = 'unlocked'
206
 
            outfile.write('    repository: %s\n' % status)
207
 
 
208
 
 
209
 
def _show_missing_revisions_branch(branch, outfile):
 
194
            print '    repository: %s' % status
 
195
 
 
196
 
 
197
def _show_missing_revisions_branch(branch):
210
198
    """Show missing master revisions in branch."""
211
199
    # Try with inaccessible branch ?
212
200
    master = branch.get_master_branch()
213
201
    if master:
214
202
        local_extra, remote_extra = find_unmerged(branch, master)
215
203
        if remote_extra:
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):
 
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):
223
210
    """Show missing revisions in working tree."""
224
211
    branch = working.branch
225
212
    basis = working.basis_tree()
233
220
    if branch_revno and tree_last_id != branch_last_revision:
234
221
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
235
222
        missing_count = branch_revno - tree_last_revno
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):
 
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):
242
229
    """Show statistics about a working tree."""
243
230
    basis = working.basis_tree()
244
231
    work_inv = working.inventory
245
232
    delta = working.changes_from(basis, want_unchanged=True)
246
233
 
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))
 
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)
254
241
 
255
242
    ignore_cnt = unknown_cnt = 0
256
243
    for path in working.extras():
258
245
            ignore_cnt += 1
259
246
        else:
260
247
            unknown_cnt += 1
261
 
    outfile.write('  %8d unknown\n' % unknown_cnt)
262
 
    outfile.write('  %8d ignored\n' % ignore_cnt)
 
248
    print '  %8d unknown' % unknown_cnt
 
249
    print '  %8d ignored' % ignore_cnt
263
250
 
264
251
    dir_cnt = 0
265
252
    for file_id in work_inv:
266
 
        if (work_inv.get_file_kind(file_id) == 'directory' and
 
253
        if (work_inv.get_file_kind(file_id) == 'directory' and 
267
254
            not work_inv.is_root(file_id)):
268
255
            dir_cnt += 1
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):
 
256
    print '  %8d versioned %s' \
 
257
          % (dir_cnt,
 
258
             plural(dir_cnt, 'subdirectory', 'subdirectories'))
 
259
 
 
260
 
 
261
def _show_branch_stats(branch, verbose):
274
262
    """Show statistics about a branch."""
275
263
    revno, head = branch.last_revision_info()
276
 
    outfile.write('\n')
277
 
    outfile.write('Branch history:\n')
278
 
    outfile.write('  %8d revision%s\n' % (revno, plural(revno)))
 
264
    print
 
265
    print 'Branch history:'
 
266
    print '  %8d revision%s' % (revno, plural(revno))
279
267
    stats = branch.repository.gather_stats(head, committers=verbose)
280
268
    if verbose:
281
269
        committers = stats['committers']
282
 
        outfile.write('  %8d committer%s\n' % (committers,
283
 
            plural(committers)))
 
270
        print '  %8d committer%s' % (committers, plural(committers))
284
271
    if revno:
285
272
        timestamp, timezone = stats['firstrev']
286
273
        age = int((time.time() - timestamp) / 3600 / 24)
287
 
        outfile.write('  %8d day%s old\n' % (age, plural(age)))
288
 
        outfile.write('   first revision: %s\n' %
289
 
            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)
290
277
        timestamp, timezone = stats['latestrev']
291
 
        outfile.write('  latest revision: %s\n' %
292
 
            osutils.format_date(timestamp, timezone))
 
278
        print '  latest revision: %s' % osutils.format_date(timestamp,
 
279
            timezone)
293
280
    return stats
294
281
 
295
282
 
296
 
def _show_repository_info(repository, outfile):
 
283
def _show_repository_info(repository):
297
284
    """Show settings of a repository."""
298
285
    if repository.make_working_trees():
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):
 
286
        print
 
287
        print 'Create working tree for new branches inside the repository.'
 
288
 
 
289
 
 
290
def _show_repository_stats(stats):
305
291
    """Show statistics about a repository."""
306
 
    f = StringIO()
 
292
    if 'revisions' in stats or 'size' in stats:
 
293
        print
 
294
        print 'Repository:'
307
295
    if 'revisions' in stats:
308
296
        revisions = stats['revisions']
309
 
        f.write('  %8d revision%s\n' % (revisions, plural(revisions)))
 
297
        print '  %8d revision%s' % (revisions, plural(revisions))
310
298
    if 'size' in stats:
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):
 
299
        print '  %8d KiB' % (stats['size']/1024)
 
300
 
 
301
def show_bzrdir_info(a_bzrdir, verbose=False):
321
302
    """Output to stdout the 'info' for a_bzrdir."""
322
 
    if outfile is None:
323
 
        outfile = sys.stdout
324
303
    try:
325
304
        tree = a_bzrdir.open_workingtree(
326
305
            recommend_upgrade=False)
348
327
 
349
328
    lockable.lock_read()
350
329
    try:
351
 
        show_component_info(a_bzrdir, repository, branch, tree, verbose,
352
 
                            outfile)
 
330
        show_component_info(a_bzrdir, repository, branch, tree, verbose)
353
331
    finally:
354
332
        lockable.unlock()
355
333
 
356
334
 
357
335
def show_component_info(control, repository, branch=None, working=None,
358
 
    verbose=1, outfile=None):
 
336
    verbose=1):
359
337
    """Write info about all bzrdir components to stdout"""
360
 
    if outfile is None:
361
 
        outfile = sys.stdout
362
338
    if verbose is False:
363
339
        verbose = 1
364
340
    if verbose is True:
365
341
        verbose = 2
366
342
    layout = describe_layout(repository, branch, working)
367
343
    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)
 
344
    print "%s (format: %s)" % (layout, format)
 
345
    _show_location_info(gather_location_info(repository, branch, working))
373
346
    if verbose == 0:
374
347
        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)
 
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)
379
354
    if working is not None:
380
 
        _show_missing_revisions_working(working, outfile)
381
 
        _show_working_stats(working, outfile)
 
355
        _show_missing_revisions_working(working)
 
356
        _show_working_stats(working)
382
357
    elif branch is not None:
383
 
        _show_missing_revisions_branch(branch, outfile)
 
358
        _show_missing_revisions_branch(branch)
384
359
    if branch is not None:
385
 
        show_committers = verbose >= 2
386
 
        stats = _show_branch_stats(branch, show_committers, outfile)
 
360
        stats = _show_branch_stats(branch, verbose==2)
387
361
    else:
388
362
        stats = repository.gather_stats()
389
363
    if branch is None and working is None:
390
 
        _show_repository_info(repository, outfile)
391
 
    _show_repository_stats(repository, stats, outfile)
 
364
        _show_repository_info(repository)
 
365
    _show_repository_stats(stats)
392
366
 
393
367
 
394
368
def describe_layout(repository=None, branch=None, tree=None):
450
424
        tree.bzrdir.root_transport.base):
451
425
        branch = None
452
426
        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:
 
427
    for key in bzrdir.format_registry.keys():
456
428
        format = bzrdir.format_registry.make_bzrdir(key)
457
429
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
458
430
            if (tree and format.workingtree_format !=
469
441
        candidates.append(key)
470
442
    if len(candidates) == 0:
471
443
        return 'unnamed'
472
 
    candidates.sort()
 
444
    new_candidates = [c for c in candidates if c != 'default']
 
445
    if len(new_candidates) > 0:
 
446
        candidates = new_candidates
473
447
    new_candidates = [c for c in candidates if not
474
448
        bzrdir.format_registry.get_info(c).hidden]
475
449
    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
450
        candidates = new_candidates
480
451
    return ' or '.join(candidates)
481
452
 
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()
 
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)