/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/cmd_version_info.py

  • Committer: Robert Collins
  • Date: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream

Show diffs side-by-side

added added

removed removed

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