2
"""Shelf - temporarily set aside changes, then bring them back."""
1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron.bentley@utoronto.ca>
2
# Copyright (C) 2005, 2006 Canonical Limited.
3
# Copyright (C) 2006 Michael Ellerman.
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
Various useful plugins for working with bzr.
26
__version__ = '0.16.1'
29
version_info = tuple(int(n) for n in __version__.split('.'))
32
def check_bzrlib_version(desired):
33
"""Check that bzrlib is compatible.
35
If version is < bzrtools version, assume incompatible.
36
If version == bzrtools version, assume completely compatible
37
If version == bzrtools version + 1, assume compatible, with deprecations
38
Otherwise, assume incompatible.
40
desired_plus = (desired[0], desired[1]+1)
41
bzrlib_version = bzrlib.version_info[:2]
42
if bzrlib_version == desired:
45
from bzrlib.trace import warning
47
# get the message out any way we can
48
from warnings import warn as warning
49
if bzrlib_version < desired:
50
warning('Installed Bazaar version %s is too old to be used with'
52
'"Bzrtools" %s.' % (bzrlib.__version__, __version__))
53
# Not using BzrNewError, because it may not exist.
54
raise Exception, ('Version mismatch', version_info)
56
warning('Plugin "Bzrtools" is not up to date with installed Bazaar'
58
' There should be a newer version of Bzrtools available, e.g.'
60
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
61
if bzrlib_version != desired_plus:
62
raise Exception, 'Version mismatch'
65
check_bzrlib_version(version_info[:2])
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
69
from bzrlib import help
73
from errors import CommandError, NoPyBaz
74
from patchsource import BzrPatchSource
78
import bzrlib.builtins
4
79
import bzrlib.commands
5
from errors import CommandError
80
from bzrlib.commands import get_cmd_object
81
from bzrlib.errors import BzrCommandError
6
83
from bzrlib.option import Option
7
from patchsource import BzrPatchSource
8
from shelf import Shelf
9
from bzrlib import DEFAULT_IGNORE
10
from bzrlib.help import command_usage
12
DEFAULT_IGNORE.append('./.shelf')
13
DEFAULT_IGNORE.append('./.bzr-shelf*')
84
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
89
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
92
class cmd_clean_tree(bzrlib.commands.Command):
93
"""Remove unwanted files from working tree.
95
By default, only unknown files, not ignored files, are deleted. Versioned
96
files are never deleted.
98
Another class is 'detritus', which includes files emitted by bzr during
99
normal operations and selftests. (The value of these files decreases with
102
If no options are specified, unknown files are deleted. Otherwise, option
103
flags are respected, and may be combined.
105
To check what clean-tree will do, use --dry-run.
107
takes_options = [Option('ignored', help='delete all ignored files.'),
108
Option('detritus', help='delete conflict files, merge'
109
' backups, and failed selftest dirs.'),
111
help='delete files unknown to bzr. (default)'),
112
Option('dry-run', help='show files to delete instead of'
114
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
115
from clean_tree import clean_tree
116
if not (unknown or ignored or detritus):
118
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
122
class cmd_graph_ancestry(bzrlib.commands.Command):
123
"""Produce ancestry graphs using dot.
125
Output format is detected according to file extension. Some of the more
126
common output formats are html, png, gif, svg, ps. An extension of '.dot'
127
will cause a dot graph file to be produced. HTML output has mouseovers
128
that show the commit message.
130
Branches are labeled r?, where ? is the revno. If they have no revno,
131
with the last 5 characters of their revision identifier are used instead.
133
The value starting with d is "(maximum) distance from the null revision".
135
If --merge-branch is specified, the two branches are compared and a merge
139
white normal revision
142
orange COMMON history
143
blue COMMON non-history ancestor
144
green Merge base (COMMON ancestor farthest from the null revision)
145
dotted Ghost revision (missing from branch storage)
147
Ancestry is usually collapsed by skipping revisions with a single parent
148
and descendant. The number of skipped revisions is shown on the arrow.
149
This feature can be disabled with --no-collapse.
151
By default, revisions are ordered by distance from root, but they can be
152
clustered instead using --cluster.
154
If available, rsvg is used to antialias PNG and JPEG output, but this can
155
be disabled with --no-antialias.
157
takes_args = ['branch', 'file']
158
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
159
Option('no-antialias',
160
help="Do not use rsvg to produce antialiased output"),
161
Option('merge-branch', type=str,
162
help="Use this branch to calcuate a merge base"),
163
Option('cluster', help="Use clustered output."),
164
Option('max-distance', help="Show no nodes farther than this",
166
def run(self, branch, file, no_collapse=False, no_antialias=False,
167
merge_branch=None, cluster=False, max_distance=None):
173
graph.write_ancestry_file(branch, file, not no_collapse,
174
not no_antialias, merge_branch, ranking,
175
max_distance=max_distance)
178
class cmd_fetch_ghosts(bzrlib.commands.Command):
179
"""Attempt to retrieve ghosts from another branch.
180
If the other branch is not supplied, the last-pulled branch is used.
182
aliases = ['fetch-missing']
183
takes_args = ['branch?']
184
takes_options = [Option('no-fix')]
185
def run(self, branch=None, no_fix=False):
186
from fetch_ghosts import fetch_ghosts
187
fetch_ghosts(branch, no_fix)
189
strip_help="""Strip the smallest prefix containing num leading slashes from \
190
each file name found in the patch file."""
193
class cmd_patch(bzrlib.commands.Command):
194
"""Apply a named patch to the current tree.
196
takes_args = ['filename?']
197
takes_options = [Option('strip', type=int, help=strip_help),
198
Option('silent', help='Suppress chatter')]
199
def run(self, filename=None, strip=None, silent=False):
200
from patch import patch
201
from bzrlib.workingtree import WorkingTree
202
wt = WorkingTree.open_containing('.')[0]
205
return patch(wt, filename, strip, silent)
15
208
class cmd_shelve(bzrlib.commands.Command):
16
209
"""Temporarily set aside some changes from the current tree.
159
366
class cmd_unshelve(bzrlib.commands.Command):
160
"""Restore the most recently shelved changes to the current tree.
367
"""Restore shelved changes.
369
By default the most recently shelved changes are restored. However if you
370
specify a patch by name those changes will be restored instead.
161
372
See 'shelve' for more information.
163
374
takes_options = [
164
375
Option('all', help='Unshelve all changes without prompting'),
165
376
Option('force', help='Force unshelving even if errors occur'),
167
def run(self, all=False, force=False):
377
Option('no-color', help='Never display changes in color')
379
takes_args = ['patch?']
380
def run(self, patch=None, all=False, force=False, no_color=False):
168
381
source = BzrPatchSource()
169
s = Shelf(source.base)
170
s.unshelve(source, all, force)
382
s = shelf.Shelf(source.base)
383
s.unshelve(source, patch, all, force, no_color)
173
bzrlib.commands.register_command(cmd_shelf)
174
bzrlib.commands.register_command(cmd_shelve)
175
bzrlib.commands.register_command(cmd_unshelve)
387
class cmd_shell(bzrlib.commands.Command):
388
"""Begin an interactive shell tailored for bzr.
389
Bzr commands can be used without typing bzr first, and will be run natively
390
when possible. Tab completion is tailored for bzr. The shell prompt shows
391
the branch nick, revno, and path.
393
If it encounters any moderately complicated shell command, it will punt to
398
bzr bzrtools:287/> status
401
bzr bzrtools:287/> status --[TAB][TAB]
402
--all --help --revision --show-ids
403
bzr bzrtools:287/> status --
407
return shell.run_shell()
410
class cmd_branch_history(bzrlib.commands.Command):
412
Display the development history of a branch.
414
Each different committer or branch nick is considered a different line of
415
development. Committers are treated as the same if they have the same
416
name, or if they have the same email address.
418
takes_args = ["branch?"]
419
def run(self, branch=None):
420
from branchhistory import branch_history
421
return branch_history(branch)
424
class cmd_zap(bzrlib.commands.Command):
426
Remove a lightweight checkout, if it can be done safely.
428
This command will remove a lightweight checkout without losing data. That
429
means it only removes lightweight checkouts, and only if they have no
432
If --branch is specified, the branch will be deleted too, but only if the
433
the branch has no new commits (relative to its parent).
435
takes_options = [Option("branch", help="Remove associtated branch from"
437
takes_args = ["checkout"]
438
def run(self, checkout, branch=False):
440
return zap(checkout, remove_branch=branch)
443
class cmd_cbranch(bzrlib.commands.Command):
445
Create a new checkout, associated with a new repository branch.
447
When you cbranch, bzr looks up a target location in locations.conf, and
448
creates the branch there.
450
In your locations.conf, add the following lines:
451
[/working_directory_root]
452
cbranch_target = /branch_root
453
cbranch_target:policy = appendpath
455
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
456
working directory root, the branch will be created in
457
"/branch_root/foo/baz"
459
NOTE: cbranch also supports "cbranch_root", but that behaviour is
462
takes_options = [Option("lightweight",
463
help="Create a lightweight checkout"), 'revision']
464
takes_args = ["source", "target?"]
465
def run(self, source, target=None, lightweight=False, revision=None):
466
from cbranch import cbranch
467
return cbranch(source, target, lightweight=lightweight,
471
class cmd_branches(bzrlib.commands.Command):
472
"""Scan a location for branches"""
473
takes_args = ["location?"]
474
def run(self, location=None):
475
from branches import branches
476
return branches(location)
479
class cmd_multi_pull(bzrlib.commands.Command):
480
"""Pull all the branches under a location, e.g. a repository.
482
Both branches present in the directory and the branches of checkouts are
485
takes_args = ["location?"]
486
def run(self, location=None):
487
from bzrlib.branch import Branch
488
from bzrlib.transport import get_transport
489
from bzrtools import iter_branch_tree
492
t = get_transport(location)
494
print "Can't list this type of location."
496
for branch, wt in iter_branch_tree(t):
501
parent = branch.get_parent()
508
if base.startswith(t.base):
509
relpath = base[len(t.base):].rstrip('/')
512
print "Pulling %s from %s" % (relpath, parent)
514
pullable.pull(Branch.open(parent))
519
class cmd_branch_mark(bzrlib.commands.Command):
521
Add, view or list branch markers <EXPERIMENTAL>
523
To add a mark, do 'bzr branch-mark MARK'.
524
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
526
To delete a mark, do 'bzr branch-mark --delete MARK'
528
These marks can be used to track a branch's status.
530
takes_args = ['mark?', 'branch?']
531
takes_options = [Option('delete', help='Delete this mark')]
532
def run(self, mark=None, branch=None, delete=False):
533
from branch_mark import branch_mark
534
branch_mark(mark, branch, delete)
537
class cmd_import(bzrlib.commands.Command):
538
"""Import sources from a directory, tarball or zip file
540
This command will import a directory, tarball or zip file into a bzr
541
tree, replacing any versioned files already present. If a directory is
542
specified, it is used as the target. If the directory does not exist, or
543
is not versioned, it is created.
545
Tarballs may be gzip or bzip2 compressed. This is autodetected.
547
If the tarball or zip has a single root directory, that directory is
548
stripped when extracting the tarball. This is not done for directories.
551
takes_args = ['source', 'tree?']
552
def run(self, source, tree=None):
553
from upstream_import import do_import
554
do_import(source, tree)
557
class cmd_cdiff(bzrlib.commands.Command):
558
"""A color version of bzr's diff"""
559
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
561
def _takes_options(self):
562
options = list(get_cmd_object('diff').takes_options)
563
options.append(Option('check-style',
564
help='Warn if trailing whitespace or spurious changes have been'
568
takes_options = property(_takes_options)
570
def run(self, check_style=False, *args, **kwargs):
571
from colordiff import colordiff
572
colordiff(check_style, *args, **kwargs)
575
class cmd_baz_import(bzrlib.commands.Command):
576
"""Import an Arch or Baz archive into a bzr repository.
578
This command should be used on local archives (or mirrors) only. It is
579
quite slow on remote archives.
581
reuse_history allows you to specify any previous imports you
582
have done of different archives, which this archive has branches
583
tagged from. This will dramatically reduce the time to convert
584
the archive as it will not have to convert the history already
585
converted in that other branch.
587
If you specify prefixes, only branches whose names start with that prefix
588
will be imported. Skipped branches will be listed, so you can import any
589
branches you missed by accident. Here's an example of doing a partial
590
import from thelove@canonical.com:
591
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
593
WARNING: Encoding should not be specified unless necessary, because if you
594
specify an encoding, your converted branch will not interoperate with
595
independently-converted branches, unless the other branches were converted
596
with exactly the same encoding. Any encoding recognized by Python may
597
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
600
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
601
takes_options = ['verbose', Option('prefixes', type=str,
602
help="Prefixes of branches to import, colon-separated"),
603
Option('encoding', type=str,
604
help='Force encoding to specified value. See WARNING.')]
606
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
607
reuse_history_list=[], prefixes=None):
608
from errors import NoPyBaz
611
baz_import.baz_import(to_root_dir, from_archive, encoding,
612
verbose, reuse_history_list, prefixes)
614
print "This command is disabled. Please install PyBaz."
617
class cmd_baz_import_branch(bzrlib.commands.Command):
618
"""Import an Arch or Baz branch into a bzr branch.
620
WARNING: Encoding should not be specified unless necessary, because if you
621
specify an encoding, your converted branch will not interoperate with
622
independently-converted branches, unless the other branches were converted
623
with exactly the same encoding. Any encoding recognized by Python may
624
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
627
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
628
takes_options = ['verbose', Option('max-count', type=int),
629
Option('encoding', type=str,
630
help='Force encoding to specified value. See WARNING.')]
632
def run(self, to_location, from_branch=None, fast=False, max_count=None,
633
encoding=None, verbose=False, dry_run=False,
634
reuse_history_list=[]):
635
from errors import NoPyBaz
638
baz_import.baz_import_branch(to_location, from_branch, fast,
639
max_count, verbose, encoding, dry_run,
642
print "This command is disabled. Please install PyBaz."
645
class cmd_rspush(bzrlib.commands.Command):
646
"""Upload this branch to another location using rsync.
648
If no location is specified, the last-used location will be used. To
649
prevent dirty trees from being uploaded, rspush will error out if there are
650
unknown files or local changes. It will also error out if the upstream
651
directory is non-empty and not an earlier version of the branch.
653
takes_args = ['location?']
654
takes_options = [Option('overwrite', help='Ignore differences between'
655
' branches and overwrite unconditionally'),
656
Option('no-tree', help='Do not push the working tree,'
659
def run(self, location=None, overwrite=False, no_tree=False):
660
from bzrlib import workingtree
662
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
663
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
664
working_tree=not no_tree)
667
class cmd_switch(bzrlib.commands.Command):
668
"""Set the branch of a lightweight checkout and update."""
670
takes_args = ['to_location']
672
def run(self, to_location):
673
from switch import cmd_switch
674
cmd_switch().run(to_location)
679
cmd_baz_import_branch,
701
if hasattr(bzrlib.commands, 'register_command'):
702
for command in commands:
703
bzrlib.commands.register_command(command)
177
706
def test_suite():
178
707
from bzrlib.tests.TestUtil import TestLoader
180
return TestLoader().loadTestsFromModule(tests)
709
from doctest import DocTestSuite, ELLIPSIS
710
from unittest import TestSuite
712
import tests.clean_tree
713
import tests.is_clean
714
import tests.upstream_import
716
import tests.blackbox
717
import tests.shelf_tests
719
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
720
result.addTest(tests.clean_tree.test_suite())
723
result.addTest(DocTestSuite(baz_import))
726
result.addTest(tests.test_suite())
727
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
728
result.addTest(tests.blackbox.test_suite())
729
result.addTest(tests.upstream_import.test_suite())
730
result.addTest(zap.test_suite())
731
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
added
removed
__init__.py
