~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
"""File annotate based on weave storage"""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
# TODO: Choice of more or less verbose formats:
20
22
#
21
23
# interposed: show more details between blocks of modified lines
41
43
    )
42
44
from bzrlib.config import extract_email_address
43
45
from bzrlib.repository import _strip_NULL_ghosts
44
 
from bzrlib.revision import CURRENT_REVISION, Revision
45
 
 
46
 
 
47
 
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
48
 
                  to_file=None, show_ids=False):
49
 
    """Annotate file_id at revision rev_id in branch.
50
 
 
51
 
    The branch should already be read_locked() when annotate_file is called.
52
 
 
53
 
    :param branch: The branch to look for revision numbers and history from.
54
 
    :param rev_id: The revision id to annotate.
55
 
    :param file_id: The file_id to annotate.
56
 
    :param verbose: Show all details rather than truncating to ensure
57
 
        reasonable text width.
58
 
    :param full: XXXX Not sure what this does.
59
 
    :param to_file: The file to output the annotation to; if None stdout is
60
 
        used.
61
 
    :param show_ids: Show revision ids in the annotation output.
62
 
    """
63
 
    if to_file is None:
64
 
        to_file = sys.stdout
65
 
 
66
 
    # Handle the show_ids case
67
 
    annotations = _annotations(branch.repository, file_id, rev_id)
68
 
    if show_ids:
69
 
        return _show_id_annotations(annotations, to_file, full)
70
 
 
71
 
    # Calculate the lengths of the various columns
72
 
    annotation = list(_expand_annotations(annotations, branch))
73
 
    _print_annotations(annotation, verbose, to_file, full)
 
46
from bzrlib.revision import (
 
47
    CURRENT_REVISION,
 
48
    Revision,
 
49
    )
74
50
 
75
51
 
76
52
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
77
 
    show_ids=False):
 
53
    show_ids=False, branch=None):
78
54
    """Annotate file_id in a tree.
79
55
 
80
56
    The tree should already be read_locked() when annotate_file_tree is called.
86
62
        reasonable text width.
87
63
    :param full: XXXX Not sure what this does.
88
64
    :param show_ids: Show revision ids in the annotation output.
 
65
    :param branch: Branch to use for revision revno lookups
89
66
    """
90
 
    rev_id = tree.last_revision()
91
 
    branch = tree.branch
 
67
    if branch is None:
 
68
        branch = tree.branch
 
69
    if to_file is None:
 
70
        to_file = sys.stdout
92
71
 
93
72
    # Handle the show_ids case
94
73
    annotations = list(tree.annotate_iter(file_id))
95
74
    if show_ids:
96
75
        return _show_id_annotations(annotations, to_file, full)
97
76
 
98
 
    # Create a virtual revision to represent the current tree state.
99
 
    # Should get some more pending commit attributes, like pending tags,
100
 
    # bugfixes etc.
101
 
    current_rev = Revision(CURRENT_REVISION)
102
 
    current_rev.parent_ids = tree.get_parent_ids()
103
 
    current_rev.committer = tree.branch.get_config().username()
104
 
    current_rev.message = "?"
105
 
    current_rev.timestamp = round(time.time(), 3)
106
 
    current_rev.timezone = osutils.local_time_offset()
107
 
    annotation = list(_expand_annotations(annotations, tree.branch,
 
77
    if not getattr(tree, "get_revision_id", False):
 
78
        # Create a virtual revision to represent the current tree state.
 
79
        # Should get some more pending commit attributes, like pending tags,
 
80
        # bugfixes etc.
 
81
        current_rev = Revision(CURRENT_REVISION)
 
82
        current_rev.parent_ids = tree.get_parent_ids()
 
83
        try:
 
84
            current_rev.committer = branch.get_config_stack().get('email')
 
85
        except errors.NoWhoami:
 
86
            current_rev.committer = 'local user'
 
87
        current_rev.message = "?"
 
88
        current_rev.timestamp = round(time.time(), 3)
 
89
        current_rev.timezone = osutils.local_time_offset()
 
90
    else:
 
91
        current_rev = None
 
92
    annotation = list(_expand_annotations(annotations, branch,
108
93
        current_rev))
109
94
    _print_annotations(annotation, verbose, to_file, full)
110
95
 
170
155
    return
171
156
 
172
157
 
173
 
def _annotations(repo, file_id, rev_id):
174
 
    """Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
175
 
    annotations = repo.texts.annotate((file_id, rev_id))
176
 
    #
177
 
    return [(key[-1], line) for (key, line) in annotations]
178
 
 
179
 
 
180
158
def _expand_annotations(annotations, branch, current_rev=None):
181
159
    """Expand a file's annotations into command line UI ready tuples.
182
160
 
189
167
    """
190
168
    repository = branch.repository
191
169
    if current_rev is not None:
192
 
        # This can probably become a function on MutableTree, get_revno_map there,
193
 
        # or something.
 
170
        # This can probably become a function on MutableTree, get_revno_map
 
171
        # there, or something.
194
172
        last_revision = current_rev.revision_id
195
173
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
196
174
        # XXX: The main difficulty is that we need to inject a single new node