/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/status.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/status.py
16
16
 
17
17
import sys
18
18
 
19
 
from bzrlib import (
 
19
from . import (
20
20
    delta as _mod_delta,
 
21
    hooks as _mod_hooks,
21
22
    log,
22
23
    osutils,
23
24
    tsort,
24
25
    revision as _mod_revision,
25
26
    )
26
 
import bzrlib.errors as errors
27
 
from bzrlib.trace import mutter, warning
 
27
from . import errors as errors
 
28
from .trace import mutter, warning
 
29
from .workingtree import ShelvingUnsupported
 
30
 
28
31
 
29
32
# TODO: when showing single-line logs, truncate to the width of the terminal
30
33
# if known, but only if really going to the terminal (not into a file)
31
34
 
32
35
 
33
 
def report_changes(to_file, old, new, specific_files, 
34
 
                   show_short_reporter, show_long_callback, 
35
 
                   short=False, want_unchanged=False, 
36
 
                   want_unversioned=False, show_ids=False):
 
36
def report_changes(to_file, old, new, specific_files,
 
37
                   show_short_reporter, show_long_callback,
 
38
                   short=False, want_unchanged=False,
 
39
                   want_unversioned=False, show_ids=False, classify=True):
37
40
    """Display summary of changes.
38
41
 
39
 
    This compares two trees with regards to a list of files, and delegates 
 
42
    This compares two trees with regards to a list of files, and delegates
40
43
    the display to underlying elements.
41
44
 
42
45
    For short output, it creates an iterator on all changes, and lets a given
58
61
        files.
59
62
    :param show_ids: If set, includes each file's id.
60
63
    :param want_unversioned: If False, only shows versioned files.
 
64
    :param classify: Add special symbols to indicate file kind.
61
65
    """
62
66
 
63
67
    if short:
64
68
        changes = new.iter_changes(old, want_unchanged, specific_files,
65
 
            require_versioned=False, want_unversioned=want_unversioned)
 
69
                                   require_versioned=False, want_unversioned=want_unversioned)
66
70
        _mod_delta.report_changes(changes, show_short_reporter)
67
 
        
68
71
    else:
69
72
        delta = new.changes_from(old, want_unchanged=want_unchanged,
70
 
                              specific_files=specific_files,
71
 
                              want_unversioned=want_unversioned)
 
73
                                 specific_files=specific_files,
 
74
                                 want_unversioned=want_unversioned)
72
75
        # filter out unknown files. We may want a tree method for
73
76
        # this
74
 
        delta.unversioned = [unversioned for unversioned in
75
 
            delta.unversioned if not new.is_ignored(unversioned[0])]
76
 
        show_long_callback(to_file, delta, 
 
77
        delta.unversioned = [change for change in delta.unversioned
 
78
                             if not new.is_ignored(change.path[1])]
 
79
        show_long_callback(to_file, delta,
77
80
                           show_ids=show_ids,
78
 
                           show_unchanged=want_unchanged)
79
 
 
80
 
 
81
 
def show_tree_status(wt, show_unchanged=None,
 
81
                           show_unchanged=want_unchanged,
 
82
                           classify=classify)
 
83
 
 
84
 
 
85
def show_tree_status(wt,
82
86
                     specific_files=None,
83
87
                     show_ids=False,
84
88
                     to_file=None,
87
91
                     short=False,
88
92
                     verbose=False,
89
93
                     versioned=False,
 
94
                     classify=True,
90
95
                     show_long_callback=_mod_delta.report_delta):
91
96
    """Display summary of changes.
92
97
 
100
105
    If showing the status of a working tree, extra information is included
101
106
    about unknown files, conflicts, and pending merges.
102
107
 
103
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
104
 
        files.
105
108
    :param specific_files: If set, a list of filenames whose status should be
106
109
        shown.  It is an error to give a filename that is not in the working
107
110
        tree, or in the working inventory or in the basis inventory.
116
119
    :param verbose: If True, show all merged revisions, not just
117
120
        the merge tips
118
121
    :param versioned: If True, only shows versioned files.
119
 
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
 
122
    :param classify: Add special symbols to indicate file kind.
 
123
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta,
120
124
        show_ids, show_unchanged, indent, filter), only used with the long output
121
125
    """
122
 
    if show_unchanged is not None:
123
 
        warn("show_tree_status with show_unchanged has been deprecated "
124
 
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
125
 
 
126
126
    if to_file is None:
127
127
        to_file = sys.stdout
128
128
 
129
 
    wt.lock_read()
130
 
    try:
 
129
    with wt.lock_read():
131
130
        new_is_working_tree = True
132
131
        if revision is None:
133
132
            if wt.last_revision() != wt.branch.last_revision():
134
 
                warning("working tree is out of date, run 'bzr update'")
 
133
                warning("working tree is out of date, run 'brz update'")
135
134
            new = wt
136
135
            old = new.basis_tree()
137
136
        elif len(revision) > 0:
138
137
            try:
139
138
                old = revision[0].as_tree(wt.branch)
140
 
            except errors.NoSuchRevision, e:
141
 
                raise errors.BzrCommandError(str(e))
 
139
            except errors.NoSuchRevision as e:
 
140
                raise errors.CommandError(str(e))
142
141
            if (len(revision) > 1) and (revision[1].spec is not None):
143
142
                try:
144
143
                    new = revision[1].as_tree(wt.branch)
145
144
                    new_is_working_tree = False
146
 
                except errors.NoSuchRevision, e:
147
 
                    raise errors.BzrCommandError(str(e))
 
145
                except errors.NoSuchRevision as e:
 
146
                    raise errors.CommandError(str(e))
148
147
            else:
149
148
                new = wt
150
 
        old.lock_read()
151
 
        new.lock_read()
152
 
        try:
 
149
        with old.lock_read(), new.lock_read():
 
150
            for hook in hooks['pre_status']:
 
151
                hook(StatusHookParams(
 
152
                    old, new, to_file, versioned, show_ids, short, verbose,
 
153
                    specific_files=specific_files))
 
154
 
153
155
            specific_files, nonexistents \
154
156
                = _filter_nonexistent(specific_files, old, new)
155
157
            want_unversioned = not versioned
156
158
 
157
159
            # Reporter used for short outputs
158
 
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
159
 
                unversioned_filter=new.is_ignored)
160
 
            report_changes(to_file, old, new, specific_files, 
161
 
                           reporter, show_long_callback, 
162
 
                           short=short, want_unchanged=show_unchanged, 
163
 
                           want_unversioned=want_unversioned, show_ids=show_ids)
 
160
            reporter = _mod_delta._ChangeReporter(
 
161
                output_file=to_file, unversioned_filter=new.is_ignored,
 
162
                classify=classify)
 
163
            report_changes(to_file, old, new, specific_files,
 
164
                           reporter, show_long_callback,
 
165
                           short=short, want_unversioned=want_unversioned,
 
166
                           show_ids=show_ids, classify=classify)
164
167
 
165
168
            # show the ignored files among specific files (i.e. show the files
166
 
            # identified from input that we choose to ignore). 
 
169
            # identified from input that we choose to ignore).
167
170
            if specific_files is not None:
168
171
                # Ignored files is sorted because specific_files is already sorted
169
172
                ignored_files = [specific for specific in
170
 
                    specific_files if new.is_ignored(specific)]
 
173
                                 specific_files if new.is_ignored(specific)]
171
174
                if len(ignored_files) > 0 and not short:
172
175
                    to_file.write("ignored:\n")
173
176
                    prefix = ' '
180
183
            # delta.
181
184
            conflicts = new.conflicts()
182
185
            if specific_files is not None:
183
 
                conflicts = conflicts.select_conflicts(new, specific_files,
184
 
                    ignore_misses=True, recurse=True)[1]
 
186
                conflicts = conflicts.select_conflicts(
 
187
                    new, specific_files, ignore_misses=True, recurse=True)[1]
185
188
            if len(conflicts) > 0 and not short:
186
189
                to_file.write("conflicts:\n")
187
190
            for conflict in conflicts:
189
192
                    prefix = 'C  '
190
193
                else:
191
194
                    prefix = ' '
192
 
                to_file.write("%s %s\n" % (prefix, conflict))
 
195
                to_file.write("%s %s\n" % (prefix, conflict.describe()))
193
196
            # Show files that were requested but don't exist (and are
194
197
            # not versioned).  We don't involve delta in this; these
195
198
            # paths are really the province of just the status
210
213
                show_pending_merges(new, to_file, short, verbose=verbose)
211
214
            if nonexistents:
212
215
                raise errors.PathsDoNotExist(nonexistents)
213
 
        finally:
214
 
            old.unlock()
215
 
            new.unlock()
216
 
    finally:
217
 
        wt.unlock()
 
216
            for hook in hooks['post_status']:
 
217
                hook(StatusHookParams(
 
218
                    old, new, to_file, versioned, show_ids, short, verbose,
 
219
                    specific_files=specific_files))
218
220
 
219
221
 
220
222
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
233
235
    # of any references pointing outside of this graph.
234
236
    parent_graph = {}
235
237
    for revision_id in revision_ids:
236
 
        if revision_id not in parent_map: # ghost
 
238
        if revision_id not in parent_map:  # ghost
237
239
            parent_graph[revision_id] = []
238
240
        else:
239
241
            # Only include parents which are in this sub-graph
240
242
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
241
 
                                            if p in revision_ids]
 
243
                                         if p in revision_ids]
242
244
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
243
245
    return sorter.iter_topo_order()
244
246
 
282
284
    log_formatter = log.LineLogFormatter(to_file)
283
285
    for merge in pending:
284
286
        try:
285
 
            rev = branch.repository.get_revisions([merge])[0]
 
287
            rev = branch.repository.get_revision(merge)
286
288
        except errors.NoSuchRevision:
287
289
            # If we are missing a revision, just print out the revision id
288
 
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
290
            to_file.write(first_prefix + '(ghost) ' +
 
291
                          merge.decode('utf-8') + '\n')
289
292
            other_revisions.append(merge)
290
293
            continue
291
294
 
301
304
        merge_extra.discard(_mod_revision.NULL_REVISION)
302
305
 
303
306
        # Get a handle to all of the revisions we will need
304
 
        try:
305
 
            revisions = dict((rev.revision_id, rev) for rev in
306
 
                             branch.repository.get_revisions(merge_extra))
307
 
        except errors.NoSuchRevision:
308
 
            # One of the sub nodes is a ghost, check each one
309
 
            revisions = {}
310
 
            for revision_id in merge_extra:
311
 
                try:
312
 
                    rev = branch.repository.get_revisions([revision_id])[0]
313
 
                except errors.NoSuchRevision:
314
 
                    revisions[revision_id] = None
315
 
                else:
316
 
                    revisions[revision_id] = rev
 
307
        revisions = dict(branch.repository.iter_revisions(merge_extra))
317
308
 
318
309
        # Display the revisions brought in by this merge.
319
310
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
320
 
                            branch.repository.get_parent_map(merge_extra))
 
311
                                                branch.repository.get_parent_map(merge_extra))
321
312
        # Skip the first node
322
 
        num, first, depth, eom = rev_id_iterator.next()
 
313
        num, first, depth, eom = next(rev_id_iterator)
323
314
        if first != merge:
324
315
            raise AssertionError('Somehow we misunderstood how'
325
 
                ' iter_topo_order works %s != %s' % (first, merge))
 
316
                                 ' iter_topo_order works %s != %s' % (first, merge))
326
317
        for num, sub_merge, depth, eom in rev_id_iterator:
327
318
            rev = revisions[sub_merge]
328
319
            if rev is None:
329
 
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
320
                to_file.write(sub_prefix + '(ghost) ' +
 
321
                              sub_merge.decode('utf-8') + '\n')
330
322
                continue
331
323
            show_log_message(revisions[sub_merge], sub_prefix)
332
324
 
341
333
 
342
334
    If either of the two lists is empty, return it as an empty list.
343
335
 
344
 
    This can be used by operations such as bzr status that can accept
 
336
    This can be used by operations such as brz status that can accept
345
337
    unknown or ignored files.
346
338
    """
347
339
    mutter("check paths: %r", orig_paths)
350
342
    s = old_tree.filter_unversioned_files(orig_paths)
351
343
    s = new_tree.filter_unversioned_files(s)
352
344
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
353
 
    remaining   = [path for path in orig_paths if not path in nonexistent]
 
345
    remaining = [path for path in orig_paths if path not in nonexistent]
354
346
    # Sorting the 'remaining' list doesn't have much effect in
355
347
    # practice, since the various status output sections will sort
356
348
    # their groups individually.  But for consistency of this
357
349
    # function's API, it's better to sort both than just 'nonexistent'.
358
350
    return sorted(remaining), sorted(nonexistent)
 
351
 
 
352
 
 
353
class StatusHooks(_mod_hooks.Hooks):
 
354
    """A dictionary mapping hook name to a list of callables for status hooks.
 
355
 
 
356
    e.g. ['post_status'] Is the list of items to be called when the
 
357
    status command has finished printing the status.
 
358
    """
 
359
 
 
360
    def __init__(self):
 
361
        """Create the default hooks.
 
362
 
 
363
        These are all empty initially, because by default nothing should get
 
364
        notified.
 
365
        """
 
366
        _mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
 
367
        self.add_hook(
 
368
            'post_status',
 
369
            "Called with argument StatusHookParams after Bazaar has "
 
370
            "displayed the status. StatusHookParams has the attributes "
 
371
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
372
            "verbose). The last four arguments correspond to the command "
 
373
            "line options specified by the user for the status command. "
 
374
            "to_file is the output stream for writing.",
 
375
            (2, 3))
 
376
        self.add_hook(
 
377
            'pre_status',
 
378
            "Called with argument StatusHookParams before Bazaar "
 
379
            "displays the status. StatusHookParams has the attributes "
 
380
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
381
            "verbose). The last four arguments correspond to the command "
 
382
            "line options specified by the user for the status command. "
 
383
            "to_file is the output stream for writing.",
 
384
            (2, 3))
 
385
 
 
386
 
 
387
class StatusHookParams(object):
 
388
    """Object holding parameters passed to post_status hooks.
 
389
 
 
390
    :ivar old_tree: Start tree (basis tree) for comparison.
 
391
    :ivar new_tree: Working tree.
 
392
    :ivar to_file: If set, write to this file.
 
393
    :ivar versioned: Show only versioned files.
 
394
    :ivar show_ids: Show internal object ids.
 
395
    :ivar short: Use short status indicators.
 
396
    :ivar verbose: Verbose flag.
 
397
    """
 
398
 
 
399
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
 
400
                 short, verbose, specific_files=None):
 
401
        """Create a group of post_status hook parameters.
 
402
 
 
403
        :param old_tree: Start tree (basis tree) for comparison.
 
404
        :param new_tree: Working tree.
 
405
        :param to_file: If set, write to this file.
 
406
        :param versioned: Show only versioned files.
 
407
        :param show_ids: Show internal object ids.
 
408
        :param short: Use short status indicators.
 
409
        :param verbose: Verbose flag.
 
410
        :param specific_files: If set, a list of filenames whose status should be
 
411
            shown.  It is an error to give a filename that is not in the
 
412
            working tree, or in the working inventory or in the basis inventory.
 
413
        """
 
414
        self.old_tree = old_tree
 
415
        self.new_tree = new_tree
 
416
        self.to_file = to_file
 
417
        self.versioned = versioned
 
418
        self.show_ids = show_ids
 
419
        self.short = short
 
420
        self.verbose = verbose
 
421
        self.specific_files = specific_files
 
422
 
 
423
    def __eq__(self, other):
 
424
        return self.__dict__ == other.__dict__
 
425
 
 
426
    def __repr__(self):
 
427
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (
 
428
            self.__class__.__name__, self.old_tree, self.new_tree,
 
429
            self.to_file, self.versioned, self.show_ids, self.short,
 
430
            self.verbose, self.specific_files)
 
431
 
 
432
 
 
433
def _show_shelve_summary(params):
 
434
    """post_status hook to display a summary of shelves.
 
435
 
 
436
    :param params: StatusHookParams.
 
437
    """
 
438
    # Don't show shelves if status of specific files is being shown, only if
 
439
    # no file arguments have been passed
 
440
    if params.specific_files:
 
441
        return
 
442
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
 
443
    if get_shelf_manager is None:
 
444
        return
 
445
    try:
 
446
        manager = get_shelf_manager()
 
447
    except ShelvingUnsupported:
 
448
        mutter('shelving not supported by tree, not displaying shelves.')
 
449
    else:
 
450
        shelves = manager.active_shelves()
 
451
        if shelves:
 
452
            singular = '%d shelf exists. '
 
453
            plural = '%d shelves exist. '
 
454
            if len(shelves) == 1:
 
455
                fmt = singular
 
456
            else:
 
457
                fmt = plural
 
458
            params.to_file.write(fmt % len(shelves))
 
459
            params.to_file.write('See "brz shelve --list" for details.\n')
 
460
 
 
461
 
 
462
hooks = StatusHooks()
 
463
 
 
464
 
 
465
hooks.install_named_hook('post_status', _show_shelve_summary,
 
466
                         'brz status')