← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

terminal_width can now returns None.

* bzrlib/win32utils.py:
(get_console_size): Fix typo in comment.

* bzrlib/ui/text.py:
(TextProgressView._show_line): Handle the no terminal present case.

* bzrlib/tests/test_osutils.py:
(TestTerminalWidth): Update tests.

* bzrlib/tests/blackbox/test_too_much.py:
Fix some imports.
(OldTests.test_bzr): Handle the no terminal present case.

* bzrlib/tests/__init__.py:
(VerboseTestResult.report_test_start): Handle the no terminal
present case.

* bzrlib/status.py:
(show_pending_merges): Handle the no terminal present case.
(show_pending_merges.show_log_message): Factor out some
code. Handle the no terminal present case.

* bzrlib/osutils.py:
(terminal_width): Return None if no precise value can be found.

* bzrlib/log.py:
(LineLogFormatter.__init__): Handle the no terminal present case.
(LineLogFormatter.truncate): Accept None as max_len meaning no
truncation.
(LineLogFormatter.log_string): 

* bzrlib/help.py:
(_help_commands_to_text): Handle the no terminal present case.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
 
62
    revision,
55
63
    trace,
56
64
    tree,
57
 
    ui,
 
65
    xml_serializer,
58
66
    )
59
67
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
68
import bzrlib.config
62
69
from bzrlib.errors import (BzrError, PointlessCommit,
63
70
                           ConflictsInTree,
64
71
                           StrictCommitFailed
65
72
                           )
66
73
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
 
74
                            kind_marker, isdir,isfile, is_inside_any,
 
75
                            is_inside_or_parent_of_any,
68
76
                            minimum_path_selection,
 
77
                            quotefn, sha_file, split_lines,
69
78
                            splitpath,
70
79
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
 
80
from bzrlib.testament import Testament
 
81
from bzrlib.trace import mutter, note, warning, is_quiet
72
82
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
83
from bzrlib import symbol_versioning
 
84
from bzrlib.symbol_versioning import (deprecated_passed,
 
85
        deprecated_function,
 
86
        DEPRECATED_PARAMETER)
 
87
from bzrlib.workingtree import WorkingTree
74
88
from bzrlib.urlutils import unescape_for_display
 
89
import bzrlib.ui
75
90
 
76
91
 
77
92
class NullCommitReporter(object):
131
146
 
132
147
    def completed(self, revno, rev_id):
133
148
        self._note('Committed revision %d.', revno)
134
 
        # self._note goes to the console too; so while we want to log the
135
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
136
 
        # term we should rearrange the reporting structure, but for now
137
 
        # we just mutter seperately. We mutter the revid and revno together
138
 
        # so that concurrent bzr invocations won't lead to confusion.
139
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
140
149
 
141
150
    def deleted(self, path):
142
151
        self._note('deleted %s', path)
173
182
        self.reporter = reporter
174
183
        self.config = config
175
184
 
176
 
    @staticmethod
177
 
    def update_revprops(revprops, branch, authors=None, author=None,
178
 
                        local=False, possible_master_transports=None):
179
 
        if revprops is None:
180
 
            revprops = {}
181
 
        if possible_master_transports is None:
182
 
            possible_master_transports = []
183
 
        if not 'branch-nick' in revprops:
184
 
            revprops['branch-nick'] = branch._get_nick(
185
 
                local,
186
 
                possible_master_transports)
187
 
        if authors is not None:
188
 
            if author is not None:
189
 
                raise AssertionError('Specifying both author and authors '
190
 
                        'is not allowed. Specify just authors instead')
191
 
            if 'author' in revprops or 'authors' in revprops:
192
 
                # XXX: maybe we should just accept one of them?
193
 
                raise AssertionError('author property given twice')
194
 
            if authors:
195
 
                for individual in authors:
196
 
                    if '\n' in individual:
197
 
                        raise AssertionError('\\n is not a valid character '
198
 
                                'in an author identity')
199
 
                revprops['authors'] = '\n'.join(authors)
200
 
        if author is not None:
201
 
            symbol_versioning.warn('The parameter author was deprecated'
202
 
                   ' in version 1.13. Use authors instead',
203
 
                   DeprecationWarning)
204
 
            if 'author' in revprops or 'authors' in revprops:
205
 
                # XXX: maybe we should just accept one of them?
206
 
                raise AssertionError('author property given twice')
207
 
            if '\n' in author:
208
 
                raise AssertionError('\\n is not a valid character '
209
 
                        'in an author identity')
210
 
            revprops['authors'] = author
211
 
        return revprops
212
 
 
213
185
    def commit(self,
214
186
               message=None,
215
187
               timestamp=None,
228
200
               message_callback=None,
229
201
               recursive='down',
230
202
               exclude=None,
231
 
               possible_master_transports=None,
232
 
               lossy=False):
 
203
               possible_master_transports=None):
233
204
        """Commit working copy as a new revision.
234
205
 
235
206
        :param message: the commit message (it or message_callback is required)
262
233
        :param exclude: None or a list of relative paths to exclude from the
263
234
            commit. Pending changes to excluded files will be ignored by the
264
235
            commit.
265
 
        :param lossy: When committing to a foreign VCS, ignore any
266
 
            data that can not be natively represented.
267
236
        """
268
 
        operation = OperationWithCleanups(self._commit)
269
 
        self.revprops = revprops or {}
270
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
271
 
        self.config = config or self.config
272
 
        return operation.run(
273
 
               message=message,
274
 
               timestamp=timestamp,
275
 
               timezone=timezone,
276
 
               committer=committer,
277
 
               specific_files=specific_files,
278
 
               rev_id=rev_id,
279
 
               allow_pointless=allow_pointless,
280
 
               strict=strict,
281
 
               verbose=verbose,
282
 
               working_tree=working_tree,
283
 
               local=local,
284
 
               reporter=reporter,
285
 
               message_callback=message_callback,
286
 
               recursive=recursive,
287
 
               exclude=exclude,
288
 
               possible_master_transports=possible_master_transports,
289
 
               lossy=lossy)
290
 
 
291
 
    def _commit(self, operation, message, timestamp, timezone, committer,
292
 
            specific_files, rev_id, allow_pointless, strict, verbose,
293
 
            working_tree, local, reporter, message_callback, recursive,
294
 
            exclude, possible_master_transports, lossy):
295
237
        mutter('preparing to commit')
296
238
 
297
239
        if working_tree is None:
320
262
            self.exclude = []
321
263
        self.local = local
322
264
        self.master_branch = None
 
265
        self.master_locked = False
323
266
        self.recursive = recursive
324
267
        self.rev_id = None
325
268
        # self.specific_files is None to indicate no filter, or any iterable to
329
272
                minimum_path_selection(specific_files))
330
273
        else:
331
274
            self.specific_files = None
332
 
 
 
275
            
333
276
        self.allow_pointless = allow_pointless
 
277
        self.revprops = revprops
334
278
        self.message_callback = message_callback
335
279
        self.timestamp = timestamp
336
280
        self.timezone = timezone
339
283
        self.verbose = verbose
340
284
 
341
285
        self.work_tree.lock_write()
342
 
        operation.add_cleanup(self.work_tree.unlock)
343
286
        self.parents = self.work_tree.get_parent_ids()
344
287
        # We can use record_iter_changes IFF iter_changes is compatible with
345
288
        # the command line parameters, and the repository has fast delta
349
292
            not self.branch.repository._format.supports_tree_reference and
350
293
            (self.branch.repository._format.fast_deltas or
351
294
             len(self.parents) < 2))
352
 
        self.pb = ui.ui_factory.nested_progress_bar()
353
 
        operation.add_cleanup(self.pb.finished)
 
295
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
354
296
        self.basis_revid = self.work_tree.last_revision()
355
297
        self.basis_tree = self.work_tree.basis_tree()
356
298
        self.basis_tree.lock_read()
357
 
        operation.add_cleanup(self.basis_tree.unlock)
358
 
        # Cannot commit with conflicts present.
359
 
        if len(self.work_tree.conflicts()) > 0:
360
 
            raise ConflictsInTree
361
 
 
362
 
        # Setup the bound branch variables as needed.
363
 
        self._check_bound_branch(operation, possible_master_transports)
364
 
 
365
 
        # Check that the working tree is up to date
366
 
        old_revno, new_revno = self._check_out_of_date_tree()
367
 
 
368
 
        # Complete configuration setup
369
 
        if reporter is not None:
370
 
            self.reporter = reporter
371
 
        elif self.reporter is None:
372
 
            self.reporter = self._select_reporter()
373
 
        if self.config is None:
374
 
            self.config = self.branch.get_config()
375
 
 
376
 
        self._set_specific_file_ids()
377
 
 
378
 
        # Setup the progress bar. As the number of files that need to be
379
 
        # committed in unknown, progress is reported as stages.
380
 
        # We keep track of entries separately though and include that
381
 
        # information in the progress bar during the relevant stages.
382
 
        self.pb_stage_name = ""
383
 
        self.pb_stage_count = 0
384
 
        self.pb_stage_total = 5
385
 
        if self.bound_branch:
386
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
387
 
            # tags to master branch"
388
 
            self.pb_stage_total += 2
389
 
        self.pb.show_pct = False
390
 
        self.pb.show_spinner = False
391
 
        self.pb.show_eta = False
392
 
        self.pb.show_count = True
393
 
        self.pb.show_bar = True
394
 
 
395
 
        self._gather_parents()
396
 
        # After a merge, a selected file commit is not supported.
397
 
        # See 'bzr help merge' for an explanation as to why.
398
 
        if len(self.parents) > 1 and self.specific_files is not None:
399
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
400
 
        # Excludes are a form of selected file commit.
401
 
        if len(self.parents) > 1 and self.exclude:
402
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
403
 
 
404
 
        # Collect the changes
405
 
        self._set_progress_stage("Collecting changes", counter=True)
406
 
        self._lossy = lossy
407
 
        self.builder = self.branch.get_commit_builder(self.parents,
408
 
            self.config, timestamp, timezone, committer, self.revprops,
409
 
            rev_id, lossy=lossy)
410
 
        if not self.builder.supports_record_entry_contents and self.exclude:
411
 
            self.builder.abort()
412
 
            raise errors.ExcludesUnsupported(self.branch.repository)
413
 
 
414
299
        try:
415
 
            self.builder.will_record_deletes()
416
 
            # find the location being committed to
417
 
            if self.bound_branch:
418
 
                master_location = self.master_branch.base
419
 
            else:
420
 
                master_location = self.branch.base
421
 
 
422
 
            # report the start of the commit
423
 
            self.reporter.started(new_revno, self.rev_id, master_location)
424
 
 
425
 
            self._update_builder_with_changes()
426
 
            self._check_pointless()
427
 
 
428
 
            # TODO: Now the new inventory is known, check for conflicts.
429
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
430
 
            # weave lines, because nothing should be recorded until it is known
431
 
            # that commit will succeed.
432
 
            self._set_progress_stage("Saving data locally")
433
 
            self.builder.finish_inventory()
434
 
 
435
 
            # Prompt the user for a commit message if none provided
436
 
            message = message_callback(self)
437
 
            self.message = message
438
 
 
439
 
            # Add revision data to the local branch
440
 
            self.rev_id = self.builder.commit(self.message)
441
 
 
442
 
        except Exception, e:
443
 
            mutter("aborting commit write group because of exception:")
444
 
            trace.log_exception_quietly()
445
 
            self.builder.abort()
446
 
            raise
447
 
 
448
 
        self._process_pre_hooks(old_revno, new_revno)
449
 
 
450
 
        # Upload revision data to the master.
451
 
        # this will propagate merged revisions too if needed.
452
 
        if self.bound_branch:
453
 
            self._set_progress_stage("Uploading data to master branch")
454
 
            # 'commit' to the master first so a timeout here causes the
455
 
            # local branch to be out of date
456
 
            (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
457
 
                self.branch, new_revno, self.rev_id, lossy=lossy)
458
 
            if lossy:
459
 
                self.branch.fetch(self.master_branch, self.rev_id)
460
 
 
461
 
        # and now do the commit locally.
462
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
463
 
 
464
 
        # Merge local tags to remote
465
 
        if self.bound_branch:
466
 
            self._set_progress_stage("Merging tags to master branch")
467
 
            tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
468
 
            if tag_conflicts:
469
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
470
 
                note("Conflicting tags in bound branch:\n" +
471
 
                    "\n".join(warning_lines))
472
 
 
473
 
        # Make the working tree be up to date with the branch. This
474
 
        # includes automatic changes scheduled to be made to the tree, such
475
 
        # as updating its basis and unversioning paths that were missing.
476
 
        self.work_tree.unversion(self.deleted_ids)
477
 
        self._set_progress_stage("Updating the working tree")
478
 
        self.work_tree.update_basis_by_delta(self.rev_id,
479
 
             self.builder.get_basis_delta())
480
 
        self.reporter.completed(new_revno, self.rev_id)
481
 
        self._process_post_hooks(old_revno, new_revno)
 
300
            # Cannot commit with conflicts present.
 
301
            if len(self.work_tree.conflicts()) > 0:
 
302
                raise ConflictsInTree
 
303
 
 
304
            # Setup the bound branch variables as needed.
 
305
            self._check_bound_branch(possible_master_transports)
 
306
 
 
307
            # Check that the working tree is up to date
 
308
            old_revno, new_revno = self._check_out_of_date_tree()
 
309
 
 
310
            # Complete configuration setup
 
311
            if reporter is not None:
 
312
                self.reporter = reporter
 
313
            elif self.reporter is None:
 
314
                self.reporter = self._select_reporter()
 
315
            if self.config is None:
 
316
                self.config = self.branch.get_config()
 
317
 
 
318
            self._set_specific_file_ids()
 
319
 
 
320
            # Setup the progress bar. As the number of files that need to be
 
321
            # committed in unknown, progress is reported as stages.
 
322
            # We keep track of entries separately though and include that
 
323
            # information in the progress bar during the relevant stages.
 
324
            self.pb_stage_name = ""
 
325
            self.pb_stage_count = 0
 
326
            self.pb_stage_total = 5
 
327
            if self.bound_branch:
 
328
                self.pb_stage_total += 1
 
329
            self.pb.show_pct = False
 
330
            self.pb.show_spinner = False
 
331
            self.pb.show_eta = False
 
332
            self.pb.show_count = True
 
333
            self.pb.show_bar = True
 
334
 
 
335
            self._gather_parents()
 
336
            # After a merge, a selected file commit is not supported.
 
337
            # See 'bzr help merge' for an explanation as to why.
 
338
            if len(self.parents) > 1 and self.specific_files is not None:
 
339
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
340
            # Excludes are a form of selected file commit.
 
341
            if len(self.parents) > 1 and self.exclude:
 
342
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
343
 
 
344
            # Collect the changes
 
345
            self._set_progress_stage("Collecting changes", counter=True)
 
346
            self.builder = self.branch.get_commit_builder(self.parents,
 
347
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
348
 
 
349
            try:
 
350
                self.builder.will_record_deletes()
 
351
                # find the location being committed to
 
352
                if self.bound_branch:
 
353
                    master_location = self.master_branch.base
 
354
                else:
 
355
                    master_location = self.branch.base
 
356
 
 
357
                # report the start of the commit
 
358
                self.reporter.started(new_revno, self.rev_id, master_location)
 
359
 
 
360
                self._update_builder_with_changes()
 
361
                self._check_pointless()
 
362
 
 
363
                # TODO: Now the new inventory is known, check for conflicts.
 
364
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
365
                # weave lines, because nothing should be recorded until it is known
 
366
                # that commit will succeed.
 
367
                self._set_progress_stage("Saving data locally")
 
368
                self.builder.finish_inventory()
 
369
 
 
370
                # Prompt the user for a commit message if none provided
 
371
                message = message_callback(self)
 
372
                self.message = message
 
373
 
 
374
                # Add revision data to the local branch
 
375
                self.rev_id = self.builder.commit(self.message)
 
376
 
 
377
            except Exception, e:
 
378
                mutter("aborting commit write group because of exception:")
 
379
                trace.log_exception_quietly()
 
380
                note("aborting commit write group: %r" % (e,))
 
381
                self.builder.abort()
 
382
                raise
 
383
 
 
384
            self._process_pre_hooks(old_revno, new_revno)
 
385
 
 
386
            # Upload revision data to the master.
 
387
            # this will propagate merged revisions too if needed.
 
388
            if self.bound_branch:
 
389
                self._set_progress_stage("Uploading data to master branch")
 
390
                # 'commit' to the master first so a timeout here causes the
 
391
                # local branch to be out of date
 
392
                self.master_branch.import_last_revision_info(
 
393
                    self.branch.repository, new_revno, self.rev_id)
 
394
 
 
395
            # and now do the commit locally.
 
396
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
397
 
 
398
            # Make the working tree be up to date with the branch. This
 
399
            # includes automatic changes scheduled to be made to the tree, such
 
400
            # as updating its basis and unversioning paths that were missing.
 
401
            self.work_tree.unversion(self.deleted_ids)
 
402
            self._set_progress_stage("Updating the working tree")
 
403
            self.work_tree.update_basis_by_delta(self.rev_id,
 
404
                 self.builder.get_basis_delta())
 
405
            self.reporter.completed(new_revno, self.rev_id)
 
406
            self._process_post_hooks(old_revno, new_revno)
 
407
        finally:
 
408
            self._cleanup()
482
409
        return self.rev_id
483
410
 
484
411
    def _select_reporter(self):
493
420
        # A merge with no effect on files
494
421
        if len(self.parents) > 1:
495
422
            return
 
423
        # TODO: we could simplify this by using self.builder.basis_delta.
 
424
 
 
425
        # The initial commit adds a root directory, but this in itself is not
 
426
        # a worthwhile commit.
 
427
        if (self.basis_revid == revision.NULL_REVISION and
 
428
            ((self.builder.new_inventory is not None and
 
429
             len(self.builder.new_inventory) == 1) or
 
430
            len(self.builder._basis_delta) == 1)):
 
431
            raise PointlessCommit()
496
432
        if self.builder.any_changes():
497
433
            return
498
434
        raise PointlessCommit()
499
435
 
500
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
436
    def _check_bound_branch(self, possible_master_transports=None):
501
437
        """Check to see if the local branch is bound.
502
438
 
503
439
        If it is bound, then most of the commit will actually be
538
474
        # so grab the lock
539
475
        self.bound_branch = self.branch
540
476
        self.master_branch.lock_write()
541
 
        operation.add_cleanup(self.master_branch.unlock)
 
477
        self.master_locked = True
542
478
 
543
479
    def _check_out_of_date_tree(self):
544
480
        """Check that the working tree is up to date.
629
565
                     old_revno, old_revid, new_revno, self.rev_id,
630
566
                     tree_delta, future_tree)
631
567
 
 
568
    def _cleanup(self):
 
569
        """Cleanup any open locks, progress bars etc."""
 
570
        cleanups = [self._cleanup_bound_branch,
 
571
                    self.basis_tree.unlock,
 
572
                    self.work_tree.unlock,
 
573
                    self.pb.finished]
 
574
        found_exception = None
 
575
        for cleanup in cleanups:
 
576
            try:
 
577
                cleanup()
 
578
            # we want every cleanup to run no matter what.
 
579
            # so we have a catchall here, but we will raise the
 
580
            # last encountered exception up the stack: and
 
581
            # typically this will be useful enough.
 
582
            except Exception, e:
 
583
                found_exception = e
 
584
        if found_exception is not None:
 
585
            # don't do a plan raise, because the last exception may have been
 
586
            # trashed, e is our sure-to-work exception even though it loses the
 
587
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
588
            # exc_info and if its the same one do a plain raise otherwise
 
589
            # 'raise e' as we do now.
 
590
            raise e
 
591
 
 
592
    def _cleanup_bound_branch(self):
 
593
        """Executed at the end of a try/finally to cleanup a bound branch.
 
594
 
 
595
        If the branch wasn't bound, this is a no-op.
 
596
        If it was, it resents self.branch to the local branch, instead
 
597
        of being the master.
 
598
        """
 
599
        if not self.bound_branch:
 
600
            return
 
601
        if self.master_locked:
 
602
            self.master_branch.unlock()
 
603
 
632
604
    def _gather_parents(self):
633
605
        """Record the parents of a merge for merge detection."""
634
606
        # TODO: Make sure that this list doesn't contain duplicate
723
695
        if self.specific_files or self.exclude:
724
696
            specific_files = self.specific_files or []
725
697
            for path, old_ie in self.basis_inv.iter_entries():
726
 
                if self.builder.new_inventory.has_id(old_ie.file_id):
 
698
                if old_ie.file_id in self.builder.new_inventory:
727
699
                    # already added - skip.
728
700
                    continue
729
701
                if (is_inside_any(specific_files, path)