← 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 Packman
  • Date: 2011-11-24 17:01:07 UTC
  • mto: This revision was merged to the branch mainline in revision 6304.
  • Revision ID: martin.packman@canonical.com-20111124170107-b3yd5vkzdglmnjk7
Allow a bracketed suffix in option help test

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