← 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: 2008-11-23 16:38:39 UTC
  • mto: This revision was merged to the branch mainline in revision 3892.
  • Revision ID: aaron@aaronbentley.com-20081123163839-ew27m17130fz85v6
Update documentation

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
16
 
 
17
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
__all__ = ['show_bzrdir_info']
20
18
 
21
 
from cStringIO import StringIO
 
19
import os
22
20
import time
23
21
import sys
24
22
 
25
23
from bzrlib import (
26
24
    bzrdir,
27
 
    controldir,
 
25
    diff,
28
26
    errors,
29
 
    hooks as _mod_hooks,
30
27
    osutils,
31
28
    urlutils,
32
29
    )
79
76
        return ["  %*s: %s\n" % (max_len, l, u) for l, u in self.locs ]
80
77
 
81
78
 
82
 
def gather_location_info(repository=None, branch=None, working=None,
83
 
        control=None):
 
79
def gather_location_info(repository, branch=None, working=None):
84
80
    locs = {}
 
81
    repository_path = repository.bzrdir.root_transport.base
85
82
    if branch is not None:
86
 
        branch_path = branch.user_url
 
83
        branch_path = branch.bzrdir.root_transport.base
87
84
        master_path = branch.get_bound_location()
88
85
        if master_path is None:
89
86
            master_path = branch_path
90
87
    else:
91
88
        branch_path = None
92
89
        master_path = None
93
 
        try:
94
 
            if control is not None and control.get_branch_reference():
95
 
                locs['checkout of branch'] = control.get_branch_reference()
96
 
        except NotBranchError:
97
 
            pass
98
90
    if working:
99
 
        working_path = working.user_url
 
91
        working_path = working.bzrdir.root_transport.base
100
92
        if working_path != branch_path:
101
93
            locs['light checkout root'] = working_path
102
94
        if master_path != branch_path:
113
105
            locs['branch root'] = branch_path
114
106
    else:
115
107
        working_path = None
116
 
        if repository is not None and repository.is_shared():
 
108
        if repository.is_shared():
117
109
            # lightweight checkout of branch in shared repository
118
110
            if branch_path is not None:
119
111
                locs['repository branch'] = branch_path
120
112
        elif branch_path is not None:
121
113
            # standalone
122
114
            locs['branch root'] = branch_path
123
 
        elif repository is not None:
124
 
            locs['repository'] = repository.user_url
125
 
        elif control is not None:
126
 
            locs['control directory'] = control.user_url
 
115
            if master_path != branch_path:
 
116
                locs['bound to branch'] = master_path
127
117
        else:
128
 
            # Really, at least a control directory should be
129
 
            # passed in for this method to be useful.
130
 
            pass
131
 
        if master_path != branch_path:
132
 
            locs['bound to branch'] = master_path
133
 
    if repository is not None and repository.is_shared():
 
118
            locs['repository'] = repository_path
 
119
    if repository.is_shared():
134
120
        # lightweight checkout of branch in shared repository
135
 
        locs['shared repository'] = repository.user_url
136
 
    order = ['control directory', 'light checkout root',
137
 
             'repository checkout root', 'checkout root',
138
 
             'checkout of branch', 'shared repository',
 
121
        locs['shared repository'] = repository_path
 
122
    order = ['light checkout root', 'repository checkout root',
 
123
             'checkout root', 'checkout of branch', 'shared repository',
139
124
             'repository', 'repository branch', 'branch root',
140
125
             'bound to branch']
141
126
    return [(n, locs[n]) for n in order if n in locs]
173
158
        outfile.writelines(locs.get_lines())
174
159
 
175
160
 
176
 
def _show_control_dir_info(control, outfile):
177
 
    """Show control dir information."""
178
 
    if control._format.colocated_branches:
179
 
        outfile.write('\n')
180
 
        outfile.write('Control directory:\n')
181
 
        outfile.write('         %d branches\n' % len(control.list_branches()))
182
 
 
183
 
 
184
161
def _show_format_info(control=None, repository=None, branch=None,
185
162
                      working=None, outfile=None):
186
163
    """Show known formats for control, working, branch and repository."""
200
177
            repository._format.get_format_description())
201
178
 
202
179
 
203
 
def _show_locking_info(repository=None, branch=None, working=None,
204
 
        outfile=None):
 
180
def _show_locking_info(repository, branch=None, working=None, outfile=None):
205
181
    """Show locking status of working, branch and repository."""
206
 
    if (repository and repository.get_physical_lock_status() or
 
182
    if (repository.get_physical_lock_status() or
207
183
        (branch and branch.get_physical_lock_status()) or
208
184
        (working and working.get_physical_lock_status())):
209
185
        outfile.write('\n')
245
221
    """Show missing revisions in working tree."""
246
222
    branch = working.branch
247
223
    basis = working.basis_tree()
248
 
    try:
249
 
        branch_revno, branch_last_revision = branch.last_revision_info()
250
 
    except errors.UnsupportedOperation:
251
 
        return
 
224
    work_inv = working.inventory
 
225
    branch_revno, branch_last_revision = branch.last_revision_info()
252
226
    try:
253
227
        tree_last_id = working.get_parent_ids()[0]
254
228
    except IndexError:
265
239
def _show_working_stats(working, outfile):
266
240
    """Show statistics about a working tree."""
267
241
    basis = working.basis_tree()
 
242
    work_inv = working.inventory
268
243
    delta = working.changes_from(basis, want_unchanged=True)
269
244
 
270
245
    outfile.write('\n')
285
260
    outfile.write('  %8d ignored\n' % ignore_cnt)
286
261
 
287
262
    dir_cnt = 0
288
 
    root_id = working.get_root_id()
289
 
    for path, entry in working.iter_entries_by_dir():
290
 
        if entry.kind == 'directory' and entry.file_id != root_id:
 
263
    for file_id in work_inv:
 
264
        if (work_inv.get_file_kind(file_id) == 'directory' and 
 
265
            not work_inv.is_root(file_id)):
291
266
            dir_cnt += 1
292
267
    outfile.write('  %8d versioned %s\n' % (dir_cnt,
293
268
        plural(dir_cnt, 'subdirectory', 'subdirectories')))
295
270
 
296
271
def _show_branch_stats(branch, verbose, outfile):
297
272
    """Show statistics about a branch."""
298
 
    try:
299
 
        revno, head = branch.last_revision_info()
300
 
    except errors.UnsupportedOperation:
301
 
        return {}
 
273
    revno, head = branch.last_revision_info()
302
274
    outfile.write('\n')
303
275
    outfile.write('Branch history:\n')
304
276
    outfile.write('  %8d revision%s\n' % (revno, plural(revno)))
327
299
            'the repository.\n')
328
300
 
329
301
 
330
 
def _show_repository_stats(repository, stats, outfile):
 
302
def _show_repository_stats(stats, outfile):
331
303
    """Show statistics about a repository."""
332
 
    f = StringIO()
 
304
    if 'revisions' in stats or 'size' in stats:
 
305
        outfile.write('\n')
 
306
        outfile.write('Repository:\n')
333
307
    if 'revisions' in stats:
334
308
        revisions = stats['revisions']
335
 
        f.write('  %8d revision%s\n' % (revisions, plural(revisions)))
 
309
        outfile.write('  %8d revision%s\n' % (revisions, plural(revisions)))
336
310
    if 'size' in stats:
337
 
        f.write('  %8d KiB\n' % (stats['size']/1024))
338
 
    for hook in hooks['repository']:
339
 
        hook(repository, stats, f)
340
 
    if f.getvalue() != "":
341
 
        outfile.write('\n')
342
 
        outfile.write('Repository:\n')
343
 
        outfile.write(f.getvalue())
 
311
        outfile.write('  %8d KiB\n' % (stats['size']/1024))
344
312
 
345
313
 
346
314
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
350
318
    try:
351
319
        tree = a_bzrdir.open_workingtree(
352
320
            recommend_upgrade=False)
353
 
    except (NoWorkingTree, NotLocalUrl, NotBranchError):
 
321
    except (NoWorkingTree, NotLocalUrl):
354
322
        tree = None
355
323
        try:
356
 
            branch = a_bzrdir.open_branch(name="")
 
324
            branch = a_bzrdir.open_branch()
357
325
        except NotBranchError:
358
326
            branch = None
359
327
            try:
360
328
                repository = a_bzrdir.open_repository()
361
329
            except NoRepositoryPresent:
362
 
                lockable = None
363
 
                repository = None
 
330
                # Return silently; cmd_info already returned NotBranchError
 
331
                # if no bzrdir could be opened.
 
332
                return
364
333
            else:
365
334
                lockable = repository
366
335
        else:
371
340
        repository = branch.repository
372
341
        lockable = tree
373
342
 
374
 
    if lockable is not None:
375
 
        lockable.lock_read()
 
343
    lockable.lock_read()
376
344
    try:
377
345
        show_component_info(a_bzrdir, repository, branch, tree, verbose,
378
346
                            outfile)
379
347
    finally:
380
 
        if lockable is not None:
381
 
            lockable.unlock()
 
348
        lockable.unlock()
382
349
 
383
350
 
384
351
def show_component_info(control, repository, branch=None, working=None,
390
357
        verbose = 1
391
358
    if verbose is True:
392
359
        verbose = 2
393
 
    layout = describe_layout(repository, branch, working, control)
 
360
    layout = describe_layout(repository, branch, working)
394
361
    format = describe_format(control, repository, branch, working)
395
362
    outfile.write("%s (format: %s)\n" % (layout, format))
396
 
    _show_location_info(
397
 
        gather_location_info(control=control, repository=repository,
398
 
            branch=branch, working=working),
399
 
        outfile)
 
363
    _show_location_info(gather_location_info(repository, branch, working),
 
364
                        outfile)
400
365
    if branch is not None:
401
366
        _show_related_info(branch, outfile)
402
367
    if verbose == 0:
403
368
        return
404
369
    _show_format_info(control, repository, branch, working, outfile)
405
370
    _show_locking_info(repository, branch, working, outfile)
406
 
    _show_control_dir_info(control, outfile)
407
371
    if branch is not None:
408
372
        _show_missing_revisions_branch(branch, outfile)
409
373
    if working is not None:
412
376
    elif branch is not None:
413
377
        _show_missing_revisions_branch(branch, outfile)
414
378
    if branch is not None:
415
 
        show_committers = verbose >= 2
416
 
        stats = _show_branch_stats(branch, show_committers, outfile)
417
 
    elif repository is not None:
 
379
        stats = _show_branch_stats(branch, verbose==2, outfile)
 
380
    else:
418
381
        stats = repository.gather_stats()
419
 
    if branch is None and working is None and repository is not None:
 
382
    if branch is None and working is None:
420
383
        _show_repository_info(repository, outfile)
421
 
    if repository is not None:
422
 
        _show_repository_stats(repository, stats, outfile)
423
 
 
424
 
 
425
 
def describe_layout(repository=None, branch=None, tree=None, control=None):
 
384
    _show_repository_stats(stats, outfile)
 
385
 
 
386
 
 
387
def describe_layout(repository=None, branch=None, tree=None):
426
388
    """Convert a control directory layout into a user-understandable term
427
389
 
428
390
    Common outputs include "Standalone tree", "Repository branch" and
429
391
    "Checkout".  Uncommon outputs include "Unshared repository with trees"
430
392
    and "Empty control directory"
431
393
    """
432
 
    if branch is None and control is not None:
433
 
        try:
434
 
            branch_reference = control.get_branch_reference()
435
 
        except NotBranchError:
436
 
            pass
437
 
        else:
438
 
            if branch_reference is not None:
439
 
                return "Dangling branch reference"
440
394
    if repository is None:
441
395
        return 'Empty control directory'
442
396
    if branch is None and tree is None:
444
398
            phrase = 'Shared repository'
445
399
        else:
446
400
            phrase = 'Unshared repository'
447
 
        extra = []
448
401
        if repository.make_working_trees():
449
 
            extra.append('trees')
450
 
        if len(control.get_branches()) > 0:
451
 
            extra.append('colocated branches')
452
 
        if extra:
453
 
            phrase += ' with ' + " and ".join(extra)
 
402
            phrase += ' with trees'
454
403
        return phrase
455
404
    else:
456
405
        if repository.is_shared():
464
413
        if branch is None and tree is not None:
465
414
            phrase = "branchless tree"
466
415
        else:
467
 
            if (tree is not None and tree.user_url !=
468
 
                branch.user_url):
 
416
            if (tree is not None and tree.bzrdir.root_transport.base !=
 
417
                branch.bzrdir.root_transport.base):
469
418
                independence = ''
470
419
                phrase = "Lightweight checkout"
471
420
            elif branch.get_bound_location() is not None:
490
439
    """
491
440
    candidates  = []
492
441
    if (branch is not None and tree is not None and
493
 
        branch.user_url != tree.user_url):
 
442
        branch.bzrdir.root_transport.base !=
 
443
        tree.bzrdir.root_transport.base):
494
444
        branch = None
495
445
        repository = None
496
 
    non_aliases = set(controldir.format_registry.keys())
497
 
    non_aliases.difference_update(controldir.format_registry.aliases())
 
446
    non_aliases = set(bzrdir.format_registry.keys())
 
447
    non_aliases.difference_update(bzrdir.format_registry.aliases())
498
448
    for key in non_aliases:
499
 
        format = controldir.format_registry.make_bzrdir(key)
 
449
        format = bzrdir.format_registry.make_bzrdir(key)
500
450
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
501
451
            if (tree and format.workingtree_format !=
502
452
                tree._format):
514
464
        return 'unnamed'
515
465
    candidates.sort()
516
466
    new_candidates = [c for c in candidates if not
517
 
        controldir.format_registry.get_info(c).hidden]
 
467
        bzrdir.format_registry.get_info(c).hidden]
518
468
    if len(new_candidates) > 0:
519
469
        # If there are any non-hidden formats that match, only return those to
520
470
        # avoid listing hidden formats except when only a hidden format will
521
471
        # do.
522
472
        candidates = new_candidates
523
473
    return ' or '.join(candidates)
524
 
 
525
 
 
526
 
class InfoHooks(_mod_hooks.Hooks):
527
 
    """Hooks for the info command."""
528
 
 
529
 
    def __init__(self):
530
 
        super(InfoHooks, self).__init__("bzrlib.info", "hooks")
531
 
        self.add_hook('repository',
532
 
            "Invoked when displaying the statistics for a repository. "
533
 
            "repository is called with a statistics dictionary as returned "
534
 
            "by the repository and a file-like object to write to.", (1, 15))
535
 
 
536
 
 
537
 
hooks = InfoHooks()