/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 bzrlib/version_info.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/version_info.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Commands for generating snapshot information about a bzr tree."""
18
18
 
19
 
from bzrlib.lazy_import import lazy_import
 
19
import sys
 
20
import codecs
20
21
 
21
 
lazy_import(globals(), """
22
22
from bzrlib import (
23
 
    branch,
24
 
    errors,
25
 
    ui,
26
23
    version_info_formats,
27
 
    workingtree,
28
24
    )
29
 
""")
30
 
 
 
25
from bzrlib.branch import Branch
31
26
from bzrlib.commands import Command
32
 
from bzrlib.option import Option, RegistryOption
 
27
from bzrlib.errors import BzrCommandError
 
28
from bzrlib.option import Option
 
29
from bzrlib.workingtree import WorkingTree
 
30
 
33
31
 
34
32
 
35
33
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
34
    try:
42
35
        return version_info_formats.get_builder(format)
43
36
    except KeyError:
44
37
        formats = version_info_formats.get_builder_formats()
45
 
        raise errors.BzrCommandError('No known version info format %s.'
46
 
                                     ' Supported types are: %s'
47
 
                                     % (format, formats))
 
38
        raise BzrCommandError('No known version info format %s.'
 
39
                              ' Supported types are: %s'
 
40
                              % (format, formats))
48
41
 
49
42
 
50
43
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.'),
 
44
    """Generate version information about this tree."""
 
45
 
 
46
    takes_options = [Option('format', type=_parse_version_info_format,
 
47
                            help='Select the output format'),
 
48
                     Option('all', help='include all possible information'),
 
49
                     Option('check-clean', help='check if tree is clean'),
81
50
                     Option('include-history',
82
 
                            help='Include the revision-history.'),
 
51
                            help='Include the revision-history'),
83
52
                     Option('include-file-revisions',
84
 
                            help='Include the last revision for each file.'),
85
 
                     Option('template', type=str, help='Template for the output.'),
 
53
                            help='Include the last revision for each file')
86
54
                     ]
87
55
    takes_args = ['location?']
88
56
 
90
58
 
91
59
    def run(self, location=None, format=None,
92
60
            all=False, check_clean=False, include_history=False,
93
 
            include_file_revisions=False, template=None):
 
61
            include_file_revisions=False):
94
62
 
95
63
        if location is None:
96
 
            location = '.'
 
64
            location = u'.'
97
65
 
98
66
        if format is None:
99
 
            format = version_info_formats.format_registry.get()
 
67
            format = version_info_formats.get_builder(None)
100
68
 
101
69
        wt = None
102
70
        try:
103
 
            wt = workingtree.WorkingTree.open_containing(location)[0]
104
 
        except errors.NoWorkingTree:
105
 
            b = branch.Branch.open(location)
 
71
            wt = WorkingTree.open_containing(location)[0]
 
72
        except NoWorkingTree:
 
73
            b = Branch.open(location)
106
74
        else:
107
75
            b = wt.branch
108
76
 
109
 
        if all or template:
 
77
        if all:
110
78
            include_history = True
111
79
            check_clean = True
112
80
            include_file_revisions=True
114
82
        builder = format(b, working_tree=wt,
115
83
                check_for_clean=check_clean,
116
84
                include_revision_history=include_history,
117
 
                include_file_revisions=include_file_revisions,
118
 
                template=template)
119
 
        builder.generate(ui.ui_factory.make_output_stream())
 
85
                include_file_revisions=include_file_revisions)
 
86
        builder.generate(self.outf)