1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
13
# GNU General Public License for more details.
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
from warnings import warn
19
"""Bazaar-NG -- a free distributed version-control tool
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
24
* Metadata format is not stable yet -- you may need to
25
discard history in the future.
27
* Many commands unimplemented or partially implemented.
29
* Space-inefficient storage.
31
* No merge operators yet.
38
Show software version/licence/non-warranty.
40
Start versioning the current directory
44
Show revision history.
47
bzr move FROM... DESTDIR
48
Move one or more files to a different directory.
50
Show changes from last revision to working copy.
51
bzr commit -m 'MESSAGE'
52
Store current state as new revision.
53
bzr export REVNO DESTINATION
54
Export the branch state at a previous version.
56
Show summary of pending changes.
58
Make a file not versioned.
60
Show statistics about this branch.
62
Verify history is stored safely.
63
(for more type 'bzr help commands')
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
71
from pprint import pprint
74
from inspect import getdoc
50
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
91
def _squish_command_name(cmd):
92
return 'cmd_' + cmd.replace('-', '_')
95
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
return cmd[4:].replace('_','-')
100
def _builtin_commands():
101
import bzrlib.builtins
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
105
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
111
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
116
def plugin_command_names():
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
138
If true, plugin commands can override builtins.
140
from bzrlib.externalcommand import ExternalCommand
142
# We want only 'ascii' command names, but the user may have typed
143
# in a Unicode name. In that case, they should just get a
144
# 'command not found' error later.
145
# In the future, we may actually support Unicode command names.
147
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
150
return cmds[cmd_name]()
154
# look for any command which claims this as an alias
155
for real_cmd_name, cmd_class in cmds.iteritems():
156
if cmd_name in cmd_class.aliases:
159
cmd_obj = ExternalCommand.find_command(cmd_name)
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
166
class Command(object):
167
"""Base class for commands.
169
Commands are the heart of the command-line bzr interface.
171
The command object mostly handles the mapping of command-line
172
parameters into one or more bzrlib operations, and of the results
175
Commands normally don't have any state. All their arguments are
176
passed in to the run method. (Subclasses may take a different
177
policy if the behaviour of the instance needs to depend on e.g. a
178
shell plugin and not just its Python class.)
180
The docstring for an actual command should give a single-line
181
summary, then a complete description of the command. A grammar
182
description will be inserted.
185
Other accepted names for this command.
188
List of argument forms, marked with whether they are optional,
193
['to_location', 'from_branch?', 'file*']
195
'to_location' is required
196
'from_branch' is optional
197
'file' can be specified 0 or more times
200
List of options that may be given for this command. These can
201
be either strings, referring to globally-defined options,
202
or option objects. Retrieve through options().
205
If true, this command isn't advertised. This is typically
206
for commands intended for expert users.
209
Command objects will get a 'outf' attribute, which has been
210
setup to properly handle encoding of unicode strings.
211
encoding_type determines what will happen when characters cannot
213
strict - abort if we cannot decode
214
replace - put in a bogus character (typically '?')
215
exact - do not encode sys.stdout
217
NOTE: by default on Windows, sys.stdout is opened as a text
218
stream, therefore LF line-endings are converted to CRLF.
219
When a command uses encoding_type = 'exact', then
220
sys.stdout is forced to be a binary stream, and line-endings
227
encoding_type = 'strict'
232
"""Construct an instance of this command."""
233
if self.__doc__ == Command.__doc__:
234
warn("No help message set for %r" % self)
237
"""Return dict of valid options for this command.
239
Maps from long option name to option object."""
241
r['help'] = option.Option.OPTIONS['help']
242
for o in self.takes_options:
243
if isinstance(o, basestring):
244
o = option.Option.OPTIONS[o]
248
def _setup_outf(self):
249
"""Return a file linked to stdout, which has proper encoding."""
250
assert self.encoding_type in ['strict', 'exact', 'replace']
252
# Originally I was using self.stdout, but that looks
253
# *way* too much like sys.stdout
254
if self.encoding_type == 'exact':
255
# force sys.stdout to be binary stream on win32
256
if sys.platform == 'win32':
257
fileno = getattr(sys.stdout, 'fileno', None)
260
msvcrt.setmode(fileno(), os.O_BINARY)
261
self.outf = sys.stdout
264
output_encoding = osutils.get_terminal_encoding()
266
# use 'replace' so that we don't abort if trying to write out
267
# in e.g. the default C locale.
268
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
269
# For whatever reason codecs.getwriter() does not advertise its encoding
270
# it just returns the encoding of the wrapped file, which is completely
271
# bogus. So set the attribute, so we can find the correct encoding later.
272
self.outf.encoding = output_encoding
274
@deprecated_method(zero_eight)
275
def run_argv(self, argv):
276
"""Parse command line and run.
278
See run_argv_aliases for the 0.8 and beyond api.
280
return self.run_argv_aliases(argv)
282
def run_argv_aliases(self, argv, alias_argv=None):
283
"""Parse the command line and run with extra aliases in alias_argv."""
285
warn("Passing None for [] is deprecated from bzrlib 0.10",
286
DeprecationWarning, stacklevel=2)
288
args, opts = parse_args(self, argv, alias_argv)
289
if 'help' in opts: # e.g. bzr add --help
290
from bzrlib.help import help_on_command
291
help_on_command(self.name())
293
# mix arguments and options into one dictionary
294
cmdargs = _match_argform(self.name(), self.takes_args, args)
296
for k, v in opts.items():
297
cmdopts[k.replace('-', '_')] = v
299
all_cmd_args = cmdargs.copy()
300
all_cmd_args.update(cmdopts)
304
return self.run(**all_cmd_args)
307
"""Actually run the command.
309
This is invoked with the options and arguments bound to
312
Return 0 or None if the command was successful, or a non-zero
313
shell error code if not. It's OK for this method to allow
314
an exception to raise up.
316
raise NotImplementedError('no implementation of command %r'
320
"""Return help message for this class."""
321
from inspect import getdoc
322
if self.__doc__ is Command.__doc__:
327
return _unsquish_command_name(self.__class__.__name__)
329
def plugin_name(self):
330
"""Get the name of the plugin that provides this command.
332
:return: The name of the plugin or None if the command is builtin.
334
mod_parts = self.__module__.split('.')
335
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
341
# Technically, this function hasn't been use in a *really* long time
342
# but we are only deprecating it now.
343
@deprecated_function(zero_eleven)
344
def parse_spec(spec):
350
>>> parse_spec("../@")
352
>>> parse_spec("../f/@35")
354
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
355
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
360
parsed = spec.split('/@')
361
assert len(parsed) == 2
366
parsed[1] = int(parsed[1])
368
pass # We can allow stuff like ./@revid:blahblahblah
372
parsed = [spec, None]
375
def parse_args(command, argv, alias_argv=None):
77
from bzrlib.store import ImmutableStore
78
from bzrlib.trace import mutter, note, log_error
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
from bzrlib.revision import Revision
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
89
## standard representation
90
NONE_STRING = '(none)'
94
## TODO: Perhaps a different version of inventory commands that
95
## returns iterators...
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
99
## TODO: Some kind of locking on branches. Perhaps there should be a
100
## parameter to the branch object saying whether we want a read or
101
## write lock; release it from destructor. Perhaps don't even need a
102
## read lock to look at immutable objects?
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
## to compare output?
107
## TODO: Some kind of global code to generate the right Branch object
108
## to work on. Almost, but not quite all, commands need one, and it
109
## can be taken either from their parameters or their working
124
def get_cmd_handler(cmd):
127
cmd = cmd_aliases.get(cmd, cmd)
130
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
132
raise BzrError("unknown command %r" % cmd)
134
return cmd, cmd_handler
138
def cmd_status(all=False):
139
"""Display status summary.
141
For each file there is a single line giving its file state and name.
142
The name is that in the current revision unless it is deleted or
143
missing, in which case the old name is shown.
145
#import bzrlib.status
146
#bzrlib.status.tree_status(Branch('.'))
147
Branch('.').show_status(show_all=all)
151
######################################################################
153
def cmd_get_revision(revision_id):
154
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
157
def cmd_get_file_text(text_id):
158
"""Get contents of a file by hash."""
159
sf = Branch('.').text_store[text_id]
160
pumpfile(sf, sys.stdout)
164
######################################################################
169
"""Show number of revisions on this branch"""
170
print Branch('.').revno()
174
def cmd_add(file_list, verbose=False):
175
"""Add specified files or directories.
177
In non-recursive mode, all the named items are added, regardless
178
of whether they were previously ignored. A warning is given if
179
any of the named files are already versioned.
181
In recursive mode (the default), files are treated the same way
182
but the behaviour for directories is different. Directories that
183
are already versioned do not give a warning. All directories,
184
whether already versioned or not, are searched for files or
185
subdirectories that are neither versioned or ignored, and these
186
are added. This search proceeds recursively into versioned
189
Therefore simply saying 'bzr add .' will version all files that
190
are currently unknown.
192
TODO: Perhaps adding a file whose directly is not versioned should
193
recursively add that parent, rather than giving an error?
195
bzrlib.add.smart_add(file_list, verbose)
198
def cmd_relpath(filename):
199
"""Show path of file relative to root"""
200
print Branch(filename).relpath(filename)
204
def cmd_inventory(revision=None):
205
"""Show inventory of the current working copy."""
206
## TODO: Also optionally show a previous inventory
207
## TODO: Format options
210
inv = b.read_working_inventory()
212
inv = b.get_revision_inventory(b.lookup_revision(revision))
214
for path, entry in inv.iter_entries():
215
print '%-50s %s' % (entry.file_id, path)
219
# TODO: Maybe a 'mv' command that has the combined move/rename
220
# special behaviour of Unix?
222
def cmd_move(source_list, dest):
225
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
229
def cmd_rename(from_name, to_name):
230
"""Change the name of an entry.
232
usage: bzr rename FROM_NAME TO_NAME
235
bzr rename frob.c frobber.c
236
bzr rename src/frob.c lib/frob.c
238
It is an error if the destination name exists.
240
See also the 'move' command, which moves files into a different
241
directory without changing their name.
243
TODO: Some way to rename multiple files without invoking bzr for each
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
251
def cmd_renames(dir='.'):
252
"""Show list of renamed files.
254
usage: bzr renames [BRANCH]
256
TODO: Option to show renames between two historical versions.
258
TODO: Only show renames under dir, rather than in the whole branch.
261
old_inv = b.basis_tree().inventory
262
new_inv = b.read_working_inventory()
264
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
266
for old_name, new_name in renames:
267
print "%s => %s" % (old_name, new_name)
272
"""info: Show statistical information for this branch
276
info.show_info(Branch('.'))
280
def cmd_remove(file_list, verbose=False):
281
b = Branch(file_list[0])
282
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
286
def cmd_file_id(filename):
287
"""Print file_id of a particular file or directory.
289
usage: bzr file-id FILE
291
The file_id is assigned when the file is first added and remains the
292
same through all revisions where the file exists, even when it is
296
i = b.inventory.path2id(b.relpath(filename))
298
bailout("%r is not a versioned file" % filename)
303
def cmd_file_id_path(filename):
304
"""Print path of file_ids to a file or directory.
306
usage: bzr file-id-path FILE
308
This prints one line for each directory down to the target,
309
starting at the branch root."""
312
fid = inv.path2id(b.relpath(filename))
314
bailout("%r is not a versioned file" % filename)
315
for fip in inv.get_idpath(fid):
319
def cmd_revision_history():
320
for patchid in Branch('.').revision_history():
324
def cmd_directories():
325
for name, ie in Branch('.').read_working_inventory().directories():
333
for name, ie in Branch('.').working_tree().missing():
338
# TODO: Check we're not already in a working directory? At the
339
# moment you'll get an ugly error.
341
# TODO: What if we're in a subdirectory of a branch? Would like
342
# to allow that, but then the parent may need to understand that
343
# the children have disappeared, or should they be versioned in
346
# TODO: Take an argument/option for branch name.
347
Branch('.', init=True)
350
def cmd_diff(revision=None, file_list=None):
351
"""bzr diff: Show differences in working tree.
353
usage: bzr diff [-r REV] [FILE...]
356
Show changes since REV, rather than predecessor.
358
If files are listed, only the changes in those files are listed.
359
Otherwise, all changes for the tree are listed.
361
TODO: Given two revision arguments, show the difference between them.
363
TODO: Allow diff across branches.
365
TODO: Option to use external diff command; could be GNU diff, wdiff,
368
TODO: Python difflib is not exactly the same as unidiff; should
369
either fix it up or prefer to use an external diff.
371
TODO: If a directory is given, diff everything under that.
373
TODO: Selected-file diff is inefficient and doesn't show you
376
TODO: This probably handles non-Unix newlines poorly.
379
## TODO: Shouldn't be in the cmd function.
384
old_tree = b.basis_tree()
386
old_tree = b.revision_tree(b.lookup_revision(revision))
388
new_tree = b.working_tree()
390
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
394
DEVNULL = '/dev/null'
395
# Windows users, don't panic about this filename -- it is a
396
# special signal to GNU patch that the file should be created or
397
# deleted respectively.
399
# TODO: Generation of pseudo-diffs for added/deleted files could
400
# be usefully made into a much faster special case.
402
# TODO: Better to return them in sorted order I think.
405
file_list = [b.relpath(f) for f in file_list]
407
# FIXME: If given a file list, compare only those files rather
408
# than comparing everything and then throwing stuff away.
410
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
412
if file_list and (new_name not in file_list):
415
# Don't show this by default; maybe do it if an option is passed
416
# idlabel = ' {%s}' % fid
419
# FIXME: Something about the diff format makes patch unhappy
420
# with newly-added files.
422
def diffit(oldlines, newlines, **kw):
424
# FIXME: difflib is wrong if there is no trailing newline.
425
# The syntax used by patch seems to be "\ No newline at
426
# end of file" following the last diff line from that
427
# file. This is not trivial to insert into the
428
# unified_diff output and it might be better to just fix
429
# or replace that function.
431
# In the meantime we at least make sure the patch isn't
435
# Special workaround for Python2.3, where difflib fails if
436
# both sequences are empty.
437
if not oldlines and not newlines:
442
if oldlines and (oldlines[-1][-1] != '\n'):
445
if newlines and (newlines[-1][-1] != '\n'):
449
ud = difflib.unified_diff(oldlines, newlines, **kw)
450
sys.stdout.writelines(ud)
452
print "\\ No newline at end of file"
453
sys.stdout.write('\n')
455
if file_state in ['.', '?', 'I']:
457
elif file_state == 'A':
458
print '*** added %s %r' % (kind, new_name)
461
new_tree.get_file(fid).readlines(),
463
tofile=new_label + new_name + idlabel)
464
elif file_state == 'D':
465
assert isinstance(old_name, types.StringTypes)
466
print '*** deleted %s %r' % (kind, old_name)
468
diffit(old_tree.get_file(fid).readlines(), [],
469
fromfile=old_label + old_name + idlabel,
471
elif file_state in ['M', 'R']:
472
if file_state == 'M':
473
assert kind == 'file'
474
assert old_name == new_name
475
print '*** modified %s %r' % (kind, new_name)
476
elif file_state == 'R':
477
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
480
diffit(old_tree.get_file(fid).readlines(),
481
new_tree.get_file(fid).readlines(),
482
fromfile=old_label + old_name + idlabel,
483
tofile=new_label + new_name)
485
bailout("can't represent state %s {%s}" % (file_state, fid))
489
def cmd_deleted(show_ids=False):
490
"""List files deleted in the working tree.
492
TODO: Show files deleted since a previous revision, or between two revisions.
496
new = b.working_tree()
498
## TODO: Much more efficient way to do this: read in new
499
## directories with readdir, rather than stating each one. Same
500
## level of effort but possibly much less IO. (Or possibly not,
501
## if the directories are very large...)
503
for path, ie in old.inventory.iter_entries():
504
if not new.has_id(ie.file_id):
506
print '%-50s %s' % (path, ie.file_id)
512
def cmd_parse_inventory():
515
cElementTree.ElementTree().parse(file('.bzr/inventory'))
519
def cmd_load_inventory():
520
"""Load inventory for timing purposes"""
521
Branch('.').basis_tree().inventory
524
def cmd_dump_inventory():
525
Branch('.').read_working_inventory().write_xml(sys.stdout)
528
def cmd_dump_new_inventory():
529
import bzrlib.newinventory
530
inv = Branch('.').basis_tree().inventory
531
bzrlib.newinventory.write_inventory(inv, sys.stdout)
534
def cmd_load_new_inventory():
535
import bzrlib.newinventory
536
bzrlib.newinventory.read_new_inventory(sys.stdin)
539
def cmd_dump_slacker_inventory():
540
import bzrlib.newinventory
541
inv = Branch('.').basis_tree().inventory
542
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
546
def cmd_dump_text_inventory():
547
import bzrlib.textinv
548
inv = Branch('.').basis_tree().inventory
549
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
552
def cmd_load_text_inventory():
553
import bzrlib.textinv
554
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
555
print 'loaded %d entries' % len(inv)
559
def cmd_root(filename=None):
560
"""Print the branch root."""
561
print bzrlib.branch.find_branch_root(filename)
564
def cmd_log(timezone='original', verbose=False):
565
"""Show log of this branch.
567
TODO: Options for utc; to show ids; to limit range; etc.
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
572
def cmd_ls(revision=None, verbose=False):
573
"""List files in a tree.
575
TODO: Take a revision or remote path and list that tree instead.
579
tree = b.working_tree()
581
tree = b.revision_tree(b.lookup_revision(revision))
583
for fp, fc, kind, fid in tree.list_files():
585
if kind == 'directory':
592
print '%-8s %s%s' % (fc, fp, kindch)
599
"""List unknown files"""
600
for f in Branch('.').unknowns():
605
def cmd_ignore(name_pattern):
606
"""Ignore a command or pattern"""
610
f = open(b.abspath('.bzrignore'), 'at')
611
f.write(name_pattern + '\n')
614
inv = b.working_tree().inventory
615
if inv.path2id('.bzrignore'):
616
mutter('.bzrignore is already versioned')
618
mutter('need to make new .bzrignore file versioned')
619
b.add(['.bzrignore'])
624
"""List ignored files and the patterns that matched them.
626
tree = Branch('.').working_tree()
627
for path, file_class, kind, file_id in tree.list_files():
628
if file_class != 'I':
630
## XXX: Slightly inefficient since this was already calculated
631
pat = tree.is_ignored(path)
632
print '%-50s %s' % (path, pat)
635
def cmd_lookup_revision(revno):
639
bailout("usage: lookup-revision REVNO",
640
["REVNO is a non-negative revision number for this branch"])
642
print Branch('.').lookup_revision(revno) or NONE_STRING
646
def cmd_export(revno, dest):
647
"""Export past revision to destination directory."""
649
rh = b.lookup_revision(int(revno))
650
t = b.revision_tree(rh)
653
def cmd_cat(revision, filename):
654
"""Print file to stdout."""
656
b.print_file(b.relpath(filename), int(revision))
659
######################################################################
660
# internal/test commands
664
"""Print a newly-generated UUID."""
665
print bzrlib.osutils.uuid()
669
def cmd_local_time_offset():
670
print bzrlib.osutils.local_time_offset()
674
def cmd_commit(message=None, verbose=False):
675
"""Commit changes to a new revision.
678
Description of changes in this revision; free form text.
679
It is recommended that the first line be a single-sentence
682
Show status of changed files,
684
TODO: Commit only selected files.
686
TODO: Run hooks on tree to-be-committed, and after commit.
688
TODO: Strict commit that fails if there are unknown or deleted files.
692
bailout("please specify a commit message")
693
Branch('.').commit(message, verbose=verbose)
696
def cmd_check(dir='.'):
697
"""check: Consistency check of branch history.
699
usage: bzr check [-v] [BRANCH]
702
--verbose, -v Show progress of checking.
704
This command checks various invariants about the branch storage to
705
detect data corruption or bzr bugs.
708
bzrlib.check.check(Branch(dir, find_root=False))
711
def cmd_is(pred, *rest):
712
"""Test whether PREDICATE is true."""
714
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
716
bailout("unknown predicate: %s" % quotefn(pred))
720
except BzrCheckError:
721
# by default we don't print the message so that this can
722
# be used from shell scripts without producing noise
726
def cmd_whoami(email=False):
732
--email Show only the email address.
736
print bzrlib.osutils.user_email()
738
print bzrlib.osutils.username()
741
def cmd_gen_revision_id():
742
print bzrlib.branch._gen_revision_id(time.time())
746
"""Run internal test suite"""
747
## -v, if present, is seen by doctest; the argument is just here
748
## so our parser doesn't complain
750
## TODO: --verbose option
752
failures, tests = 0, 0
754
import doctest, bzrlib.store, bzrlib.tests
755
bzrlib.trace.verbose = False
757
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
758
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
759
mf, mt = doctest.testmod(m)
762
print '%-40s %3d tests' % (m.__name__, mt),
764
print '%3d FAILED!' % mf
768
print '%-40s %3d tests' % ('total', tests),
770
print '%3d FAILED!' % failures
777
cmd_doctest = cmd_selftest
780
######################################################################
784
def cmd_help(topic=None):
787
elif topic == 'commands':
790
# otherwise, maybe the name of a command?
791
topic, cmdfn = get_cmd_handler(topic)
795
bailout("sorry, no detailed help yet for %r" % topic)
801
"""List all commands"""
803
for k in globals().keys():
804
if k.startswith('cmd_'):
805
accu.append(k[4:].replace('_','-'))
807
print "bzr commands: "
810
print "note: some of these commands are internal-use or obsolete"
811
# TODO: Some kind of marker for internal-use commands?
812
# TODO: Show aliases?
818
print "bzr (bazaar-ng) %s" % bzrlib.__version__
819
print bzrlib.__copyright__
820
print "http://bazaar-ng.org/"
823
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
824
you may use, modify and redistribute it under the terms of the GNU
825
General Public License version 2 or later."""
829
"""Statement of optimism."""
830
print "it sure does!"
834
######################################################################
838
# list of all available options; the rhs can be either None for an
839
# option that takes no argument, or a constructor function that checks
860
# List of options that apply to particular commands; commands not
865
'commit': ['message', 'verbose'],
866
'deleted': ['show-ids'],
867
'diff': ['revision'],
868
'inventory': ['revision'],
869
'log': ['timezone', 'verbose'],
870
'ls': ['revision', 'verbose'],
871
'remove': ['verbose'],
882
'export': ['revno', 'dest'],
883
'file-id': ['filename'],
884
'file-id-path': ['filename'],
885
'get-file-text': ['text_id'],
886
'get-inventory': ['inventory_id'],
887
'get-revision': ['revision_id'],
888
'get-revision-inventory': ['revision_id'],
890
'ignore': ['name_pattern'],
893
'lookup-revision': ['revno'],
894
'move': ['source$', 'dest'],
895
'relpath': ['filename'],
897
'rename': ['from_name', 'to_name'],
899
'root': ['filename?'],
904
def parse_args(argv):
376
905
"""Parse command line.
378
907
Arguments and options are parsed at this level before being passed
379
908
down to specific command handlers. This routine knows, from a
380
909
lookup table, something about the available options, what optargs
381
910
they take, and which commands will accept them.
912
>>> parse_args('--help'.split())
914
>>> parse_args('--version'.split())
915
([], {'version': True})
916
>>> parse_args('status --all'.split())
917
(['status'], {'all': True})
918
>>> parse_args('commit --message=biter'.split())
919
(['commit'], {'message': u'biter'})
383
# TODO: make it a method of the Command?
384
parser = option.get_optparser(command.options())
385
if alias_argv is not None:
386
args = alias_argv + argv
390
options, args = parser.parse_args(args)
391
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
392
v is not option.OptionParser.DEFAULT_VALUE])
924
# TODO: Maybe handle '--' to end options?
929
# option names must not be unicode
933
mutter(" got option %r" % a)
935
optname, optarg = a[2:].split('=', 1)
938
if optname not in OPTIONS:
939
bailout('unknown long option %r' % a)
942
if shortopt not in SHORT_OPTIONS:
943
bailout('unknown short option %r' % a)
944
optname = SHORT_OPTIONS[shortopt]
947
# XXX: Do we ever want to support this, e.g. for -r?
948
bailout('repeated option %r' % a)
950
optargfn = OPTIONS[optname]
954
bailout('option %r needs an argument' % a)
957
opts[optname] = optargfn(optarg)
960
bailout('option %r takes no argument' % optname)
393
965
return args, opts
396
def _match_argform(cmd, takes_args, args):
969
def _match_args(cmd, args):
970
"""Check non-option arguments match required pattern.
972
>>> _match_args('status', ['asdasdsadasd'])
973
Traceback (most recent call last):
975
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
976
>>> _match_args('add', ['asdasdsadasd'])
977
{'file_list': ['asdasdsadasd']}
978
>>> _match_args('add', 'abc def gj'.split())
979
{'file_list': ['abc', 'def', 'gj']}
981
# match argument pattern
982
argform = cmd_args.get(cmd, [])
984
# TODO: Need a way to express 'cp SRC... DEST', where it matches
399
# step through args and takes_args, allowing appropriate 0-many matches
400
for ap in takes_args:
987
# step through args and argform, allowing appropriate 0-many matches
401
989
argname = ap[:-1]
402
990
if ap[-1] == '?':
410
998
argdict[argname + '_list'] = None
411
999
elif ap[-1] == '+':
413
raise errors.BzrCommandError("command %r needs one or more %s"
414
% (cmd, argname.upper()))
1001
bailout("command %r needs one or more %s"
1002
% (cmd, argname.upper()))
416
1004
argdict[argname + '_list'] = args[:]
418
1006
elif ap[-1] == '$': # all but one
419
1007
if len(args) < 2:
420
raise errors.BzrCommandError("command %r needs one or more %s"
421
% (cmd, argname.upper()))
1008
bailout("command %r needs one or more %s"
1009
% (cmd, argname.upper()))
422
1010
argdict[argname + '_list'] = args[:-1]
425
1013
# just a plain arg
428
raise errors.BzrCommandError("command %r requires argument %s"
429
% (cmd, argname.upper()))
1016
bailout("command %r requires argument %s"
1017
% (cmd, argname.upper()))
431
1019
argdict[argname] = args.pop(0)
434
raise errors.BzrCommandError("extra argument to command %s: %s"
1022
bailout("extra arguments to command %s: %r"
441
def apply_profiled(the_callable, *args, **kwargs):
445
pffileno, pfname = tempfile.mkstemp()
447
prof = hotshot.Profile(pfname)
449
ret = prof.runcall(the_callable, *args, **kwargs) or 0
452
stats = hotshot.stats.load(pfname)
454
stats.sort_stats('cum') # 'time'
455
## XXX: Might like to write to stderr or the trace file instead but
456
## print_stats seems hardcoded to stdout
457
stats.print_stats(20)
464
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
465
from bzrlib.lsprof import profile
467
ret, stats = profile(the_callable, *args, **kwargs)
473
cPickle.dump(stats, open(filename, 'w'), 2)
474
print 'Profile data written to %r.' % filename
478
def get_alias(cmd, config=None):
479
"""Return an expanded alias, or None if no alias exists.
482
Command to be checked for an alias.
484
Used to specify an alternative config to use,
485
which is especially useful for testing.
486
If it is unspecified, the global config will be used.
490
config = bzrlib.config.GlobalConfig()
491
alias = config.get_alias(cmd)
494
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
498
1029
def run_bzr(argv):
499
1030
"""Execute a command.
501
1032
This is similar to main(), but without all the trappings for
502
1033
logging and error handling.
505
The command-line arguments, without the program name from argv[0]
506
These should already be decoded. All library/test code calling
507
run_bzr should be passing valid strings (don't need decoding).
509
Returns a command status or raises an exception.
511
Special master options: these must come before the command because
512
they control how the command is interpreted.
515
Do not load plugin modules at all
521
Only use builtin commands. (Plugins are still allowed to change
525
Run under the Python hotshot profiler.
528
Run under the Python lsprof profiler.
531
trace.mutter("bzr arguments: %r", argv)
533
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
534
opt_no_aliases = False
535
opt_lsprof_file = None
537
# --no-plugins is handled specially at a very early stage. We need
538
# to load plugins before doing other command parsing so that they
539
# can override commands, but this needs to happen first.
547
elif a == '--lsprof':
549
elif a == '--lsprof-file':
551
opt_lsprof_file = argv[i + 1]
553
elif a == '--no-plugins':
554
opt_no_plugins = True
555
elif a == '--no-aliases':
556
opt_no_aliases = True
557
elif a == '--builtin':
559
elif a in ('--quiet', '-q'):
561
elif a.startswith('-D'):
562
debug.debug_flags.add(a[2:])
569
from bzrlib.builtins import cmd_help
570
cmd_help().run_argv_aliases([])
573
if argv[0] == '--version':
574
from bzrlib.version import show_version
578
if not opt_no_plugins:
579
from bzrlib.plugin import load_plugins
582
from bzrlib.plugin import disable_plugins
587
if not opt_no_aliases:
588
alias_argv = get_alias(argv[0])
590
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
591
argv[0] = alias_argv.pop(0)
594
# We want only 'ascii' command names, but the user may have typed
595
# in a Unicode name. In that case, they should just get a
596
# 'command not found' error later.
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
1036
argv = [a.decode(bzrlib.user_encoding) for a in argv]
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
610
ret = apply_profiled(run, *run_argv)
615
# reset, in case we may do other commands later within the same process
616
trace.be_quiet(False)
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
1039
args, opts = parse_args(argv[1:])
1041
# TODO: pass down other arguments in case they asked for
1042
# help on a command name?
1048
elif 'version' in opts:
1051
cmd = str(args.pop(0))
1053
log_error('usage: bzr COMMAND')
1054
log_error(' try "bzr help"')
1057
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1060
if 'profile' in opts:
1066
# check options are reasonable
1067
allowed = cmd_options.get(canonical_cmd, [])
1069
if oname not in allowed:
1070
bailout("option %r is not allowed for command %r"
1073
# TODO: give an error if there are any mandatory options which are
1074
# not specified? Or maybe there shouldn't be any "mandatory
1075
# options" (it is an oxymoron)
1077
# mix arguments and options into one dictionary
1078
cmdargs = _match_args(canonical_cmd, args)
1079
for k, v in opts.items():
1080
cmdargs[k.replace('-', '_')] = v
1084
pffileno, pfname = tempfile.mkstemp()
622
result = func(*args, **kwargs)
626
if getattr(e, 'errno', None) is None:
628
if e.errno != errno.EPIPE:
629
# Win32 raises IOError with errno=0 on a broken pipe
630
if sys.platform != 'win32' or e.errno != 0:
633
except KeyboardInterrupt:
1086
prof = hotshot.Profile(pfname)
1087
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1090
import hotshot.stats
1091
stats = hotshot.stats.load(pfname)
1093
stats.sort_stats('time')
1094
## XXX: Might like to write to stderr or the trace file instead but
1095
## print_stats seems hardcoded to stdout
1096
stats.print_stats(20)
1104
return cmd_handler(**cmdargs) or 0
1108
def _report_exception(e, summary):
1110
log_error('bzr: ' + summary)
1111
bzrlib.trace.log_exception(e)
1112
tb = sys.exc_info()[2]
1113
exinfo = traceback.extract_tb(tb)
1115
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1116
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1119
def cmd_assert_fail():
1120
assert False, "always fails"
640
from bzrlib.ui.text import TextUIFactory
641
bzrlib.ui.ui_factory = TextUIFactory()
642
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
643
ret = run_bzr_catch_errors(argv)
644
trace.mutter("return code %d", ret)
648
def run_bzr_catch_errors(argv):
1124
bzrlib.trace.create_tracefile(argv)
651
# do this here inside the exception wrappers to catch EPIPE
653
except (KeyboardInterrupt, Exception), e:
654
# used to handle AssertionError and KeyboardInterrupt
655
# specially here, but hopefully they're handled ok by the logger now
656
trace.report_exception(sys.exc_info(), sys.stderr)
657
if os.environ.get('BZR_PDB'):
658
print '**** entering debugger'
660
pdb.post_mortem(sys.exc_traceback)
1131
_report_exception(e, 'error: ' + e.args[0])
1134
# some explanation or hints
1137
except AssertionError, e:
1138
msg = 'assertion failed'
1140
msg += ': ' + str(e)
1141
_report_exception(e, msg)
1142
except Exception, e:
1143
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1146
bzrlib.trace.close_trace()
1148
## TODO: Trap AssertionError
1150
# TODO: Maybe nicer handling of IOError especially for broken pipe.
663
1154
if __name__ == '__main__':
664
1155
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
