/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: Jelmer Vernooij
  • Date: 2019-08-12 20:24:50 UTC
  • mto: (7290.1.35 work)
  • mto: This revision was merged to the branch mainline in revision 7405.
  • Revision ID: jelmer@jelmer.uk-20190812202450-vdpamxay6sebo93w
Fix path to brz.

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