164
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
165
52
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
191
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
def builtin_command_names():
220
"""Return list of builtin command names.
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
return plugin_cmds.keys()
233
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
237
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
This always returns a list. The list will have one element for
60
It supports integers directly, but everything else it
61
defers for passing to Branch.get_revision_info()
63
>>> _parse_revision_str('234')
65
>>> _parse_revision_str('234..567')
67
>>> _parse_revision_str('..')
69
>>> _parse_revision_str('..234')
71
>>> _parse_revision_str('234..')
73
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
75
>>> _parse_revision_str('234....789') # Error?
77
>>> _parse_revision_str('revid:test@other.com-234234')
78
['revid:test@other.com-234234']
79
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
80
['revid:test@other.com-234234', 'revid:test@other.com-234235']
81
>>> _parse_revision_str('revid:test@other.com-234234..23')
82
['revid:test@other.com-234234', 23]
83
>>> _parse_revision_str('date:2005-04-12')
85
>>> _parse_revision_str('date:2005-04-12 12:24:33')
86
['date:2005-04-12 12:24:33']
87
>>> _parse_revision_str('date:2005-04-12T12:24:33')
88
['date:2005-04-12T12:24:33']
89
>>> _parse_revision_str('date:2005-04-12,12:24:33')
90
['date:2005-04-12,12:24:33']
91
>>> _parse_revision_str('-5..23')
93
>>> _parse_revision_str('-5')
95
>>> _parse_revision_str('123a')
97
>>> _parse_revision_str('abc')
101
old_format_re = re.compile('\d*:\d*')
102
m = old_format_re.match(revstr)
104
warning('Colon separator for revision numbers is deprecated.'
107
for rev in revstr.split(':'):
109
revs.append(int(rev))
114
for x in revstr.split('..'):
126
def _get_cmd_dict(plugins_override=True):
128
for k, v in globals().iteritems():
129
if k.startswith("cmd_"):
130
d[_unsquish_command_name(k)] = v
131
# If we didn't load plugins, the plugin_cmds dict will be empty
133
d.update(plugin_cmds)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
324
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
135
d2 = plugin_cmds.copy()
141
def get_all_cmds(plugins_override=True):
142
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
147
def get_cmd_class(cmd, plugins_override=True):
148
"""Return the canonical name and command class for a command.
150
cmd = str(cmd) # not unicode
152
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
155
return cmd, cmds[cmd]
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
159
# look for any command which claims this as an alias
160
for cmdname, cmdclass in cmds.iteritems():
161
if cmd in cmdclass.aliases:
162
return cmdname, cmdclass
164
cmdclass = ExternalCommand.find_command(cmd)
168
raise BzrCommandError("unknown command %r" % cmd)
342
171
class Command(object):
343
172
"""Base class for commands.
345
Commands are the heart of the command-line bzr interface.
347
The command object mostly handles the mapping of command-line
348
parameters into one or more bzrlib operations, and of the results
351
Commands normally don't have any state. All their arguments are
352
passed in to the run method. (Subclasses may take a different
353
policy if the behaviour of the instance needs to depend on e.g. a
354
shell plugin and not just its Python class.)
356
174
The docstring for an actual command should give a single-line
357
175
summary, then a complete description of the command. A grammar
358
176
description will be inserted.
361
Other accepted names for this command.
364
179
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
183
List of options that may be given for this command.
381
If true, this command isn't advertised. This is typically
382
for commands intended for expert users.
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
399
:cvar hooks: An instance of CommandHooks.
186
If true, this command isn't advertised.
403
191
takes_options = []
404
encoding_type = 'strict'
195
def __init__(self, options, arguments):
196
"""Construct and run the command.
409
"""Construct an instance of this command."""
198
Sets self.status to the return value of run()."""
199
assert isinstance(options, dict)
200
assert isinstance(arguments, dict)
201
cmdargs = options.copy()
202
cmdargs.update(arguments)
410
203
if self.__doc__ == Command.__doc__:
204
from warnings import warn
411
205
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
491
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
493
usage = sections.pop('Usage')
495
usage = self._usage()
497
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
500
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
503
result += ':Usage: %s\n' % usage
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
547
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
550
result += ', '.join(self.aliases) + '\n'
551
plugin_name = self.plugin_name()
552
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
554
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
578
def _get_help_parts(text):
579
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
A section starts with a heading line of the form ":xxx:".
585
Indented text on following lines is the section value.
586
All text found outside a named section is assigned to the
587
default section which is given the key of None.
589
def save_section(sections, order, label, section):
591
if sections.has_key(label):
592
sections[label] += '\n' + section
595
sections[label] = section
597
lines = text.rstrip().splitlines()
598
summary = lines.pop(0)
601
label,section = None,''
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
608
label,section = None,line
611
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
617
def get_help_topic(self):
618
"""Return the commands help topic - its name."""
621
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
624
The list is derived from the content of the _see_also attribute. Any
625
duplicates are removed and the result is in lexical order.
626
:param additional_terms: Additional help topics to cross-reference.
627
:return: A list of help topics.
629
see_also = set(getattr(self, '_see_also', []))
631
see_also.update(additional_terms)
632
return sorted(see_also)
635
"""Return dict of valid options for this command.
637
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
640
for o in self.takes_options:
641
if isinstance(o, basestring):
642
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
def _setup_outf(self):
649
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
653
def run_argv_aliases(self, argv, alias_argv=None):
654
"""Parse the command line and run with extra aliases in alias_argv."""
655
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
674
# mix arguments and options into one dictionary
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
677
for k, v in opts.items():
678
cmdopts[k.replace('-', '_')] = v
680
all_cmd_args = cmdargs.copy()
681
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
206
self.status = self.run(**cmdargs)
207
if self.status is None:
711
"""Actually run the command.
212
"""Override this in sub-classes.
713
214
This is invoked with the options and arguments bound to
714
215
keyword parameters.
716
Return 0 or None if the command was successful, or a non-zero
717
shell error code if not. It's OK for this method to allow
718
an exception to raise up.
720
This method is automatically wrapped by Command.__init__ with a
721
cleanup operation, stored as self._operation. This can be used
722
via self.add_cleanup to perform automatic cleanups at the end of
725
The argument for run are assembled by introspection. So for instance,
726
if your command takes an argument files, you would declare::
728
def run(self, files=None):
217
Return 0 or None if the command was successful, or a shell
731
raise NotImplementedError('no implementation of command %r'
735
"""Return help message for this class."""
223
class ExternalCommand(Command):
224
"""Class to wrap external commands.
226
We cheat a little here, when get_cmd_class() calls us we actually
227
give it back an object we construct that has the appropriate path,
228
help, options etc for the specified command.
230
When run_bzr() tries to instantiate that 'class' it gets caught by
231
the __call__ method, which we override to call the Command.__init__
232
method. That then calls our run method which is pretty straight
235
The only wrinkle is that we have to map bzr's dictionary of options
236
and arguments back into command line options and arguments for the
240
def find_command(cls, cmd):
242
bzrpath = os.environ.get('BZRPATH', '')
244
for dir in bzrpath.split(os.pathsep):
245
path = os.path.join(dir, cmd)
246
if os.path.isfile(path):
247
return ExternalCommand(path)
251
find_command = classmethod(find_command)
253
def __init__(self, path):
256
pipe = os.popen('%s --bzr-usage' % path, 'r')
257
self.takes_options = pipe.readline().split()
259
for opt in self.takes_options:
260
if not opt in OPTIONS:
261
raise BzrError("Unknown option '%s' returned by external command %s"
264
# TODO: Is there any way to check takes_args is valid here?
265
self.takes_args = pipe.readline().split()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-usage'" % path)
270
pipe = os.popen('%s --bzr-help' % path, 'r')
271
self.__doc__ = pipe.read()
272
if pipe.close() is not None:
273
raise BzrError("Failed funning '%s --bzr-help'" % path)
275
def __call__(self, options, arguments):
276
Command.__init__(self, options, arguments)
279
def run(self, **kargs):
286
optname = name.replace('_','-')
288
if OPTIONS.has_key(optname):
290
opts.append('--%s' % optname)
291
if value is not None and value is not True:
292
opts.append(str(value))
294
# it's an arg, or arg list
295
if type(value) is not list:
301
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
305
class cmd_status(Command):
306
"""Display status summary.
308
This reports on versioned and unknown files, reporting them
309
grouped by state. Possible states are:
312
Versioned in the working copy but not in the previous revision.
315
Versioned in the previous revision but removed or deleted
319
Path of this file changed from the previous revision;
320
the text may also have changed. This includes files whose
321
parent directory was renamed.
324
Text has changed since the previous revision.
327
Nothing about this file has changed since the previous revision.
328
Only shown with --all.
331
Not versioned and not matching an ignore pattern.
333
To see ignored files use 'bzr ignored'. For details in the
334
changes to file texts, use 'bzr diff'.
336
If no arguments are specified, the status of the entire working
337
directory is shown. Otherwise, only the status of the specified
338
files or directories is reported. If a directory is given, status
339
is reported for everything inside that directory.
341
If a revision is specified, the changes since that revision are shown.
343
takes_args = ['file*']
344
takes_options = ['all', 'show-ids', 'revision']
345
aliases = ['st', 'stat']
347
def run(self, all=False, show_ids=False, file_list=None):
349
b = find_branch(file_list[0])
350
file_list = [b.relpath(x) for x in file_list]
351
# special case: only one path was given and it's the root
353
if file_list == ['']:
358
from bzrlib.status import show_status
359
show_status(b, show_unchanged=all, show_ids=show_ids,
360
specific_files=file_list)
363
class cmd_cat_revision(Command):
364
"""Write out metadata for a revision."""
367
takes_args = ['revision_id']
369
def run(self, revision_id):
370
from bzrlib.xml import pack_xml
371
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
374
class cmd_revno(Command):
375
"""Show current revision number.
377
This is equal to the number of revisions on this branch."""
379
print find_branch('.').revno()
381
class cmd_revision_info(Command):
382
"""Show revision number and revision id for a given revision identifier.
385
takes_args = ['revision_info*']
386
takes_options = ['revision']
387
def run(self, revision=None, revision_info_list=None):
388
from bzrlib.branch import find_branch
391
if revision is not None:
392
revs.extend(revision)
393
if revision_info_list is not None:
394
revs.extend(revision_info_list)
396
raise BzrCommandError('You must supply a revision identifier')
401
print '%4d %s' % b.get_revision_info(rev)
404
class cmd_add(Command):
405
"""Add specified files or directories.
407
In non-recursive mode, all the named items are added, regardless
408
of whether they were previously ignored. A warning is given if
409
any of the named files are already versioned.
411
In recursive mode (the default), files are treated the same way
412
but the behaviour for directories is different. Directories that
413
are already versioned do not give a warning. All directories,
414
whether already versioned or not, are searched for files or
415
subdirectories that are neither versioned or ignored, and these
416
are added. This search proceeds recursively into versioned
417
directories. If no names are given '.' is assumed.
419
Therefore simply saying 'bzr add' will version all files that
420
are currently unknown.
422
TODO: Perhaps adding a file whose directly is not versioned should
423
recursively add that parent, rather than giving an error?
425
takes_args = ['file*']
426
takes_options = ['verbose', 'no-recurse']
428
def run(self, file_list, verbose=False, no_recurse=False):
429
from bzrlib.add import smart_add
430
smart_add(file_list, verbose, not no_recurse)
434
class cmd_mkdir(Command):
435
"""Create a new versioned directory.
437
This is equivalent to creating the directory and then adding it.
439
takes_args = ['dir+']
441
def run(self, dir_list):
448
b.add([d], verbose=True)
451
class cmd_relpath(Command):
452
"""Show path of a file relative to root"""
453
takes_args = ['filename']
456
def run(self, filename):
457
print find_branch(filename).relpath(filename)
461
class cmd_inventory(Command):
462
"""Show inventory of the current working copy or a revision."""
463
takes_options = ['revision', 'show-ids']
465
def run(self, revision=None, show_ids=False):
468
inv = b.read_working_inventory()
470
if len(revision) > 1:
471
raise BzrCommandError('bzr inventory --revision takes'
472
' exactly one revision identifier')
473
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
475
for path, entry in inv.entries():
477
print '%-50s %s' % (path, entry.file_id)
482
class cmd_move(Command):
483
"""Move files to a different directory.
488
The destination must be a versioned directory in the same branch.
490
takes_args = ['source$', 'dest']
491
def run(self, source_list, dest):
494
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
497
class cmd_rename(Command):
498
"""Change the name of an entry.
501
bzr rename frob.c frobber.c
502
bzr rename src/frob.c lib/frob.c
504
It is an error if the destination name exists.
506
See also the 'move' command, which moves files into a different
507
directory without changing their name.
509
TODO: Some way to rename multiple files without invoking bzr for each
511
takes_args = ['from_name', 'to_name']
513
def run(self, from_name, to_name):
515
b.rename_one(b.relpath(from_name), b.relpath(to_name))
521
class cmd_pull(Command):
522
"""Pull any changes from another branch into the current one.
524
If the location is omitted, the last-used location will be used.
525
Both the revision history and the working directory will be
528
This command only works on branches that have not diverged. Branches are
529
considered diverged if both branches have had commits without first
530
pulling from the other.
532
If branches have diverged, you can use 'bzr merge' to pull the text changes
533
from one into the other.
535
takes_args = ['location?']
537
def run(self, location=None):
538
from bzrlib.merge import merge
540
from shutil import rmtree
543
br_to = find_branch('.')
546
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
548
if e.errno != errno.ENOENT:
551
if stored_loc is None:
552
raise BzrCommandError("No pull location known or specified.")
554
print "Using last location: %s" % stored_loc
555
location = stored_loc
556
cache_root = tempfile.mkdtemp()
557
from bzrlib.branch import DivergedBranches
558
br_from = find_branch(location)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
562
from branch import find_cached_branch, DivergedBranches
563
br_from = find_cached_branch(location, cache_root)
564
location = pull_loc(br_from)
565
old_revno = br_to.revno()
567
br_to.update_revisions(br_from)
568
except DivergedBranches:
569
raise BzrCommandError("These branches have diverged."
572
merge(('.', -1), ('.', old_revno), check_clean=False)
573
if location != stored_loc:
574
br_to.controlfile("x-pull", "wb").write(location + "\n")
580
class cmd_branch(Command):
581
"""Create a new copy of a branch.
583
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
584
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
586
To retrieve the branch as of a particular revision, supply the --revision
587
parameter, as in "branch foo/bar -r 5".
589
takes_args = ['from_location', 'to_location?']
590
takes_options = ['revision']
592
def run(self, from_location, to_location=None, revision=None):
594
from bzrlib.merge import merge
595
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
596
find_cached_branch, Branch
597
from shutil import rmtree
598
from meta_store import CachedStore
600
cache_root = tempfile.mkdtemp()
604
elif len(revision) > 1:
605
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
609
br_from = find_cached_branch(from_location, cache_root)
611
if e.errno == errno.ENOENT:
612
raise BzrCommandError('Source location "%s" does not'
613
' exist.' % to_location)
617
if to_location is None:
618
to_location = os.path.basename(from_location.rstrip("/\\"))
621
os.mkdir(to_location)
623
if e.errno == errno.EEXIST:
624
raise BzrCommandError('Target directory "%s" already'
625
' exists.' % to_location)
626
if e.errno == errno.ENOENT:
627
raise BzrCommandError('Parent of "%s" does not exist.' %
631
br_to = Branch(to_location, init=True)
633
br_to.set_root_id(br_from.get_root_id())
636
if revision[0] is None:
637
revno = br_from.revno()
639
revno, rev_id = br_from.get_revision_info(revision[0])
641
br_to.update_revisions(br_from, stop_revision=revno)
642
except NoSuchRevision:
644
msg = "The branch %s has no revision %d." % (from_location,
646
raise BzrCommandError(msg)
648
merge((to_location, -1), (to_location, 0), this_dir=to_location,
649
check_clean=False, ignore_zero=True)
650
from_location = pull_loc(br_from)
651
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
656
def pull_loc(branch):
657
# TODO: Should perhaps just make attribute be 'base' in
658
# RemoteBranch and Branch?
659
if hasattr(branch, "baseurl"):
660
return branch.baseurl
666
class cmd_renames(Command):
667
"""Show list of renamed files.
669
TODO: Option to show renames between two historical versions.
671
TODO: Only show renames under dir, rather than in the whole branch.
673
takes_args = ['dir?']
675
def run(self, dir='.'):
677
old_inv = b.basis_tree().inventory
678
new_inv = b.read_working_inventory()
680
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
682
for old_name, new_name in renames:
683
print "%s => %s" % (old_name, new_name)
686
class cmd_info(Command):
687
"""Show statistical information about a branch."""
688
takes_args = ['branch?']
690
def run(self, branch=None):
693
b = find_branch(branch)
697
class cmd_remove(Command):
698
"""Make a file unversioned.
700
This makes bzr stop tracking changes to a versioned file. It does
701
not delete the working copy.
703
takes_args = ['file+']
704
takes_options = ['verbose']
706
def run(self, file_list, verbose=False):
707
b = find_branch(file_list[0])
708
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
711
class cmd_file_id(Command):
712
"""Print file_id of a particular file or directory.
714
The file_id is assigned when the file is first added and remains the
715
same through all revisions where the file exists, even when it is
719
takes_args = ['filename']
720
def run(self, filename):
721
b = find_branch(filename)
722
i = b.inventory.path2id(b.relpath(filename))
724
raise BzrError("%r is not a versioned file" % filename)
729
class cmd_file_path(Command):
730
"""Print path of file_ids to a file or directory.
732
This prints one line for each directory down to the target,
733
starting at the branch root."""
735
takes_args = ['filename']
736
def run(self, filename):
737
b = find_branch(filename)
739
fid = inv.path2id(b.relpath(filename))
741
raise BzrError("%r is not a versioned file" % filename)
742
for fip in inv.get_idpath(fid):
746
class cmd_revision_history(Command):
747
"""Display list of revision ids on this branch."""
750
for patchid in find_branch('.').revision_history():
754
class cmd_directories(Command):
755
"""Display list of versioned directories in this branch."""
757
for name, ie in find_branch('.').read_working_inventory().directories():
764
class cmd_init(Command):
765
"""Make a directory into a versioned branch.
767
Use this to create an empty branch, or before importing an
770
Recipe for importing a tree of files:
775
bzr commit -m 'imported project'
778
from bzrlib.branch import Branch
779
Branch('.', init=True)
782
class cmd_diff(Command):
783
"""Show differences in working tree.
785
If files are listed, only the changes in those files are listed.
786
Otherwise, all changes for the tree are listed.
788
TODO: Given two revision arguments, show the difference between them.
790
TODO: Allow diff across branches.
792
TODO: Option to use external diff command; could be GNU diff, wdiff,
795
TODO: Python difflib is not exactly the same as unidiff; should
796
either fix it up or prefer to use an external diff.
798
TODO: If a directory is given, diff everything under that.
800
TODO: Selected-file diff is inefficient and doesn't show you
803
TODO: This probably handles non-Unix newlines poorly.
806
takes_args = ['file*']
807
takes_options = ['revision', 'diff-options']
808
aliases = ['di', 'dif']
810
def run(self, revision=None, file_list=None, diff_options=None):
811
from bzrlib.diff import show_diff
814
b = find_branch(file_list[0])
815
file_list = [b.relpath(f) for f in file_list]
816
if file_list == ['']:
817
# just pointing to top-of-tree
822
# TODO: Make show_diff support taking 2 arguments
824
if revision is not None:
825
if len(revision) != 1:
826
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
827
base_rev = revision[0]
829
show_diff(b, base_rev, specific_files=file_list,
830
external_diff_options=diff_options)
836
class cmd_deleted(Command):
837
"""List files deleted in the working tree.
839
TODO: Show files deleted since a previous revision, or between two revisions.
841
def run(self, show_ids=False):
844
new = b.working_tree()
846
## TODO: Much more efficient way to do this: read in new
847
## directories with readdir, rather than stating each one. Same
848
## level of effort but possibly much less IO. (Or possibly not,
849
## if the directories are very large...)
851
for path, ie in old.inventory.iter_entries():
852
if not new.has_id(ie.file_id):
854
print '%-50s %s' % (path, ie.file_id)
859
class cmd_modified(Command):
860
"""List files modified in working tree."""
863
from bzrlib.diff import compare_trees
866
td = compare_trees(b.basis_tree(), b.working_tree())
868
for path, id, kind in td.modified:
873
class cmd_added(Command):
874
"""List files added in working tree."""
878
wt = b.working_tree()
879
basis_inv = b.basis_tree().inventory
882
if file_id in basis_inv:
884
path = inv.id2path(file_id)
885
if not os.access(b.abspath(path), os.F_OK):
891
class cmd_root(Command):
892
"""Show the tree root directory.
894
The root is the nearest enclosing directory with a .bzr control
896
takes_args = ['filename?']
897
def run(self, filename=None):
898
"""Print the branch root."""
899
b = find_branch(filename)
900
print getattr(b, 'base', None) or getattr(b, 'baseurl')
903
class cmd_log(Command):
904
"""Show log of this branch.
906
To request a range of logs, you can use the command -r begin:end
907
-r revision requests a specific revision, -r :end or -r begin: are
910
--message allows you to give a regular expression, which will be evaluated
911
so that only matching entries will be displayed.
913
TODO: Make --revision support uuid: and hash: [future tag:] notation.
917
takes_args = ['filename?']
918
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
920
def run(self, filename=None, timezone='original',
927
from bzrlib.branch import find_branch
928
from bzrlib.log import log_formatter, show_log
931
direction = (forward and 'forward') or 'reverse'
934
b = find_branch(filename)
935
fp = b.relpath(filename)
937
file_id = b.read_working_inventory().path2id(fp)
939
file_id = None # points to branch root
947
elif len(revision) == 1:
948
rev1 = rev2 = b.get_revision_info(revision[0])[0]
949
elif len(revision) == 2:
950
rev1 = b.get_revision_info(revision[0])[0]
951
rev2 = b.get_revision_info(revision[1])[0]
953
raise BzrCommandError('bzr log --revision takes one or two values.')
960
mutter('encoding log as %r' % bzrlib.user_encoding)
962
# use 'replace' so that we don't abort if trying to write out
963
# in e.g. the default C locale.
964
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
970
lf = log_formatter(log_format,
973
show_timezone=timezone)
986
class cmd_touching_revisions(Command):
987
"""Return revision-ids which affected a particular file.
989
A more user-friendly interface is "bzr log FILE"."""
991
takes_args = ["filename"]
992
def run(self, filename):
993
b = find_branch(filename)
994
inv = b.read_working_inventory()
995
file_id = inv.path2id(b.relpath(filename))
996
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
997
print "%6d %s" % (revno, what)
1000
class cmd_ls(Command):
1001
"""List files in a tree.
1003
TODO: Take a revision or remote path and list that tree instead.
1006
def run(self, revision=None, verbose=False):
1007
b = find_branch('.')
1008
if revision == None:
1009
tree = b.working_tree()
1011
tree = b.revision_tree(b.lookup_revision(revision))
1013
for fp, fc, kind, fid in tree.list_files():
1015
if kind == 'directory':
1017
elif kind == 'file':
1022
print '%-8s %s%s' % (fc, fp, kindch)
1028
class cmd_unknowns(Command):
1029
"""List unknown files."""
1031
from bzrlib.osutils import quotefn
1032
for f in find_branch('.').unknowns():
1037
class cmd_ignore(Command):
1038
"""Ignore a command or pattern.
1040
To remove patterns from the ignore list, edit the .bzrignore file.
1042
If the pattern contains a slash, it is compared to the whole path
1043
from the branch root. Otherwise, it is comapred to only the last
1044
component of the path.
1046
Ignore patterns are case-insensitive on case-insensitive systems.
1048
Note: wildcards must be quoted from the shell on Unix.
1051
bzr ignore ./Makefile
1052
bzr ignore '*.class'
1054
takes_args = ['name_pattern']
1056
def run(self, name_pattern):
1057
from bzrlib.atomicfile import AtomicFile
1060
b = find_branch('.')
1061
ifn = b.abspath('.bzrignore')
1063
if os.path.exists(ifn):
1066
igns = f.read().decode('utf-8')
1072
# TODO: If the file already uses crlf-style termination, maybe
1073
# we should use that for the newly added lines?
1075
if igns and igns[-1] != '\n':
1077
igns += name_pattern + '\n'
1080
f = AtomicFile(ifn, 'wt')
1081
f.write(igns.encode('utf-8'))
1086
inv = b.working_tree().inventory
1087
if inv.path2id('.bzrignore'):
1088
mutter('.bzrignore is already versioned')
1090
mutter('need to make new .bzrignore file versioned')
1091
b.add(['.bzrignore'])
1095
class cmd_ignored(Command):
1096
"""List ignored files and the patterns that matched them.
1098
See also: bzr ignore"""
1100
tree = find_branch('.').working_tree()
1101
for path, file_class, kind, file_id in tree.list_files():
1102
if file_class != 'I':
1104
## XXX: Slightly inefficient since this was already calculated
1105
pat = tree.is_ignored(path)
1106
print '%-50s %s' % (path, pat)
1109
class cmd_lookup_revision(Command):
1110
"""Lookup the revision-id from a revision-number
1113
bzr lookup-revision 33
1116
takes_args = ['revno']
1118
def run(self, revno):
1122
raise BzrCommandError("not a valid revision-number: %r" % revno)
1124
print find_branch('.').lookup_revision(revno)
1127
class cmd_export(Command):
1128
"""Export past revision to destination directory.
1130
If no revision is specified this exports the last committed revision.
1132
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1133
given, try to find the format with the extension. If no extension
1134
is found exports to a directory (equivalent to --format=dir).
1136
Root may be the top directory for tar, tgz and tbz2 formats. If none
1137
is given, the top directory will be the root name of the file."""
1138
# TODO: list known exporters
1139
takes_args = ['dest']
1140
takes_options = ['revision', 'format', 'root']
1141
def run(self, dest, revision=None, format=None, root=None):
1143
b = find_branch('.')
1144
if revision is None:
1145
rev_id = b.last_patch()
1147
if len(revision) != 1:
1148
raise BzrError('bzr export --revision takes exactly 1 argument')
1149
revno, rev_id = b.get_revision_info(revision[0])
1150
t = b.revision_tree(rev_id)
1151
root, ext = os.path.splitext(dest)
1153
if ext in (".tar",):
1155
elif ext in (".gz", ".tgz"):
1157
elif ext in (".bz2", ".tbz2"):
1161
t.export(dest, format, root)
1164
class cmd_cat(Command):
1165
"""Write a file's text from a previous revision."""
1167
takes_options = ['revision']
1168
takes_args = ['filename']
1170
def run(self, filename, revision=None):
1171
if revision == None:
1172
raise BzrCommandError("bzr cat requires a revision number")
1173
elif len(revision) != 1:
1174
raise BzrCommandError("bzr cat --revision takes exactly one number")
1175
b = find_branch('.')
1176
b.print_file(b.relpath(filename), revision[0])
1179
class cmd_local_time_offset(Command):
1180
"""Show the offset in seconds from GMT to local time."""
1183
print bzrlib.osutils.local_time_offset()
1187
class cmd_commit(Command):
1188
"""Commit changes into a new revision.
1190
If no arguments are given, the entire tree is committed.
1192
If selected files are specified, only changes to those files are
1193
committed. If a directory is specified then the directory and everything
1194
within it is committed.
1196
A selected-file commit may fail in some cases where the committed
1197
tree would be invalid, such as trying to commit a file in a
1198
newly-added directory that is not itself committed.
1200
TODO: Run hooks on tree to-be-committed, and after commit.
1202
TODO: Strict commit that fails if there are unknown or deleted files.
1204
takes_args = ['selected*']
1205
takes_options = ['message', 'file', 'verbose', 'unchanged']
1206
aliases = ['ci', 'checkin']
1208
# TODO: Give better message for -s, --summary, used by tla people
1210
def run(self, message=None, file=None, verbose=True, selected_list=None,
1212
from bzrlib.errors import PointlessCommit
1213
from bzrlib.osutils import get_text_message
1215
## Warning: shadows builtin file()
1216
if not message and not file:
1217
# FIXME: Ugly; change status code to send to a provided function?
1221
catcher = cStringIO.StringIO()
1222
sys.stdout = catcher
1223
cmd_status({"file_list":selected_list}, {})
1224
info = catcher.getvalue()
1226
message = get_text_message(info)
1229
raise BzrCommandError("please specify a commit message",
1230
["use either --message or --file"])
1231
elif message and file:
1232
raise BzrCommandError("please specify either --message or --file")
1236
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1238
b = find_branch('.')
1240
selected_list = [b.relpath(s) for s in selected_list]
1243
b.commit(message, verbose=verbose,
1244
specific_files=selected_list,
1245
allow_pointless=unchanged)
1246
except PointlessCommit:
1247
# FIXME: This should really happen before the file is read in;
1248
# perhaps prepare the commit; get the message; then actually commit
1249
raise BzrCommandError("no changes to commit",
1250
["use --unchanged to commit anyhow"])
1253
class cmd_check(Command):
1254
"""Validate consistency of branch history.
1256
This command checks various invariants about the branch storage to
1257
detect data corruption or bzr bugs.
1259
If given the --update flag, it will update some optional fields
1260
to help ensure data consistency.
1262
takes_args = ['dir?']
1264
def run(self, dir='.'):
1265
from bzrlib.check import check
1266
check(find_branch(dir))
1270
class cmd_scan_cache(Command):
1273
from bzrlib.hashcache import HashCache
1280
print '%6d stats' % c.stat_count
1281
print '%6d in hashcache' % len(c._cache)
1282
print '%6d files removed from cache' % c.removed_count
1283
print '%6d hashes updated' % c.update_count
1284
print '%6d files changed too recently to cache' % c.danger_count
1291
class cmd_upgrade(Command):
1292
"""Upgrade branch storage to current format.
1294
This should normally be used only after the check command tells
1297
takes_args = ['dir?']
1299
def run(self, dir='.'):
1300
from bzrlib.upgrade import upgrade
1301
upgrade(find_branch(dir))
1305
class cmd_whoami(Command):
1306
"""Show bzr user id."""
1307
takes_options = ['email']
1309
def run(self, email=False):
1311
print bzrlib.osutils.user_email()
1313
print bzrlib.osutils.username()
1316
class cmd_selftest(Command):
1317
"""Run internal test suite"""
1319
takes_options = ['verbose']
1320
def run(self, verbose=False):
1321
from bzrlib.selftest import selftest
1322
return int(not selftest(verbose=verbose))
1325
class cmd_version(Command):
1326
"""Show version of bzr."""
1331
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1332
# is bzrlib itself in a branch?
1333
bzrrev = bzrlib.get_bzr_revision()
1335
print " (bzr checkout, revision %d {%s})" % bzrrev
1336
print bzrlib.__copyright__
1337
print "http://bazaar-ng.org/"
1339
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1340
print "you may use, modify and redistribute it under the terms of the GNU"
1341
print "General Public License version 2 or later."
1344
class cmd_rocks(Command):
1345
"""Statement of optimism."""
1348
print "it sure does!"
1350
def parse_spec(spec):
1352
>>> parse_spec(None)
1354
>>> parse_spec("./")
1356
>>> parse_spec("../@")
1358
>>> parse_spec("../f/@35")
1360
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1361
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1366
parsed = spec.split('/@')
1367
assert len(parsed) == 2
1372
parsed[1] = int(parsed[1])
1374
pass # We can allow stuff like ./@revid:blahblahblah
1376
assert parsed[1] >=0
1378
parsed = [spec, None]
1383
class cmd_merge(Command):
1384
"""Perform a three-way merge of trees.
1386
The SPEC parameters are working tree or revision specifiers. Working trees
1387
are specified using standard paths or urls. No component of a directory
1388
path may begin with '@'.
1390
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1392
Revisions are specified using a dirname/@revno pair, where dirname is the
1393
branch directory and revno is the revision within that branch. If no revno
1394
is specified, the latest revision is used.
1396
Revision examples: './@127', 'foo/@', '../@1'
1398
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1399
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1402
merge refuses to run if there are any uncommitted changes, unless
1405
takes_args = ['other_spec', 'base_spec?']
1406
takes_options = ['force']
1408
def run(self, other_spec, base_spec=None, force=False):
1409
from bzrlib.merge import merge
1410
merge(parse_spec(other_spec), parse_spec(base_spec),
1411
check_clean=(not force))
1415
class cmd_revert(Command):
1416
"""Restore selected files from a previous revision.
1418
takes_args = ['file+']
1419
def run(self, file_list):
1420
from bzrlib.branch import find_branch
1425
b = find_branch(file_list[0])
1427
b.revert([b.relpath(f) for f in file_list])
1430
class cmd_merge_revert(Command):
1431
"""Reverse all changes since the last commit.
1433
Only versioned files are affected.
1435
TODO: Store backups of any files that will be reverted, so
1436
that the revert can be undone.
1438
takes_options = ['revision']
1440
def run(self, revision=None):
1441
from bzrlib.merge import merge
1442
if revision is None:
1444
elif len(revision) != 1:
1445
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1446
merge(('.', revision[0]), parse_spec('.'),
1451
class cmd_assert_fail(Command):
1452
"""Test reporting of assertion failures"""
1455
assert False, "always fails"
1458
class cmd_help(Command):
1459
"""Show help on a command or other topic.
1461
For a list of all available commands, say 'bzr help commands'."""
1462
takes_args = ['topic?']
1465
def run(self, topic=None):
1472
class cmd_plugins(Command):
1476
import bzrlib.plugin
736
1477
from inspect import getdoc
737
if self.__doc__ is Command.__doc__:
742
return _unsquish_command_name(self.__class__.__name__)
744
def plugin_name(self):
745
"""Get the name of the plugin that provides this command.
747
:return: The name of the plugin or None if the command is builtin.
749
mod_parts = self.__module__.split('.')
750
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
793
def parse_args(command, argv, alias_argv=None):
1478
from pprint import pprint
1479
for plugin in bzrlib.plugin.all_plugins:
1480
print plugin.__path__[0]
1483
print '\t', d.split('\n')[0]
1485
#pprint(bzrlib.plugin.all_plugins)
1489
# list of all available options; the rhs can be either None for an
1490
# option that takes no argument, or a constructor function that checks
1494
'diff-options': str,
1503
'revision': _parse_revision_str,
1525
def parse_args(argv):
794
1526
"""Parse command line.
796
1528
Arguments and options are parsed at this level before being passed
797
1529
down to specific command handlers. This routine knows, from a
798
1530
lookup table, something about the available options, what optargs
799
1531
they take, and which commands will accept them.
1533
>>> parse_args('--help'.split())
1534
([], {'help': True})
1535
>>> parse_args('--version'.split())
1536
([], {'version': True})
1537
>>> parse_args('status --all'.split())
1538
(['status'], {'all': True})
1539
>>> parse_args('commit --message=biter'.split())
1540
(['commit'], {'message': u'biter'})
1541
>>> parse_args('log -r 500'.split())
1542
(['log'], {'revision': [500]})
1543
>>> parse_args('log -r500..600'.split())
1544
(['log'], {'revision': [500, 600]})
1545
>>> parse_args('log -vr500..600'.split())
1546
(['log'], {'verbose': True, 'revision': [500, 600]})
1547
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1548
(['log'], {'revision': ['v500', 600]})
801
# TODO: make it a method of the Command?
802
parser = option.get_optparser(command.options())
803
if alias_argv is not None:
804
args = alias_argv + argv
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
1553
# TODO: Maybe handle '--' to end options?
1558
# option names must not be unicode
1562
mutter(" got option %r" % a)
1564
optname, optarg = a[2:].split('=', 1)
1567
if optname not in OPTIONS:
1568
raise BzrError('unknown long option %r' % a)
1571
if shortopt in SHORT_OPTIONS:
1572
# Multi-character options must have a space to delimit
1574
optname = SHORT_OPTIONS[shortopt]
1576
# Single character short options, can be chained,
1577
# and have their value appended to their name
1579
if shortopt not in SHORT_OPTIONS:
1580
# We didn't find the multi-character name, and we
1581
# didn't find the single char name
1582
raise BzrError('unknown short option %r' % a)
1583
optname = SHORT_OPTIONS[shortopt]
1586
# There are extra things on this option
1587
# see if it is the value, or if it is another
1589
optargfn = OPTIONS[optname]
1590
if optargfn is None:
1591
# This option does not take an argument, so the
1592
# next entry is another short option, pack it back
1594
argv.insert(0, '-' + a[2:])
1596
# This option takes an argument, so pack it
1601
# XXX: Do we ever want to support this, e.g. for -r?
1602
raise BzrError('repeated option %r' % a)
1604
optargfn = OPTIONS[optname]
1608
raise BzrError('option %r needs an argument' % a)
1610
optarg = argv.pop(0)
1611
opts[optname] = optargfn(optarg)
1614
raise BzrError('option %r takes no argument' % optname)
1615
opts[optname] = True
811
1619
return args, opts
814
1624
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
