2
"""Shelf - temporarily set aside changes, then bring them back."""
3
Various useful plugins for working with bzr.
4
5
import bzrlib.commands
8
from shelf import Shelf
11
from bzrlib.option import Option
5
12
import bzrlib.branch
6
13
from bzrlib.errors import BzrCommandError
7
from bzrlib.option import Option
8
from shelf import Shelf
14
sys.path.append(os.path.dirname(__file__))
16
Option.OPTIONS['ignored'] = Option('ignored',
17
help='delete all ignored files.')
18
Option.OPTIONS['detritus'] = Option('detritus',
19
help='delete conflict files merge backups, and failed selftest dirs.' +
20
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
21
Option.OPTIONS['dry-run'] = Option('dry-run',
22
help='show files to delete instead of deleting them.')
24
class cmd_clean_tree(bzrlib.commands.Command):
25
"""Remove unwanted files from working tree.
26
Normally, ignored files are left alone.
28
takes_options = ['ignored', 'detritus', 'dry-run']
29
def run(self, ignored=False, detritus=False, dry_run=False):
30
from clean_tree import clean_tree
31
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
33
Option.OPTIONS['no-collapse'] = Option('no-collapse')
34
Option.OPTIONS['no-antialias'] = Option('no-antialias')
35
Option.OPTIONS['cluster'] = Option('cluster')
36
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
38
class cmd_graph_ancestry(bzrlib.commands.Command):
39
"""Produce ancestry graphs using dot.
41
Output format is detected according to file extension. Some of the more
42
common output formats are png, gif, svg, ps. An extension of '.dot' will
43
cause a dot graph file to be produced.
45
Branches are labeled r?, where ? is the revno. If they have no revno,
46
with the last 5 characters of their revision identifier are used instead.
48
If --merge-branch is specified, the two branches are compared and a merge
56
blue COMMON non-history ancestor
57
dotted Missing from branch storage
59
Ancestry is usually collapsed by removing revisions with a single parent
60
and descendant. The number of skipped revisions is shown on the arrow.
61
This feature can be disabled with --no-collapse.
63
By default, revisions are ordered by distance from root, but they can be
64
clustered instead using --cluster.
66
If available, rsvg is used to antialias PNG and JPEG output, but this can
67
be disabled with --no-antialias.
69
takes_args = ['branch', 'file']
70
takes_options = ['no-collapse', 'no-antialias', 'merge-branch', 'cluster']
71
def run(self, branch, file, no_collapse=False, no_antialias=False,
72
merge_branch=None, cluster=False):
78
graph.write_ancestry_file(branch, file, not no_collapse,
79
not no_antialias, merge_branch, ranking)
81
class cmd_fetch_ghosts(bzrlib.commands.Command):
82
"""Attempt to retrieve ghosts from another branch.
83
If the other branch is not supplied, the last-pulled branch is used.
85
aliases = ['fetch-missing']
86
takes_args = ['branch?']
87
def run(self, branch=None):
88
from fetch_ghosts import fetch_ghosts
91
strip_help="""Strip the smallest prefix containing num leading slashes from \
92
each file name found in the patch file."""
93
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
94
class cmd_patch(bzrlib.commands.Command):
95
"""Apply a named patch to the current tree.
97
takes_args = ['filename?']
98
takes_options = ['strip']
99
def run(self, filename=None, strip=0):
100
from patch import patch
101
from bzrlib.branch import Branch
102
b = Branch.open_containing('.')[0]
103
return patch(b, filename, strip)
10
106
class cmd_shelve(bzrlib.commands.Command):
11
"""Temporarily set aside some changes to the current working tree.
13
Shelve allows you to temporarily put changes you've made "on the shelf",
14
ie. out of the way, until a later time when you can bring them back from
15
the shelf with the 'unshelve' command.
17
You can put multiple items on the shelf, each time you run unshelve the
18
most recently shelved changes will be reinstated.
20
If filenames are specified, only the changes to those files will be
21
shelved, other files will be left untouched.
23
If a revision is specified, changes since that revision will be shelved.
25
If you specifiy "--pick" you'll be prompted for each hunk of the diff as
26
to whether you want to shelve it or not. Press "?" at the prompt for help.
107
"""Temporarily remove some changes from the current tree.
108
Use 'unshelve' to restore these changes.
110
If filenames are specified, only changes to those files will be unshelved.
111
If a revision is specified, all changes since that revision will may be
28
114
takes_args = ['file*']
29
takes_options = [Option('pick'), 'message', 'revision']
30
def run(self, pick=False, file_list=None, message=None, revision=None):
115
takes_options = ['all', 'message', 'revision']
116
def run(self, all=False, file_list=None, message=None, revision=None):
31
117
if file_list is not None and len(file_list) > 0:
32
118
branchdir = file_list[0]
43
129
s = Shelf(branchdir)
44
return s.shelve(pick, message, revision, file_list)
130
return s.shelve(all, message, revision, file_list)
46
133
class cmd_unshelve(bzrlib.commands.Command):
47
"""Reinstate the most recently shelved changes.
48
See 'shelve' for more information.
134
"""Restore previously-shelved changes to the current tree.
50
takes_options = [Option('pick')]
51
def run(self, pick=False):
53
return s.unshelve(pick)
55
bzrlib.commands.register_command(cmd_shelve)
56
bzrlib.commands.register_command(cmd_unshelve)
141
class cmd_shell(bzrlib.commands.Command):
146
commands = [cmd_shelve, cmd_unshelve, cmd_clean_tree, cmd_graph_ancestry,
147
cmd_fetch_ghosts, cmd_patch, cmd_shell]
149
command_decorators = []
151
import bzrlib.builtins
152
if not hasattr(bzrlib.builtins, "cmd_annotate"):
153
commands.append(annotate.cmd_annotate)
154
if not hasattr(bzrlib.builtins, "cmd_push"):
155
commands.append(push.cmd_push)
157
command_decorators.append(push.cmd_push)
159
from errors import NoPyBaz
162
commands.append(baz_import.cmd_baz_import)
165
class cmd_baz_import(bzrlib.commands.Command):
166
"""Disabled. (Requires PyBaz)"""
167
takes_args = ['to_root_dir?', 'from_archive?']
168
takes_options = ['verbose']
169
def run(self, to_root_dir=None, from_archive=None, verbose=False):
170
print "This command is disabled. Please install PyBaz."
171
commands.append(cmd_baz_import)
174
if hasattr(bzrlib.commands, 'register_command'):
175
for command in commands:
176
bzrlib.commands.register_command(command)
177
for command in command_decorators:
178
command._original_command = bzrlib.commands.register_command(
59
from bzrlib.tests.TestUtil import TestLoader
61
return TestLoader().loadTestsFromModule(tests)
183
from doctest import DocTestSuite
184
from unittest import TestSuite, TestLoader
189
result.addTest(DocTestSuite(bzrtools))
190
result.addTest(clean_tree.test_suite())
191
result.addTest(TestLoader().loadTestsFromModule(shelf_tests))
192
result.addTest(blackbox.test_suite())