1
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Routines for extracting all version information from a bzr branch."""
21
from bzrlib.osutils import local_time_offset, format_date
24
# This contains a map of format id => formatter
25
# None is considered the default formatter
28
def create_date_str(timestamp=None, offset=None):
29
"""Just a wrapper around format_date to provide the right format.
31
We don't want to use '%a' in the time string, because it is locale
32
dependant. We also want to force timezone original, and show_offset
34
Without parameters this function yields the current date in the local
37
if timestamp is None and offset is None:
38
timestamp = time.time()
39
offset = local_time_offset()
40
return format_date(timestamp, offset, date_fmt='%Y-%m-%d %H:%M:%S',
41
timezone='original', show_offset=True)
44
class VersionInfoBuilder(object):
45
"""A class which lets you build up information about a revision."""
47
def __init__(self, branch, working_tree=None,
48
check_for_clean=False,
49
include_revision_history=False,
50
include_file_revisions=False,
52
"""Build up information about the given branch.
53
If working_tree is given, it can be checked for changes.
55
:param branch: The branch to work on
56
:param working_tree: If supplied, preferentially check
57
the working tree for changes.
58
:param check_for_clean: If False, we will skip the expense
59
of looking for changes.
60
:param include_revision_history: If True, the output
61
will include the full mainline revision history, including
63
:param include_file_revisions: The output should
64
include the explicit last-changed revision for each file.
67
self._working_tree = working_tree
68
self._check = check_for_clean
69
self._include_history = include_revision_history
70
self._include_file_revs = include_file_revisions
73
self._file_revisions = {}
74
self._revision_history_info= []
76
def _extract_file_revisions(self):
77
"""Extract the working revisions for all files"""
79
# Things seem clean if we never look :)
82
if self._working_tree is not None:
83
basis_tree = self._working_tree.basis_tree()
85
basis_tree = self._branch.basis_tree()
87
# Build up the list from the basis inventory
88
for info in basis_tree.list_files():
89
self._file_revisions[info[0]] = info[-1].revision
91
if not self._check or self._working_tree is None:
94
delta = self._working_tree.changes_from(basis_tree)
96
# Using a 2-pass algorithm for renames. This is because you might have
97
# renamed something out of the way, and then created a new file
98
# in which case we would rather see the new marker
99
# Or you might have removed the target, and then renamed
100
# in which case we would rather see the renamed marker
101
for (old_path, new_path, file_id,
102
kind, text_mod, meta_mod) in delta.renamed:
104
self._file_revisions[old_path] = u'renamed to %s' % (new_path,)
105
for path, file_id, kind in delta.removed:
107
self._file_revisions[path] = 'removed'
108
for path, file_id, kind in delta.added:
110
self._file_revisions[path] = 'new'
111
for (old_path, new_path, file_id,
112
kind, text_mod, meta_mod) in delta.renamed:
114
self._file_revisions[new_path] = u'renamed from %s' % (old_path,)
115
for path, file_id, kind, text_mod, meta_mod in delta.modified:
117
self._file_revisions[path] = 'modified'
119
for path in self._working_tree.unknowns():
121
self._file_revisions[path] = 'unversioned'
123
def _extract_revision_history(self):
124
"""Find the messages for all revisions in history."""
126
# Unfortunately, there is no WorkingTree.revision_history
127
rev_hist = self._branch.revision_history()
128
if self._working_tree is not None:
129
last_rev = self._working_tree.last_revision()
130
assert last_rev in rev_hist, \
131
"Working Tree's last revision not in branch.revision_history"
132
rev_hist = rev_hist[:rev_hist.index(last_rev)+1]
134
repository = self._branch.repository
135
repository.lock_read()
137
for revision_id in rev_hist:
138
rev = repository.get_revision(revision_id)
139
self._revision_history_info.append(
140
(rev.revision_id, rev.message,
141
rev.timestamp, rev.timezone))
145
def _get_revision_id(self):
146
"""Get the revision id we are working on."""
147
if self._working_tree is not None:
148
return self._working_tree.last_revision()
149
return self._branch.last_revision()
151
def generate(self, to_file):
152
"""Output the version information to the supplied file.
154
:param to_file: The file to write the stream to. The output
155
will already be encoded, so to_file should not try
159
raise NotImplementedError(VersionInfoBuilder.generate)
163
def register_builder(format, module, class_name):
164
"""Register a version info format.
166
:param format: The short name of the format, this will be used as the
168
:param module: The string name to the module where the format class
170
:param class_name: The string name of the class to instantiate
172
if len(_version_formats) == 0:
173
_version_formats[None] = (module, class_name)
174
_version_formats[format] = (module, class_name)
177
def get_builder(format):
178
"""Get a handle to the version info builder class
180
:param format: The lookup key supplied to register_builder
181
:return: A class, which follows the VersionInfoBuilder api.
183
builder_module, builder_class_name = _version_formats[format]
184
module = __import__(builder_module, globals(), locals(),
185
[builder_class_name])
186
klass = getattr(module, builder_class_name)
190
def get_builder_formats():
191
"""Get the possible list of formats"""
192
formats = _version_formats.keys()
197
register_builder('rio',
198
'bzrlib.version_info_formats.format_rio',
199
'RioVersionInfoBuilder')
200
register_builder('python',
201
'bzrlib.version_info_formats.format_python',
202
'PythonVersionInfoBuilder')
added
removed
bzrlib/version_info_formats/__init__.py
