/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-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

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