← 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: Martin Pool
  • Date: 2005-08-05 19:23:12 UTC
  • Revision ID: mbp@sourcefrog.net-20050805192312-273968b3145cbcf6
- cleanup re-raise of exception

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
1
 
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""Commands for generating snapshot information about a bzr tree."""
18
 
 
19
 
from __future__ import absolute_import
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
 
23
 
lazy_import(globals(), """
24
 
from bzrlib import (
25
 
    branch,
26
 
    errors,
27
 
    version_info_formats,
28
 
    workingtree,
29
 
    )
30
 
from bzrlib.i18n import gettext
31
 
""")
32
 
 
33
 
from bzrlib.commands import Command
34
 
from bzrlib.option import Option, RegistryOption
35
 
 
36
 
 
37
 
def _parse_version_info_format(format):
38
 
    """Convert a string passed by the user into a VersionInfoFormat.
39
 
 
40
 
    This looks in the version info format registry, and if the format
41
 
    cannot be found, generates a useful error exception.
42
 
    """
43
 
    try:
44
 
        return version_info_formats.get_builder(format)
45
 
    except KeyError:
46
 
        formats = version_info_formats.get_builder_formats()
47
 
        raise errors.BzrCommandError(gettext('No known version info format {0}.'
48
 
                                     ' Supported types are: {1}').format(
49
 
                                     format, formats))
50
 
 
51
 
 
52
 
class cmd_version_info(Command):
53
 
    __doc__ = """Show version information about this tree.
54
 
 
55
 
    You can use this command to add information about version into
56
 
    source code of an application. The output can be in one of the
57
 
    supported formats or in a custom format based on a template.
58
 
 
59
 
    For example::
60
 
 
61
 
      bzr version-info --custom \\
62
 
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
63
 
 
64
 
    will produce a C header file with formatted string containing the
65
 
    current revision number. Other supported variables in templates are:
66
 
 
67
 
      * {date} - date of the last revision
68
 
      * {build_date} - current date
69
 
      * {revno} - revision number
70
 
      * {revision_id} - revision id
71
 
      * {branch_nick} - branch nickname
72
 
      * {clean} - 0 if the source tree contains uncommitted changes,
73
 
                  otherwise 1
74
 
    """
75
 
 
76
 
    takes_options = [RegistryOption('format',
77
 
                            'Select the output format.',
78
 
                            value_switches=True,
79
 
                            lazy_registry=('bzrlib.version_info_formats',
80
 
                                           'format_registry')),
81
 
                     Option('all', help='Include all possible information.'),
82
 
                     Option('check-clean', help='Check if tree is clean.'),
83
 
                     Option('include-history',
84
 
                            help='Include the revision-history.'),
85
 
                     Option('include-file-revisions',
86
 
                            help='Include the last revision for each file.'),
87
 
                     Option('template', type=str, help='Template for the output.'),
88
 
                     'revision',
89
 
                     ]
90
 
    takes_args = ['location?']
91
 
 
92
 
    encoding_type = 'exact'
93
 
 
94
 
    def run(self, location=None, format=None,
95
 
            all=False, check_clean=False, include_history=False,
96
 
            include_file_revisions=False, template=None,
97
 
            revision=None):
98
 
 
99
 
        if revision and len(revision) > 1:
100
 
            raise errors.BzrCommandError(
101
 
                gettext('bzr version-info --revision takes exactly'
102
 
                        ' one revision specifier'))
103
 
 
104
 
        if location is None:
105
 
            location = '.'
106
 
 
107
 
        if format is None:
108
 
            format = version_info_formats.format_registry.get()
109
 
 
110
 
        try:
111
 
            wt = workingtree.WorkingTree.open_containing(location)[0]
112
 
        except errors.NoWorkingTree:
113
 
            b = branch.Branch.open(location)
114
 
            wt = None
115
 
        else:
116
 
            b = wt.branch
117
 
 
118
 
        if all:
119
 
            include_history = True
120
 
            check_clean = True
121
 
            include_file_revisions = True
122
 
        if template:
123
 
            include_history = True
124
 
            include_file_revisions = True
125
 
            if '{clean}' in template:
126
 
                check_clean = True
127
 
 
128
 
        if revision is not None:
129
 
            revision_id = revision[0].as_revision_id(b)
130
 
        else:
131
 
            revision_id = None
132
 
 
133
 
        builder = format(b, working_tree=wt,
134
 
                check_for_clean=check_clean,
135
 
                include_revision_history=include_history,
136
 
                include_file_revisions=include_file_revisions,
137
 
                template=template, revision_id=revision_id)
138
 
        builder.generate(self.outf)