164
55
def _unsquish_command_name(cmd):
56
assert cmd.startswith("cmd_")
165
57
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)
60
def _parse_revision_str(revstr):
61
"""This handles a revision string -> revno.
63
This always returns a list. The list will have one element for
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
68
>>> _parse_revision_str('234')
70
>>> _parse_revision_str('234..567')
72
>>> _parse_revision_str('..')
74
>>> _parse_revision_str('..234')
76
>>> _parse_revision_str('234..')
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
80
>>> _parse_revision_str('234....789') # Error?
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
98
>>> _parse_revision_str('-5')
100
>>> _parse_revision_str('123a')
102
>>> _parse_revision_str('abc')
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
109
warning('Colon separator for revision numbers is deprecated.'
112
for rev in revstr.split(':'):
114
revs.append(int(rev))
119
for x in revstr.split('..'):
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
134
return merge_types[typestring][0]
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
145
def _get_cmd_dict(plugins_override=True):
147
for k, v in globals().iteritems():
148
if k.startswith("cmd_"):
149
d[_unsquish_command_name(k)] = v
150
# If we didn't load plugins, the plugin_cmds dict will be empty
152
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."""
154
d2 = plugin_cmds.copy()
160
def get_all_cmds(plugins_override=True):
161
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
166
def get_cmd_class(cmd, plugins_override=True):
167
"""Return the canonical name and command class for a command.
169
cmd = str(cmd) # not unicode
171
# first look up this command under the specified name
172
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
174
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)()
178
# look for any command which claims this as an alias
179
for cmdname, cmdclass in cmds.iteritems():
180
if cmd in cmdclass.aliases:
181
return cmdname, cmdclass
183
cmdclass = ExternalCommand.find_command(cmd)
187
raise BzrCommandError("unknown command %r" % cmd)
342
190
class Command(object):
343
191
"""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
193
The docstring for an actual command should give a single-line
357
194
summary, then a complete description of the command. A grammar
358
195
description will be inserted.
361
Other accepted names for this command.
364
198
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().
202
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.
205
If true, this command isn't advertised.
403
210
takes_options = []
404
encoding_type = 'strict'
214
def __init__(self, options, arguments):
215
"""Construct and run the command.
409
"""Construct an instance of this command."""
217
Sets self.status to the return value of run()."""
218
assert isinstance(options, dict)
219
assert isinstance(arguments, dict)
220
cmdargs = options.copy()
221
cmdargs.update(arguments)
410
222
if self.__doc__ == Command.__doc__:
223
from warnings import warn
411
224
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)
225
self.status = self.run(**cmdargs)
226
if self.status is None:
711
"""Actually run the command.
231
"""Override this in sub-classes.
713
233
This is invoked with the options and arguments bound to
714
234
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):
236
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."""
242
class ExternalCommand(Command):
243
"""Class to wrap external commands.
245
We cheat a little here, when get_cmd_class() calls us we actually
246
give it back an object we construct that has the appropriate path,
247
help, options etc for the specified command.
249
When run_bzr() tries to instantiate that 'class' it gets caught by
250
the __call__ method, which we override to call the Command.__init__
251
method. That then calls our run method which is pretty straight
254
The only wrinkle is that we have to map bzr's dictionary of options
255
and arguments back into command line options and arguments for the
259
def find_command(cls, cmd):
261
bzrpath = os.environ.get('BZRPATH', '')
263
for dir in bzrpath.split(os.pathsep):
264
path = os.path.join(dir, cmd)
265
if os.path.isfile(path):
266
return ExternalCommand(path)
270
find_command = classmethod(find_command)
272
def __init__(self, path):
275
pipe = os.popen('%s --bzr-usage' % path, 'r')
276
self.takes_options = pipe.readline().split()
278
for opt in self.takes_options:
279
if not opt in OPTIONS:
280
raise BzrError("Unknown option '%s' returned by external command %s"
283
# TODO: Is there any way to check takes_args is valid here?
284
self.takes_args = pipe.readline().split()
286
if pipe.close() is not None:
287
raise BzrError("Failed funning '%s --bzr-usage'" % path)
289
pipe = os.popen('%s --bzr-help' % path, 'r')
290
self.__doc__ = pipe.read()
291
if pipe.close() is not None:
292
raise BzrError("Failed funning '%s --bzr-help'" % path)
294
def __call__(self, options, arguments):
295
Command.__init__(self, options, arguments)
298
def run(self, **kargs):
305
optname = name.replace('_','-')
307
if OPTIONS.has_key(optname):
309
opts.append('--%s' % optname)
310
if value is not None and value is not True:
311
opts.append(str(value))
313
# it's an arg, or arg list
314
if type(value) is not list:
320
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
324
class cmd_status(Command):
325
"""Display status summary.
327
This reports on versioned and unknown files, reporting them
328
grouped by state. Possible states are:
331
Versioned in the working copy but not in the previous revision.
334
Versioned in the previous revision but removed or deleted
338
Path of this file changed from the previous revision;
339
the text may also have changed. This includes files whose
340
parent directory was renamed.
343
Text has changed since the previous revision.
346
Nothing about this file has changed since the previous revision.
347
Only shown with --all.
350
Not versioned and not matching an ignore pattern.
352
To see ignored files use 'bzr ignored'. For details in the
353
changes to file texts, use 'bzr diff'.
355
If no arguments are specified, the status of the entire working
356
directory is shown. Otherwise, only the status of the specified
357
files or directories is reported. If a directory is given, status
358
is reported for everything inside that directory.
360
If a revision is specified, the changes since that revision are shown.
362
takes_args = ['file*']
363
takes_options = ['all', 'show-ids', 'revision']
364
aliases = ['st', 'stat']
366
def run(self, all=False, show_ids=False, file_list=None):
368
b = find_branch(file_list[0])
369
file_list = [b.relpath(x) for x in file_list]
370
# special case: only one path was given and it's the root
372
if file_list == ['']:
377
from bzrlib.status import show_status
378
show_status(b, show_unchanged=all, show_ids=show_ids,
379
specific_files=file_list)
382
class cmd_cat_revision(Command):
383
"""Write out metadata for a revision."""
386
takes_args = ['revision_id']
388
def run(self, revision_id):
389
from bzrlib.xml import pack_xml
390
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
393
class cmd_revno(Command):
394
"""Show current revision number.
396
This is equal to the number of revisions on this branch."""
398
print find_branch('.').revno()
400
class cmd_revision_info(Command):
401
"""Show revision number and revision id for a given revision identifier.
404
takes_args = ['revision_info*']
405
takes_options = ['revision']
406
def run(self, revision=None, revision_info_list=None):
407
from bzrlib.branch import find_branch
410
if revision is not None:
411
revs.extend(revision)
412
if revision_info_list is not None:
413
revs.extend(revision_info_list)
415
raise BzrCommandError('You must supply a revision identifier')
420
print '%4d %s' % b.get_revision_info(rev)
423
class cmd_add(Command):
424
"""Add specified files or directories.
426
In non-recursive mode, all the named items are added, regardless
427
of whether they were previously ignored. A warning is given if
428
any of the named files are already versioned.
430
In recursive mode (the default), files are treated the same way
431
but the behaviour for directories is different. Directories that
432
are already versioned do not give a warning. All directories,
433
whether already versioned or not, are searched for files or
434
subdirectories that are neither versioned or ignored, and these
435
are added. This search proceeds recursively into versioned
436
directories. If no names are given '.' is assumed.
438
Therefore simply saying 'bzr add' will version all files that
439
are currently unknown.
441
TODO: Perhaps adding a file whose directly is not versioned should
442
recursively add that parent, rather than giving an error?
444
takes_args = ['file*']
445
takes_options = ['verbose', 'no-recurse']
447
def run(self, file_list, verbose=False, no_recurse=False):
448
from bzrlib.add import smart_add
449
smart_add(file_list, verbose, not no_recurse)
453
class cmd_mkdir(Command):
454
"""Create a new versioned directory.
456
This is equivalent to creating the directory and then adding it.
458
takes_args = ['dir+']
460
def run(self, dir_list):
467
b.add([d], verbose=True)
470
class cmd_relpath(Command):
471
"""Show path of a file relative to root"""
472
takes_args = ['filename']
475
def run(self, filename):
476
print find_branch(filename).relpath(filename)
480
class cmd_inventory(Command):
481
"""Show inventory of the current working copy or a revision."""
482
takes_options = ['revision', 'show-ids']
484
def run(self, revision=None, show_ids=False):
487
inv = b.read_working_inventory()
489
if len(revision) > 1:
490
raise BzrCommandError('bzr inventory --revision takes'
491
' exactly one revision identifier')
492
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
494
for path, entry in inv.entries():
496
print '%-50s %s' % (path, entry.file_id)
501
class cmd_move(Command):
502
"""Move files to a different directory.
507
The destination must be a versioned directory in the same branch.
509
takes_args = ['source$', 'dest']
510
def run(self, source_list, dest):
513
# TODO: glob expansion on windows?
514
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
517
class cmd_rename(Command):
518
"""Change the name of an entry.
521
bzr rename frob.c frobber.c
522
bzr rename src/frob.c lib/frob.c
524
It is an error if the destination name exists.
526
See also the 'move' command, which moves files into a different
527
directory without changing their name.
529
TODO: Some way to rename multiple files without invoking bzr for each
531
takes_args = ['from_name', 'to_name']
533
def run(self, from_name, to_name):
535
b.rename_one(b.relpath(from_name), b.relpath(to_name))
539
class cmd_mv(Command):
540
"""Move or rename a file.
543
bzr mv OLDNAME NEWNAME
544
bzr mv SOURCE... DESTINATION
546
If the last argument is a versioned directory, all the other names
547
are moved into it. Otherwise, there must be exactly two arguments
548
and the file is changed to a new name, which must not already exist.
550
Files cannot be moved between branches.
552
takes_args = ['names*']
553
def run(self, names_list):
554
if len(names_list) < 2:
555
raise BzrCommandError("missing file argument")
556
b = find_branch(names_list[0])
558
rel_names = [b.relpath(x) for x in names_list]
560
if os.path.isdir(names_list[-1]):
561
# move into existing directory
562
b.move(rel_names[:-1], rel_names[-1])
564
if len(names_list) != 2:
565
raise BzrCommandError('to mv multiple files the destination '
566
'must be a versioned directory')
567
b.move(rel_names[0], rel_names[1])
572
class cmd_pull(Command):
573
"""Pull any changes from another branch into the current one.
575
If the location is omitted, the last-used location will be used.
576
Both the revision history and the working directory will be
579
This command only works on branches that have not diverged. Branches are
580
considered diverged if both branches have had commits without first
581
pulling from the other.
583
If branches have diverged, you can use 'bzr merge' to pull the text changes
584
from one into the other.
586
takes_args = ['location?']
588
def run(self, location=None):
589
from bzrlib.merge import merge
591
from shutil import rmtree
594
br_to = find_branch('.')
597
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
599
if e.errno != errno.ENOENT:
602
if stored_loc is None:
603
raise BzrCommandError("No pull location known or specified.")
605
print "Using last location: %s" % stored_loc
606
location = stored_loc
607
cache_root = tempfile.mkdtemp()
608
from bzrlib.branch import DivergedBranches
609
br_from = find_branch(location)
610
location = pull_loc(br_from)
611
old_revno = br_to.revno()
613
from branch import find_cached_branch, DivergedBranches
614
br_from = find_cached_branch(location, cache_root)
615
location = pull_loc(br_from)
616
old_revno = br_to.revno()
618
br_to.update_revisions(br_from)
619
except DivergedBranches:
620
raise BzrCommandError("These branches have diverged."
623
merge(('.', -1), ('.', old_revno), check_clean=False)
624
if location != stored_loc:
625
br_to.controlfile("x-pull", "wb").write(location + "\n")
631
class cmd_branch(Command):
632
"""Create a new copy of a branch.
634
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
635
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
637
To retrieve the branch as of a particular revision, supply the --revision
638
parameter, as in "branch foo/bar -r 5".
640
takes_args = ['from_location', 'to_location?']
641
takes_options = ['revision']
642
aliases = ['get', 'clone']
644
def run(self, from_location, to_location=None, revision=None):
646
from bzrlib.merge import merge
647
from bzrlib.branch import DivergedBranches, \
648
find_cached_branch, Branch
649
from shutil import rmtree
650
from meta_store import CachedStore
652
cache_root = tempfile.mkdtemp()
656
elif len(revision) > 1:
657
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
661
br_from = find_cached_branch(from_location, cache_root)
663
if e.errno == errno.ENOENT:
664
raise BzrCommandError('Source location "%s" does not'
665
' exist.' % to_location)
669
if to_location is None:
670
to_location = os.path.basename(from_location.rstrip("/\\"))
673
os.mkdir(to_location)
675
if e.errno == errno.EEXIST:
676
raise BzrCommandError('Target directory "%s" already'
677
' exists.' % to_location)
678
if e.errno == errno.ENOENT:
679
raise BzrCommandError('Parent of "%s" does not exist.' %
683
br_to = Branch(to_location, init=True)
685
br_to.set_root_id(br_from.get_root_id())
688
if revision[0] is None:
689
revno = br_from.revno()
691
revno, rev_id = br_from.get_revision_info(revision[0])
693
br_to.update_revisions(br_from, stop_revision=revno)
694
except bzrlib.errors.NoSuchRevision:
696
msg = "The branch %s has no revision %d." % (from_location,
698
raise BzrCommandError(msg)
700
merge((to_location, -1), (to_location, 0), this_dir=to_location,
701
check_clean=False, ignore_zero=True)
702
from_location = pull_loc(br_from)
703
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
708
def pull_loc(branch):
709
# TODO: Should perhaps just make attribute be 'base' in
710
# RemoteBranch and Branch?
711
if hasattr(branch, "baseurl"):
712
return branch.baseurl
718
class cmd_renames(Command):
719
"""Show list of renamed files.
721
TODO: Option to show renames between two historical versions.
723
TODO: Only show renames under dir, rather than in the whole branch.
725
takes_args = ['dir?']
727
def run(self, dir='.'):
729
old_inv = b.basis_tree().inventory
730
new_inv = b.read_working_inventory()
732
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
734
for old_name, new_name in renames:
735
print "%s => %s" % (old_name, new_name)
738
class cmd_info(Command):
739
"""Show statistical information about a branch."""
740
takes_args = ['branch?']
742
def run(self, branch=None):
745
b = find_branch(branch)
749
class cmd_remove(Command):
750
"""Make a file unversioned.
752
This makes bzr stop tracking changes to a versioned file. It does
753
not delete the working copy.
755
takes_args = ['file+']
756
takes_options = ['verbose']
758
def run(self, file_list, verbose=False):
759
b = find_branch(file_list[0])
760
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
763
class cmd_file_id(Command):
764
"""Print file_id of a particular file or directory.
766
The file_id is assigned when the file is first added and remains the
767
same through all revisions where the file exists, even when it is
771
takes_args = ['filename']
772
def run(self, filename):
773
b = find_branch(filename)
774
i = b.inventory.path2id(b.relpath(filename))
776
raise BzrError("%r is not a versioned file" % filename)
781
class cmd_file_path(Command):
782
"""Print path of file_ids to a file or directory.
784
This prints one line for each directory down to the target,
785
starting at the branch root."""
787
takes_args = ['filename']
788
def run(self, filename):
789
b = find_branch(filename)
791
fid = inv.path2id(b.relpath(filename))
793
raise BzrError("%r is not a versioned file" % filename)
794
for fip in inv.get_idpath(fid):
798
class cmd_revision_history(Command):
799
"""Display list of revision ids on this branch."""
802
for patchid in find_branch('.').revision_history():
806
class cmd_directories(Command):
807
"""Display list of versioned directories in this branch."""
809
for name, ie in find_branch('.').read_working_inventory().directories():
816
class cmd_init(Command):
817
"""Make a directory into a versioned branch.
819
Use this to create an empty branch, or before importing an
822
Recipe for importing a tree of files:
827
bzr commit -m 'imported project'
830
from bzrlib.branch import Branch
831
Branch('.', init=True)
834
class cmd_diff(Command):
835
"""Show differences in working tree.
837
If files are listed, only the changes in those files are listed.
838
Otherwise, all changes for the tree are listed.
840
TODO: Allow diff across branches.
842
TODO: Option to use external diff command; could be GNU diff, wdiff,
845
TODO: Python difflib is not exactly the same as unidiff; should
846
either fix it up or prefer to use an external diff.
848
TODO: If a directory is given, diff everything under that.
850
TODO: Selected-file diff is inefficient and doesn't show you
853
TODO: This probably handles non-Unix newlines poorly.
861
takes_args = ['file*']
862
takes_options = ['revision', 'diff-options']
863
aliases = ['di', 'dif']
865
def run(self, revision=None, file_list=None, diff_options=None):
866
from bzrlib.diff import show_diff
869
b = find_branch(file_list[0])
870
file_list = [b.relpath(f) for f in file_list]
871
if file_list == ['']:
872
# just pointing to top-of-tree
877
if revision is not None:
878
if len(revision) == 1:
879
show_diff(b, revision[0], specific_files=file_list,
880
external_diff_options=diff_options)
881
elif len(revision) == 2:
882
show_diff(b, revision[0], specific_files=file_list,
883
external_diff_options=diff_options,
884
revision2=revision[1])
886
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
888
show_diff(b, None, specific_files=file_list,
889
external_diff_options=diff_options)
894
class cmd_deleted(Command):
895
"""List files deleted in the working tree.
897
TODO: Show files deleted since a previous revision, or between two revisions.
899
def run(self, show_ids=False):
902
new = b.working_tree()
904
## TODO: Much more efficient way to do this: read in new
905
## directories with readdir, rather than stating each one. Same
906
## level of effort but possibly much less IO. (Or possibly not,
907
## if the directories are very large...)
909
for path, ie in old.inventory.iter_entries():
910
if not new.has_id(ie.file_id):
912
print '%-50s %s' % (path, ie.file_id)
917
class cmd_modified(Command):
918
"""List files modified in working tree."""
921
from bzrlib.delta import compare_trees
924
td = compare_trees(b.basis_tree(), b.working_tree())
926
for path, id, kind in td.modified:
931
class cmd_added(Command):
932
"""List files added in working tree."""
936
wt = b.working_tree()
937
basis_inv = b.basis_tree().inventory
940
if file_id in basis_inv:
942
path = inv.id2path(file_id)
943
if not os.access(b.abspath(path), os.F_OK):
949
class cmd_root(Command):
950
"""Show the tree root directory.
952
The root is the nearest enclosing directory with a .bzr control
954
takes_args = ['filename?']
955
def run(self, filename=None):
956
"""Print the branch root."""
957
b = find_branch(filename)
958
print getattr(b, 'base', None) or getattr(b, 'baseurl')
961
class cmd_log(Command):
962
"""Show log of this branch.
964
To request a range of logs, you can use the command -r begin:end
965
-r revision requests a specific revision, -r :end or -r begin: are
968
--message allows you to give a regular expression, which will be evaluated
969
so that only matching entries will be displayed.
971
TODO: Make --revision support uuid: and hash: [future tag:] notation.
975
takes_args = ['filename?']
976
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
978
def run(self, filename=None, timezone='original',
985
from bzrlib.branch import find_branch
986
from bzrlib.log import log_formatter, show_log
989
direction = (forward and 'forward') or 'reverse'
992
b = find_branch(filename)
993
fp = b.relpath(filename)
995
file_id = b.read_working_inventory().path2id(fp)
997
file_id = None # points to branch root
1002
if revision is None:
1005
elif len(revision) == 1:
1006
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1007
elif len(revision) == 2:
1008
rev1 = b.get_revision_info(revision[0])[0]
1009
rev2 = b.get_revision_info(revision[1])[0]
1011
raise BzrCommandError('bzr log --revision takes one or two values.')
1018
mutter('encoding log as %r' % bzrlib.user_encoding)
1020
# use 'replace' so that we don't abort if trying to write out
1021
# in e.g. the default C locale.
1022
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1027
log_format = 'short'
1028
lf = log_formatter(log_format,
1031
show_timezone=timezone)
1037
direction=direction,
1038
start_revision=rev1,
1044
class cmd_touching_revisions(Command):
1045
"""Return revision-ids which affected a particular file.
1047
A more user-friendly interface is "bzr log FILE"."""
1049
takes_args = ["filename"]
1050
def run(self, filename):
1051
b = find_branch(filename)
1052
inv = b.read_working_inventory()
1053
file_id = inv.path2id(b.relpath(filename))
1054
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1055
print "%6d %s" % (revno, what)
1058
class cmd_ls(Command):
1059
"""List files in a tree.
1061
TODO: Take a revision or remote path and list that tree instead.
1064
def run(self, revision=None, verbose=False):
1065
b = find_branch('.')
1066
if revision == None:
1067
tree = b.working_tree()
1069
tree = b.revision_tree(b.lookup_revision(revision))
1071
for fp, fc, kind, fid in tree.list_files():
1073
if kind == 'directory':
1075
elif kind == 'file':
1080
print '%-8s %s%s' % (fc, fp, kindch)
1086
class cmd_unknowns(Command):
1087
"""List unknown files."""
1089
from bzrlib.osutils import quotefn
1090
for f in find_branch('.').unknowns():
1095
class cmd_ignore(Command):
1096
"""Ignore a command or pattern.
1098
To remove patterns from the ignore list, edit the .bzrignore file.
1100
If the pattern contains a slash, it is compared to the whole path
1101
from the branch root. Otherwise, it is comapred to only the last
1102
component of the path.
1104
Ignore patterns are case-insensitive on case-insensitive systems.
1106
Note: wildcards must be quoted from the shell on Unix.
1109
bzr ignore ./Makefile
1110
bzr ignore '*.class'
1112
takes_args = ['name_pattern']
1114
def run(self, name_pattern):
1115
from bzrlib.atomicfile import AtomicFile
1118
b = find_branch('.')
1119
ifn = b.abspath('.bzrignore')
1121
if os.path.exists(ifn):
1124
igns = f.read().decode('utf-8')
1130
# TODO: If the file already uses crlf-style termination, maybe
1131
# we should use that for the newly added lines?
1133
if igns and igns[-1] != '\n':
1135
igns += name_pattern + '\n'
1138
f = AtomicFile(ifn, 'wt')
1139
f.write(igns.encode('utf-8'))
1144
inv = b.working_tree().inventory
1145
if inv.path2id('.bzrignore'):
1146
mutter('.bzrignore is already versioned')
1148
mutter('need to make new .bzrignore file versioned')
1149
b.add(['.bzrignore'])
1153
class cmd_ignored(Command):
1154
"""List ignored files and the patterns that matched them.
1156
See also: bzr ignore"""
1158
tree = find_branch('.').working_tree()
1159
for path, file_class, kind, file_id in tree.list_files():
1160
if file_class != 'I':
1162
## XXX: Slightly inefficient since this was already calculated
1163
pat = tree.is_ignored(path)
1164
print '%-50s %s' % (path, pat)
1167
class cmd_lookup_revision(Command):
1168
"""Lookup the revision-id from a revision-number
1171
bzr lookup-revision 33
1174
takes_args = ['revno']
1176
def run(self, revno):
1180
raise BzrCommandError("not a valid revision-number: %r" % revno)
1182
print find_branch('.').lookup_revision(revno)
1185
class cmd_export(Command):
1186
"""Export past revision to destination directory.
1188
If no revision is specified this exports the last committed revision.
1190
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1191
given, try to find the format with the extension. If no extension
1192
is found exports to a directory (equivalent to --format=dir).
1194
Root may be the top directory for tar, tgz and tbz2 formats. If none
1195
is given, the top directory will be the root name of the file."""
1196
# TODO: list known exporters
1197
takes_args = ['dest']
1198
takes_options = ['revision', 'format', 'root']
1199
def run(self, dest, revision=None, format=None, root=None):
1201
b = find_branch('.')
1202
if revision is None:
1203
rev_id = b.last_patch()
1205
if len(revision) != 1:
1206
raise BzrError('bzr export --revision takes exactly 1 argument')
1207
revno, rev_id = b.get_revision_info(revision[0])
1208
t = b.revision_tree(rev_id)
1209
root, ext = os.path.splitext(dest)
1211
if ext in (".tar",):
1213
elif ext in (".gz", ".tgz"):
1215
elif ext in (".bz2", ".tbz2"):
1219
t.export(dest, format, root)
1222
class cmd_cat(Command):
1223
"""Write a file's text from a previous revision."""
1225
takes_options = ['revision']
1226
takes_args = ['filename']
1228
def run(self, filename, revision=None):
1229
if revision == None:
1230
raise BzrCommandError("bzr cat requires a revision number")
1231
elif len(revision) != 1:
1232
raise BzrCommandError("bzr cat --revision takes exactly one number")
1233
b = find_branch('.')
1234
b.print_file(b.relpath(filename), revision[0])
1237
class cmd_local_time_offset(Command):
1238
"""Show the offset in seconds from GMT to local time."""
1241
print bzrlib.osutils.local_time_offset()
1245
class cmd_commit(Command):
1246
"""Commit changes into a new revision.
1248
If no arguments are given, the entire tree is committed.
1250
If selected files are specified, only changes to those files are
1251
committed. If a directory is specified then the directory and everything
1252
within it is committed.
1254
A selected-file commit may fail in some cases where the committed
1255
tree would be invalid, such as trying to commit a file in a
1256
newly-added directory that is not itself committed.
1258
TODO: Run hooks on tree to-be-committed, and after commit.
1260
TODO: Strict commit that fails if there are unknown or deleted files.
1262
takes_args = ['selected*']
1263
takes_options = ['message', 'file', 'verbose', 'unchanged']
1264
aliases = ['ci', 'checkin']
1266
# TODO: Give better message for -s, --summary, used by tla people
1268
def run(self, message=None, file=None, verbose=True, selected_list=None,
1270
from bzrlib.errors import PointlessCommit
1271
from bzrlib.osutils import get_text_message
1273
## Warning: shadows builtin file()
1274
if not message and not file:
1275
# FIXME: Ugly; change status code to send to a provided function?
1279
catcher = cStringIO.StringIO()
1280
sys.stdout = catcher
1281
cmd_status({"file_list":selected_list}, {})
1282
info = catcher.getvalue()
1284
message = get_text_message(info)
1287
raise BzrCommandError("please specify a commit message",
1288
["use either --message or --file"])
1289
elif message and file:
1290
raise BzrCommandError("please specify either --message or --file")
1294
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1296
b = find_branch('.')
1298
selected_list = [b.relpath(s) for s in selected_list]
1301
b.commit(message, verbose=verbose,
1302
specific_files=selected_list,
1303
allow_pointless=unchanged)
1304
except PointlessCommit:
1305
# FIXME: This should really happen before the file is read in;
1306
# perhaps prepare the commit; get the message; then actually commit
1307
raise BzrCommandError("no changes to commit",
1308
["use --unchanged to commit anyhow"])
1311
class cmd_check(Command):
1312
"""Validate consistency of branch history.
1314
This command checks various invariants about the branch storage to
1315
detect data corruption or bzr bugs.
1317
If given the --update flag, it will update some optional fields
1318
to help ensure data consistency.
1320
takes_args = ['dir?']
1322
def run(self, dir='.'):
1323
from bzrlib.check import check
1324
check(find_branch(dir))
1328
class cmd_scan_cache(Command):
1331
from bzrlib.hashcache import HashCache
1338
print '%6d stats' % c.stat_count
1339
print '%6d in hashcache' % len(c._cache)
1340
print '%6d files removed from cache' % c.removed_count
1341
print '%6d hashes updated' % c.update_count
1342
print '%6d files changed too recently to cache' % c.danger_count
1349
class cmd_upgrade(Command):
1350
"""Upgrade branch storage to current format.
1352
This should normally be used only after the check command tells
1355
takes_args = ['dir?']
1357
def run(self, dir='.'):
1358
from bzrlib.upgrade import upgrade
1359
upgrade(find_branch(dir))
1363
class cmd_whoami(Command):
1364
"""Show bzr user id."""
1365
takes_options = ['email']
1367
def run(self, email=False):
1369
print bzrlib.osutils.user_email()
1371
print bzrlib.osutils.username()
1374
class cmd_selftest(Command):
1375
"""Run internal test suite"""
1377
takes_options = ['verbose']
1378
def run(self, verbose=False):
1379
from bzrlib.selftest import selftest
1380
return int(not selftest(verbose=verbose))
1383
class cmd_version(Command):
1384
"""Show version of bzr."""
1389
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1390
# is bzrlib itself in a branch?
1391
bzrrev = bzrlib.get_bzr_revision()
1393
print " (bzr checkout, revision %d {%s})" % bzrrev
1394
print bzrlib.__copyright__
1395
print "http://bazaar-ng.org/"
1397
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1398
print "you may use, modify and redistribute it under the terms of the GNU"
1399
print "General Public License version 2 or later."
1402
class cmd_rocks(Command):
1403
"""Statement of optimism."""
1406
print "it sure does!"
1408
def parse_spec(spec):
1410
>>> parse_spec(None)
1412
>>> parse_spec("./")
1414
>>> parse_spec("../@")
1416
>>> parse_spec("../f/@35")
1418
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1419
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1424
parsed = spec.split('/@')
1425
assert len(parsed) == 2
1430
parsed[1] = int(parsed[1])
1432
pass # We can allow stuff like ./@revid:blahblahblah
1434
assert parsed[1] >=0
1436
parsed = [spec, None]
1441
class cmd_merge(Command):
1442
"""Perform a three-way merge of trees.
1444
The SPEC parameters are working tree or revision specifiers. Working trees
1445
are specified using standard paths or urls. No component of a directory
1446
path may begin with '@'.
1448
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1450
Revisions are specified using a dirname/@revno pair, where dirname is the
1451
branch directory and revno is the revision within that branch. If no revno
1452
is specified, the latest revision is used.
1454
Revision examples: './@127', 'foo/@', '../@1'
1456
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1457
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1460
merge refuses to run if there are any uncommitted changes, unless
1463
takes_args = ['other_spec', 'base_spec?']
1464
takes_options = ['force', 'merge-type']
1466
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1467
from bzrlib.merge import merge
1468
from bzrlib.merge_core import ApplyMerge3
1469
if merge_type is None:
1470
merge_type = ApplyMerge3
1471
merge(parse_spec(other_spec), parse_spec(base_spec),
1472
check_clean=(not force), merge_type=merge_type)
1475
class cmd_revert(Command):
1476
"""Reverse all changes since the last commit.
1478
Only versioned files are affected. Specify filenames to revert only
1479
those files. By default, any files that are changed will be backed up
1480
first. Backup files have a '~' appended to their name.
1482
takes_options = ['revision', 'no-backup']
1483
takes_args = ['file*']
1484
aliases = ['merge-revert']
1486
def run(self, revision=None, no_backup=False, file_list=None):
1487
from bzrlib.merge import merge
1488
if file_list is not None:
1489
if len(file_list) == 0:
1490
raise BzrCommandError("No files specified")
1491
if revision is None:
1493
elif len(revision) != 1:
1494
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1495
merge(('.', revision[0]), parse_spec('.'),
1498
backup_files=not no_backup,
1499
file_list=file_list)
1502
class cmd_assert_fail(Command):
1503
"""Test reporting of assertion failures"""
1506
assert False, "always fails"
1509
class cmd_help(Command):
1510
"""Show help on a command or other topic.
1512
For a list of all available commands, say 'bzr help commands'."""
1513
takes_args = ['topic?']
1516
def run(self, topic=None):
1523
class cmd_plugins(Command):
1527
import bzrlib.plugin
736
1528
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):
1529
from pprint import pprint
1530
for plugin in bzrlib.plugin.all_plugins:
1531
print plugin.__path__[0]
1534
print '\t', d.split('\n')[0]
1536
#pprint(bzrlib.plugin.all_plugins)
1540
# list of all available options; the rhs can be either None for an
1541
# option that takes no argument, or a constructor function that checks
1545
'diff-options': str,
1554
'revision': _parse_revision_str,
1565
'merge-type': get_merge_type,
1578
def parse_args(argv):
794
1579
"""Parse command line.
796
1581
Arguments and options are parsed at this level before being passed
797
1582
down to specific command handlers. This routine knows, from a
798
1583
lookup table, something about the available options, what optargs
799
1584
they take, and which commands will accept them.
1586
>>> parse_args('--help'.split())
1587
([], {'help': True})
1588
>>> parse_args('--version'.split())
1589
([], {'version': True})
1590
>>> parse_args('status --all'.split())
1591
(['status'], {'all': True})
1592
>>> parse_args('commit --message=biter'.split())
1593
(['commit'], {'message': u'biter'})
1594
>>> parse_args('log -r 500'.split())
1595
(['log'], {'revision': [500]})
1596
>>> parse_args('log -r500..600'.split())
1597
(['log'], {'revision': [500, 600]})
1598
>>> parse_args('log -vr500..600'.split())
1599
(['log'], {'verbose': True, 'revision': [500, 600]})
1600
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1601
(['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])
1606
# TODO: Maybe handle '--' to end options?
1611
# option names must not be unicode
1615
mutter(" got option %r" % a)
1617
optname, optarg = a[2:].split('=', 1)
1620
if optname not in OPTIONS:
1621
raise BzrError('unknown long option %r' % a)
1624
if shortopt in SHORT_OPTIONS:
1625
# Multi-character options must have a space to delimit
1627
optname = SHORT_OPTIONS[shortopt]
1629
# Single character short options, can be chained,
1630
# and have their value appended to their name
1632
if shortopt not in SHORT_OPTIONS:
1633
# We didn't find the multi-character name, and we
1634
# didn't find the single char name
1635
raise BzrError('unknown short option %r' % a)
1636
optname = SHORT_OPTIONS[shortopt]
1639
# There are extra things on this option
1640
# see if it is the value, or if it is another
1642
optargfn = OPTIONS[optname]
1643
if optargfn is None:
1644
# This option does not take an argument, so the
1645
# next entry is another short option, pack it back
1647
argv.insert(0, '-' + a[2:])
1649
# This option takes an argument, so pack it
1654
# XXX: Do we ever want to support this, e.g. for -r?
1655
raise BzrError('repeated option %r' % a)
1657
optargfn = OPTIONS[optname]
1661
raise BzrError('option %r needs an argument' % a)
1663
optarg = argv.pop(0)
1664
opts[optname] = optargfn(optarg)
1667
raise BzrError('option %r takes no argument' % optname)
1668
opts[optname] = True
811
1672
return args, opts
814
1677
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
