285
283
:param lossy: When committing to a foreign VCS, ignore any
286
284
data that can not be natively represented.
288
with ExitStack() as stack:
289
self.revprops = revprops or {}
290
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
self.config_stack = config or self.config_stack
292
mutter('preparing to commit')
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
297
self.work_tree = working_tree
298
self.branch = self.work_tree.branch
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, bytes):
305
message = message.decode(get_user_encoding())
307
def message_callback(x):
310
raise BzrError("The message or message_callback keyword"
311
" parameter is required for commit().")
313
self.bound_branch = None
314
self.any_entries_deleted = False
315
if exclude is not None:
316
self.exclude = sorted(
317
minimum_path_selection(exclude))
321
self.master_branch = None
322
self.recursive = recursive
324
# self.specific_files is None to indicate no filter, or any iterable to
325
# indicate a filter - [] means no files at all, as per iter_changes.
326
if specific_files is not None:
327
self.specific_files = sorted(
328
minimum_path_selection(specific_files))
330
self.specific_files = None
332
self.allow_pointless = allow_pointless
333
self.message_callback = message_callback
334
self.timestamp = timestamp
335
self.timezone = timezone
336
self.committer = committer
338
self.verbose = verbose
340
stack.enter_context(self.work_tree.lock_write())
341
self.parents = self.work_tree.get_parent_ids()
342
self.pb = ui.ui_factory.nested_progress_bar()
343
stack.callback(self.pb.finished)
344
self.basis_revid = self.work_tree.last_revision()
345
self.basis_tree = self.work_tree.basis_tree()
346
stack.enter_context(self.basis_tree.lock_read())
347
# Cannot commit with conflicts present.
348
if len(self.work_tree.conflicts()) > 0:
349
raise ConflictsInTree
351
# Setup the bound branch variables as needed.
352
self._check_bound_branch(stack, possible_master_transports)
353
if self.config_stack is None:
354
self.config_stack = self.work_tree.get_config_stack()
356
# Check that the working tree is up to date
357
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
359
# Complete configuration setup
360
if reporter is not None:
361
self.reporter = reporter
362
elif self.reporter is None:
363
self.reporter = self._select_reporter()
365
# Setup the progress bar. As the number of files that need to be
366
# committed in unknown, progress is reported as stages.
367
# We keep track of entries separately though and include that
368
# information in the progress bar during the relevant stages.
369
self.pb_stage_name = ""
370
self.pb_stage_count = 0
371
self.pb_stage_total = 5
286
operation = OperationWithCleanups(self._commit)
287
self.revprops = revprops or {}
288
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
self.config_stack = config or self.config_stack
290
return operation.run(
295
specific_files=specific_files,
297
allow_pointless=allow_pointless,
300
working_tree=working_tree,
303
message_callback=message_callback,
306
possible_master_transports=possible_master_transports,
309
def _commit(self, operation, message, timestamp, timezone, committer,
310
specific_files, rev_id, allow_pointless, strict, verbose,
311
working_tree, local, reporter, message_callback, recursive,
312
exclude, possible_master_transports, lossy):
313
mutter('preparing to commit')
315
if working_tree is None:
316
raise BzrError("working_tree must be passed into commit().")
318
self.work_tree = working_tree
319
self.branch = self.work_tree.branch
320
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
321
if not self.branch.repository.supports_rich_root():
322
raise errors.RootNotRich()
323
if message_callback is None:
324
if message is not None:
325
if isinstance(message, bytes):
326
message = message.decode(get_user_encoding())
328
def message_callback(x):
331
raise BzrError("The message or message_callback keyword"
332
" parameter is required for commit().")
334
self.bound_branch = None
335
self.any_entries_deleted = False
336
if exclude is not None:
337
self.exclude = sorted(
338
minimum_path_selection(exclude))
342
self.master_branch = None
343
self.recursive = recursive
345
# self.specific_files is None to indicate no filter, or any iterable to
346
# indicate a filter - [] means no files at all, as per iter_changes.
347
if specific_files is not None:
348
self.specific_files = sorted(
349
minimum_path_selection(specific_files))
351
self.specific_files = None
353
self.allow_pointless = allow_pointless
354
self.message_callback = message_callback
355
self.timestamp = timestamp
356
self.timezone = timezone
357
self.committer = committer
359
self.verbose = verbose
361
self.work_tree.lock_write()
362
operation.add_cleanup(self.work_tree.unlock)
363
self.parents = self.work_tree.get_parent_ids()
364
self.pb = ui.ui_factory.nested_progress_bar()
365
operation.add_cleanup(self.pb.finished)
366
self.basis_revid = self.work_tree.last_revision()
367
self.basis_tree = self.work_tree.basis_tree()
368
self.basis_tree.lock_read()
369
operation.add_cleanup(self.basis_tree.unlock)
370
# Cannot commit with conflicts present.
371
if len(self.work_tree.conflicts()) > 0:
372
raise ConflictsInTree
374
# Setup the bound branch variables as needed.
375
self._check_bound_branch(operation, possible_master_transports)
377
# Check that the working tree is up to date
378
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
380
# Complete configuration setup
381
if reporter is not None:
382
self.reporter = reporter
383
elif self.reporter is None:
384
self.reporter = self._select_reporter()
385
if self.config_stack is None:
386
self.config_stack = self.work_tree.get_config_stack()
388
# Setup the progress bar. As the number of files that need to be
389
# committed in unknown, progress is reported as stages.
390
# We keep track of entries separately though and include that
391
# information in the progress bar during the relevant stages.
392
self.pb_stage_name = ""
393
self.pb_stage_count = 0
394
self.pb_stage_total = 5
395
if self.bound_branch:
396
# 2 extra stages: "Uploading data to master branch" and "Merging
397
# tags to master branch"
398
self.pb_stage_total += 2
399
self.pb.show_pct = False
400
self.pb.show_spinner = False
401
self.pb.show_eta = False
402
self.pb.show_count = True
403
self.pb.show_bar = True
405
# After a merge, a selected file commit is not supported.
406
# See 'bzr help merge' for an explanation as to why.
407
if len(self.parents) > 1 and self.specific_files is not None:
408
raise CannotCommitSelectedFileMerge(self.specific_files)
409
# Excludes are a form of selected file commit.
410
if len(self.parents) > 1 and self.exclude:
411
raise CannotCommitSelectedFileMerge(self.exclude)
413
# Collect the changes
414
self._set_progress_stage("Collecting changes", counter=True)
416
self.builder = self.branch.get_commit_builder(
417
self.parents, self.config_stack, timestamp, timezone, committer,
418
self.revprops, rev_id, lossy=lossy)
420
if self.builder.updates_branch and self.bound_branch:
422
raise AssertionError(
423
"bound branches not supported for commit builders "
424
"that update the branch")
427
# find the location being committed to
372
428
if self.bound_branch:
373
# 2 extra stages: "Uploading data to master branch" and "Merging
374
# tags to master branch"
375
self.pb_stage_total += 2
376
self.pb.show_pct = False
377
self.pb.show_spinner = False
378
self.pb.show_eta = False
379
self.pb.show_count = True
380
self.pb.show_bar = True
382
# After a merge, a selected file commit is not supported.
383
# See 'bzr help merge' for an explanation as to why.
384
if len(self.parents) > 1 and self.specific_files is not None:
385
raise CannotCommitSelectedFileMerge(self.specific_files)
386
# Excludes are a form of selected file commit.
387
if len(self.parents) > 1 and self.exclude:
388
raise CannotCommitSelectedFileMerge(self.exclude)
390
# Collect the changes
391
self._set_progress_stage("Collecting changes", counter=True)
393
self.builder = self.branch.get_commit_builder(
394
self.parents, self.config_stack, timestamp, timezone, committer,
395
self.revprops, rev_id, lossy=lossy)
397
if self.builder.updates_branch and self.bound_branch:
399
raise AssertionError(
400
"bound branches not supported for commit builders "
401
"that update the branch")
404
# find the location being committed to
405
if self.bound_branch:
406
master_location = self.master_branch.base
408
master_location = self.branch.base
410
# report the start of the commit
411
self.reporter.started(new_revno, self.rev_id, master_location)
413
self._update_builder_with_changes()
414
self._check_pointless()
416
# TODO: Now the new inventory is known, check for conflicts.
417
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
418
# weave lines, because nothing should be recorded until it is known
419
# that commit will succeed.
420
self._set_progress_stage("Saving data locally")
421
self.builder.finish_inventory()
423
# Prompt the user for a commit message if none provided
424
message = message_callback(self)
425
self.message = message
427
# Add revision data to the local branch
428
self.rev_id = self.builder.commit(self.message)
431
mutter("aborting commit write group because of exception:")
432
trace.log_exception_quietly()
436
self._update_branches(old_revno, old_revid, new_revno)
438
# Make the working tree be up to date with the branch. This
439
# includes automatic changes scheduled to be made to the tree, such
440
# as updating its basis and unversioning paths that were missing.
441
self.work_tree.unversion(self.deleted_paths)
442
self._set_progress_stage("Updating the working tree")
443
self.work_tree.update_basis_by_delta(self.rev_id,
444
self.builder.get_basis_delta())
445
self.reporter.completed(new_revno, self.rev_id)
446
self._process_post_hooks(old_revno, new_revno)
429
master_location = self.master_branch.base
431
master_location = self.branch.base
433
# report the start of the commit
434
self.reporter.started(new_revno, self.rev_id, master_location)
436
self._update_builder_with_changes()
437
self._check_pointless()
439
# TODO: Now the new inventory is known, check for conflicts.
440
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
441
# weave lines, because nothing should be recorded until it is known
442
# that commit will succeed.
443
self._set_progress_stage("Saving data locally")
444
self.builder.finish_inventory()
446
# Prompt the user for a commit message if none provided
447
message = message_callback(self)
448
self.message = message
450
# Add revision data to the local branch
451
self.rev_id = self.builder.commit(self.message)
454
mutter("aborting commit write group because of exception:")
455
trace.log_exception_quietly()
459
self._update_branches(old_revno, old_revid, new_revno)
461
# Make the working tree be up to date with the branch. This
462
# includes automatic changes scheduled to be made to the tree, such
463
# as updating its basis and unversioning paths that were missing.
464
self.work_tree.unversion(self.deleted_paths)
465
self._set_progress_stage("Updating the working tree")
466
self.work_tree.update_basis_by_delta(self.rev_id,
467
self.builder.get_basis_delta())
468
self.reporter.completed(new_revno, self.rev_id)
469
self._process_post_hooks(old_revno, new_revno)
449
472
def _update_branches(self, old_revno, old_revid, new_revno):
450
473
"""Update the master and local branch to the new revision.
added
removed
breezy/commit.py
