/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: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

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 .lazy_import import lazy_import
 
20
 
 
21
lazy_import(globals(), """
 
22
from breezy import (
 
23
    branch,
 
24
    version_info_formats,
 
25
    workingtree,
 
26
    )
 
27
from breezy.i18n import gettext
 
28
""")
 
29
 
 
30
from . import (
 
31
    errors,
 
32
    )
 
33
from .commands import Command
 
34
from .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(
 
48
            gettext('No known version info format {0}.'
 
49
                    ' Supported types are: {1}').format(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
      brz 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=('breezy.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,
 
88
                            help='Template for the output.'),
 
89
                     'revision',
 
90
                     ]
 
91
    takes_args = ['location?']
 
92
 
 
93
    encoding_type = 'replace'
 
94
 
 
95
    def run(self, location=None, format=None,
 
96
            all=False, check_clean=False, include_history=False,
 
97
            include_file_revisions=False, template=None,
 
98
            revision=None):
 
99
 
 
100
        if revision and len(revision) > 1:
 
101
            raise errors.BzrCommandError(
 
102
                gettext('brz version-info --revision takes exactly'
 
103
                        ' one revision specifier'))
 
104
 
 
105
        if location is None:
 
106
            location = '.'
 
107
 
 
108
        if format is None:
 
109
            format = version_info_formats.format_registry.get()
 
110
 
 
111
        try:
 
112
            wt = workingtree.WorkingTree.open_containing(location)[0]
 
113
        except errors.NoWorkingTree:
 
114
            b = branch.Branch.open(location)
 
115
            wt = None
 
116
        else:
 
117
            b = wt.branch
 
118
 
 
119
        if all:
 
120
            include_history = True
 
121
            check_clean = True
 
122
            include_file_revisions = True
 
123
        if template:
 
124
            include_history = True
 
125
            include_file_revisions = True
 
126
            if '{clean}' in template:
 
127
                check_clean = True
 
128
 
 
129
        if revision is not None:
 
130
            revision_id = revision[0].as_revision_id(b)
 
131
        else:
 
132
            revision_id = None
 
133
 
 
134
        builder = format(b, working_tree=wt,
 
135
                         check_for_clean=check_clean,
 
136
                         include_revision_history=include_history,
 
137
                         include_file_revisions=include_file_revisions,
 
138
                         template=template, revision_id=revision_id)
 
139
        builder.generate(self.outf)