1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2006 by Canonical Ltd
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
11
# GNU General Public License for more details.
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
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?
33
from warnings import warn
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():
606
"""List ignored files and the patterns that matched them.
608
tree = Branch('.').working_tree()
609
for path, file_class, kind, file_id in tree.list_files():
610
if file_class != 'I':
612
## XXX: Slightly inefficient since this was already calculated
613
pat = tree.is_ignored(path)
614
print '%-50s %s' % (path, pat)
617
def cmd_lookup_revision(revno):
621
bailout("usage: lookup-revision REVNO",
622
["REVNO is a non-negative revision number for this branch"])
624
print Branch('.').lookup_revision(revno) or NONE_STRING
628
def cmd_export(revno, dest):
629
"""Export past revision to destination directory."""
631
rh = b.lookup_revision(int(revno))
632
t = b.revision_tree(rh)
635
def cmd_cat(revision, filename):
636
"""Print file to stdout."""
638
b.print_file(b.relpath(filename), int(revision))
641
######################################################################
642
# internal/test commands
646
"""Print a newly-generated UUID."""
647
print bzrlib.osutils.uuid()
651
def cmd_local_time_offset():
652
print bzrlib.osutils.local_time_offset()
656
def cmd_commit(message=None, verbose=False):
657
"""Commit changes to a new revision.
660
Description of changes in this revision; free form text.
661
It is recommended that the first line be a single-sentence
664
Show status of changed files,
666
TODO: Commit only selected files.
668
TODO: Run hooks on tree to-be-committed, and after commit.
670
TODO: Strict commit that fails if there are unknown or deleted files.
674
bailout("please specify a commit message")
675
Branch('.').commit(message, verbose=verbose)
678
def cmd_check(dir='.'):
679
"""check: Consistency check of branch history.
681
usage: bzr check [-v] [BRANCH]
684
--verbose, -v Show progress of checking.
686
This command checks various invariants about the branch storage to
687
detect data corruption or bzr bugs.
690
bzrlib.check.check(Branch(dir, find_root=False))
693
def cmd_is(pred, *rest):
694
"""Test whether PREDICATE is true."""
696
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
698
bailout("unknown predicate: %s" % quotefn(pred))
702
except BzrCheckError:
703
# by default we don't print the message so that this can
704
# be used from shell scripts without producing noise
708
def cmd_whoami(email=False):
714
--email Show only the email address.
718
print bzrlib.osutils.user_email()
720
print bzrlib.osutils.username()
723
def cmd_gen_revision_id():
724
print bzrlib.branch._gen_revision_id(time.time())
728
"""Run internal test suite"""
729
## -v, if present, is seen by doctest; the argument is just here
730
## so our parser doesn't complain
732
## TODO: --verbose option
734
failures, tests = 0, 0
736
import doctest, bzrlib.store, bzrlib.tests
737
bzrlib.trace.verbose = False
739
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
740
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
741
mf, mt = doctest.testmod(m)
744
print '%-40s %3d tests' % (m.__name__, mt),
746
print '%3d FAILED!' % mf
750
print '%-40s %3d tests' % ('total', tests),
752
print '%3d FAILED!' % failures
759
cmd_doctest = cmd_selftest
762
######################################################################
766
def cmd_help(topic=None):
769
elif topic == 'commands':
772
# otherwise, maybe the name of a command?
773
topic, cmdfn = get_cmd_handler(topic)
777
bailout("sorry, no detailed help yet for %r" % topic)
783
"""List all commands"""
785
for k in globals().keys():
786
if k.startswith('cmd_'):
787
accu.append(k[4:].replace('_','-'))
789
print "bzr commands: "
792
print "note: some of these commands are internal-use or obsolete"
793
# TODO: Some kind of marker for internal-use commands?
794
# TODO: Show aliases?
800
print "bzr (bazaar-ng) %s" % bzrlib.__version__
801
print bzrlib.__copyright__
802
print "http://bazaar-ng.org/"
805
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
806
you may use, modify and redistribute it under the terms of the GNU
807
General Public License version 2 or later."""
811
"""Statement of optimism."""
812
print "it sure does!"
816
######################################################################
820
# list of all available options; the rhs can be either None for an
821
# option that takes no argument, or a constructor function that checks
842
# List of options that apply to particular commands; commands not
847
'commit': ['message', 'verbose'],
848
'deleted': ['show-ids'],
849
'diff': ['revision'],
850
'inventory': ['revision'],
851
'log': ['timezone', 'verbose'],
852
'ls': ['revision', 'verbose'],
853
'remove': ['verbose'],
864
'export': ['revno', 'dest'],
865
'file-id': ['filename'],
866
'file-id-path': ['filename'],
867
'get-file-text': ['text_id'],
868
'get-inventory': ['inventory_id'],
869
'get-revision': ['revision_id'],
870
'get-revision-inventory': ['revision_id'],
874
'lookup-revision': ['revno'],
875
'move': ['source$', 'dest'],
876
'relpath': ['filename'],
878
'rename': ['from_name', 'to_name'],
880
'root': ['filename?'],
885
def parse_args(argv):
37
from bzrlib.errors import (BzrError,
42
from bzrlib.option import Option
43
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.symbol_versioning import *
46
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
51
def register_command(cmd, decorate=False):
52
"""Utility function to help register a command
54
:param cmd: Command subclass to register
55
:param decorate: If true, allow overriding an existing command
56
of the same name; the old command is returned by this function.
57
Otherwise it is an error to try to override an existing command.
61
if k.startswith("cmd_"):
62
k_unsquished = _unsquish_command_name(k)
65
if not plugin_cmds.has_key(k_unsquished):
66
plugin_cmds[k_unsquished] = cmd
67
mutter('registered plugin command %s', k_unsquished)
68
if decorate and k_unsquished in builtin_command_names():
69
return _builtin_commands()[k_unsquished]
71
result = plugin_cmds[k_unsquished]
72
plugin_cmds[k_unsquished] = cmd
75
log_error('Two plugins defined the same command: %r' % k)
76
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
79
def _squish_command_name(cmd):
80
return 'cmd_' + cmd.replace('-', '_')
83
def _unsquish_command_name(cmd):
84
assert cmd.startswith("cmd_")
85
return cmd[4:].replace('_','-')
88
def _builtin_commands():
89
import bzrlib.builtins
91
builtins = bzrlib.builtins.__dict__
93
if name.startswith("cmd_"):
94
real_name = _unsquish_command_name(name)
95
r[real_name] = builtins[name]
99
def builtin_command_names():
100
"""Return list of builtin command names."""
101
return _builtin_commands().keys()
104
def plugin_command_names():
105
return plugin_cmds.keys()
108
def _get_cmd_dict(plugins_override=True):
109
"""Return name->class mapping for all commands."""
110
d = _builtin_commands()
112
d.update(plugin_cmds)
116
def get_all_cmds(plugins_override=True):
117
"""Return canonical name and class for all registered commands."""
118
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
122
def get_cmd_object(cmd_name, plugins_override=True):
123
"""Return the canonical name and command class for a command.
126
If true, plugin commands can override builtins.
128
from bzrlib.externalcommand import ExternalCommand
130
cmd_name = str(cmd_name) # not unicode
132
# first look up this command under the specified name
133
cmds = _get_cmd_dict(plugins_override=plugins_override)
135
return cmds[cmd_name]()
139
# look for any command which claims this as an alias
140
for real_cmd_name, cmd_class in cmds.iteritems():
141
if cmd_name in cmd_class.aliases:
144
cmd_obj = ExternalCommand.find_command(cmd_name)
148
raise BzrCommandError("unknown command %r" % cmd_name)
151
class Command(object):
152
"""Base class for commands.
154
Commands are the heart of the command-line bzr interface.
156
The command object mostly handles the mapping of command-line
157
parameters into one or more bzrlib operations, and of the results
160
Commands normally don't have any state. All their arguments are
161
passed in to the run method. (Subclasses may take a different
162
policy if the behaviour of the instance needs to depend on e.g. a
163
shell plugin and not just its Python class.)
165
The docstring for an actual command should give a single-line
166
summary, then a complete description of the command. A grammar
167
description will be inserted.
170
Other accepted names for this command.
173
List of argument forms, marked with whether they are optional,
178
['to_location', 'from_branch?', 'file*']
180
'to_location' is required
181
'from_branch' is optional
182
'file' can be specified 0 or more times
185
List of options that may be given for this command. These can
186
be either strings, referring to globally-defined options,
187
or option objects. Retrieve through options().
190
If true, this command isn't advertised. This is typically
191
for commands intended for expert users.
200
"""Construct an instance of this command."""
201
if self.__doc__ == Command.__doc__:
202
warn("No help message set for %r" % self)
205
"""Return dict of valid options for this command.
207
Maps from long option name to option object."""
209
r['help'] = Option.OPTIONS['help']
210
for o in self.takes_options:
211
if not isinstance(o, Option):
212
o = Option.OPTIONS[o]
216
@deprecated_method(zero_eight)
217
def run_argv(self, argv):
218
"""Parse command line and run.
220
See run_argv_aliases for the 0.8 and beyond api.
222
return self.run_argv_aliases(argv)
224
def run_argv_aliases(self, argv, alias_argv=None):
225
"""Parse the command line and run with extra aliases in alias_argv."""
226
args, opts = parse_args(self, argv, alias_argv)
227
if 'help' in opts: # e.g. bzr add --help
228
from bzrlib.help import help_on_command
229
help_on_command(self.name())
231
# XXX: This should be handled by the parser
232
allowed_names = self.options().keys()
234
if oname not in allowed_names:
235
raise BzrCommandError("option '--%s' is not allowed for"
236
" command %r" % (oname, self.name()))
237
# mix arguments and options into one dictionary
238
cmdargs = _match_argform(self.name(), self.takes_args, args)
240
for k, v in opts.items():
241
cmdopts[k.replace('-', '_')] = v
243
all_cmd_args = cmdargs.copy()
244
all_cmd_args.update(cmdopts)
246
return self.run(**all_cmd_args)
249
"""Actually run the command.
251
This is invoked with the options and arguments bound to
254
Return 0 or None if the command was successful, or a non-zero
255
shell error code if not. It's OK for this method to allow
256
an exception to raise up.
258
raise NotImplementedError('no implementation of command %r'
262
"""Return help message for this class."""
263
from inspect import getdoc
264
if self.__doc__ is Command.__doc__:
269
return _unsquish_command_name(self.__class__.__name__)
272
def parse_spec(spec):
278
>>> parse_spec("../@")
280
>>> parse_spec("../f/@35")
282
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
283
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
288
parsed = spec.split('/@')
289
assert len(parsed) == 2
294
parsed[1] = int(parsed[1])
296
pass # We can allow stuff like ./@revid:blahblahblah
300
parsed = [spec, None]
303
def parse_args(command, argv, alias_argv=None):
886
304
"""Parse command line.
888
306
Arguments and options are parsed at this level before being passed
889
307
down to specific command handlers. This routine knows, from a
890
308
lookup table, something about the available options, what optargs
891
309
they take, and which commands will accept them.
893
>>> parse_args('--help'.split())
895
>>> parse_args('--version'.split())
896
([], {'version': True})
897
>>> parse_args('status --all'.split())
898
(['status'], {'all': True})
899
>>> parse_args('commit --message=biter'.split())
900
(['commit'], {'message': u'biter'})
311
# TODO: chop up this beast; make it a method of the Command
905
# TODO: Maybe handle '--' to end options?
910
# option names must not be unicode
914
mutter(" got option %r" % a)
916
optname, optarg = a[2:].split('=', 1)
316
cmd_options = command.options()
318
proc_aliasarg = True # Are we processing alias_argv now?
319
for proc_argv in alias_argv, argv:
326
# We've received a standalone -- No more flags
330
# option names must not be unicode
334
mutter(" got option %r", a)
336
optname, optarg = a[2:].split('=', 1)
339
if optname not in cmd_options:
340
raise BzrOptionError('unknown long option %r for'
919
if optname not in OPTIONS:
920
bailout('unknown long option %r' % a)
923
if shortopt not in SHORT_OPTIONS:
924
bailout('unknown short option %r' % a)
925
optname = SHORT_OPTIONS[shortopt]
928
# XXX: Do we ever want to support this, e.g. for -r?
929
bailout('repeated option %r' % a)
345
if shortopt in Option.SHORT_OPTIONS:
346
# Multi-character options must have a space to delimit
348
# ^^^ what does this mean? mbp 20051014
349
optname = Option.SHORT_OPTIONS[shortopt].name
351
# Single character short options, can be chained,
352
# and have their value appended to their name
354
if shortopt not in Option.SHORT_OPTIONS:
355
# We didn't find the multi-character name, and we
356
# didn't find the single char name
357
raise BzrError('unknown short option %r' % a)
358
optname = Option.SHORT_OPTIONS[shortopt].name
361
# There are extra things on this option
362
# see if it is the value, or if it is another
364
optargfn = Option.OPTIONS[optname].type
366
# This option does not take an argument, so the
367
# next entry is another short option, pack it
369
proc_argv.insert(0, '-' + a[2:])
371
# This option takes an argument, so pack it
931
optargfn = OPTIONS[optname]
935
bailout('option %r needs an argument' % a)
375
if optname not in cmd_options:
376
raise BzrOptionError('unknown short option %r for'
378
(shortopt, command.name()))
380
# XXX: Do we ever want to support this, e.g. for -r?
382
raise BzrError('repeated option %r' % a)
383
elif optname in alias_opts:
384
# Replace what's in the alias with what's in the real
386
del alias_opts[optname]
388
proc_argv.insert(0, a)
938
opts[optname] = optargfn(optarg)
391
raise BzrError('repeated option %r' % a)
393
option_obj = cmd_options[optname]
394
optargfn = option_obj.type
398
raise BzrError('option %r needs an argument' % a)
400
optarg = proc_argv.pop(0)
401
opts[optname] = optargfn(optarg)
403
alias_opts[optname] = optargfn(optarg)
406
raise BzrError('option %r takes no argument' % optname)
409
alias_opts[optname] = True
941
bailout('option %r takes no argument' % optname)
412
proc_aliasarg = False # Done with alias argv
946
413
return args, opts
950
def _match_args(cmd, args):
951
"""Check non-option arguments match required pattern.
953
>>> _match_args('status', ['asdasdsadasd'])
954
Traceback (most recent call last):
956
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
957
>>> _match_args('add', ['asdasdsadasd'])
958
{'file_list': ['asdasdsadasd']}
959
>>> _match_args('add', 'abc def gj'.split())
960
{'file_list': ['abc', 'def', 'gj']}
962
# match argument pattern
963
argform = cmd_args.get(cmd, [])
416
def _match_argform(cmd, takes_args, args):
965
# TODO: Need a way to express 'cp SRC... DEST', where it matches
968
# step through args and argform, allowing appropriate 0-many matches
419
# step through args and takes_args, allowing appropriate 0-many matches
420
for ap in takes_args:
970
421
argname = ap[:-1]
971
422
if ap[-1] == '?':
994
445
# just a plain arg
997
bailout("command %r requires argument %s"
448
raise BzrCommandError("command %r requires argument %s"
998
449
% (cmd, argname.upper()))
1000
451
argdict[argname] = args.pop(0)
1003
bailout("extra arguments to command %s: %r"
454
raise BzrCommandError("extra argument to command %s: %s"
461
def apply_profiled(the_callable, *args, **kwargs):
465
pffileno, pfname = tempfile.mkstemp()
467
prof = hotshot.Profile(pfname)
469
ret = prof.runcall(the_callable, *args, **kwargs) or 0
472
stats = hotshot.stats.load(pfname)
474
stats.sort_stats('cum') # 'time'
475
## XXX: Might like to write to stderr or the trace file instead but
476
## print_stats seems hardcoded to stdout
477
stats.print_stats(20)
484
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
485
from bzrlib.lsprof import profile
487
ret, stats = profile(the_callable, *args, **kwargs)
493
cPickle.dump(stats, open(filename, 'w'), 2)
494
print 'Profile data written to %r.' % filename
499
"""Return an expanded alias, or None if no alias exists"""
501
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
503
return alias.split(' ')
1010
507
def run_bzr(argv):
1011
508
"""Execute a command.
1013
510
This is similar to main(), but without all the trappings for
1014
511
logging and error handling.
514
The command-line arguments, without the program name from argv[0]
516
Returns a command status or raises an exception.
518
Special master options: these must come before the command because
519
they control how the command is interpreted.
522
Do not load plugin modules at all
528
Only use builtin commands. (Plugins are still allowed to change
532
Run under the Python hotshot profiler.
535
Run under the Python lsprof profiler.
1017
537
argv = [a.decode(bzrlib.user_encoding) for a in argv]
539
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
540
opt_no_aliases = False
541
opt_lsprof_file = None
543
# --no-plugins is handled specially at a very early stage. We need
544
# to load plugins before doing other command parsing so that they
545
# can override commands, but this needs to happen first.
553
elif a == '--lsprof':
555
elif a == '--lsprof-file':
556
opt_lsprof_file = argv[i + 1]
558
elif a == '--no-plugins':
559
opt_no_plugins = True
560
elif a == '--no-aliases':
561
opt_no_aliases = True
562
elif a == '--builtin':
564
elif a in ('--quiet', '-q'):
572
from bzrlib.builtins import cmd_help
573
cmd_help().run_argv_aliases([])
576
if argv[0] == '--version':
577
from bzrlib.builtins import show_version
581
if not opt_no_plugins:
582
from bzrlib.plugin import load_plugins
585
from bzrlib.plugin import disable_plugins
590
if not opt_no_aliases:
591
alias_argv = get_alias(argv[0])
593
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
594
argv[0] = alias_argv.pop(0)
596
cmd = str(argv.pop(0))
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]
1020
args, opts = parse_args(argv[1:])
1022
# TODO: pass down other arguments in case they asked for
1023
# help on a command name?
1029
elif 'version' in opts:
1032
cmd = str(args.pop(0))
1034
log_error('usage: bzr COMMAND')
1035
log_error(' try "bzr help"')
1038
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1041
if 'profile' in opts:
1047
# check options are reasonable
1048
allowed = cmd_options.get(canonical_cmd, [])
1050
if oname not in allowed:
1051
bailout("option %r is not allowed for command %r"
1054
# TODO: give an error if there are any mandatory options which are
1055
# not specified? Or maybe there shouldn't be any "mandatory
1056
# options" (it is an oxymoron)
1058
# mix arguments and options into one dictionary
1059
cmdargs = _match_args(canonical_cmd, args)
1060
for k, v in opts.items():
1061
cmdargs[k.replace('-', '_')] = v
1065
pffileno, pfname = tempfile.mkstemp()
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
618
def display_command(func):
619
"""Decorator that suppresses pipe/interrupt errors."""
620
def ignore_pipe(*args, **kwargs):
1067
prof = hotshot.Profile(pfname)
1068
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1071
import hotshot.stats
1072
stats = hotshot.stats.load(pfname)
1074
stats.sort_stats('time')
1075
## XXX: Might like to write to stderr or the trace file instead but
1076
## print_stats seems hardcoded to stdout
1077
stats.print_stats(20)
1085
return cmd_handler(**cmdargs) or 0
1089
def _report_exception(e, summary):
1091
log_error('bzr: ' + summary)
1092
bzrlib.trace.log_exception(e)
1093
tb = sys.exc_info()[2]
1094
exinfo = traceback.extract_tb(tb)
1096
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1097
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1100
def cmd_assert_fail():
1101
assert False, "always fails"
622
result = func(*args, **kwargs)
626
if not hasattr(e, 'errno'):
628
if e.errno != errno.EPIPE:
631
except KeyboardInterrupt:
1105
bzrlib.trace.create_tracefile(argv)
638
from bzrlib.ui.text import TextUIFactory
639
## bzrlib.trace.enable_default_logging()
640
bzrlib.trace.log_startup(argv)
641
bzrlib.ui.ui_factory = TextUIFactory()
642
ret = run_bzr_catch_errors(argv[1:])
643
mutter("return code %d", ret)
647
def run_bzr_catch_errors(argv):
1112
_report_exception(e, 'error: ' + e.args[0])
1115
# some explanation or hints
1118
except AssertionError, e:
1119
msg = 'assertion failed'
1121
msg += ': ' + str(e)
1122
_report_exception(e, msg)
1123
except Exception, e:
1124
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1127
bzrlib.trace.close_trace()
1129
## TODO: Trap AssertionError
1131
# TODO: Maybe nicer handling of IOError especially for broken pipe.
652
# do this here inside the exception wrappers to catch EPIPE
655
# used to handle AssertionError and KeyboardInterrupt
656
# specially here, but hopefully they're handled ok by the logger now
658
if (isinstance(e, IOError)
659
and hasattr(e, 'errno')
660
and e.errno == errno.EPIPE):
661
bzrlib.trace.note('broken pipe')
664
bzrlib.trace.log_exception()
665
if os.environ.get('BZR_PDB'):
666
print '**** entering debugger'
668
pdb.post_mortem(sys.exc_traceback)
1135
671
if __name__ == '__main__':
1136
672
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
