← 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: Canonical.com Patch Queue Manager
  • Date: 2006-09-21 22:59:25 UTC
  • mfrom: (2022.1.7 version-info-55794)
  • Revision ID: pqm@pqm.ubuntu.com-20060921225925-ab09f1d0cb2c838c
(jam) Add command 'bzr version-info'

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 import (
 
20
    branch,
 
21
    version_info_formats,
 
22
    workingtree,
 
23
    )
 
24
from bzrlib.commands import Command
 
25
from bzrlib.errors import BzrCommandError
 
26
from bzrlib.option import Option
 
27
 
 
28
 
 
29
def _parse_version_info_format(format):
 
30
    """Convert a string passed by the user into a VersionInfoFormat.
 
31
 
 
32
    This looks in the version info format registry, and if the format
 
33
    cannot be found, generates a useful error exception.
 
34
    """
 
35
    try:
 
36
        return version_info_formats.get_builder(format)
 
37
    except KeyError:
 
38
        formats = version_info_formats.get_builder_formats()
 
39
        raise BzrCommandError('No known version info format %s.'
 
40
                              ' Supported types are: %s'
 
41
                              % (format, formats))
 
42
 
 
43
 
 
44
class cmd_version_info(Command):
 
45
    """Generate version information about this tree."""
 
46
 
 
47
    takes_options = [Option('format', type=_parse_version_info_format,
 
48
                            help='Select the output format'),
 
49
                     Option('all', help='include all possible information'),
 
50
                     Option('check-clean', help='check if tree is clean'),
 
51
                     Option('include-history',
 
52
                            help='Include the revision-history'),
 
53
                     Option('include-file-revisions',
 
54
                            help='Include the last revision for each file')
 
55
                     ]
 
56
    takes_args = ['location?']
 
57
 
 
58
    encoding_type = 'exact'
 
59
 
 
60
    def run(self, location=None, format=None,
 
61
            all=False, check_clean=False, include_history=False,
 
62
            include_file_revisions=False):
 
63
 
 
64
        if location is None:
 
65
            location = '.'
 
66
 
 
67
        if format is None:
 
68
            format = version_info_formats.get_builder(None)
 
69
 
 
70
        wt = None
 
71
        try:
 
72
            wt = workingtree.WorkingTree.open_containing(location)[0]
 
73
        except NoWorkingTree:
 
74
            b = branch.Branch.open(location)
 
75
        else:
 
76
            b = wt.branch
 
77
 
 
78
        if all:
 
79
            include_history = True
 
80
            check_clean = True
 
81
            include_file_revisions=True
 
82
 
 
83
        builder = format(b, working_tree=wt,
 
84
                check_for_clean=check_clean,
 
85
                include_revision_history=include_history,
 
86
                include_file_revisions=include_file_revisions)
 
87
        builder.generate(self.outf)