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('..'):
125
def get_merge_type(typestring):
126
"""Attempt to find the merge class/factory associated with a string."""
127
from merge import merge_types
129
return merge_types[typestring][0]
131
templ = '%s%%7s: %%s' % (' '*12)
132
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
133
type_list = '\n'.join(lines)
134
msg = "No known merge type %s. Supported types are:\n%s" %\
135
(typestring, type_list)
136
raise BzrCommandError(msg)
140
def _get_cmd_dict(plugins_override=True):
142
for k, v in globals().iteritems():
143
if k.startswith("cmd_"):
144
d[_unsquish_command_name(k)] = v
145
# If we didn't load plugins, the plugin_cmds dict will be empty
147
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."""
149
d2 = plugin_cmds.copy()
155
def get_all_cmds(plugins_override=True):
156
"""Return canonical name and class for all registered commands."""
157
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
161
def get_cmd_class(cmd, plugins_override=True):
162
"""Return the canonical name and command class for a command.
164
cmd = str(cmd) # not unicode
166
# first look up this command under the specified name
167
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
169
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)()
173
# look for any command which claims this as an alias
174
for cmdname, cmdclass in cmds.iteritems():
175
if cmd in cmdclass.aliases:
176
return cmdname, cmdclass
178
cmdclass = ExternalCommand.find_command(cmd)
182
raise BzrCommandError("unknown command %r" % cmd)
342
185
class Command(object):
343
186
"""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
188
The docstring for an actual command should give a single-line
357
189
summary, then a complete description of the command. A grammar
358
190
description will be inserted.
361
Other accepted names for this command.
364
193
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().
197
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.
200
If true, this command isn't advertised.
403
205
takes_options = []
404
encoding_type = 'strict'
209
def __init__(self, options, arguments):
210
"""Construct and run the command.
409
"""Construct an instance of this command."""
212
Sets self.status to the return value of run()."""
213
assert isinstance(options, dict)
214
assert isinstance(arguments, dict)
215
cmdargs = options.copy()
216
cmdargs.update(arguments)
410
217
if self.__doc__ == Command.__doc__:
218
from warnings import warn
411
219
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)
220
self.status = self.run(**cmdargs)
221
if self.status is None:
711
"""Actually run the command.
226
"""Override this in sub-classes.
713
228
This is invoked with the options and arguments bound to
714
229
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):
231
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."""
237
class ExternalCommand(Command):
238
"""Class to wrap external commands.
240
We cheat a little here, when get_cmd_class() calls us we actually
241
give it back an object we construct that has the appropriate path,
242
help, options etc for the specified command.
244
When run_bzr() tries to instantiate that 'class' it gets caught by
245
the __call__ method, which we override to call the Command.__init__
246
method. That then calls our run method which is pretty straight
249
The only wrinkle is that we have to map bzr's dictionary of options
250
and arguments back into command line options and arguments for the
254
def find_command(cls, cmd):
256
bzrpath = os.environ.get('BZRPATH', '')
258
for dir in bzrpath.split(os.pathsep):
259
path = os.path.join(dir, cmd)
260
if os.path.isfile(path):
261
return ExternalCommand(path)
265
find_command = classmethod(find_command)
267
def __init__(self, path):
270
pipe = os.popen('%s --bzr-usage' % path, 'r')
271
self.takes_options = pipe.readline().split()
273
for opt in self.takes_options:
274
if not opt in OPTIONS:
275
raise BzrError("Unknown option '%s' returned by external command %s"
278
# TODO: Is there any way to check takes_args is valid here?
279
self.takes_args = pipe.readline().split()
281
if pipe.close() is not None:
282
raise BzrError("Failed funning '%s --bzr-usage'" % path)
284
pipe = os.popen('%s --bzr-help' % path, 'r')
285
self.__doc__ = pipe.read()
286
if pipe.close() is not None:
287
raise BzrError("Failed funning '%s --bzr-help'" % path)
289
def __call__(self, options, arguments):
290
Command.__init__(self, options, arguments)
293
def run(self, **kargs):
300
optname = name.replace('_','-')
302
if OPTIONS.has_key(optname):
304
opts.append('--%s' % optname)
305
if value is not None and value is not True:
306
opts.append(str(value))
308
# it's an arg, or arg list
309
if type(value) is not list:
315
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
319
class cmd_status(Command):
320
"""Display status summary.
322
This reports on versioned and unknown files, reporting them
323
grouped by state. Possible states are:
326
Versioned in the working copy but not in the previous revision.
329
Versioned in the previous revision but removed or deleted
333
Path of this file changed from the previous revision;
334
the text may also have changed. This includes files whose
335
parent directory was renamed.
338
Text has changed since the previous revision.
341
Nothing about this file has changed since the previous revision.
342
Only shown with --all.
345
Not versioned and not matching an ignore pattern.
347
To see ignored files use 'bzr ignored'. For details in the
348
changes to file texts, use 'bzr diff'.
350
If no arguments are specified, the status of the entire working
351
directory is shown. Otherwise, only the status of the specified
352
files or directories is reported. If a directory is given, status
353
is reported for everything inside that directory.
355
If a revision is specified, the changes since that revision are shown.
357
takes_args = ['file*']
358
takes_options = ['all', 'show-ids', 'revision']
359
aliases = ['st', 'stat']
361
def run(self, all=False, show_ids=False, file_list=None):
363
b = find_branch(file_list[0])
364
file_list = [b.relpath(x) for x in file_list]
365
# special case: only one path was given and it's the root
367
if file_list == ['']:
372
from bzrlib.status import show_status
373
show_status(b, show_unchanged=all, show_ids=show_ids,
374
specific_files=file_list)
377
class cmd_cat_revision(Command):
378
"""Write out metadata for a revision."""
381
takes_args = ['revision_id']
383
def run(self, revision_id):
384
from bzrlib.xml import pack_xml
385
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
388
class cmd_revno(Command):
389
"""Show current revision number.
391
This is equal to the number of revisions on this branch."""
393
print find_branch('.').revno()
395
class cmd_revision_info(Command):
396
"""Show revision number and revision id for a given revision identifier.
399
takes_args = ['revision_info*']
400
takes_options = ['revision']
401
def run(self, revision=None, revision_info_list=None):
402
from bzrlib.branch import find_branch
405
if revision is not None:
406
revs.extend(revision)
407
if revision_info_list is not None:
408
revs.extend(revision_info_list)
410
raise BzrCommandError('You must supply a revision identifier')
415
print '%4d %s' % b.get_revision_info(rev)
418
class cmd_add(Command):
419
"""Add specified files or directories.
421
In non-recursive mode, all the named items are added, regardless
422
of whether they were previously ignored. A warning is given if
423
any of the named files are already versioned.
425
In recursive mode (the default), files are treated the same way
426
but the behaviour for directories is different. Directories that
427
are already versioned do not give a warning. All directories,
428
whether already versioned or not, are searched for files or
429
subdirectories that are neither versioned or ignored, and these
430
are added. This search proceeds recursively into versioned
431
directories. If no names are given '.' is assumed.
433
Therefore simply saying 'bzr add' will version all files that
434
are currently unknown.
436
TODO: Perhaps adding a file whose directly is not versioned should
437
recursively add that parent, rather than giving an error?
439
takes_args = ['file*']
440
takes_options = ['verbose', 'no-recurse']
442
def run(self, file_list, verbose=False, no_recurse=False):
443
from bzrlib.add import smart_add
444
smart_add(file_list, verbose, not no_recurse)
448
class cmd_mkdir(Command):
449
"""Create a new versioned directory.
451
This is equivalent to creating the directory and then adding it.
453
takes_args = ['dir+']
455
def run(self, dir_list):
462
b.add([d], verbose=True)
465
class cmd_relpath(Command):
466
"""Show path of a file relative to root"""
467
takes_args = ['filename']
470
def run(self, filename):
471
print find_branch(filename).relpath(filename)
475
class cmd_inventory(Command):
476
"""Show inventory of the current working copy or a revision."""
477
takes_options = ['revision', 'show-ids']
479
def run(self, revision=None, show_ids=False):
482
inv = b.read_working_inventory()
484
if len(revision) > 1:
485
raise BzrCommandError('bzr inventory --revision takes'
486
' exactly one revision identifier')
487
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
489
for path, entry in inv.entries():
491
print '%-50s %s' % (path, entry.file_id)
496
class cmd_move(Command):
497
"""Move files to a different directory.
502
The destination must be a versioned directory in the same branch.
504
takes_args = ['source$', 'dest']
505
def run(self, source_list, dest):
508
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
511
class cmd_rename(Command):
512
"""Change the name of an entry.
515
bzr rename frob.c frobber.c
516
bzr rename src/frob.c lib/frob.c
518
It is an error if the destination name exists.
520
See also the 'move' command, which moves files into a different
521
directory without changing their name.
523
TODO: Some way to rename multiple files without invoking bzr for each
525
takes_args = ['from_name', 'to_name']
527
def run(self, from_name, to_name):
529
b.rename_one(b.relpath(from_name), b.relpath(to_name))
535
class cmd_pull(Command):
536
"""Pull any changes from another branch into the current one.
538
If the location is omitted, the last-used location will be used.
539
Both the revision history and the working directory will be
542
This command only works on branches that have not diverged. Branches are
543
considered diverged if both branches have had commits without first
544
pulling from the other.
546
If branches have diverged, you can use 'bzr merge' to pull the text changes
547
from one into the other.
549
takes_args = ['location?']
551
def run(self, location=None):
552
from bzrlib.merge import merge
554
from shutil import rmtree
557
br_to = find_branch('.')
560
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
562
if e.errno != errno.ENOENT:
565
if stored_loc is None:
566
raise BzrCommandError("No pull location known or specified.")
568
print "Using last location: %s" % stored_loc
569
location = stored_loc
570
cache_root = tempfile.mkdtemp()
571
from bzrlib.branch import DivergedBranches
572
br_from = find_branch(location)
573
location = pull_loc(br_from)
574
old_revno = br_to.revno()
576
from branch import find_cached_branch, DivergedBranches
577
br_from = find_cached_branch(location, cache_root)
578
location = pull_loc(br_from)
579
old_revno = br_to.revno()
581
br_to.update_revisions(br_from)
582
except DivergedBranches:
583
raise BzrCommandError("These branches have diverged."
586
merge(('.', -1), ('.', old_revno), check_clean=False)
587
if location != stored_loc:
588
br_to.controlfile("x-pull", "wb").write(location + "\n")
594
class cmd_branch(Command):
595
"""Create a new copy of a branch.
597
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
598
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
600
To retrieve the branch as of a particular revision, supply the --revision
601
parameter, as in "branch foo/bar -r 5".
603
takes_args = ['from_location', 'to_location?']
604
takes_options = ['revision']
605
aliases = ['get', 'clone']
607
def run(self, from_location, to_location=None, revision=None):
609
from bzrlib.merge import merge
610
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
611
find_cached_branch, Branch
612
from shutil import rmtree
613
from meta_store import CachedStore
615
cache_root = tempfile.mkdtemp()
619
elif len(revision) > 1:
620
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
624
br_from = find_cached_branch(from_location, cache_root)
626
if e.errno == errno.ENOENT:
627
raise BzrCommandError('Source location "%s" does not'
628
' exist.' % to_location)
632
if to_location is None:
633
to_location = os.path.basename(from_location.rstrip("/\\"))
636
os.mkdir(to_location)
638
if e.errno == errno.EEXIST:
639
raise BzrCommandError('Target directory "%s" already'
640
' exists.' % to_location)
641
if e.errno == errno.ENOENT:
642
raise BzrCommandError('Parent of "%s" does not exist.' %
646
br_to = Branch(to_location, init=True)
648
br_to.set_root_id(br_from.get_root_id())
651
if revision[0] is None:
652
revno = br_from.revno()
654
revno, rev_id = br_from.get_revision_info(revision[0])
656
br_to.update_revisions(br_from, stop_revision=revno)
657
except NoSuchRevision:
659
msg = "The branch %s has no revision %d." % (from_location,
661
raise BzrCommandError(msg)
663
merge((to_location, -1), (to_location, 0), this_dir=to_location,
664
check_clean=False, ignore_zero=True)
665
from_location = pull_loc(br_from)
666
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
671
def pull_loc(branch):
672
# TODO: Should perhaps just make attribute be 'base' in
673
# RemoteBranch and Branch?
674
if hasattr(branch, "baseurl"):
675
return branch.baseurl
681
class cmd_renames(Command):
682
"""Show list of renamed files.
684
TODO: Option to show renames between two historical versions.
686
TODO: Only show renames under dir, rather than in the whole branch.
688
takes_args = ['dir?']
690
def run(self, dir='.'):
692
old_inv = b.basis_tree().inventory
693
new_inv = b.read_working_inventory()
695
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
697
for old_name, new_name in renames:
698
print "%s => %s" % (old_name, new_name)
701
class cmd_info(Command):
702
"""Show statistical information about a branch."""
703
takes_args = ['branch?']
705
def run(self, branch=None):
708
b = find_branch(branch)
712
class cmd_remove(Command):
713
"""Make a file unversioned.
715
This makes bzr stop tracking changes to a versioned file. It does
716
not delete the working copy.
718
takes_args = ['file+']
719
takes_options = ['verbose']
721
def run(self, file_list, verbose=False):
722
b = find_branch(file_list[0])
723
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
726
class cmd_file_id(Command):
727
"""Print file_id of a particular file or directory.
729
The file_id is assigned when the file is first added and remains the
730
same through all revisions where the file exists, even when it is
734
takes_args = ['filename']
735
def run(self, filename):
736
b = find_branch(filename)
737
i = b.inventory.path2id(b.relpath(filename))
739
raise BzrError("%r is not a versioned file" % filename)
744
class cmd_file_path(Command):
745
"""Print path of file_ids to a file or directory.
747
This prints one line for each directory down to the target,
748
starting at the branch root."""
750
takes_args = ['filename']
751
def run(self, filename):
752
b = find_branch(filename)
754
fid = inv.path2id(b.relpath(filename))
756
raise BzrError("%r is not a versioned file" % filename)
757
for fip in inv.get_idpath(fid):
761
class cmd_revision_history(Command):
762
"""Display list of revision ids on this branch."""
765
for patchid in find_branch('.').revision_history():
769
class cmd_directories(Command):
770
"""Display list of versioned directories in this branch."""
772
for name, ie in find_branch('.').read_working_inventory().directories():
779
class cmd_init(Command):
780
"""Make a directory into a versioned branch.
782
Use this to create an empty branch, or before importing an
785
Recipe for importing a tree of files:
790
bzr commit -m 'imported project'
793
from bzrlib.branch import Branch
794
Branch('.', init=True)
797
class cmd_diff(Command):
798
"""Show differences in working tree.
800
If files are listed, only the changes in those files are listed.
801
Otherwise, all changes for the tree are listed.
803
TODO: Given two revision arguments, show the difference between them.
805
TODO: Allow diff across branches.
807
TODO: Option to use external diff command; could be GNU diff, wdiff,
810
TODO: Python difflib is not exactly the same as unidiff; should
811
either fix it up or prefer to use an external diff.
813
TODO: If a directory is given, diff everything under that.
815
TODO: Selected-file diff is inefficient and doesn't show you
818
TODO: This probably handles non-Unix newlines poorly.
821
takes_args = ['file*']
822
takes_options = ['revision', 'diff-options']
823
aliases = ['di', 'dif']
825
def run(self, revision=None, file_list=None, diff_options=None):
826
from bzrlib.diff import show_diff
829
b = find_branch(file_list[0])
830
file_list = [b.relpath(f) for f in file_list]
831
if file_list == ['']:
832
# just pointing to top-of-tree
837
# TODO: Make show_diff support taking 2 arguments
839
if revision is not None:
840
if len(revision) != 1:
841
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
842
base_rev = revision[0]
844
show_diff(b, base_rev, specific_files=file_list,
845
external_diff_options=diff_options)
851
class cmd_deleted(Command):
852
"""List files deleted in the working tree.
854
TODO: Show files deleted since a previous revision, or between two revisions.
856
def run(self, show_ids=False):
859
new = b.working_tree()
861
## TODO: Much more efficient way to do this: read in new
862
## directories with readdir, rather than stating each one. Same
863
## level of effort but possibly much less IO. (Or possibly not,
864
## if the directories are very large...)
866
for path, ie in old.inventory.iter_entries():
867
if not new.has_id(ie.file_id):
869
print '%-50s %s' % (path, ie.file_id)
874
class cmd_modified(Command):
875
"""List files modified in working tree."""
878
from bzrlib.delta import compare_trees
881
td = compare_trees(b.basis_tree(), b.working_tree())
883
for path, id, kind in td.modified:
888
class cmd_added(Command):
889
"""List files added in working tree."""
893
wt = b.working_tree()
894
basis_inv = b.basis_tree().inventory
897
if file_id in basis_inv:
899
path = inv.id2path(file_id)
900
if not os.access(b.abspath(path), os.F_OK):
906
class cmd_root(Command):
907
"""Show the tree root directory.
909
The root is the nearest enclosing directory with a .bzr control
911
takes_args = ['filename?']
912
def run(self, filename=None):
913
"""Print the branch root."""
914
b = find_branch(filename)
915
print getattr(b, 'base', None) or getattr(b, 'baseurl')
918
class cmd_log(Command):
919
"""Show log of this branch.
921
To request a range of logs, you can use the command -r begin:end
922
-r revision requests a specific revision, -r :end or -r begin: are
925
--message allows you to give a regular expression, which will be evaluated
926
so that only matching entries will be displayed.
928
TODO: Make --revision support uuid: and hash: [future tag:] notation.
932
takes_args = ['filename?']
933
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
935
def run(self, filename=None, timezone='original',
942
from bzrlib.branch import find_branch
943
from bzrlib.log import log_formatter, show_log
946
direction = (forward and 'forward') or 'reverse'
949
b = find_branch(filename)
950
fp = b.relpath(filename)
952
file_id = b.read_working_inventory().path2id(fp)
954
file_id = None # points to branch root
962
elif len(revision) == 1:
963
rev1 = rev2 = b.get_revision_info(revision[0])[0]
964
elif len(revision) == 2:
965
rev1 = b.get_revision_info(revision[0])[0]
966
rev2 = b.get_revision_info(revision[1])[0]
968
raise BzrCommandError('bzr log --revision takes one or two values.')
975
mutter('encoding log as %r' % bzrlib.user_encoding)
977
# use 'replace' so that we don't abort if trying to write out
978
# in e.g. the default C locale.
979
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
985
lf = log_formatter(log_format,
988
show_timezone=timezone)
1001
class cmd_touching_revisions(Command):
1002
"""Return revision-ids which affected a particular file.
1004
A more user-friendly interface is "bzr log FILE"."""
1006
takes_args = ["filename"]
1007
def run(self, filename):
1008
b = find_branch(filename)
1009
inv = b.read_working_inventory()
1010
file_id = inv.path2id(b.relpath(filename))
1011
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1012
print "%6d %s" % (revno, what)
1015
class cmd_ls(Command):
1016
"""List files in a tree.
1018
TODO: Take a revision or remote path and list that tree instead.
1021
def run(self, revision=None, verbose=False):
1022
b = find_branch('.')
1023
if revision == None:
1024
tree = b.working_tree()
1026
tree = b.revision_tree(b.lookup_revision(revision))
1028
for fp, fc, kind, fid in tree.list_files():
1030
if kind == 'directory':
1032
elif kind == 'file':
1037
print '%-8s %s%s' % (fc, fp, kindch)
1043
class cmd_unknowns(Command):
1044
"""List unknown files."""
1046
from bzrlib.osutils import quotefn
1047
for f in find_branch('.').unknowns():
1052
class cmd_ignore(Command):
1053
"""Ignore a command or pattern.
1055
To remove patterns from the ignore list, edit the .bzrignore file.
1057
If the pattern contains a slash, it is compared to the whole path
1058
from the branch root. Otherwise, it is comapred to only the last
1059
component of the path.
1061
Ignore patterns are case-insensitive on case-insensitive systems.
1063
Note: wildcards must be quoted from the shell on Unix.
1066
bzr ignore ./Makefile
1067
bzr ignore '*.class'
1069
takes_args = ['name_pattern']
1071
def run(self, name_pattern):
1072
from bzrlib.atomicfile import AtomicFile
1075
b = find_branch('.')
1076
ifn = b.abspath('.bzrignore')
1078
if os.path.exists(ifn):
1081
igns = f.read().decode('utf-8')
1087
# TODO: If the file already uses crlf-style termination, maybe
1088
# we should use that for the newly added lines?
1090
if igns and igns[-1] != '\n':
1092
igns += name_pattern + '\n'
1095
f = AtomicFile(ifn, 'wt')
1096
f.write(igns.encode('utf-8'))
1101
inv = b.working_tree().inventory
1102
if inv.path2id('.bzrignore'):
1103
mutter('.bzrignore is already versioned')
1105
mutter('need to make new .bzrignore file versioned')
1106
b.add(['.bzrignore'])
1110
class cmd_ignored(Command):
1111
"""List ignored files and the patterns that matched them.
1113
See also: bzr ignore"""
1115
tree = find_branch('.').working_tree()
1116
for path, file_class, kind, file_id in tree.list_files():
1117
if file_class != 'I':
1119
## XXX: Slightly inefficient since this was already calculated
1120
pat = tree.is_ignored(path)
1121
print '%-50s %s' % (path, pat)
1124
class cmd_lookup_revision(Command):
1125
"""Lookup the revision-id from a revision-number
1128
bzr lookup-revision 33
1131
takes_args = ['revno']
1133
def run(self, revno):
1137
raise BzrCommandError("not a valid revision-number: %r" % revno)
1139
print find_branch('.').lookup_revision(revno)
1142
class cmd_export(Command):
1143
"""Export past revision to destination directory.
1145
If no revision is specified this exports the last committed revision.
1147
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1148
given, try to find the format with the extension. If no extension
1149
is found exports to a directory (equivalent to --format=dir).
1151
Root may be the top directory for tar, tgz and tbz2 formats. If none
1152
is given, the top directory will be the root name of the file."""
1153
# TODO: list known exporters
1154
takes_args = ['dest']
1155
takes_options = ['revision', 'format', 'root']
1156
def run(self, dest, revision=None, format=None, root=None):
1158
b = find_branch('.')
1159
if revision is None:
1160
rev_id = b.last_patch()
1162
if len(revision) != 1:
1163
raise BzrError('bzr export --revision takes exactly 1 argument')
1164
revno, rev_id = b.get_revision_info(revision[0])
1165
t = b.revision_tree(rev_id)
1166
root, ext = os.path.splitext(dest)
1168
if ext in (".tar",):
1170
elif ext in (".gz", ".tgz"):
1172
elif ext in (".bz2", ".tbz2"):
1176
t.export(dest, format, root)
1179
class cmd_cat(Command):
1180
"""Write a file's text from a previous revision."""
1182
takes_options = ['revision']
1183
takes_args = ['filename']
1185
def run(self, filename, revision=None):
1186
if revision == None:
1187
raise BzrCommandError("bzr cat requires a revision number")
1188
elif len(revision) != 1:
1189
raise BzrCommandError("bzr cat --revision takes exactly one number")
1190
b = find_branch('.')
1191
b.print_file(b.relpath(filename), revision[0])
1194
class cmd_local_time_offset(Command):
1195
"""Show the offset in seconds from GMT to local time."""
1198
print bzrlib.osutils.local_time_offset()
1202
class cmd_commit(Command):
1203
"""Commit changes into a new revision.
1205
If no arguments are given, the entire tree is committed.
1207
If selected files are specified, only changes to those files are
1208
committed. If a directory is specified then the directory and everything
1209
within it is committed.
1211
A selected-file commit may fail in some cases where the committed
1212
tree would be invalid, such as trying to commit a file in a
1213
newly-added directory that is not itself committed.
1215
TODO: Run hooks on tree to-be-committed, and after commit.
1217
TODO: Strict commit that fails if there are unknown or deleted files.
1219
takes_args = ['selected*']
1220
takes_options = ['message', 'file', 'verbose', 'unchanged']
1221
aliases = ['ci', 'checkin']
1223
# TODO: Give better message for -s, --summary, used by tla people
1225
def run(self, message=None, file=None, verbose=True, selected_list=None,
1227
from bzrlib.errors import PointlessCommit
1228
from bzrlib.osutils import get_text_message
1230
## Warning: shadows builtin file()
1231
if not message and not file:
1232
# FIXME: Ugly; change status code to send to a provided function?
1236
catcher = cStringIO.StringIO()
1237
sys.stdout = catcher
1238
cmd_status({"file_list":selected_list}, {})
1239
info = catcher.getvalue()
1241
message = get_text_message(info)
1244
raise BzrCommandError("please specify a commit message",
1245
["use either --message or --file"])
1246
elif message and file:
1247
raise BzrCommandError("please specify either --message or --file")
1251
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1253
b = find_branch('.')
1255
selected_list = [b.relpath(s) for s in selected_list]
1258
b.commit(message, verbose=verbose,
1259
specific_files=selected_list,
1260
allow_pointless=unchanged)
1261
except PointlessCommit:
1262
# FIXME: This should really happen before the file is read in;
1263
# perhaps prepare the commit; get the message; then actually commit
1264
raise BzrCommandError("no changes to commit",
1265
["use --unchanged to commit anyhow"])
1268
class cmd_check(Command):
1269
"""Validate consistency of branch history.
1271
This command checks various invariants about the branch storage to
1272
detect data corruption or bzr bugs.
1274
If given the --update flag, it will update some optional fields
1275
to help ensure data consistency.
1277
takes_args = ['dir?']
1279
def run(self, dir='.'):
1280
from bzrlib.check import check
1281
check(find_branch(dir))
1285
class cmd_scan_cache(Command):
1288
from bzrlib.hashcache import HashCache
1295
print '%6d stats' % c.stat_count
1296
print '%6d in hashcache' % len(c._cache)
1297
print '%6d files removed from cache' % c.removed_count
1298
print '%6d hashes updated' % c.update_count
1299
print '%6d files changed too recently to cache' % c.danger_count
1306
class cmd_upgrade(Command):
1307
"""Upgrade branch storage to current format.
1309
This should normally be used only after the check command tells
1312
takes_args = ['dir?']
1314
def run(self, dir='.'):
1315
from bzrlib.upgrade import upgrade
1316
upgrade(find_branch(dir))
1320
class cmd_whoami(Command):
1321
"""Show bzr user id."""
1322
takes_options = ['email']
1324
def run(self, email=False):
1326
print bzrlib.osutils.user_email()
1328
print bzrlib.osutils.username()
1331
class cmd_selftest(Command):
1332
"""Run internal test suite"""
1334
takes_options = ['verbose']
1335
def run(self, verbose=False):
1336
from bzrlib.selftest import selftest
1337
return int(not selftest(verbose=verbose))
1340
class cmd_version(Command):
1341
"""Show version of bzr."""
1346
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1347
# is bzrlib itself in a branch?
1348
bzrrev = bzrlib.get_bzr_revision()
1350
print " (bzr checkout, revision %d {%s})" % bzrrev
1351
print bzrlib.__copyright__
1352
print "http://bazaar-ng.org/"
1354
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1355
print "you may use, modify and redistribute it under the terms of the GNU"
1356
print "General Public License version 2 or later."
1359
class cmd_rocks(Command):
1360
"""Statement of optimism."""
1363
print "it sure does!"
1365
def parse_spec(spec):
1367
>>> parse_spec(None)
1369
>>> parse_spec("./")
1371
>>> parse_spec("../@")
1373
>>> parse_spec("../f/@35")
1375
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1376
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1381
parsed = spec.split('/@')
1382
assert len(parsed) == 2
1387
parsed[1] = int(parsed[1])
1389
pass # We can allow stuff like ./@revid:blahblahblah
1391
assert parsed[1] >=0
1393
parsed = [spec, None]
1398
class cmd_merge(Command):
1399
"""Perform a three-way merge of trees.
1401
The SPEC parameters are working tree or revision specifiers. Working trees
1402
are specified using standard paths or urls. No component of a directory
1403
path may begin with '@'.
1405
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1407
Revisions are specified using a dirname/@revno pair, where dirname is the
1408
branch directory and revno is the revision within that branch. If no revno
1409
is specified, the latest revision is used.
1411
Revision examples: './@127', 'foo/@', '../@1'
1413
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1414
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1417
merge refuses to run if there are any uncommitted changes, unless
1420
takes_args = ['other_spec', 'base_spec?']
1421
takes_options = ['force', 'merge-type']
1423
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1424
from bzrlib.merge import merge
1425
from bzrlib.merge_core import ApplyMerge3
1426
if merge_type is None:
1427
merge_type = ApplyMerge3
1428
merge(parse_spec(other_spec), parse_spec(base_spec),
1429
check_clean=(not force), merge_type=merge_type)
1432
class cmd_revert(Command):
1433
"""Reverse all changes since the last commit.
1435
Only versioned files are affected. Specify filenames to revert only
1436
those files. By default, any files that are changed will be backed up
1437
first. Backup files have a '~' appended to their name.
1439
takes_options = ['revision', 'no-backup']
1440
takes_args = ['file*']
1441
aliases = ['merge-revert']
1443
def run(self, revision=None, no_backup=False, file_list=None):
1444
from bzrlib.merge import merge
1445
if file_list is not None:
1446
if len(file_list) == 0:
1447
raise BzrCommandError("No files specified")
1448
if revision is None:
1450
elif len(revision) != 1:
1451
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1452
merge(('.', revision[0]), parse_spec('.'),
1455
backup_files=not no_backup,
1456
file_list=file_list)
1459
class cmd_assert_fail(Command):
1460
"""Test reporting of assertion failures"""
1463
assert False, "always fails"
1466
class cmd_help(Command):
1467
"""Show help on a command or other topic.
1469
For a list of all available commands, say 'bzr help commands'."""
1470
takes_args = ['topic?']
1473
def run(self, topic=None):
1480
class cmd_plugins(Command):
1484
import bzrlib.plugin
736
1485
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):
1486
from pprint import pprint
1487
for plugin in bzrlib.plugin.all_plugins:
1488
print plugin.__path__[0]
1491
print '\t', d.split('\n')[0]
1493
#pprint(bzrlib.plugin.all_plugins)
1497
# list of all available options; the rhs can be either None for an
1498
# option that takes no argument, or a constructor function that checks
1502
'diff-options': str,
1511
'revision': _parse_revision_str,
1522
'merge-type': get_merge_type,
1535
def parse_args(argv):
794
1536
"""Parse command line.
796
1538
Arguments and options are parsed at this level before being passed
797
1539
down to specific command handlers. This routine knows, from a
798
1540
lookup table, something about the available options, what optargs
799
1541
they take, and which commands will accept them.
1543
>>> parse_args('--help'.split())
1544
([], {'help': True})
1545
>>> parse_args('--version'.split())
1546
([], {'version': True})
1547
>>> parse_args('status --all'.split())
1548
(['status'], {'all': True})
1549
>>> parse_args('commit --message=biter'.split())
1550
(['commit'], {'message': u'biter'})
1551
>>> parse_args('log -r 500'.split())
1552
(['log'], {'revision': [500]})
1553
>>> parse_args('log -r500..600'.split())
1554
(['log'], {'revision': [500, 600]})
1555
>>> parse_args('log -vr500..600'.split())
1556
(['log'], {'verbose': True, 'revision': [500, 600]})
1557
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1558
(['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])
1563
# TODO: Maybe handle '--' to end options?
1568
# option names must not be unicode
1572
mutter(" got option %r" % a)
1574
optname, optarg = a[2:].split('=', 1)
1577
if optname not in OPTIONS:
1578
raise BzrError('unknown long option %r' % a)
1581
if shortopt in SHORT_OPTIONS:
1582
# Multi-character options must have a space to delimit
1584
optname = SHORT_OPTIONS[shortopt]
1586
# Single character short options, can be chained,
1587
# and have their value appended to their name
1589
if shortopt not in SHORT_OPTIONS:
1590
# We didn't find the multi-character name, and we
1591
# didn't find the single char name
1592
raise BzrError('unknown short option %r' % a)
1593
optname = SHORT_OPTIONS[shortopt]
1596
# There are extra things on this option
1597
# see if it is the value, or if it is another
1599
optargfn = OPTIONS[optname]
1600
if optargfn is None:
1601
# This option does not take an argument, so the
1602
# next entry is another short option, pack it back
1604
argv.insert(0, '-' + a[2:])
1606
# This option takes an argument, so pack it
1611
# XXX: Do we ever want to support this, e.g. for -r?
1612
raise BzrError('repeated option %r' % a)
1614
optargfn = OPTIONS[optname]
1618
raise BzrError('option %r needs an argument' % a)
1620
optarg = argv.pop(0)
1621
opts[optname] = optargfn(optarg)
1624
raise BzrError('option %r takes no argument' % optname)
1625
opts[optname] = True
811
1629
return args, opts
814
1634
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
