139
36
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
140
38
return cmd[4:].replace('_','-')
143
def _builtin_commands():
144
import bzrlib.builtins
145
return _scan_module_for_commands(bzrlib.builtins)
148
def _scan_module_for_commands(module):
150
for name, obj in module.__dict__.iteritems():
151
if name.startswith("cmd_"):
152
real_name = _unsquish_command_name(name)
157
def _list_bzr_commands(names):
158
"""Find commands from bzr's core and plugins."""
159
# to eliminate duplicates
160
names.update(builtin_command_names())
161
names.update(plugin_command_names())
165
def all_command_names():
166
"""Return a set of all command names."""
168
for hook in Command.hooks['list_commands']:
171
raise AssertionError(
172
'hook %s returned None' % Command.hooks.get_hook_name(hook))
176
def builtin_command_names():
177
"""Return list of builtin command names.
179
Use of all_command_names() is encouraged rather than builtin_command_names
180
and/or plugin_command_names.
182
return _builtin_commands().keys()
185
def plugin_command_names():
186
"""Returns command names from commands registered by plugins."""
187
return plugin_cmds.keys()
190
def get_cmd_object(cmd_name, plugins_override=True):
191
"""Return the command object for a command.
194
If true, plugin commands can override builtins.
197
return _get_cmd_object(cmd_name, plugins_override)
199
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
202
def _get_cmd_object(cmd_name, plugins_override=True):
203
"""Get a command object.
205
:param cmd_name: The name of the command.
206
:param plugins_override: Allow plugins to override builtins.
207
:return: A Command object instance
208
:raises KeyError: If no command is found.
210
# We want only 'ascii' command names, but the user may have typed
211
# in a Unicode name. In that case, they should just get a
212
# 'command not found' error later.
213
# In the future, we may actually support Unicode command names.
216
for hook in Command.hooks['get_command']:
217
cmd = hook(cmd, cmd_name)
218
if cmd is not None and not plugins_override and not cmd.plugin_name():
219
# We've found a non-plugin command, don't permit it to be
223
for hook in Command.hooks['get_missing_command']:
230
# Allow plugins to extend commands
231
for hook in Command.hooks['extend_command']:
236
def _try_plugin_provider(cmd_name):
237
"""Probe for a plugin provider having cmd_name."""
239
plugin_metadata, provider = probe_for_provider(cmd_name)
240
raise errors.CommandAvailableInPlugin(cmd_name,
241
plugin_metadata, provider)
242
except errors.NoPluginAvailable:
246
def probe_for_provider(cmd_name):
247
"""Look for a provider for cmd_name.
249
:param cmd_name: The command name.
250
:return: plugin_metadata, provider for getting cmd_name.
251
:raises NoPluginAvailable: When no provider can supply the plugin.
253
# look for providers that provide this command but aren't installed
254
for provider in command_providers_registry:
256
return provider.plugin_for_command(cmd_name), provider
257
except errors.NoPluginAvailable:
259
raise errors.NoPluginAvailable(cmd_name)
262
def _get_bzr_command(cmd_or_None, cmd_name):
263
"""Get a command from bzr's core."""
264
cmds = _builtin_commands()
266
return cmds[cmd_name]()
41
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
47
"""Return the canonical name and command class for a command.
49
cmd = str(cmd) # not unicode
51
# first look up this command under the specified name
53
return cmd, globals()[_squish_command_name(cmd)]
269
57
# look for any command which claims this as an alias
270
for real_cmd_name, cmd_class in cmds.iteritems():
271
if cmd_name in cmd_class.aliases:
276
def _get_external_command(cmd_or_None, cmd_name):
277
"""Lookup a command that is a shell script."""
278
# Only do external command lookups when no command is found so far.
279
if cmd_or_None is not None:
281
from bzrlib.externalcommand import ExternalCommand
282
cmd_obj = ExternalCommand.find_command(cmd_name)
287
def _get_plugin_command(cmd_or_None, cmd_name):
288
"""Get a command from bzr's plugins."""
290
return plugin_cmds.get(cmd_name)()
293
for key in plugin_cmds.keys():
294
info = plugin_cmds.get_info(key)
295
if cmd_name in info.aliases:
296
return plugin_cmds.get(key)()
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
62
cmdclass = ExternalCommand.find_command(cmd)
66
raise BzrCommandError("unknown command %r" % cmd)
300
69
class Command(object):
301
70
"""Base class for commands.
303
Commands are the heart of the command-line bzr interface.
305
The command object mostly handles the mapping of command-line
306
parameters into one or more bzrlib operations, and of the results
309
Commands normally don't have any state. All their arguments are
310
passed in to the run method. (Subclasses may take a different
311
policy if the behaviour of the instance needs to depend on e.g. a
312
shell plugin and not just its Python class.)
314
72
The docstring for an actual command should give a single-line
315
73
summary, then a complete description of the command. A grammar
316
74
description will be inserted.
319
Other accepted names for this command.
322
77
List of argument forms, marked with whether they are optional,
327
['to_location', 'from_branch?', 'file*']
329
'to_location' is required
330
'from_branch' is optional
331
'file' can be specified 0 or more times
334
List of options that may be given for this command. These can
335
be either strings, referring to globally-defined options,
336
or option objects. Retrieve through options().
81
List of options that may be given for this command.
339
If true, this command isn't advertised. This is typically
340
for commands intended for expert users.
343
Command objects will get a 'outf' attribute, which has been
344
setup to properly handle encoding of unicode strings.
345
encoding_type determines what will happen when characters cannot
347
strict - abort if we cannot decode
348
replace - put in a bogus character (typically '?')
349
exact - do not encode sys.stdout
351
NOTE: by default on Windows, sys.stdout is opened as a text
352
stream, therefore LF line-endings are converted to CRLF.
353
When a command uses encoding_type = 'exact', then
354
sys.stdout is forced to be a binary stream, and line-endings
357
:cvar hooks: An instance of CommandHooks.
84
If true, this command isn't advertised.
361
89
takes_options = []
362
encoding_type = 'strict'
367
"""Construct an instance of this command."""
368
if self.__doc__ == Command.__doc__:
369
warn("No help message set for %r" % self)
370
# List of standard options directly supported
371
self.supported_std_options = []
372
self._operation = cleanup.OperationWithCleanups(self.run)
374
def add_cleanup(self, cleanup_func, *args, **kwargs):
375
"""Register a function to call after self.run returns or raises.
377
Functions will be called in LIFO order.
379
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
381
def cleanup_now(self):
382
"""Execute and empty pending cleanup functions immediately.
384
After cleanup_now all registered cleanups are forgotten. add_cleanup
385
may be called again after cleanup_now; these cleanups will be called
386
after self.run returns or raises (or when cleanup_now is next called).
388
This is useful for releasing expensive or contentious resources (such
389
as write locks) before doing further work that does not require those
390
resources (such as writing results to self.outf).
392
self._operation.cleanup_now()
394
@deprecated_method(deprecated_in((2, 1, 0)))
395
def _maybe_expand_globs(self, file_list):
396
"""Glob expand file_list if the platform does not do that itself.
398
Not used anymore, now that the bzr command-line parser globs on
401
:return: A possibly empty list of unicode paths.
403
Introduced in bzrlib 0.18.
408
"""Return single-line grammar for this command.
410
Only describes arguments, not options.
412
s = 'bzr ' + self.name() + ' '
413
for aname in self.takes_args:
414
aname = aname.upper()
415
if aname[-1] in ['$', '+']:
416
aname = aname[:-1] + '...'
417
elif aname[-1] == '?':
418
aname = '[' + aname[:-1] + ']'
419
elif aname[-1] == '*':
420
aname = '[' + aname[:-1] + '...]'
422
s = s[:-1] # remove last space
425
def get_help_text(self, additional_see_also=None, plain=True,
426
see_also_as_links=False, verbose=True):
427
"""Return a text string with help for this command.
429
:param additional_see_also: Additional help topics to be
431
:param plain: if False, raw help (reStructuredText) is
432
returned instead of plain text.
433
:param see_also_as_links: if True, convert items in 'See also'
434
list to internal links (used by bzr_man rstx generator)
435
:param verbose: if True, display the full help, otherwise
436
leave out the descriptive sections and just display
437
usage help (e.g. Purpose, Usage, Options) with a
438
message explaining how to obtain full help.
442
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
444
# Extract the summary (purpose) and sections out from the text
445
purpose,sections,order = self._get_help_parts(doc)
447
# If a custom usage section was provided, use it
448
if sections.has_key('Usage'):
449
usage = sections.pop('Usage')
451
usage = self._usage()
453
# The header is the purpose and usage
455
result += ':Purpose: %s\n' % purpose
456
if usage.find('\n') >= 0:
457
result += ':Usage:\n%s\n' % usage
459
result += ':Usage: %s\n' % usage
464
# XXX: optparse implicitly rewraps the help, and not always perfectly,
465
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
467
options = option.get_optparser(self.options()).format_option_help()
468
# XXX: According to the spec, ReST option lists actually don't support
469
# options like --1.9 so that causes syntax errors (in Sphinx at least).
470
# As that pattern always appears in the commands that break, we trap
471
# on that and then format that block of 'format' options as a literal
473
if not plain and options.find(' --1.9 ') != -1:
474
options = options.replace(' format:\n', ' format::\n\n', 1)
475
if options.startswith('Options:'):
476
result += ':' + options
477
elif options.startswith('options:'):
478
# Python 2.4 version of optparse
479
result += ':Options:' + options[len('options:'):]
485
# Add the description, indenting it 2 spaces
486
# to match the indentation of the options
487
if sections.has_key(None):
488
text = sections.pop(None)
489
text = '\n '.join(text.splitlines())
490
result += ':%s:\n %s\n\n' % ('Description',text)
492
# Add the custom sections (e.g. Examples). Note that there's no need
493
# to indent these as they must be indented already in the source.
496
if sections.has_key(label):
497
result += ':%s:\n%s\n' % (label,sections[label])
500
result += ("See bzr help %s for more details and examples.\n\n"
503
# Add the aliases, source (plug-in) and see also links, if any
505
result += ':Aliases: '
506
result += ', '.join(self.aliases) + '\n'
507
plugin_name = self.plugin_name()
508
if plugin_name is not None:
509
result += ':From: plugin "%s"\n' % plugin_name
510
see_also = self.get_see_also(additional_see_also)
512
if not plain and see_also_as_links:
514
for item in see_also:
516
# topics doesn't have an independent section
517
# so don't create a real link
518
see_also_links.append(item)
520
# Use a Sphinx link for this entry
521
link_text = ":doc:`%s <%s-help>`" % (item, item)
522
see_also_links.append(link_text)
523
see_also = see_also_links
524
result += ':See also: '
525
result += ', '.join(see_also) + '\n'
527
# If this will be rendered as plain text, convert it
529
import bzrlib.help_topics
530
result = bzrlib.help_topics.help_as_plain_text(result)
534
def _get_help_parts(text):
535
"""Split help text into a summary and named sections.
537
:return: (summary,sections,order) where summary is the top line and
538
sections is a dictionary of the rest indexed by section name.
539
order is the order the section appear in the text.
540
A section starts with a heading line of the form ":xxx:".
541
Indented text on following lines is the section value.
542
All text found outside a named section is assigned to the
543
default section which is given the key of None.
545
def save_section(sections, order, label, section):
547
if sections.has_key(label):
548
sections[label] += '\n' + section
551
sections[label] = section
553
lines = text.rstrip().splitlines()
554
summary = lines.pop(0)
557
label,section = None,''
559
if line.startswith(':') and line.endswith(':') and len(line) > 2:
560
save_section(sections, order, label, section)
561
label,section = line[1:-1],''
562
elif (label is not None) and len(line) > 1 and not line[0].isspace():
563
save_section(sections, order, label, section)
564
label,section = None,line
567
section += '\n' + line
570
save_section(sections, order, label, section)
571
return summary, sections, order
573
def get_help_topic(self):
574
"""Return the commands help topic - its name."""
577
def get_see_also(self, additional_terms=None):
578
"""Return a list of help topics that are related to this command.
580
The list is derived from the content of the _see_also attribute. Any
581
duplicates are removed and the result is in lexical order.
582
:param additional_terms: Additional help topics to cross-reference.
583
:return: A list of help topics.
585
see_also = set(getattr(self, '_see_also', []))
587
see_also.update(additional_terms)
588
return sorted(see_also)
591
"""Return dict of valid options for this command.
593
Maps from long option name to option object."""
594
r = Option.STD_OPTIONS.copy()
596
for o in self.takes_options:
597
if isinstance(o, basestring):
598
o = option.Option.OPTIONS[o]
600
if o.name in std_names:
601
self.supported_std_options.append(o.name)
604
def _setup_outf(self):
605
"""Return a file linked to stdout, which has proper encoding."""
606
self.outf = ui.ui_factory.make_output_stream(
607
encoding_type=self.encoding_type)
609
def run_argv_aliases(self, argv, alias_argv=None):
610
"""Parse the command line and run with extra aliases in alias_argv."""
611
args, opts = parse_args(self, argv, alias_argv)
613
# Process the standard options
614
if 'help' in opts: # e.g. bzr add --help
615
sys.stdout.write(self.get_help_text())
617
if 'usage' in opts: # e.g. bzr add --usage
618
sys.stdout.write(self.get_help_text(verbose=False))
620
trace.set_verbosity_level(option._verbosity_level)
621
if 'verbose' in self.supported_std_options:
622
opts['verbose'] = trace.is_verbose()
623
elif opts.has_key('verbose'):
625
if 'quiet' in self.supported_std_options:
626
opts['quiet'] = trace.is_quiet()
627
elif opts.has_key('quiet'):
630
# mix arguments and options into one dictionary
631
cmdargs = _match_argform(self.name(), self.takes_args, args)
633
for k, v in opts.items():
634
cmdopts[k.replace('-', '_')] = v
636
all_cmd_args = cmdargs.copy()
637
all_cmd_args.update(cmdopts)
641
return self.run_direct(**all_cmd_args)
643
def run_direct(self, *args, **kwargs):
644
"""Call run directly with objects (without parsing an argv list)."""
645
return self._operation.run_simple(*args, **kwargs)
93
def __init__(self, options, arguments):
94
"""Construct and run the command.
96
Sets self.status to the return value of run()."""
97
assert isinstance(options, dict)
98
assert isinstance(arguments, dict)
99
cmdargs = options.copy()
100
cmdargs.update(arguments)
101
assert self.__doc__ != Command.__doc__, \
102
("No help message set for %r" % self)
103
self.status = self.run(**cmdargs)
648
"""Actually run the command.
107
"""Override this in sub-classes.
650
109
This is invoked with the options and arguments bound to
651
110
keyword parameters.
653
Return 0 or None if the command was successful, or a non-zero
654
shell error code if not. It's OK for this method to allow
655
an exception to raise up.
657
raise NotImplementedError('no implementation of command %r'
661
"""Return help message for this class."""
662
from inspect import getdoc
663
if self.__doc__ is Command.__doc__:
668
return _unsquish_command_name(self.__class__.__name__)
670
def plugin_name(self):
671
"""Get the name of the plugin that provides this command.
673
:return: The name of the plugin or None if the command is builtin.
675
mod_parts = self.__module__.split('.')
676
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
682
class CommandHooks(Hooks):
683
"""Hooks related to Command object creation/enumeration."""
686
"""Create the default hooks.
688
These are all empty initially, because by default nothing should get
692
self.create_hook(HookPoint('extend_command',
693
"Called after creating a command object to allow modifications "
694
"such as adding or removing options, docs etc. Called with the "
695
"new bzrlib.commands.Command object.", (1, 13), None))
696
self.create_hook(HookPoint('get_command',
697
"Called when creating a single command. Called with "
698
"(cmd_or_None, command_name). get_command should either return "
699
"the cmd_or_None parameter, or a replacement Command object that "
700
"should be used for the command. Note that the Command.hooks "
701
"hooks are core infrastructure. Many users will prefer to use "
702
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
704
self.create_hook(HookPoint('get_missing_command',
705
"Called when creating a single command if no command could be "
706
"found. Called with (command_name). get_missing_command should "
707
"either return None, or a Command object to be used for the "
708
"command.", (1, 17), None))
709
self.create_hook(HookPoint('list_commands',
710
"Called when enumerating commands. Called with a set of "
711
"cmd_name strings for all the commands found so far. This set "
712
" is safe to mutate - e.g. to remove a command. "
713
"list_commands should return the updated set of command names.",
716
Command.hooks = CommandHooks()
719
def parse_args(command, argv, alias_argv=None):
112
Return 0 or None if the command was successful, or a shell
118
class ExternalCommand(Command):
119
"""Class to wrap external commands.
121
We cheat a little here, when get_cmd_class() calls us we actually give it back
122
an object we construct that has the appropriate path, help, options etc for the
125
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
126
method, which we override to call the Command.__init__ method. That then calls
127
our run method which is pretty straight forward.
129
The only wrinkle is that we have to map bzr's dictionary of options and arguments
130
back into command line options and arguments for the script.
133
def find_command(cls, cmd):
134
bzrpath = os.environ.get('BZRPATH', '')
136
for dir in bzrpath.split(':'):
137
path = os.path.join(dir, cmd)
138
if os.path.isfile(path):
139
return ExternalCommand(path)
143
find_command = classmethod(find_command)
145
def __init__(self, path):
148
# TODO: If either of these fail, we should detect that and
149
# assume that path is not really a bzr plugin after all.
151
pipe = os.popen('%s --bzr-usage' % path, 'r')
152
self.takes_options = pipe.readline().split()
153
self.takes_args = pipe.readline().split()
156
pipe = os.popen('%s --bzr-help' % path, 'r')
157
self.__doc__ = pipe.read()
160
def __call__(self, options, arguments):
161
Command.__init__(self, options, arguments)
164
def run(self, **kargs):
172
if OPTIONS.has_key(name):
174
opts.append('--%s' % name)
175
if value is not None and value is not True:
176
opts.append(str(value))
178
# it's an arg, or arg list
179
if type(value) is not list:
185
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
189
class cmd_status(Command):
190
"""Display status summary.
192
This reports on versioned and unknown files, reporting them
193
grouped by state. Possible states are:
196
Versioned in the working copy but not in the previous revision.
199
Versioned in the previous revision but removed or deleted
203
Path of this file changed from the previous revision;
204
the text may also have changed. This includes files whose
205
parent directory was renamed.
208
Text has changed since the previous revision.
211
Nothing about this file has changed since the previous revision.
212
Only shown with --all.
215
Not versioned and not matching an ignore pattern.
217
To see ignored files use 'bzr ignored'. For details in the
218
changes to file texts, use 'bzr diff'.
220
If no arguments are specified, the status of the entire working
221
directory is shown. Otherwise, only the status of the specified
222
files or directories is reported. If a directory is given, status
223
is reported for everything inside that directory.
225
takes_args = ['file*']
226
takes_options = ['all', 'show-ids']
227
aliases = ['st', 'stat']
229
def run(self, all=False, show_ids=False, file_list=None):
231
b = Branch(file_list[0], lock_mode='r')
232
file_list = [b.relpath(x) for x in file_list]
233
# special case: only one path was given and it's the root
235
if file_list == ['']:
238
b = Branch('.', lock_mode='r')
240
status.show_status(b, show_unchanged=all, show_ids=show_ids,
241
specific_files=file_list)
244
class cmd_cat_revision(Command):
245
"""Write out metadata for a revision."""
248
takes_args = ['revision_id']
250
def run(self, revision_id):
251
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
254
class cmd_revno(Command):
255
"""Show current revision number.
257
This is equal to the number of revisions on this branch."""
259
print Branch('.').revno()
262
class cmd_add(Command):
263
"""Add specified files or directories.
265
In non-recursive mode, all the named items are added, regardless
266
of whether they were previously ignored. A warning is given if
267
any of the named files are already versioned.
269
In recursive mode (the default), files are treated the same way
270
but the behaviour for directories is different. Directories that
271
are already versioned do not give a warning. All directories,
272
whether already versioned or not, are searched for files or
273
subdirectories that are neither versioned or ignored, and these
274
are added. This search proceeds recursively into versioned
277
Therefore simply saying 'bzr add .' will version all files that
278
are currently unknown.
280
TODO: Perhaps adding a file whose directly is not versioned should
281
recursively add that parent, rather than giving an error?
283
takes_args = ['file+']
284
takes_options = ['verbose']
286
def run(self, file_list, verbose=False):
287
bzrlib.add.smart_add(file_list, verbose)
290
class cmd_relpath(Command):
291
"""Show path of a file relative to root"""
292
takes_args = ['filename']
294
def run(self, filename):
295
print Branch(filename).relpath(filename)
299
class cmd_inventory(Command):
300
"""Show inventory of the current working copy or a revision."""
301
takes_options = ['revision']
303
def run(self, revision=None):
306
inv = b.read_working_inventory()
308
inv = b.get_revision_inventory(b.lookup_revision(revision))
310
for path, entry in inv.entries():
311
print '%-50s %s' % (entry.file_id, path)
314
class cmd_move(Command):
315
"""Move files to a different directory.
320
The destination must be a versioned directory in the same branch.
322
takes_args = ['source$', 'dest']
323
def run(self, source_list, dest):
326
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
329
class cmd_rename(Command):
330
"""Change the name of an entry.
333
bzr rename frob.c frobber.c
334
bzr rename src/frob.c lib/frob.c
336
It is an error if the destination name exists.
338
See also the 'move' command, which moves files into a different
339
directory without changing their name.
341
TODO: Some way to rename multiple files without invoking bzr for each
343
takes_args = ['from_name', 'to_name']
345
def run(self, from_name, to_name):
347
b.rename_one(b.relpath(from_name), b.relpath(to_name))
351
class cmd_renames(Command):
352
"""Show list of renamed files.
354
TODO: Option to show renames between two historical versions.
356
TODO: Only show renames under dir, rather than in the whole branch.
358
takes_args = ['dir?']
360
def run(self, dir='.'):
362
old_inv = b.basis_tree().inventory
363
new_inv = b.read_working_inventory()
365
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
367
for old_name, new_name in renames:
368
print "%s => %s" % (old_name, new_name)
371
class cmd_info(Command):
372
"""Show statistical information about a branch."""
373
takes_args = ['branch?']
375
def run(self, branch=None):
378
from branch import find_branch
379
b = find_branch(branch)
383
class cmd_remove(Command):
384
"""Make a file unversioned.
386
This makes bzr stop tracking changes to a versioned file. It does
387
not delete the working copy.
389
takes_args = ['file+']
390
takes_options = ['verbose']
392
def run(self, file_list, verbose=False):
393
b = Branch(file_list[0])
394
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
397
class cmd_file_id(Command):
398
"""Print file_id of a particular file or directory.
400
The file_id is assigned when the file is first added and remains the
401
same through all revisions where the file exists, even when it is
405
takes_args = ['filename']
406
def run(self, filename):
408
i = b.inventory.path2id(b.relpath(filename))
410
bailout("%r is not a versioned file" % filename)
415
class cmd_file_path(Command):
416
"""Print path of file_ids to a file or directory.
418
This prints one line for each directory down to the target,
419
starting at the branch root."""
421
takes_args = ['filename']
422
def run(self, filename):
425
fid = inv.path2id(b.relpath(filename))
427
bailout("%r is not a versioned file" % filename)
428
for fip in inv.get_idpath(fid):
432
class cmd_revision_history(Command):
433
"""Display list of revision ids on this branch."""
435
for patchid in Branch('.').revision_history():
439
class cmd_directories(Command):
440
"""Display list of versioned directories in this branch."""
442
for name, ie in Branch('.').read_working_inventory().directories():
449
class cmd_init(Command):
450
"""Make a directory into a versioned branch.
452
Use this to create an empty branch, or before importing an
455
Recipe for importing a tree of files:
460
bzr commit -m 'imported project'
463
Branch('.', init=True)
466
class cmd_diff(Command):
467
"""Show differences in working tree.
469
If files are listed, only the changes in those files are listed.
470
Otherwise, all changes for the tree are listed.
472
TODO: Given two revision arguments, show the difference between them.
474
TODO: Allow diff across branches.
476
TODO: Option to use external diff command; could be GNU diff, wdiff,
479
TODO: Python difflib is not exactly the same as unidiff; should
480
either fix it up or prefer to use an external diff.
482
TODO: If a directory is given, diff everything under that.
484
TODO: Selected-file diff is inefficient and doesn't show you
487
TODO: This probably handles non-Unix newlines poorly.
490
takes_args = ['file*']
491
takes_options = ['revision']
494
def run(self, revision=None, file_list=None):
495
from bzrlib.diff import show_diff
496
from bzrlib import find_branch
499
b = find_branch(file_list[0], lock_mode='r')
500
file_list = [b.relpath(f) for f in file_list]
501
if file_list == ['']:
502
# just pointing to top-of-tree
505
b = Branch('.', lock_mode='r')
507
show_diff(b, revision, specific_files=file_list)
513
class cmd_deleted(Command):
514
"""List files deleted in the working tree.
516
TODO: Show files deleted since a previous revision, or between two revisions.
518
def run(self, show_ids=False):
521
new = b.working_tree()
523
## TODO: Much more efficient way to do this: read in new
524
## directories with readdir, rather than stating each one. Same
525
## level of effort but possibly much less IO. (Or possibly not,
526
## if the directories are very large...)
528
for path, ie in old.inventory.iter_entries():
529
if not new.has_id(ie.file_id):
531
print '%-50s %s' % (path, ie.file_id)
536
class cmd_modified(Command):
537
"""List files modified in working tree."""
542
inv = b.read_working_inventory()
543
sc = statcache.update_cache(b, inv)
544
basis = b.basis_tree()
545
basis_inv = basis.inventory
547
# We used to do this through iter_entries(), but that's slow
548
# when most of the files are unmodified, as is usually the
549
# case. So instead we iterate by inventory entry, and only
550
# calculate paths as necessary.
552
for file_id in basis_inv:
553
cacheentry = sc.get(file_id)
554
if not cacheentry: # deleted
556
ie = basis_inv[file_id]
557
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
558
path = inv.id2path(file_id)
563
class cmd_added(Command):
564
"""List files added in working tree."""
568
wt = b.working_tree()
569
basis_inv = b.basis_tree().inventory
572
if file_id in basis_inv:
574
path = inv.id2path(file_id)
575
if not os.access(b.abspath(path), os.F_OK):
581
class cmd_root(Command):
582
"""Show the tree root directory.
584
The root is the nearest enclosing directory with a .bzr control
586
takes_args = ['filename?']
587
def run(self, filename=None):
588
"""Print the branch root."""
589
from branch import find_branch
590
b = find_branch(filename)
591
print getattr(b, 'base', None) or getattr(b, 'baseurl')
594
class cmd_log(Command):
595
"""Show log of this branch.
597
TODO: Option to limit range.
600
takes_args = ['filename?']
601
takes_options = ['forward', 'timezone', 'verbose', 'show-ids']
603
def run(self, filename=None, timezone='original',
607
from bzrlib import show_log, find_branch
609
direction = (forward and 'forward') or 'reverse'
612
b = find_branch(filename, lock_mode='r')
613
fp = b.relpath(filename)
615
file_id = b.read_working_inventory().path2id(fp)
617
file_id = None # points to branch root
619
b = find_branch('.', lock_mode='r')
623
show_timezone=timezone,
631
class cmd_touching_revisions(Command):
632
"""Return revision-ids which affected a particular file.
634
A more user-friendly interface is "bzr log FILE"."""
636
takes_args = ["filename"]
637
def run(self, filename):
638
b = Branch(filename, lock_mode='r')
639
inv = b.read_working_inventory()
640
file_id = inv.path2id(b.relpath(filename))
641
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
642
print "%6d %s" % (revno, what)
645
class cmd_ls(Command):
646
"""List files in a tree.
648
TODO: Take a revision or remote path and list that tree instead.
651
def run(self, revision=None, verbose=False):
654
tree = b.working_tree()
656
tree = b.revision_tree(b.lookup_revision(revision))
658
for fp, fc, kind, fid in tree.list_files():
660
if kind == 'directory':
667
print '%-8s %s%s' % (fc, fp, kindch)
673
class cmd_unknowns(Command):
674
"""List unknown files"""
676
for f in Branch('.').unknowns():
681
class cmd_ignore(Command):
682
"""Ignore a command or pattern
684
To remove patterns from the ignore list, edit the .bzrignore file.
686
If the pattern contains a slash, it is compared to the whole path
687
from the branch root. Otherwise, it is comapred to only the last
688
component of the path.
690
Ignore patterns are case-insensitive on case-insensitive systems.
692
Note: wildcards must be quoted from the shell on Unix.
695
bzr ignore ./Makefile
698
takes_args = ['name_pattern']
700
def run(self, name_pattern):
701
from bzrlib.atomicfile import AtomicFile
705
ifn = b.abspath('.bzrignore')
707
if os.path.exists(ifn):
710
igns = f.read().decode('utf-8')
716
if igns and igns[-1] != '\n':
718
igns += name_pattern + '\n'
721
f = AtomicFile(ifn, 'wt')
722
f.write(igns.encode('utf-8'))
727
inv = b.working_tree().inventory
728
if inv.path2id('.bzrignore'):
729
mutter('.bzrignore is already versioned')
731
mutter('need to make new .bzrignore file versioned')
732
b.add(['.bzrignore'])
736
class cmd_ignored(Command):
737
"""List ignored files and the patterns that matched them.
739
See also: bzr ignore"""
741
tree = Branch('.').working_tree()
742
for path, file_class, kind, file_id in tree.list_files():
743
if file_class != 'I':
745
## XXX: Slightly inefficient since this was already calculated
746
pat = tree.is_ignored(path)
747
print '%-50s %s' % (path, pat)
750
class cmd_lookup_revision(Command):
751
"""Lookup the revision-id from a revision-number
754
bzr lookup-revision 33
757
takes_args = ['revno']
759
def run(self, revno):
763
raise BzrCommandError("not a valid revision-number: %r" % revno)
765
print Branch('.').lookup_revision(revno)
768
class cmd_export(Command):
769
"""Export past revision to destination directory.
771
If no revision is specified this exports the last committed revision."""
772
takes_args = ['dest']
773
takes_options = ['revision']
774
def run(self, dest, revision=None):
777
rh = b.revision_history()[-1]
779
rh = b.lookup_revision(int(revision))
780
t = b.revision_tree(rh)
784
class cmd_cat(Command):
785
"""Write a file's text from a previous revision."""
787
takes_options = ['revision']
788
takes_args = ['filename']
790
def run(self, filename, revision=None):
792
raise BzrCommandError("bzr cat requires a revision number")
794
b.print_file(b.relpath(filename), int(revision))
797
class cmd_local_time_offset(Command):
798
"""Show the offset in seconds from GMT to local time."""
801
print bzrlib.osutils.local_time_offset()
805
class cmd_commit(Command):
806
"""Commit changes into a new revision.
808
If selected files are specified, only changes to those files are
809
committed. If a directory is specified then its contents are also
812
A selected-file commit may fail in some cases where the committed
813
tree would be invalid, such as trying to commit a file in a
814
newly-added directory that is not itself committed.
816
TODO: Run hooks on tree to-be-committed, and after commit.
818
TODO: Strict commit that fails if there are unknown or deleted files.
820
takes_args = ['selected*']
821
takes_options = ['message', 'file', 'verbose']
822
aliases = ['ci', 'checkin']
824
def run(self, message=None, file=None, verbose=True, selected_list=None):
825
from bzrlib.commit import commit
827
## Warning: shadows builtin file()
828
if not message and not file:
829
raise BzrCommandError("please specify a commit message",
830
["use either --message or --file"])
831
elif message and file:
832
raise BzrCommandError("please specify either --message or --file")
836
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
839
commit(b, message, verbose=verbose, specific_files=selected_list)
842
class cmd_check(Command):
843
"""Validate consistency of branch history.
845
This command checks various invariants about the branch storage to
846
detect data corruption or bzr bugs.
848
takes_args = ['dir?']
849
def run(self, dir='.'):
851
bzrlib.check.check(Branch(dir))
855
class cmd_whoami(Command):
856
"""Show bzr user id."""
857
takes_options = ['email']
859
def run(self, email=False):
861
print bzrlib.osutils.user_email()
863
print bzrlib.osutils.username()
866
class cmd_selftest(Command):
867
"""Run internal test suite"""
870
failures, tests = 0, 0
872
import doctest, bzrlib.store
873
bzrlib.trace.verbose = False
875
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
876
bzrlib.tree, bzrlib.commands, bzrlib.add:
877
mf, mt = doctest.testmod(m)
880
print '%-40s %3d tests' % (m.__name__, mt),
882
print '%3d FAILED!' % mf
886
print '%-40s %3d tests' % ('total', tests),
888
print '%3d FAILED!' % failures
896
class cmd_version(Command):
897
"""Show version of bzr"""
902
print "bzr (bazaar-ng) %s" % bzrlib.__version__
903
print bzrlib.__copyright__
904
print "http://bazaar-ng.org/"
906
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
907
print "you may use, modify and redistribute it under the terms of the GNU"
908
print "General Public License version 2 or later."
911
class cmd_rocks(Command):
912
"""Statement of optimism."""
915
print "it sure does!"
917
def parse_spec(spec):
919
parsed = spec.split('/@')
920
assert len(parsed) == 2
924
parsed[1] = int(parsed[1])
927
parsed = [spec, None]
930
class cmd_merge(Command):
931
"""Perform a three-way merge of trees."""
932
takes_args = ['other_spec', 'base_spec']
934
def run(self, other_spec, base_spec):
935
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
937
class cmd_assert_fail(Command):
938
"""Test reporting of assertion failures"""
941
assert False, "always fails"
944
class cmd_help(Command):
945
"""Show help on a command or other topic.
947
For a list of all available commands, say 'bzr help commands'."""
948
takes_args = ['topic?']
951
def run(self, topic=None):
956
class cmd_update_stat_cache(Command):
957
"""Update stat-cache mapping inodes to SHA-1 hashes.
964
statcache.update_cache(b.base, b.read_working_inventory())
967
######################################################################
971
# list of all available options; the rhs can be either None for an
972
# option that takes no argument, or a constructor function that checks
997
def parse_args(argv):
720
998
"""Parse command line.
722
1000
Arguments and options are parsed at this level before being passed
723
1001
down to specific command handlers. This routine knows, from a
724
1002
lookup table, something about the available options, what optargs
725
1003
they take, and which commands will accept them.
1005
>>> parse_args('--help'.split())
1006
([], {'help': True})
1007
>>> parse_args('--version'.split())
1008
([], {'version': True})
1009
>>> parse_args('status --all'.split())
1010
(['status'], {'all': True})
1011
>>> parse_args('commit --message=biter'.split())
1012
(['commit'], {'message': u'biter'})
727
# TODO: make it a method of the Command?
728
parser = option.get_optparser(command.options())
729
if alias_argv is not None:
730
args = alias_argv + argv
734
options, args = parser.parse_args(args)
735
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
736
v is not option.OptionParser.DEFAULT_VALUE])
1017
# TODO: Maybe handle '--' to end options?
1022
# option names must not be unicode
1026
mutter(" got option %r" % a)
1028
optname, optarg = a[2:].split('=', 1)
1031
if optname not in OPTIONS:
1032
bailout('unknown long option %r' % a)
1035
if shortopt not in SHORT_OPTIONS:
1036
bailout('unknown short option %r' % a)
1037
optname = SHORT_OPTIONS[shortopt]
1040
# XXX: Do we ever want to support this, e.g. for -r?
1041
bailout('repeated option %r' % a)
1043
optargfn = OPTIONS[optname]
1047
bailout('option %r needs an argument' % a)
1049
optarg = argv.pop(0)
1050
opts[optname] = optargfn(optarg)
1053
bailout('option %r takes no argument' % optname)
1054
opts[optname] = True
737
1058
return args, opts
740
1063
def _match_argform(cmd, takes_args, args):
754
1077
argdict[argname + '_list'] = None
755
1078
elif ap[-1] == '+':
757
raise errors.BzrCommandError("command %r needs one or more %s"
758
% (cmd, argname.upper()))
1080
raise BzrCommandError("command %r needs one or more %s"
1081
% (cmd, argname.upper()))
760
1083
argdict[argname + '_list'] = args[:]
762
1085
elif ap[-1] == '$': # all but one
763
1086
if len(args) < 2:
764
raise errors.BzrCommandError("command %r needs one or more %s"
765
% (cmd, argname.upper()))
1087
raise BzrCommandError("command %r needs one or more %s"
1088
% (cmd, argname.upper()))
766
1089
argdict[argname + '_list'] = args[:-1]
769
1092
# just a plain arg
772
raise errors.BzrCommandError("command %r requires argument %s"
773
% (cmd, argname.upper()))
1095
raise BzrCommandError("command %r requires argument %s"
1096
% (cmd, argname.upper()))
775
1098
argdict[argname] = args.pop(0)
778
raise errors.BzrCommandError("extra argument to command %s: %s"
1101
raise BzrCommandError("extra argument to command %s: %s"
783
def apply_coveraged(dirname, the_callable, *args, **kwargs):
784
# Cannot use "import trace", as that would import bzrlib.trace instead of
785
# the standard library's trace.
786
trace = __import__('trace')
788
tracer = trace.Trace(count=1, trace=0)
789
sys.settrace(tracer.globaltrace)
790
threading.settrace(tracer.globaltrace)
793
return exception_to_return_code(the_callable, *args, **kwargs)
796
results = tracer.results()
797
results.write_results(show_missing=1, summary=False,
801
def apply_profiled(the_callable, *args, **kwargs):
805
pffileno, pfname = tempfile.mkstemp()
807
prof = hotshot.Profile(pfname)
1109
"""Execute a command.
1111
This is similar to main(), but without all the trappings for
1112
logging and error handling.
1114
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1117
args, opts = parse_args(argv[1:])
1125
elif 'version' in opts:
1128
cmd = str(args.pop(0))
1135
canonical_cmd, cmd_class = get_cmd_class(cmd)
1138
if 'profile' in opts:
1144
# check options are reasonable
1145
allowed = cmd_class.takes_options
1147
if oname not in allowed:
1148
raise BzrCommandError("option '--%s' is not allowed for command %r"
1151
# mix arguments and options into one dictionary
1152
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1154
for k, v in opts.items():
1155
cmdopts[k.replace('-', '_')] = v
1158
import hotshot, tempfile
1159
pffileno, pfname = tempfile.mkstemp()
809
ret = prof.runcall(exception_to_return_code, the_callable, *args,
1161
prof = hotshot.Profile(pfname)
1162
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
813
stats = hotshot.stats.load(pfname)
815
stats.sort_stats('cum') # 'time'
816
## XXX: Might like to write to stderr or the trace file instead but
817
## print_stats seems hardcoded to stdout
818
stats.print_stats(20)
825
def exception_to_return_code(the_callable, *args, **kwargs):
826
"""UI level helper for profiling and coverage.
828
This transforms exceptions into a return value of 3. As such its only
829
relevant to the UI layer, and should never be called where catching
830
exceptions may be desirable.
1165
import hotshot.stats
1166
stats = hotshot.stats.load(pfname)
1168
stats.sort_stats('time')
1169
## XXX: Might like to write to stderr or the trace file instead but
1170
## print_stats seems hardcoded to stdout
1171
stats.print_stats(20)
1179
return cmd_class(cmdopts, cmdargs).status
1182
def _report_exception(summary, quiet=False):
1184
log_error('bzr: ' + summary)
1185
bzrlib.trace.log_exception()
1188
tb = sys.exc_info()[2]
1189
exinfo = traceback.extract_tb(tb)
1191
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1192
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1199
bzrlib.open_tracefile(argv)
833
return the_callable(*args, **kwargs)
834
except (KeyboardInterrupt, Exception), e:
835
# used to handle AssertionError and KeyboardInterrupt
836
# specially here, but hopefully they're handled ok by the logger now
837
exc_info = sys.exc_info()
838
exitcode = trace.report_exception(exc_info, sys.stderr)
839
if os.environ.get('BZR_PDB'):
840
print '**** entering debugger'
843
if sys.version_info[:2] < (2, 6):
845
# pdb.post_mortem(tb)
846
# but because pdb.post_mortem gives bad results for tracebacks
847
# from inside generators, we do it manually.
848
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
850
# Setup pdb on the traceback
853
p.setup(tb.tb_frame, tb)
854
# Point the debugger at the deepest frame of the stack
855
p.curindex = len(p.stack) - 1
856
p.curframe = p.stack[p.curindex][0]
857
# Start the pdb prompt.
858
p.print_stack_entry(p.stack[p.curindex])
1204
return run_bzr(argv)
1206
# do this here inside the exception wrappers to catch EPIPE
1209
quiet = isinstance(e, (BzrCommandError))
1210
_report_exception('error: ' + e.args[0], quiet=quiet)
1213
# some explanation or hints
1216
except AssertionError, e:
1217
msg = 'assertion failed'
1219
msg += ': ' + str(e)
1220
_report_exception(msg)
1222
except KeyboardInterrupt, e:
1223
_report_exception('interrupted', quiet=True)
1225
except Exception, e:
1227
if (isinstance(e, IOError)
1228
and hasattr(e, 'errno')
1229
and e.errno == errno.EPIPE):
866
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
867
from bzrlib.lsprof import profile
868
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
874
trace.note('Profile data written to "%s".', filename)
878
def get_alias(cmd, config=None):
879
"""Return an expanded alias, or None if no alias exists.
882
Command to be checked for an alias.
884
Used to specify an alternative config to use,
885
which is especially useful for testing.
886
If it is unspecified, the global config will be used.
890
config = bzrlib.config.GlobalConfig()
891
alias = config.get_alias(cmd)
893
return cmdline.split(alias)
897
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
898
"""Execute a command.
900
:param argv: The command-line arguments, without the program name from
901
argv[0] These should already be decoded. All library/test code calling
902
run_bzr should be passing valid strings (don't need decoding).
903
:param load_plugins: What function to call when triggering plugin loading.
904
This function should take no arguments and cause all plugins to be
906
:param disable_plugins: What function to call when disabling plugin
907
loading. This function should take no arguments and cause all plugin
908
loading to be prohibited (so that code paths in your application that
909
know about some plugins possibly being present will fail to import
910
those plugins even if they are installed.)
911
:return: Returns a command exit code or raises an exception.
913
Special master options: these must come before the command because
914
they control how the command is interpreted.
917
Do not load plugin modules at all
923
Only use builtin commands. (Plugins are still allowed to change
927
Run under the Python hotshot profiler.
930
Run under the Python lsprof profiler.
933
Generate line coverage report in the specified directory.
936
Specify the number of processes that can be run concurrently (selftest).
938
trace.mutter("bazaar version: " + bzrlib.__version__)
940
trace.mutter("bzr arguments: %r", argv)
942
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
943
opt_no_aliases = False
944
opt_lsprof_file = opt_coverage_dir = None
946
# --no-plugins is handled specially at a very early stage. We need
947
# to load plugins before doing other command parsing so that they
948
# can override commands, but this needs to happen first.
956
elif a == '--lsprof':
958
elif a == '--lsprof-file':
960
opt_lsprof_file = argv[i + 1]
962
elif a == '--no-plugins':
963
opt_no_plugins = True
964
elif a == '--no-aliases':
965
opt_no_aliases = True
966
elif a == '--builtin':
968
elif a == '--concurrency':
969
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
971
elif a == '--coverage':
972
opt_coverage_dir = argv[i + 1]
974
elif a.startswith('-D'):
975
debug.debug_flags.add(a[2:])
980
debug.set_debug_flags_from_config()
982
if not opt_no_plugins:
989
get_cmd_object('help').run_argv_aliases([])
992
if argv[0] == '--version':
993
get_cmd_object('version').run_argv_aliases([])
998
if not opt_no_aliases:
999
alias_argv = get_alias(argv[0])
1001
user_encoding = osutils.get_user_encoding()
1002
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1003
argv[0] = alias_argv.pop(0)
1006
# We want only 'ascii' command names, but the user may have typed
1007
# in a Unicode name. In that case, they should just get a
1008
# 'command not found' error later.
1010
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1011
run = cmd_obj.run_argv_aliases
1012
run_argv = [argv, alias_argv]
1015
# We can be called recursively (tests for example), but we don't want
1016
# the verbosity level to propagate.
1017
saved_verbosity_level = option._verbosity_level
1018
option._verbosity_level = 0
1020
if opt_coverage_dir:
1022
'--coverage ignored, because --lsprof is in use.')
1023
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1025
if opt_coverage_dir:
1027
'--coverage ignored, because --profile is in use.')
1028
ret = apply_profiled(run, *run_argv)
1029
elif opt_coverage_dir:
1030
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1032
ret = run(*run_argv)
1233
msg = str(e).rstrip('\n')
1234
_report_exception(msg, quiet)
1035
# reset, in case we may do other commands later within the same
1036
# process. Commands that want to execute sub-commands must propagate
1037
# --verbose in their own way.
1038
if 'memory' in debug.debug_flags:
1039
trace.debug_memory('Process status after command:', short=False)
1040
option._verbosity_level = saved_verbosity_level
1043
def display_command(func):
1044
"""Decorator that suppresses pipe/interrupt errors."""
1045
def ignore_pipe(*args, **kwargs):
1047
result = func(*args, **kwargs)
1051
if getattr(e, 'errno', None) is None:
1053
if e.errno != errno.EPIPE:
1054
# Win32 raises IOError with errno=0 on a broken pipe
1055
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1058
except KeyboardInterrupt:
1063
def install_bzr_command_hooks():
1064
"""Install the hooks to supply bzr's own commands."""
1065
if _list_bzr_commands in Command.hooks["list_commands"]:
1067
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1069
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1071
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1072
"bzr plugin commands")
1073
Command.hooks.install_named_hook("get_command", _get_external_command,
1074
"bzr external command lookup")
1075
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1076
"bzr plugin-provider-db check")
1080
def _specified_or_unicode_argv(argv):
1081
# For internal or testing use, argv can be passed. Otherwise, get it from
1082
# the process arguments in a unicode-safe way.
1084
return osutils.get_unicode_argv()
1088
# ensure all arguments are unicode strings
1090
if isinstance(a, unicode):
1093
new_argv.append(a.decode('ascii'))
1094
except UnicodeDecodeError:
1095
raise errors.BzrError("argv should be list of unicode strings.")
1099
def main(argv=None):
1100
"""Main entry point of command-line interface.
1102
Typically `bzrlib.initialize` should be called first.
1104
:param argv: list of unicode command-line arguments similar to sys.argv.
1105
argv[0] is script name usually, it will be ignored.
1106
Don't pass here sys.argv because this list contains plain strings
1107
and not unicode; pass None instead.
1109
:return: exit code of bzr command.
1111
argv = _specified_or_unicode_argv(argv)
1112
ret = run_bzr_catch_errors(argv)
1113
bzrlib.ui.ui_factory.log_transport_activity(
1114
display=('bytes' in debug.debug_flags))
1115
trace.mutter("return code %d", ret)
1119
def run_bzr_catch_errors(argv):
1120
"""Run a bzr command with parameters as described by argv.
1122
This function assumed that that UI layer is setup, that symbol deprecations
1123
are already applied, and that unicode decoding has already been performed on argv.
1125
# done here so that they're covered for every test run
1126
install_bzr_command_hooks()
1127
return exception_to_return_code(run_bzr, argv)
1130
def run_bzr_catch_user_errors(argv):
1131
"""Run bzr and report user errors, but let internal errors propagate.
1133
This is used for the test suite, and might be useful for other programs
1134
that want to wrap the commandline interface.
1136
# done here so that they're covered for every test run
1137
install_bzr_command_hooks()
1139
return run_bzr(argv)
1140
except Exception, e:
1141
if (isinstance(e, (OSError, IOError))
1142
or not getattr(e, 'internal_error', True)):
1143
trace.report_exception(sys.exc_info(), sys.stderr)
1149
class HelpCommandIndex(object):
1150
"""A index for bzr help that returns commands."""
1153
self.prefix = 'commands/'
1155
def get_topics(self, topic):
1156
"""Search for topic amongst commands.
1158
:param topic: A topic to search for.
1159
:return: A list which is either empty or contains a single
1162
if topic and topic.startswith(self.prefix):
1163
topic = topic[len(self.prefix):]
1165
cmd = _get_cmd_object(topic)
1172
class Provider(object):
1173
'''Generic class to be overriden by plugins'''
1175
def plugin_for_command(self, cmd_name):
1176
'''Takes a command and returns the information for that plugin
1178
:return: A dictionary with all the available information
1179
for the requested plugin
1181
raise NotImplementedError
1184
class ProvidersRegistry(registry.Registry):
1185
'''This registry exists to allow other providers to exist'''
1188
for key, provider in self.iteritems():
1191
command_providers_registry = ProvidersRegistry()
1237
bzrlib.trace.close_trace()
1240
if __name__ == '__main__':
1241
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
