← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/cmd_version_info.py

  • Committer: Robert Collins
  • Date: 2007-04-23 03:41:48 UTC
  • mfrom: (2387.2.1 cleanassertions)
  • mto: This revision was merged to the branch mainline in revision 2444.
  • Revision ID: robertc@robertcollins.net-20070423034148-b4m9c1iwl7528prf
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
"""Commands for generating snapshot information about a bzr tree."""
 
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
from bzrlib import (
 
22
    branch,
 
23
    errors,
 
24
    version_info_formats,
 
25
    workingtree,
 
26
    )
 
27
""")
 
28
from bzrlib.commands import Command
 
29
from bzrlib.option import Option
 
30
 
 
31
 
 
32
def _parse_version_info_format(format):
 
33
    """Convert a string passed by the user into a VersionInfoFormat.
 
34
 
 
35
    This looks in the version info format registry, and if the format
 
36
    cannot be found, generates a useful error exception.
 
37
    """
 
38
    try:
 
39
        return version_info_formats.get_builder(format)
 
40
    except KeyError:
 
41
        formats = version_info_formats.get_builder_formats()
 
42
        raise errors.BzrCommandError('No known version info format %s.'
 
43
                                     ' Supported types are: %s'
 
44
                                     % (format, formats))
 
45
 
 
46
 
 
47
class cmd_version_info(Command):
 
48
    """Show version information about this tree."""
 
49
 
 
50
    takes_options = [Option('format', type=_parse_version_info_format,
 
51
                            help='Select the output format'),
 
52
                     Option('all', help='include all possible information'),
 
53
                     Option('check-clean', help='check if tree is clean'),
 
54
                     Option('include-history',
 
55
                            help='Include the revision-history'),
 
56
                     Option('include-file-revisions',
 
57
                            help='Include the last revision for each file')
 
58
                     ]
 
59
    takes_args = ['location?']
 
60
 
 
61
    encoding_type = 'exact'
 
62
 
 
63
    def run(self, location=None, format=None,
 
64
            all=False, check_clean=False, include_history=False,
 
65
            include_file_revisions=False):
 
66
 
 
67
        if location is None:
 
68
            location = '.'
 
69
 
 
70
        if format is None:
 
71
            format = version_info_formats.get_builder(None)
 
72
 
 
73
        wt = None
 
74
        try:
 
75
            wt = workingtree.WorkingTree.open_containing(location)[0]
 
76
        except errors.NoWorkingTree:
 
77
            b = branch.Branch.open(location)
 
78
        else:
 
79
            b = wt.branch
 
80
 
 
81
        if all:
 
82
            include_history = True
 
83
            check_clean = True
 
84
            include_file_revisions=True
 
85
 
 
86
        builder = format(b, working_tree=wt,
 
87
                check_for_clean=check_clean,
 
88
                include_revision_history=include_history,
 
89
                include_file_revisions=include_file_revisions)
 
90
        builder.generate(self.outf)