4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2006 Canonical Ltd
8
3
# This program is free software; you can redistribute it and/or modify
9
4
# it under the terms of the GNU General Public License as published by
10
5
# the Free Software Foundation; either version 2 of the License, or
11
6
# (at your option) any later version.
13
8
# This program is distributed in the hope that it will be useful,
14
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
11
# GNU General Public License for more details.
18
13
# You should have received a copy of the GNU General Public License
19
14
# along with this program; if not, write to the Free Software
20
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Show some information about this branch.
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
81
from pprint import pprint
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
86
from bzrlib.store import ImmutableStore
87
from bzrlib.trace import mutter, note, log_error
88
from bzrlib.errors import bailout, BzrError
89
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
from bzrlib.revision import Revision
92
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
98
## standard representation
99
NONE_STRING = '(none)'
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
108
## TODO: Some kind of locking on branches. Perhaps there should be a
109
## parameter to the branch object saying whether we want a read or
110
## write lock; release it from destructor. Perhaps don't even need a
111
## read lock to look at immutable objects?
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
116
## TODO: Some kind of global code to generate the right Branch object
117
## to work on. Almost, but not quite all, commands need one, and it
118
## can be taken either from their parameters or their working
121
## TODO: rename command, needed soon: check destination doesn't exist
122
## either in working copy or tree; move working copy; update
123
## inventory; write out
125
## TODO: move command; check destination is a directory and will not
128
## TODO: command to show renames, one per line, as to->from
133
def cmd_status(all=False):
134
"""Display status summary.
136
For each file there is a single line giving its file state and name.
137
The name is that in the current revision unless it is deleted or
138
missing, in which case the old name is shown.
140
:todo: Don't show unchanged files unless ``--all`` is given?
142
Branch('.').show_status(show_all=all)
146
######################################################################
148
def cmd_get_revision(revision_id):
149
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
152
def cmd_get_file_text(text_id):
153
"""Get contents of a file by hash."""
154
sf = Branch('.').text_store[text_id]
155
pumpfile(sf, sys.stdout)
159
######################################################################
164
"""Show number of revisions on this branch"""
165
print Branch('.').revno()
169
def cmd_add(file_list, verbose=False):
170
"""Add specified files or directories.
172
In non-recursive mode, all the named items are added, regardless
173
of whether they were previously ignored. A warning is given if
174
any of the named files are already versioned.
176
In recursive mode (the default), files are treated the same way
177
but the behaviour for directories is different. Directories that
178
are already versioned do not give a warning. All directories,
179
whether already versioned or not, are searched for files or
180
subdirectories that are neither versioned or ignored, and these
181
are added. This search proceeds recursively into versioned
184
Therefore simply saying 'bzr add .' will version all files that
185
are currently unknown.
188
bzrlib.add.smart_add(file_list, verbose)
192
b = Branch(file_list[0], find_root=True)
193
b.add([b.relpath(f) for f in file_list], verbose=verbose)
197
def cmd_relpath(filename):
198
print Branch(filename).relpath(filename)
201
def cmd_inventory(revision=None):
202
"""Show inventory of the current working copy."""
203
## TODO: Also optionally show a previous inventory
204
## TODO: Format options
207
inv = b.read_working_inventory()
209
inv = b.get_revision_inventory(b.lookup_revision(revision))
211
for path, entry in inv.iter_entries():
212
print '%-50s %s' % (entry.file_id, path)
218
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
220
def plural(n, base='', pl=None):
228
count_version_dirs = 0
230
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
231
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
233
count_status[fs] += 1
234
if fs not in ['I', '?'] and st_tup[4] == 'directory':
235
count_version_dirs += 1
238
print 'in the working tree:'
239
for name, fs in (('unchanged', '.'),
240
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
241
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
243
print ' %5d %s' % (count_status[fs], name)
244
print ' %5d versioned subdirector%s' % (count_version_dirs,
245
plural(count_version_dirs, 'y', 'ies'))
248
print 'branch history:'
249
history = b.revision_history()
251
print ' %5d revision%s' % (revno, plural(revno))
254
committers.add(b.get_revision(rev).committer)
255
print ' %5d committer%s' % (len(committers), plural(len(committers)))
257
firstrev = b.get_revision(history[0])
258
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
259
print ' %5d day%s old' % (age, plural(age))
260
print ' first revision: %s' % format_date(firstrev.timestamp,
263
lastrev = b.get_revision(history[-1])
264
print ' latest revision: %s' % format_date(lastrev.timestamp,
270
def cmd_remove(file_list, verbose=False):
271
b = Branch(file_list[0])
272
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
276
def cmd_file_id(filename):
278
i = b.inventory.path2id(b.relpath(filename))
280
bailout("%s is not a versioned file" % filename)
285
def cmd_find_filename(fileid):
286
n = find_filename(fileid)
288
bailout("%s is not a live file id" % fileid)
293
def cmd_revision_history():
294
for patchid in Branch('.').revision_history():
300
# TODO: Check we're not already in a working directory? At the
301
# moment you'll get an ugly error.
303
# TODO: What if we're in a subdirectory of a branch? Would like
304
# to allow that, but then the parent may need to understand that
305
# the children have disappeared, or should they be versioned in
308
# TODO: Take an argument/option for branch name.
309
Branch('.', init=True)
312
def cmd_diff(revision=None):
313
"""Show diff from basis to working copy.
315
:todo: Take one or two revision arguments, look up those trees,
318
:todo: Allow diff across branches.
320
:todo: Mangle filenames in diff to be more relevant.
322
:todo: Shouldn't be in the cmd function.
328
old_tree = b.basis_tree()
330
old_tree = b.revision_tree(b.lookup_revision(revision))
332
new_tree = b.working_tree()
333
old_inv = old_tree.inventory
334
new_inv = new_tree.inventory
336
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
340
DEVNULL = '/dev/null'
341
# Windows users, don't panic about this filename -- it is a
342
# special signal to GNU patch that the file should be created or
343
# deleted respectively.
345
# TODO: Generation of pseudo-diffs for added/deleted files could
346
# be usefully made into a much faster special case.
348
# TODO: Better to return them in sorted order I think.
350
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
353
# Don't show this by default; maybe do it if an option is passed
354
# idlabel = ' {%s}' % fid
357
# FIXME: Something about the diff format makes patch unhappy
358
# with newly-added files.
360
def diffit(*a, **kw):
361
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
364
if file_state in ['.', '?', 'I']:
366
elif file_state == 'A':
367
print '*** added %s %r' % (kind, new_name)
370
new_tree.get_file(fid).readlines(),
372
tofile=new_label + new_name + idlabel)
373
elif file_state == 'D':
374
assert isinstance(old_name, types.StringTypes)
375
print '*** deleted %s %r' % (kind, old_name)
377
diffit(old_tree.get_file(fid).readlines(), [],
378
fromfile=old_label + old_name + idlabel,
380
elif file_state in ['M', 'R']:
381
if file_state == 'M':
382
assert kind == 'file'
383
assert old_name == new_name
384
print '*** modified %s %r' % (kind, new_name)
385
elif file_state == 'R':
386
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
389
diffit(old_tree.get_file(fid).readlines(),
390
new_tree.get_file(fid).readlines(),
391
fromfile=old_label + old_name + idlabel,
392
tofile=new_label + new_name)
394
bailout("can't represent state %s {%s}" % (file_state, fid))
398
def cmd_root(filename=None):
399
"""Print the branch root."""
400
print bzrlib.branch.find_branch_root(filename)
403
def cmd_log(timezone='original'):
404
"""Show log of this branch.
406
:todo: Options for utc; to show ids; to limit range; etc.
408
Branch('.').write_log(show_timezone=timezone)
411
def cmd_ls(revision=None, verbose=False):
412
"""List files in a tree.
414
:todo: Take a revision or remote path and list that tree instead.
418
tree = b.working_tree()
420
tree = b.revision_tree(b.lookup_revision(revision))
422
for fp, fc, kind, fid in tree.list_files():
424
if kind == 'directory':
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
def run_argv_aliases(self, argv, alias_argv=None):
275
"""Parse the command line and run with extra aliases in alias_argv."""
277
warn("Passing None for [] is deprecated from bzrlib 0.10",
278
DeprecationWarning, stacklevel=2)
280
args, opts = parse_args(self, argv, alias_argv)
281
if 'help' in opts: # e.g. bzr add --help
282
from bzrlib.help import help_on_command
283
help_on_command(self.name())
285
# mix arguments and options into one dictionary
286
cmdargs = _match_argform(self.name(), self.takes_args, args)
288
for k, v in opts.items():
289
cmdopts[k.replace('-', '_')] = v
291
all_cmd_args = cmdargs.copy()
292
all_cmd_args.update(cmdopts)
296
return self.run(**all_cmd_args)
299
"""Actually run the command.
301
This is invoked with the options and arguments bound to
304
Return 0 or None if the command was successful, or a non-zero
305
shell error code if not. It's OK for this method to allow
306
an exception to raise up.
308
raise NotImplementedError('no implementation of command %r'
312
"""Return help message for this class."""
313
from inspect import getdoc
314
if self.__doc__ is Command.__doc__:
319
return _unsquish_command_name(self.__class__.__name__)
321
def plugin_name(self):
322
"""Get the name of the plugin that provides this command.
324
:return: The name of the plugin or None if the command is builtin.
326
mod_parts = self.__module__.split('.')
327
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
333
# Technically, this function hasn't been use in a *really* long time
334
# but we are only deprecating it now.
335
@deprecated_function(zero_eleven)
336
def parse_spec(spec):
342
>>> parse_spec("../@")
344
>>> parse_spec("../f/@35")
346
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
347
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
352
parsed = spec.split('/@')
353
assert len(parsed) == 2
358
parsed[1] = int(parsed[1])
360
pass # We can allow stuff like ./@revid:blahblahblah
431
print '%-8s %s%s' % (fc, fp, kindch)
438
"""List unknown files"""
439
for f in Branch('.').unknowns():
443
def cmd_lookup_revision(revno):
447
bailout("usage: lookup-revision REVNO",
448
["REVNO is a non-negative revision number for this branch"])
450
print Branch('.').lookup_revision(revno) or NONE_STRING
454
def cmd_export(revno, dest):
455
"""Export past revision to destination directory."""
457
rh = b.lookup_revision(int(revno))
458
t = b.revision_tree(rh)
463
######################################################################
464
# internal/test commands
468
"""Print a newly-generated UUID."""
469
print bzrlib.osutils.uuid()
473
def cmd_local_time_offset():
474
print bzrlib.osutils.local_time_offset()
478
def cmd_commit(message=None, verbose=False):
480
bailout("please specify a commit message")
481
Branch('.').commit(message, verbose=verbose)
485
"""Check consistency of the branch."""
489
def cmd_is(pred, *rest):
490
"""Test whether PREDICATE is true."""
492
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
494
bailout("unknown predicate: %s" % quotefn(pred))
498
except BzrCheckError:
499
# by default we don't print the message so that this can
500
# be used from shell scripts without producing noise
505
print bzrlib.osutils.username()
508
def cmd_user_email():
509
print bzrlib.osutils.user_email()
512
def cmd_gen_revision_id():
514
print bzrlib.branch._gen_revision_id(time.time())
517
def cmd_selftest(verbose=False):
518
"""Run internal test suite"""
519
## -v, if present, is seen by doctest; the argument is just here
520
## so our parser doesn't complain
522
## TODO: --verbose option
524
failures, tests = 0, 0
526
import doctest, bzrlib.store, bzrlib.tests
527
bzrlib.trace.verbose = False
529
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
530
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
531
mf, mt = doctest.testmod(m)
534
print '%-40s %3d tests' % (m.__name__, mt),
536
print '%3d FAILED!' % mf
540
print '%-40s %3d tests' % ('total', tests),
542
print '%3d FAILED!' % failures
549
cmd_doctest = cmd_selftest
552
######################################################################
557
# TODO: Specific help for particular commands
562
print "bzr (bazaar-ng) %s" % __version__
564
print "http://bazaar-ng.org/"
567
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
568
you may use, modify and redistribute it under the terms of the GNU
569
General Public License version 2 or later."""
573
"""Statement of optimism."""
574
print "it sure does!"
578
######################################################################
582
# list of all available options; the rhs can be either None for an
583
# option that takes no argument, or a constructor function that checks
602
# List of options that apply to particular commands; commands not
606
'commit': ['message', 'verbose'],
607
'diff': ['revision'],
608
'inventory': ['revision'],
609
'log': ['show-ids', 'timezone'],
610
'ls': ['revision', 'verbose'],
611
'remove': ['verbose'],
621
'file-id': ['filename'],
622
'root': ['filename?'],
623
'relpath': ['filename'],
624
'get-file-text': ['text_id'],
625
'get-inventory': ['inventory_id'],
626
'get-revision': ['revision_id'],
627
'get-revision-inventory': ['revision_id'],
629
'lookup-revision': ['revno'],
630
'export': ['revno', 'dest'],
636
def parse_args(argv):
364
parsed = [spec, None]
367
def parse_args(command, argv, alias_argv=None):
637
368
"""Parse command line.
639
370
Arguments and options are parsed at this level before being passed
640
371
down to specific command handlers. This routine knows, from a
641
372
lookup table, something about the available options, what optargs
642
373
they take, and which commands will accept them.
644
>>> parse_args('--help'.split())
646
>>> parse_args('--version'.split())
647
([], {'version': True})
648
>>> parse_args('status --all'.split())
649
(['status'], {'all': True})
650
>>> parse_args('commit --message=biter'.split())
651
(['commit'], {'message': u'biter'})
656
# TODO: Maybe handle '--' to end options?
663
mutter(" got option %r" % a)
665
optname, optarg = a[2:].split('=', 1)
668
if optname not in OPTIONS:
669
bailout('unknown long option %r' % a)
672
if shortopt not in SHORT_OPTIONS:
673
bailout('unknown short option %r' % a)
674
optname = SHORT_OPTIONS[shortopt]
677
# XXX: Do we ever want to support this, e.g. for -r?
678
bailout('repeated option %r' % a)
680
optargfn = OPTIONS[optname]
684
bailout('option %r needs an argument' % a)
687
opts[optname] = optargfn(optarg)
688
mutter(" option argument %r" % opts[optname])
691
bailout('option %r takes no argument' % optname)
375
# TODO: make it a method of the Command?
376
parser = option.get_optparser(command.options())
377
if alias_argv is not None:
378
args = alias_argv + argv
382
options, args = parser.parse_args(args)
383
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
384
v is not option.OptionParser.DEFAULT_VALUE])
696
385
return args, opts
700
def _match_args(cmd, args):
701
"""Check non-option arguments match required pattern.
703
>>> _match_args('status', ['asdasdsadasd'])
704
Traceback (most recent call last):
706
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
707
>>> _match_args('add', ['asdasdsadasd'])
708
{'file_list': ['asdasdsadasd']}
709
>>> _match_args('add', 'abc def gj'.split())
710
{'file_list': ['abc', 'def', 'gj']}
712
# match argument pattern
713
argform = cmd_args.get(cmd, [])
388
def _match_argform(cmd, takes_args, args):
715
# TODO: Need a way to express 'cp SRC... DEST', where it matches
718
# step through args and argform, allowing appropriate 0-many matches
391
# step through args and takes_args, allowing appropriate 0-many matches
392
for ap in takes_args:
720
393
argname = ap[:-1]
721
394
if ap[-1] == '?':
723
396
argdict[argname] = args.pop(0)
397
elif ap[-1] == '*': # all remaining arguments
399
argdict[argname + '_list'] = args[:]
402
argdict[argname + '_list'] = None
726
403
elif ap[-1] == '+':
728
bailout("command %r needs one or more %s"
729
% (cmd, argname.upper()))
405
raise errors.BzrCommandError("command %r needs one or more %s"
406
% (cmd, argname.upper()))
731
408
argdict[argname + '_list'] = args[:]
410
elif ap[-1] == '$': # all but one
412
raise errors.BzrCommandError("command %r needs one or more %s"
413
% (cmd, argname.upper()))
414
argdict[argname + '_list'] = args[:-1]
734
417
# just a plain arg
737
bailout("command %r requires argument %s"
738
% (cmd, argname.upper()))
420
raise errors.BzrCommandError("command %r requires argument %s"
421
% (cmd, argname.upper()))
740
423
argdict[argname] = args.pop(0)
743
bailout("extra arguments to command %s: %r"
426
raise errors.BzrCommandError("extra argument to command %s: %s"
433
def apply_profiled(the_callable, *args, **kwargs):
437
pffileno, pfname = tempfile.mkstemp()
439
prof = hotshot.Profile(pfname)
441
ret = prof.runcall(the_callable, *args, **kwargs) or 0
444
stats = hotshot.stats.load(pfname)
446
stats.sort_stats('cum') # 'time'
447
## XXX: Might like to write to stderr or the trace file instead but
448
## print_stats seems hardcoded to stdout
449
stats.print_stats(20)
456
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
457
from bzrlib.lsprof import profile
459
ret, stats = profile(the_callable, *args, **kwargs)
465
cPickle.dump(stats, open(filename, 'w'), 2)
466
print 'Profile data written to %r.' % filename
470
def get_alias(cmd, config=None):
471
"""Return an expanded alias, or None if no alias exists.
474
Command to be checked for an alias.
476
Used to specify an alternative config to use,
477
which is especially useful for testing.
478
If it is unspecified, the global config will be used.
482
config = bzrlib.config.GlobalConfig()
483
alias = config.get_alias(cmd)
486
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
750
490
def run_bzr(argv):
751
491
"""Execute a command.
753
493
This is similar to main(), but without all the trappings for
754
logging and error handling.
494
logging and error handling.
497
The command-line arguments, without the program name from argv[0]
498
These should already be decoded. All library/test code calling
499
run_bzr should be passing valid strings (don't need decoding).
501
Returns a command status or raises an exception.
503
Special master options: these must come before the command because
504
they control how the command is interpreted.
507
Do not load plugin modules at all
513
Only use builtin commands. (Plugins are still allowed to change
517
Run under the Python hotshot profiler.
520
Run under the Python lsprof profiler.
757
args, opts = parse_args(argv[1:])
759
# TODO: pass down other arguments in case they asked for
760
# help on a command name?
763
elif 'version' in opts:
768
log_error('usage: bzr COMMAND\n')
769
log_error(' try "bzr help"\n')
773
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
775
bailout("unknown command " + `cmd`)
777
# TODO: special --profile option to turn on the Python profiler
779
# check options are reasonable
780
allowed = cmd_options.get(cmd, [])
782
if oname not in allowed:
783
bailout("option %r is not allowed for command %r"
786
cmdargs = _match_args(cmd, args)
789
ret = cmd_handler(**cmdargs) or 0
523
trace.mutter("bzr arguments: %r", argv)
525
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
526
opt_no_aliases = False
527
opt_lsprof_file = None
529
# --no-plugins is handled specially at a very early stage. We need
530
# to load plugins before doing other command parsing so that they
531
# can override commands, but this needs to happen first.
539
elif a == '--lsprof':
541
elif a == '--lsprof-file':
543
opt_lsprof_file = argv[i + 1]
545
elif a == '--no-plugins':
546
opt_no_plugins = True
547
elif a == '--no-aliases':
548
opt_no_aliases = True
549
elif a == '--builtin':
551
elif a in ('--quiet', '-q'):
553
elif a.startswith('-D'):
554
debug.debug_flags.add(a[2:])
561
from bzrlib.builtins import cmd_help
562
cmd_help().run_argv_aliases([])
565
if argv[0] == '--version':
566
from bzrlib.version import show_version
570
if not opt_no_plugins:
571
from bzrlib.plugin import load_plugins
574
from bzrlib.plugin import disable_plugins
579
if not opt_no_aliases:
580
alias_argv = get_alias(argv[0])
582
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
583
argv[0] = alias_argv.pop(0)
586
# We want only 'ascii' command names, but the user may have typed
587
# in a Unicode name. In that case, they should just get a
588
# 'command not found' error later.
590
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
591
run = cmd_obj.run_argv_aliases
592
run_argv = [argv, alias_argv]
596
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
598
ret = apply_profiled(run, *run_argv)
603
# reset, in case we may do other commands later within the same process
604
trace.be_quiet(False)
606
def display_command(func):
607
"""Decorator that suppresses pipe/interrupt errors."""
608
def ignore_pipe(*args, **kwargs):
610
result = func(*args, **kwargs)
614
if getattr(e, 'errno', None) is None:
616
if e.errno != errno.EPIPE:
617
# Win32 raises IOError with errno=0 on a broken pipe
618
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
621
except KeyboardInterrupt:
794
## TODO: Handle command-line options; probably know what options are valid for
797
## TODO: If the arguments are wrong, give a usage message rather
798
## than just a backtrace.
800
bzrlib.trace.create_tracefile(argv)
628
from bzrlib.ui.text import TextUIFactory
629
bzrlib.ui.ui_factory = TextUIFactory()
630
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
631
ret = run_bzr_catch_errors(argv)
632
trace.mutter("return code %d", ret)
636
def run_bzr_catch_errors(argv):
806
log_error('bzr: error: ' + e.args[0] + '\n')
809
log_error(' ' + h + '\n')
812
log_error('bzr: exception: %s\n' % e)
813
log_error(' see .bzr.log for details\n')
814
traceback.print_exc(None, bzrlib.trace._tracefile)
815
traceback.print_exc(None, sys.stderr)
818
# TODO: Maybe nicer handling of IOError?
639
# do this here inside the exception wrappers to catch EPIPE
641
except (KeyboardInterrupt, Exception), e:
642
# used to handle AssertionError and KeyboardInterrupt
643
# specially here, but hopefully they're handled ok by the logger now
644
trace.report_exception(sys.exc_info(), sys.stderr)
645
if os.environ.get('BZR_PDB'):
646
print '**** entering debugger'
648
pdb.post_mortem(sys.exc_traceback)
822
651
if __name__ == '__main__':
823
652
sys.exit(main(sys.argv))
825
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
