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
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
67
from pprint import pprint
70
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
73
from bzrlib.store import ImmutableStore
74
from bzrlib.trace import mutter, note, log_error
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
## standard representation
86
NONE_STRING = '(none)'
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
112
## TODO: move command; check destination is a directory and will not
115
## TODO: command to show renames, one per line, as to->from
120
def cmd_status(all=False):
121
"""Display status summary.
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
127
#import bzrlib.status
128
#bzrlib.status.tree_status(Branch('.'))
129
Branch('.').show_status(show_all=all)
133
######################################################################
135
def cmd_get_revision(revision_id):
136
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
139
def cmd_get_file_text(text_id):
140
"""Get contents of a file by hash."""
141
sf = Branch('.').text_store[text_id]
142
pumpfile(sf, sys.stdout)
146
######################################################################
151
"""Show number of revisions on this branch"""
152
print Branch('.').revno()
156
def cmd_add(file_list, verbose=False):
157
"""Add specified files or directories.
159
In non-recursive mode, all the named items are added, regardless
160
of whether they were previously ignored. A warning is given if
161
any of the named files are already versioned.
163
In recursive mode (the default), files are treated the same way
164
but the behaviour for directories is different. Directories that
165
are already versioned do not give a warning. All directories,
166
whether already versioned or not, are searched for files or
167
subdirectories that are neither versioned or ignored, and these
168
are added. This search proceeds recursively into versioned
171
Therefore simply saying 'bzr add .' will version all files that
172
are currently unknown.
174
bzrlib.add.smart_add(file_list, verbose)
177
def cmd_relpath(filename):
178
"""Show path of file relative to root"""
179
print Branch(filename).relpath(filename)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
198
# TODO: Maybe a 'mv' command that has the combined move/rename
199
# special behaviour of Unix?
201
def cmd_move(source_list, dest):
204
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
208
def cmd_rename(from_name, to_name):
209
"""Change the name of an entry.
211
usage: bzr rename FROM_NAME TO_NAME
214
bzr rename frob.c frobber.c
215
bzr rename src/frob.c lib/frob.c
217
It is an error if the destination name exists.
219
See also the 'move' command, which moves files into a different
220
directory without changing their name.
222
TODO: Some way to rename multiple files without invoking bzr for each
225
b.rename_one(b.relpath(from_name), b.relpath(to_name))
230
def cmd_renames(dir='.'):
231
"""Show list of renamed files.
233
usage: bzr renames [BRANCH]
235
TODO: Option to show renames between two historical versions.
237
TODO: Only show renames under dir, rather than in the whole branch.
240
old_inv = b.basis_tree().inventory
241
new_inv = b.read_working_inventory()
243
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
245
for old_name, new_name in renames:
246
print "%s => %s" % (old_name, new_name)
251
"""info: Show statistical information for this branch
255
info.show_info(Branch('.'))
259
def cmd_remove(file_list, verbose=False):
260
b = Branch(file_list[0])
261
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
265
def cmd_file_id(filename):
266
"""Print file_id of a particular file or directory.
268
usage: bzr file-id FILE
270
The file_id is assigned when the file is first added and remains the
271
same through all revisions where the file exists, even when it is
275
i = b.inventory.path2id(b.relpath(filename))
277
bailout("%r is not a versioned file" % filename)
282
def cmd_file_id_path(filename):
283
"""Print path of file_ids to a file or directory.
285
usage: bzr file-id-path FILE
287
This prints one line for each directory down to the target,
288
starting at the branch root."""
291
fid = inv.path2id(b.relpath(filename))
293
bailout("%r is not a versioned file" % filename)
294
for fip in inv.get_idpath(fid):
298
def cmd_revision_history():
299
for patchid in Branch('.').revision_history():
303
def cmd_directories():
304
for name, ie in Branch('.').read_working_inventory().directories():
312
for name, ie in Branch('.').working_tree().missing():
317
# TODO: Check we're not already in a working directory? At the
318
# moment you'll get an ugly error.
320
# TODO: What if we're in a subdirectory of a branch? Would like
321
# to allow that, but then the parent may need to understand that
322
# the children have disappeared, or should they be versioned in
325
# TODO: Take an argument/option for branch name.
326
Branch('.', init=True)
329
def cmd_diff(revision=None, file_list=None):
330
"""bzr diff: Show differences in working tree.
332
usage: bzr diff [-r REV] [FILE...]
335
Show changes since REV, rather than predecessor.
337
If files are listed, only the changes in those files are listed.
338
Otherwise, all changes for the tree are listed.
340
TODO: Given two revision arguments, show the difference between them.
342
TODO: Allow diff across branches.
344
TODO: Option to use external diff command; could be GNU diff, wdiff,
347
TODO: If a directory is given, diff everything under that.
349
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
352
## TODO: Shouldn't be in the cmd function.
357
old_tree = b.basis_tree()
359
old_tree = b.revision_tree(b.lookup_revision(revision))
361
new_tree = b.working_tree()
363
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
367
DEVNULL = '/dev/null'
368
# Windows users, don't panic about this filename -- it is a
369
# special signal to GNU patch that the file should be created or
370
# deleted respectively.
372
# TODO: Generation of pseudo-diffs for added/deleted files could
373
# be usefully made into a much faster special case.
375
# TODO: Better to return them in sorted order I think.
377
# FIXME: If given a file list, compare only those files rather
378
# than comparing everything and then throwing stuff away.
380
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
382
if file_list and new_name not in file_list:
385
# Don't show this by default; maybe do it if an option is passed
386
# idlabel = ' {%s}' % fid
389
# FIXME: Something about the diff format makes patch unhappy
390
# with newly-added files.
392
def diffit(oldlines, newlines, **kw):
393
# FIXME: difflib is wrong if there is no trailing newline.
395
# Special workaround for Python2.3, where difflib fails if
396
# both sequences are empty.
397
if oldlines or newlines:
398
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
401
if file_state in ['.', '?', 'I']:
403
elif file_state == 'A':
404
print '*** added %s %r' % (kind, new_name)
407
new_tree.get_file(fid).readlines(),
409
tofile=new_label + new_name + idlabel)
410
elif file_state == 'D':
411
assert isinstance(old_name, types.StringTypes)
412
print '*** deleted %s %r' % (kind, old_name)
414
diffit(old_tree.get_file(fid).readlines(), [],
415
fromfile=old_label + old_name + idlabel,
417
elif file_state in ['M', 'R']:
418
if file_state == 'M':
419
assert kind == 'file'
420
assert old_name == new_name
421
print '*** modified %s %r' % (kind, new_name)
422
elif file_state == 'R':
423
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
426
diffit(old_tree.get_file(fid).readlines(),
427
new_tree.get_file(fid).readlines(),
428
fromfile=old_label + old_name + idlabel,
429
tofile=new_label + new_name)
431
bailout("can't represent state %s {%s}" % (file_state, fid))
435
def cmd_deleted(show_ids=False):
436
"""List files deleted in the working tree.
438
TODO: Show files deleted since a previous revision, or between two revisions.
442
new = b.working_tree()
444
## TODO: Much more efficient way to do this: read in new
445
## directories with readdir, rather than stating each one. Same
446
## level of effort but possibly much less IO. (Or possibly not,
447
## if the directories are very large...)
449
for path, ie in old.inventory.iter_entries():
450
if not new.has_id(ie.file_id):
452
print '%-50s %s' % (path, ie.file_id)
458
def cmd_parse_inventory():
461
cElementTree.ElementTree().parse(file('.bzr/inventory'))
465
def cmd_load_inventory():
466
"""Load inventory for timing purposes"""
467
Branch('.').basis_tree().inventory
470
def cmd_dump_inventory():
471
Branch('.').read_working_inventory().write_xml(sys.stdout)
474
def cmd_dump_new_inventory():
475
import bzrlib.newinventory
476
inv = Branch('.').basis_tree().inventory
477
bzrlib.newinventory.write_inventory(inv, sys.stdout)
480
def cmd_load_new_inventory():
481
import bzrlib.newinventory
482
bzrlib.newinventory.read_new_inventory(sys.stdin)
485
def cmd_dump_slacker_inventory():
486
import bzrlib.newinventory
487
inv = Branch('.').basis_tree().inventory
488
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
492
def cmd_dump_text_inventory():
493
import bzrlib.textinv
494
inv = Branch('.').basis_tree().inventory
495
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
498
def cmd_load_text_inventory():
499
import bzrlib.textinv
500
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
501
print 'loaded %d entries' % len(inv)
505
def cmd_root(filename=None):
506
"""Print the branch root."""
507
print bzrlib.branch.find_branch_root(filename)
510
def cmd_log(timezone='original', verbose=False):
511
"""Show log of this branch.
513
:todo: Options for utc; to show ids; to limit range; etc.
515
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
518
def cmd_ls(revision=None, verbose=False):
519
"""List files in a tree.
521
:todo: Take a revision or remote path and list that tree instead.
525
tree = b.working_tree()
527
tree = b.revision_tree(b.lookup_revision(revision))
529
for fp, fc, kind, fid in tree.list_files():
531
if kind == 'directory':
538
print '%-8s %s%s' % (fc, fp, kindch)
545
"""List unknown files"""
546
for f in Branch('.').unknowns():
552
"""List ignored files and the patterns that matched them.
554
tree = Branch('.').working_tree()
555
for path, file_class, kind, file_id in tree.list_files():
556
if file_class != 'I':
558
## XXX: Slightly inefficient since this was already calculated
559
pat = tree.is_ignored(path)
560
print '%-50s %s' % (path, pat)
563
def cmd_lookup_revision(revno):
567
bailout("usage: lookup-revision REVNO",
568
["REVNO is a non-negative revision number for this branch"])
570
print Branch('.').lookup_revision(revno) or NONE_STRING
574
def cmd_export(revno, dest):
575
"""Export past revision to destination directory."""
577
rh = b.lookup_revision(int(revno))
578
t = b.revision_tree(rh)
581
def cmd_cat(revision, filename):
582
"""Print file to stdout."""
584
b.print_file(b.relpath(filename), int(revision))
587
######################################################################
588
# internal/test commands
592
"""Print a newly-generated UUID."""
593
print bzrlib.osutils.uuid()
597
def cmd_local_time_offset():
598
print bzrlib.osutils.local_time_offset()
602
def cmd_commit(message=None, verbose=False):
603
"""Commit changes to a new revision.
606
Description of changes in this revision; free form text.
607
It is recommended that the first line be a single-sentence
610
Show status of changed files,
612
TODO: Commit only selected files.
614
TODO: Run hooks on tree to-be-committed, and after commit.
616
TODO: Strict commit that fails if there are unknown or deleted files.
620
bailout("please specify a commit message")
621
Branch('.').commit(message, verbose=verbose)
624
def cmd_check(dir='.'):
625
"""check: Consistency check of branch history.
627
usage: bzr check [-v] [BRANCH]
630
--verbose, -v Show progress of checking.
632
This command checks various invariants about the branch storage to
633
detect data corruption or bzr bugs.
636
bzrlib.check.check(Branch(dir, find_root=False))
639
def cmd_is(pred, *rest):
640
"""Test whether PREDICATE is true."""
642
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
644
bailout("unknown predicate: %s" % quotefn(pred))
648
except BzrCheckError:
649
# by default we don't print the message so that this can
650
# be used from shell scripts without producing noise
655
print bzrlib.osutils.username()
658
def cmd_user_email():
659
print bzrlib.osutils.user_email()
662
def cmd_gen_revision_id():
663
print bzrlib.branch._gen_revision_id(time.time())
667
"""Run internal test suite"""
668
## -v, if present, is seen by doctest; the argument is just here
669
## so our parser doesn't complain
671
## TODO: --verbose option
673
failures, tests = 0, 0
675
import doctest, bzrlib.store, bzrlib.tests
676
bzrlib.trace.verbose = False
678
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
679
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
680
mf, mt = doctest.testmod(m)
683
print '%-40s %3d tests' % (m.__name__, mt),
685
print '%3d FAILED!' % mf
689
print '%-40s %3d tests' % ('total', tests),
691
print '%3d FAILED!' % failures
698
cmd_doctest = cmd_selftest
701
######################################################################
705
def cmd_help(topic=None):
710
# otherwise, maybe the name of a command?
712
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
714
bailout("no help for %r" % topic)
718
bailout("sorry, no detailed help yet for %r" % topic)
726
print "bzr (bazaar-ng) %s" % bzrlib.__version__
727
print bzrlib.__copyright__
728
print "http://bazaar-ng.org/"
731
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
732
you may use, modify and redistribute it under the terms of the GNU
733
General Public License version 2 or later."""
737
"""Statement of optimism."""
738
print "it sure does!"
742
######################################################################
746
# list of all available options; the rhs can be either None for an
747
# option that takes no argument, or a constructor function that checks
767
# List of options that apply to particular commands; commands not
772
'commit': ['message', 'verbose'],
773
'deleted': ['show-ids'],
774
'diff': ['revision'],
775
'inventory': ['revision'],
776
'log': ['timezone', 'verbose'],
777
'ls': ['revision', 'verbose'],
778
'remove': ['verbose'],
788
'export': ['revno', 'dest'],
789
'file-id': ['filename'],
790
'file-id-path': ['filename'],
791
'get-file-text': ['text_id'],
792
'get-inventory': ['inventory_id'],
793
'get-revision': ['revision_id'],
794
'get-revision-inventory': ['revision_id'],
798
'lookup-revision': ['revno'],
799
'move': ['source$', 'dest'],
800
'relpath': ['filename'],
802
'rename': ['from_name', 'to_name'],
804
'root': ['filename?'],
809
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):
810
304
"""Parse command line.
812
306
Arguments and options are parsed at this level before being passed
813
307
down to specific command handlers. This routine knows, from a
814
308
lookup table, something about the available options, what optargs
815
309
they take, and which commands will accept them.
817
>>> parse_args('--help'.split())
819
>>> parse_args('--version'.split())
820
([], {'version': True})
821
>>> parse_args('status --all'.split())
822
(['status'], {'all': True})
823
>>> parse_args('commit --message=biter'.split())
824
(['commit'], {'message': u'biter'})
311
# TODO: chop up this beast; make it a method of the Command
829
# TODO: Maybe handle '--' to end options?
836
mutter(" got option %r" % a)
838
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'
841
if optname not in OPTIONS:
842
bailout('unknown long option %r' % a)
845
if shortopt not in SHORT_OPTIONS:
846
bailout('unknown short option %r' % a)
847
optname = SHORT_OPTIONS[shortopt]
850
# XXX: Do we ever want to support this, e.g. for -r?
851
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
853
optargfn = OPTIONS[optname]
857
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)
860
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
863
bailout('option %r takes no argument' % optname)
412
proc_aliasarg = False # Done with alias argv
868
413
return args, opts
872
def _match_args(cmd, args):
873
"""Check non-option arguments match required pattern.
875
>>> _match_args('status', ['asdasdsadasd'])
876
Traceback (most recent call last):
878
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
879
>>> _match_args('add', ['asdasdsadasd'])
880
{'file_list': ['asdasdsadasd']}
881
>>> _match_args('add', 'abc def gj'.split())
882
{'file_list': ['abc', 'def', 'gj']}
884
# match argument pattern
885
argform = cmd_args.get(cmd, [])
416
def _match_argform(cmd, takes_args, args):
887
# TODO: Need a way to express 'cp SRC... DEST', where it matches
890
# 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:
892
421
argname = ap[:-1]
893
422
if ap[-1] == '?':
916
445
# just a plain arg
919
bailout("command %r requires argument %s"
448
raise BzrCommandError("command %r requires argument %s"
920
449
% (cmd, argname.upper()))
922
451
argdict[argname] = args.pop(0)
925
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(' ')
932
507
def run_bzr(argv):
933
508
"""Execute a command.
935
510
This is similar to main(), but without all the trappings for
936
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.
939
537
argv = [a.decode(bzrlib.user_encoding) for a in argv]
942
args, opts = parse_args(argv[1:])
944
# TODO: pass down other arguments in case they asked for
945
# help on a command name?
951
elif 'version' in opts:
956
log_error('usage: bzr COMMAND\n')
957
log_error(' try "bzr help"\n')
961
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
963
bailout("unknown command " + `cmd`)
966
if 'profile' in opts:
972
# check options are reasonable
973
allowed = cmd_options.get(cmd, [])
975
if oname not in allowed:
976
bailout("option %r is not allowed for command %r"
979
# TODO: give an error if there are any mandatory options which are
980
# not specified? Or maybe there shouldn't be any "mandatory
981
# options" (it is an oxymoron)
983
# mix arguments and options into one dictionary
984
cmdargs = _match_args(cmd, args)
985
for k, v in opts.items():
986
cmdargs[str(k.replace('-', '_'))] = v
990
pffileno, pfname = tempfile.mkstemp()
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]
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):
992
prof = hotshot.Profile(pfname)
993
ret = prof.runcall(cmd_handler, **cmdargs) or 0
997
stats = hotshot.stats.load(pfname)
999
stats.sort_stats('time')
1000
## XXX: Might like to write to stderr or the trace file instead but
1001
## print_stats seems hardcoded to stdout
1002
stats.print_stats(20)
1010
return cmd_handler(**cmdargs) or 0
622
result = func(*args, **kwargs)
626
if not hasattr(e, 'errno'):
628
if e.errno != errno.EPIPE:
631
except KeyboardInterrupt:
1015
## TODO: Handle command-line options; probably know what options are valid for
1018
## TODO: If the arguments are wrong, give a usage message rather
1019
## than just a backtrace.
1021
bzrlib.trace.create_tracefile(argv)
638
from bzrlib.ui.text import TextUIFactory
639
## bzrlib.trace.enable_default_logging()
640
bzrlib.ui.ui_factory = TextUIFactory()
641
ret = run_bzr_catch_errors(argv[1:])
642
mutter("return code %d", ret)
646
def run_bzr_catch_errors(argv):
1027
log_error('bzr: error: ' + e.args[0] + '\n')
1030
log_error(' ' + h + '\n')
1031
traceback.print_exc(None, bzrlib.trace._tracefile)
1032
log_error('(see $HOME/.bzr.log for debug information)\n')
651
# do this here inside the exception wrappers to catch EPIPE
1034
653
except Exception, e:
1035
log_error('bzr: exception: %s\n' % e)
1036
log_error('(see $HOME/.bzr.log for debug information)\n')
1037
traceback.print_exc(None, bzrlib.trace._tracefile)
1038
## traceback.print_exc(None, sys.stderr)
1041
## TODO: Trap AssertionError
1043
# TODO: Maybe nicer handling of IOError especially for broken pipe.
654
# used to handle AssertionError and KeyboardInterrupt
655
# specially here, but hopefully they're handled ok by the logger now
656
bzrlib.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)
1047
663
if __name__ == '__main__':
1048
664
sys.exit(main(sys.argv))
1050
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
