164
54
def _unsquish_command_name(cmd):
55
assert cmd.startswith("cmd_")
165
56
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)
59
def _parse_revision_str(revstr):
60
"""This handles a revision string -> revno.
62
This always returns a list. The list will have one element for
64
It supports integers directly, but everything else it
65
defers for passing to Branch.get_revision_info()
67
>>> _parse_revision_str('234')
69
>>> _parse_revision_str('234..567')
71
>>> _parse_revision_str('..')
73
>>> _parse_revision_str('..234')
75
>>> _parse_revision_str('234..')
77
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
79
>>> _parse_revision_str('234....789') # Error?
81
>>> _parse_revision_str('revid:test@other.com-234234')
82
['revid:test@other.com-234234']
83
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
84
['revid:test@other.com-234234', 'revid:test@other.com-234235']
85
>>> _parse_revision_str('revid:test@other.com-234234..23')
86
['revid:test@other.com-234234', 23]
87
>>> _parse_revision_str('date:2005-04-12')
89
>>> _parse_revision_str('date:2005-04-12 12:24:33')
90
['date:2005-04-12 12:24:33']
91
>>> _parse_revision_str('date:2005-04-12T12:24:33')
92
['date:2005-04-12T12:24:33']
93
>>> _parse_revision_str('date:2005-04-12,12:24:33')
94
['date:2005-04-12,12:24:33']
95
>>> _parse_revision_str('-5..23')
97
>>> _parse_revision_str('-5')
99
>>> _parse_revision_str('123a')
101
>>> _parse_revision_str('abc')
105
old_format_re = re.compile('\d*:\d*')
106
m = old_format_re.match(revstr)
108
warning('Colon separator for revision numbers is deprecated.'
111
for rev in revstr.split(':'):
113
revs.append(int(rev))
118
for x in revstr.split('..'):
129
def get_merge_type(typestring):
130
"""Attempt to find the merge class/factory associated with a string."""
131
from merge import merge_types
133
return merge_types[typestring][0]
135
templ = '%s%%7s: %%s' % (' '*12)
136
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
137
type_list = '\n'.join(lines)
138
msg = "No known merge type %s. Supported types are:\n%s" %\
139
(typestring, type_list)
140
raise BzrCommandError(msg)
144
def _get_cmd_dict(plugins_override=True):
146
for k, v in globals().iteritems():
147
if k.startswith("cmd_"):
148
d[_unsquish_command_name(k)] = v
149
# If we didn't load plugins, the plugin_cmds dict will be empty
151
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."""
153
d2 = plugin_cmds.copy()
159
def get_all_cmds(plugins_override=True):
160
"""Return canonical name and class for all registered commands."""
161
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
165
def get_cmd_class(cmd, plugins_override=True):
166
"""Return the canonical name and command class for a command.
168
cmd = str(cmd) # not unicode
170
# first look up this command under the specified name
171
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
173
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)()
177
# look for any command which claims this as an alias
178
for cmdname, cmdclass in cmds.iteritems():
179
if cmd in cmdclass.aliases:
180
return cmdname, cmdclass
182
cmdclass = ExternalCommand.find_command(cmd)
186
raise BzrCommandError("unknown command %r" % cmd)
342
189
class Command(object):
343
190
"""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
192
The docstring for an actual command should give a single-line
357
193
summary, then a complete description of the command. A grammar
358
194
description will be inserted.
361
Other accepted names for this command.
364
197
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().
201
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.
204
If true, this command isn't advertised.
403
209
takes_options = []
404
encoding_type = 'strict'
213
def __init__(self, options, arguments):
214
"""Construct and run the command.
409
"""Construct an instance of this command."""
216
Sets self.status to the return value of run()."""
217
assert isinstance(options, dict)
218
assert isinstance(arguments, dict)
219
cmdargs = options.copy()
220
cmdargs.update(arguments)
410
221
if self.__doc__ == Command.__doc__:
222
from warnings import warn
411
223
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)
224
self.status = self.run(**cmdargs)
225
if self.status is None:
711
"""Actually run the command.
230
"""Override this in sub-classes.
713
232
This is invoked with the options and arguments bound to
714
233
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):
235
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."""
241
class ExternalCommand(Command):
242
"""Class to wrap external commands.
244
We cheat a little here, when get_cmd_class() calls us we actually
245
give it back an object we construct that has the appropriate path,
246
help, options etc for the specified command.
248
When run_bzr() tries to instantiate that 'class' it gets caught by
249
the __call__ method, which we override to call the Command.__init__
250
method. That then calls our run method which is pretty straight
253
The only wrinkle is that we have to map bzr's dictionary of options
254
and arguments back into command line options and arguments for the
258
def find_command(cls, cmd):
260
bzrpath = os.environ.get('BZRPATH', '')
262
for dir in bzrpath.split(os.pathsep):
263
path = os.path.join(dir, cmd)
264
if os.path.isfile(path):
265
return ExternalCommand(path)
269
find_command = classmethod(find_command)
271
def __init__(self, path):
274
pipe = os.popen('%s --bzr-usage' % path, 'r')
275
self.takes_options = pipe.readline().split()
277
for opt in self.takes_options:
278
if not opt in OPTIONS:
279
raise BzrError("Unknown option '%s' returned by external command %s"
282
# TODO: Is there any way to check takes_args is valid here?
283
self.takes_args = pipe.readline().split()
285
if pipe.close() is not None:
286
raise BzrError("Failed funning '%s --bzr-usage'" % path)
288
pipe = os.popen('%s --bzr-help' % path, 'r')
289
self.__doc__ = pipe.read()
290
if pipe.close() is not None:
291
raise BzrError("Failed funning '%s --bzr-help'" % path)
293
def __call__(self, options, arguments):
294
Command.__init__(self, options, arguments)
297
def run(self, **kargs):
304
optname = name.replace('_','-')
306
if OPTIONS.has_key(optname):
308
opts.append('--%s' % optname)
309
if value is not None and value is not True:
310
opts.append(str(value))
312
# it's an arg, or arg list
313
if type(value) is not list:
319
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
323
class cmd_status(Command):
324
"""Display status summary.
326
This reports on versioned and unknown files, reporting them
327
grouped by state. Possible states are:
330
Versioned in the working copy but not in the previous revision.
333
Versioned in the previous revision but removed or deleted
337
Path of this file changed from the previous revision;
338
the text may also have changed. This includes files whose
339
parent directory was renamed.
342
Text has changed since the previous revision.
345
Nothing about this file has changed since the previous revision.
346
Only shown with --all.
349
Not versioned and not matching an ignore pattern.
351
To see ignored files use 'bzr ignored'. For details in the
352
changes to file texts, use 'bzr diff'.
354
If no arguments are specified, the status of the entire working
355
directory is shown. Otherwise, only the status of the specified
356
files or directories is reported. If a directory is given, status
357
is reported for everything inside that directory.
359
If a revision is specified, the changes since that revision are shown.
361
takes_args = ['file*']
362
takes_options = ['all', 'show-ids', 'revision']
363
aliases = ['st', 'stat']
365
def run(self, all=False, show_ids=False, file_list=None):
367
b = find_branch(file_list[0])
368
file_list = [b.relpath(x) for x in file_list]
369
# special case: only one path was given and it's the root
371
if file_list == ['']:
376
from bzrlib.status import show_status
377
show_status(b, show_unchanged=all, show_ids=show_ids,
378
specific_files=file_list)
381
class cmd_cat_revision(Command):
382
"""Write out metadata for a revision."""
385
takes_args = ['revision_id']
387
def run(self, revision_id):
388
from bzrlib.xml import pack_xml
389
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
392
class cmd_revno(Command):
393
"""Show current revision number.
395
This is equal to the number of revisions on this branch."""
397
print find_branch('.').revno()
399
class cmd_revision_info(Command):
400
"""Show revision number and revision id for a given revision identifier.
403
takes_args = ['revision_info*']
404
takes_options = ['revision']
405
def run(self, revision=None, revision_info_list=None):
406
from bzrlib.branch import find_branch
409
if revision is not None:
410
revs.extend(revision)
411
if revision_info_list is not None:
412
revs.extend(revision_info_list)
414
raise BzrCommandError('You must supply a revision identifier')
419
print '%4d %s' % b.get_revision_info(rev)
422
class cmd_add(Command):
423
"""Add specified files or directories.
425
In non-recursive mode, all the named items are added, regardless
426
of whether they were previously ignored. A warning is given if
427
any of the named files are already versioned.
429
In recursive mode (the default), files are treated the same way
430
but the behaviour for directories is different. Directories that
431
are already versioned do not give a warning. All directories,
432
whether already versioned or not, are searched for files or
433
subdirectories that are neither versioned or ignored, and these
434
are added. This search proceeds recursively into versioned
435
directories. If no names are given '.' is assumed.
437
Therefore simply saying 'bzr add' will version all files that
438
are currently unknown.
440
TODO: Perhaps adding a file whose directly is not versioned should
441
recursively add that parent, rather than giving an error?
443
takes_args = ['file*']
444
takes_options = ['verbose', 'no-recurse']
446
def run(self, file_list, verbose=False, no_recurse=False):
447
from bzrlib.add import smart_add
448
smart_add(file_list, verbose, not no_recurse)
452
class cmd_mkdir(Command):
453
"""Create a new versioned directory.
455
This is equivalent to creating the directory and then adding it.
457
takes_args = ['dir+']
459
def run(self, dir_list):
466
b.add([d], verbose=True)
469
class cmd_relpath(Command):
470
"""Show path of a file relative to root"""
471
takes_args = ['filename']
474
def run(self, filename):
475
print find_branch(filename).relpath(filename)
479
class cmd_inventory(Command):
480
"""Show inventory of the current working copy or a revision."""
481
takes_options = ['revision', 'show-ids']
483
def run(self, revision=None, show_ids=False):
486
inv = b.read_working_inventory()
488
if len(revision) > 1:
489
raise BzrCommandError('bzr inventory --revision takes'
490
' exactly one revision identifier')
491
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
493
for path, entry in inv.entries():
495
print '%-50s %s' % (path, entry.file_id)
500
class cmd_move(Command):
501
"""Move files to a different directory.
506
The destination must be a versioned directory in the same branch.
508
takes_args = ['source$', 'dest']
509
def run(self, source_list, dest):
512
# TODO: glob expansion on windows?
513
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
516
class cmd_rename(Command):
517
"""Change the name of an entry.
520
bzr rename frob.c frobber.c
521
bzr rename src/frob.c lib/frob.c
523
It is an error if the destination name exists.
525
See also the 'move' command, which moves files into a different
526
directory without changing their name.
528
TODO: Some way to rename multiple files without invoking bzr for each
530
takes_args = ['from_name', 'to_name']
532
def run(self, from_name, to_name):
534
b.rename_one(b.relpath(from_name), b.relpath(to_name))
538
class cmd_mv(Command):
539
"""Move or rename a file.
542
bzr mv OLDNAME NEWNAME
543
bzr mv SOURCE... DESTINATION
545
If the last argument is a versioned directory, all the other names
546
are moved into it. Otherwise, there must be exactly two arguments
547
and the file is changed to a new name, which must not already exist.
549
Files cannot be moved between branches.
551
takes_args = ['names*']
552
def run(self, names_list):
553
if len(names_list) < 2:
554
raise BzrCommandError("missing file argument")
555
b = find_branch(names_list[0])
557
rel_names = [b.relpath(x) for x in names_list]
559
if os.path.isdir(names_list[-1]):
560
# move into existing directory
561
b.move(rel_names[:-1], rel_names[-1])
563
if len(names_list) != 2:
564
raise BzrCommandError('to mv multiple files the destination '
565
'must be a versioned directory')
566
b.move(rel_names[0], rel_names[1])
571
class cmd_pull(Command):
572
"""Pull any changes from another branch into the current one.
574
If the location is omitted, the last-used location will be used.
575
Both the revision history and the working directory will be
578
This command only works on branches that have not diverged. Branches are
579
considered diverged if both branches have had commits without first
580
pulling from the other.
582
If branches have diverged, you can use 'bzr merge' to pull the text changes
583
from one into the other.
585
takes_args = ['location?']
587
def run(self, location=None):
588
from bzrlib.merge import merge
590
from shutil import rmtree
593
br_to = find_branch('.')
596
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
598
if e.errno != errno.ENOENT:
601
if stored_loc is None:
602
raise BzrCommandError("No pull location known or specified.")
604
print "Using last location: %s" % stored_loc
605
location = stored_loc
606
cache_root = tempfile.mkdtemp()
607
from bzrlib.branch import DivergedBranches
608
br_from = find_branch(location)
609
location = pull_loc(br_from)
610
old_revno = br_to.revno()
612
from branch import find_cached_branch, DivergedBranches
613
br_from = find_cached_branch(location, cache_root)
614
location = pull_loc(br_from)
615
old_revno = br_to.revno()
617
br_to.update_revisions(br_from)
618
except DivergedBranches:
619
raise BzrCommandError("These branches have diverged."
622
merge(('.', -1), ('.', old_revno), check_clean=False)
623
if location != stored_loc:
624
br_to.controlfile("x-pull", "wb").write(location + "\n")
630
class cmd_branch(Command):
631
"""Create a new copy of a branch.
633
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
634
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
636
To retrieve the branch as of a particular revision, supply the --revision
637
parameter, as in "branch foo/bar -r 5".
639
takes_args = ['from_location', 'to_location?']
640
takes_options = ['revision']
641
aliases = ['get', 'clone']
643
def run(self, from_location, to_location=None, revision=None):
645
from bzrlib.merge import merge
646
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
647
find_cached_branch, Branch
648
from shutil import rmtree
649
from meta_store import CachedStore
651
cache_root = tempfile.mkdtemp()
655
elif len(revision) > 1:
656
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
660
br_from = find_cached_branch(from_location, cache_root)
662
if e.errno == errno.ENOENT:
663
raise BzrCommandError('Source location "%s" does not'
664
' exist.' % to_location)
668
if to_location is None:
669
to_location = os.path.basename(from_location.rstrip("/\\"))
672
os.mkdir(to_location)
674
if e.errno == errno.EEXIST:
675
raise BzrCommandError('Target directory "%s" already'
676
' exists.' % to_location)
677
if e.errno == errno.ENOENT:
678
raise BzrCommandError('Parent of "%s" does not exist.' %
682
br_to = Branch(to_location, init=True)
684
br_to.set_root_id(br_from.get_root_id())
687
if revision[0] is None:
688
revno = br_from.revno()
690
revno, rev_id = br_from.get_revision_info(revision[0])
692
br_to.update_revisions(br_from, stop_revision=revno)
693
except NoSuchRevision:
695
msg = "The branch %s has no revision %d." % (from_location,
697
raise BzrCommandError(msg)
699
merge((to_location, -1), (to_location, 0), this_dir=to_location,
700
check_clean=False, ignore_zero=True)
701
from_location = pull_loc(br_from)
702
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
707
def pull_loc(branch):
708
# TODO: Should perhaps just make attribute be 'base' in
709
# RemoteBranch and Branch?
710
if hasattr(branch, "baseurl"):
711
return branch.baseurl
717
class cmd_renames(Command):
718
"""Show list of renamed files.
720
TODO: Option to show renames between two historical versions.
722
TODO: Only show renames under dir, rather than in the whole branch.
724
takes_args = ['dir?']
726
def run(self, dir='.'):
728
old_inv = b.basis_tree().inventory
729
new_inv = b.read_working_inventory()
731
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
733
for old_name, new_name in renames:
734
print "%s => %s" % (old_name, new_name)
737
class cmd_info(Command):
738
"""Show statistical information about a branch."""
739
takes_args = ['branch?']
741
def run(self, branch=None):
744
b = find_branch(branch)
748
class cmd_remove(Command):
749
"""Make a file unversioned.
751
This makes bzr stop tracking changes to a versioned file. It does
752
not delete the working copy.
754
takes_args = ['file+']
755
takes_options = ['verbose']
757
def run(self, file_list, verbose=False):
758
b = find_branch(file_list[0])
759
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
762
class cmd_file_id(Command):
763
"""Print file_id of a particular file or directory.
765
The file_id is assigned when the file is first added and remains the
766
same through all revisions where the file exists, even when it is
770
takes_args = ['filename']
771
def run(self, filename):
772
b = find_branch(filename)
773
i = b.inventory.path2id(b.relpath(filename))
775
raise BzrError("%r is not a versioned file" % filename)
780
class cmd_file_path(Command):
781
"""Print path of file_ids to a file or directory.
783
This prints one line for each directory down to the target,
784
starting at the branch root."""
786
takes_args = ['filename']
787
def run(self, filename):
788
b = find_branch(filename)
790
fid = inv.path2id(b.relpath(filename))
792
raise BzrError("%r is not a versioned file" % filename)
793
for fip in inv.get_idpath(fid):
797
class cmd_revision_history(Command):
798
"""Display list of revision ids on this branch."""
801
for patchid in find_branch('.').revision_history():
805
class cmd_directories(Command):
806
"""Display list of versioned directories in this branch."""
808
for name, ie in find_branch('.').read_working_inventory().directories():
815
class cmd_init(Command):
816
"""Make a directory into a versioned branch.
818
Use this to create an empty branch, or before importing an
821
Recipe for importing a tree of files:
826
bzr commit -m 'imported project'
829
from bzrlib.branch import Branch
830
Branch('.', init=True)
833
class cmd_diff(Command):
834
"""Show differences in working tree.
836
If files are listed, only the changes in those files are listed.
837
Otherwise, all changes for the tree are listed.
839
TODO: Given two revision arguments, show the difference between them.
841
TODO: Allow diff across branches.
843
TODO: Option to use external diff command; could be GNU diff, wdiff,
846
TODO: Python difflib is not exactly the same as unidiff; should
847
either fix it up or prefer to use an external diff.
849
TODO: If a directory is given, diff everything under that.
851
TODO: Selected-file diff is inefficient and doesn't show you
854
TODO: This probably handles non-Unix newlines poorly.
857
takes_args = ['file*']
858
takes_options = ['revision', 'diff-options']
859
aliases = ['di', 'dif']
861
def run(self, revision=None, file_list=None, diff_options=None):
862
from bzrlib.diff import show_diff
865
b = find_branch(file_list[0])
866
file_list = [b.relpath(f) for f in file_list]
867
if file_list == ['']:
868
# just pointing to top-of-tree
873
# TODO: Make show_diff support taking 2 arguments
875
if revision is not None:
876
if len(revision) != 1:
877
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
878
base_rev = revision[0]
880
show_diff(b, base_rev, specific_files=file_list,
881
external_diff_options=diff_options)
887
class cmd_deleted(Command):
888
"""List files deleted in the working tree.
890
TODO: Show files deleted since a previous revision, or between two revisions.
892
def run(self, show_ids=False):
895
new = b.working_tree()
897
## TODO: Much more efficient way to do this: read in new
898
## directories with readdir, rather than stating each one. Same
899
## level of effort but possibly much less IO. (Or possibly not,
900
## if the directories are very large...)
902
for path, ie in old.inventory.iter_entries():
903
if not new.has_id(ie.file_id):
905
print '%-50s %s' % (path, ie.file_id)
910
class cmd_modified(Command):
911
"""List files modified in working tree."""
914
from bzrlib.delta import compare_trees
917
td = compare_trees(b.basis_tree(), b.working_tree())
919
for path, id, kind in td.modified:
924
class cmd_added(Command):
925
"""List files added in working tree."""
929
wt = b.working_tree()
930
basis_inv = b.basis_tree().inventory
933
if file_id in basis_inv:
935
path = inv.id2path(file_id)
936
if not os.access(b.abspath(path), os.F_OK):
942
class cmd_root(Command):
943
"""Show the tree root directory.
945
The root is the nearest enclosing directory with a .bzr control
947
takes_args = ['filename?']
948
def run(self, filename=None):
949
"""Print the branch root."""
950
b = find_branch(filename)
951
print getattr(b, 'base', None) or getattr(b, 'baseurl')
954
class cmd_log(Command):
955
"""Show log of this branch.
957
To request a range of logs, you can use the command -r begin:end
958
-r revision requests a specific revision, -r :end or -r begin: are
961
--message allows you to give a regular expression, which will be evaluated
962
so that only matching entries will be displayed.
964
TODO: Make --revision support uuid: and hash: [future tag:] notation.
968
takes_args = ['filename?']
969
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
971
def run(self, filename=None, timezone='original',
978
from bzrlib.branch import find_branch
979
from bzrlib.log import log_formatter, show_log
982
direction = (forward and 'forward') or 'reverse'
985
b = find_branch(filename)
986
fp = b.relpath(filename)
988
file_id = b.read_working_inventory().path2id(fp)
990
file_id = None # points to branch root
998
elif len(revision) == 1:
999
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1000
elif len(revision) == 2:
1001
rev1 = b.get_revision_info(revision[0])[0]
1002
rev2 = b.get_revision_info(revision[1])[0]
1004
raise BzrCommandError('bzr log --revision takes one or two values.')
1011
mutter('encoding log as %r' % bzrlib.user_encoding)
1013
# use 'replace' so that we don't abort if trying to write out
1014
# in e.g. the default C locale.
1015
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1020
log_format = 'short'
1021
lf = log_formatter(log_format,
1024
show_timezone=timezone)
1030
direction=direction,
1031
start_revision=rev1,
1037
class cmd_touching_revisions(Command):
1038
"""Return revision-ids which affected a particular file.
1040
A more user-friendly interface is "bzr log FILE"."""
1042
takes_args = ["filename"]
1043
def run(self, filename):
1044
b = find_branch(filename)
1045
inv = b.read_working_inventory()
1046
file_id = inv.path2id(b.relpath(filename))
1047
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1048
print "%6d %s" % (revno, what)
1051
class cmd_ls(Command):
1052
"""List files in a tree.
1054
TODO: Take a revision or remote path and list that tree instead.
1057
def run(self, revision=None, verbose=False):
1058
b = find_branch('.')
1059
if revision == None:
1060
tree = b.working_tree()
1062
tree = b.revision_tree(b.lookup_revision(revision))
1064
for fp, fc, kind, fid in tree.list_files():
1066
if kind == 'directory':
1068
elif kind == 'file':
1073
print '%-8s %s%s' % (fc, fp, kindch)
1079
class cmd_unknowns(Command):
1080
"""List unknown files."""
1082
from bzrlib.osutils import quotefn
1083
for f in find_branch('.').unknowns():
1088
class cmd_ignore(Command):
1089
"""Ignore a command or pattern.
1091
To remove patterns from the ignore list, edit the .bzrignore file.
1093
If the pattern contains a slash, it is compared to the whole path
1094
from the branch root. Otherwise, it is comapred to only the last
1095
component of the path.
1097
Ignore patterns are case-insensitive on case-insensitive systems.
1099
Note: wildcards must be quoted from the shell on Unix.
1102
bzr ignore ./Makefile
1103
bzr ignore '*.class'
1105
takes_args = ['name_pattern']
1107
def run(self, name_pattern):
1108
from bzrlib.atomicfile import AtomicFile
1111
b = find_branch('.')
1112
ifn = b.abspath('.bzrignore')
1114
if os.path.exists(ifn):
1117
igns = f.read().decode('utf-8')
1123
# TODO: If the file already uses crlf-style termination, maybe
1124
# we should use that for the newly added lines?
1126
if igns and igns[-1] != '\n':
1128
igns += name_pattern + '\n'
1131
f = AtomicFile(ifn, 'wt')
1132
f.write(igns.encode('utf-8'))
1137
inv = b.working_tree().inventory
1138
if inv.path2id('.bzrignore'):
1139
mutter('.bzrignore is already versioned')
1141
mutter('need to make new .bzrignore file versioned')
1142
b.add(['.bzrignore'])
1146
class cmd_ignored(Command):
1147
"""List ignored files and the patterns that matched them.
1149
See also: bzr ignore"""
1151
tree = find_branch('.').working_tree()
1152
for path, file_class, kind, file_id in tree.list_files():
1153
if file_class != 'I':
1155
## XXX: Slightly inefficient since this was already calculated
1156
pat = tree.is_ignored(path)
1157
print '%-50s %s' % (path, pat)
1160
class cmd_lookup_revision(Command):
1161
"""Lookup the revision-id from a revision-number
1164
bzr lookup-revision 33
1167
takes_args = ['revno']
1169
def run(self, revno):
1173
raise BzrCommandError("not a valid revision-number: %r" % revno)
1175
print find_branch('.').lookup_revision(revno)
1178
class cmd_export(Command):
1179
"""Export past revision to destination directory.
1181
If no revision is specified this exports the last committed revision.
1183
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1184
given, try to find the format with the extension. If no extension
1185
is found exports to a directory (equivalent to --format=dir).
1187
Root may be the top directory for tar, tgz and tbz2 formats. If none
1188
is given, the top directory will be the root name of the file."""
1189
# TODO: list known exporters
1190
takes_args = ['dest']
1191
takes_options = ['revision', 'format', 'root']
1192
def run(self, dest, revision=None, format=None, root=None):
1194
b = find_branch('.')
1195
if revision is None:
1196
rev_id = b.last_patch()
1198
if len(revision) != 1:
1199
raise BzrError('bzr export --revision takes exactly 1 argument')
1200
revno, rev_id = b.get_revision_info(revision[0])
1201
t = b.revision_tree(rev_id)
1202
root, ext = os.path.splitext(dest)
1204
if ext in (".tar",):
1206
elif ext in (".gz", ".tgz"):
1208
elif ext in (".bz2", ".tbz2"):
1212
t.export(dest, format, root)
1215
class cmd_cat(Command):
1216
"""Write a file's text from a previous revision."""
1218
takes_options = ['revision']
1219
takes_args = ['filename']
1221
def run(self, filename, revision=None):
1222
if revision == None:
1223
raise BzrCommandError("bzr cat requires a revision number")
1224
elif len(revision) != 1:
1225
raise BzrCommandError("bzr cat --revision takes exactly one number")
1226
b = find_branch('.')
1227
b.print_file(b.relpath(filename), revision[0])
1230
class cmd_local_time_offset(Command):
1231
"""Show the offset in seconds from GMT to local time."""
1234
print bzrlib.osutils.local_time_offset()
1238
class cmd_commit(Command):
1239
"""Commit changes into a new revision.
1241
If no arguments are given, the entire tree is committed.
1243
If selected files are specified, only changes to those files are
1244
committed. If a directory is specified then the directory and everything
1245
within it is committed.
1247
A selected-file commit may fail in some cases where the committed
1248
tree would be invalid, such as trying to commit a file in a
1249
newly-added directory that is not itself committed.
1251
TODO: Run hooks on tree to-be-committed, and after commit.
1253
TODO: Strict commit that fails if there are unknown or deleted files.
1255
takes_args = ['selected*']
1256
takes_options = ['message', 'file', 'verbose', 'unchanged']
1257
aliases = ['ci', 'checkin']
1259
# TODO: Give better message for -s, --summary, used by tla people
1261
def run(self, message=None, file=None, verbose=True, selected_list=None,
1263
from bzrlib.errors import PointlessCommit
1264
from bzrlib.osutils import get_text_message
1266
## Warning: shadows builtin file()
1267
if not message and not file:
1268
# FIXME: Ugly; change status code to send to a provided function?
1272
catcher = cStringIO.StringIO()
1273
sys.stdout = catcher
1274
cmd_status({"file_list":selected_list}, {})
1275
info = catcher.getvalue()
1277
message = get_text_message(info)
1280
raise BzrCommandError("please specify a commit message",
1281
["use either --message or --file"])
1282
elif message and file:
1283
raise BzrCommandError("please specify either --message or --file")
1287
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1289
b = find_branch('.')
1291
selected_list = [b.relpath(s) for s in selected_list]
1294
b.commit(message, verbose=verbose,
1295
specific_files=selected_list,
1296
allow_pointless=unchanged)
1297
except PointlessCommit:
1298
# FIXME: This should really happen before the file is read in;
1299
# perhaps prepare the commit; get the message; then actually commit
1300
raise BzrCommandError("no changes to commit",
1301
["use --unchanged to commit anyhow"])
1304
class cmd_check(Command):
1305
"""Validate consistency of branch history.
1307
This command checks various invariants about the branch storage to
1308
detect data corruption or bzr bugs.
1310
If given the --update flag, it will update some optional fields
1311
to help ensure data consistency.
1313
takes_args = ['dir?']
1315
def run(self, dir='.'):
1316
from bzrlib.check import check
1317
check(find_branch(dir))
1321
class cmd_scan_cache(Command):
1324
from bzrlib.hashcache import HashCache
1331
print '%6d stats' % c.stat_count
1332
print '%6d in hashcache' % len(c._cache)
1333
print '%6d files removed from cache' % c.removed_count
1334
print '%6d hashes updated' % c.update_count
1335
print '%6d files changed too recently to cache' % c.danger_count
1342
class cmd_upgrade(Command):
1343
"""Upgrade branch storage to current format.
1345
This should normally be used only after the check command tells
1348
takes_args = ['dir?']
1350
def run(self, dir='.'):
1351
from bzrlib.upgrade import upgrade
1352
upgrade(find_branch(dir))
1356
class cmd_whoami(Command):
1357
"""Show bzr user id."""
1358
takes_options = ['email']
1360
def run(self, email=False):
1362
print bzrlib.osutils.user_email()
1364
print bzrlib.osutils.username()
1367
class cmd_selftest(Command):
1368
"""Run internal test suite"""
1370
takes_options = ['verbose']
1371
def run(self, verbose=False):
1372
from bzrlib.selftest import selftest
1373
return int(not selftest(verbose=verbose))
1376
class cmd_version(Command):
1377
"""Show version of bzr."""
1382
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1383
# is bzrlib itself in a branch?
1384
bzrrev = bzrlib.get_bzr_revision()
1386
print " (bzr checkout, revision %d {%s})" % bzrrev
1387
print bzrlib.__copyright__
1388
print "http://bazaar-ng.org/"
1390
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1391
print "you may use, modify and redistribute it under the terms of the GNU"
1392
print "General Public License version 2 or later."
1395
class cmd_rocks(Command):
1396
"""Statement of optimism."""
1399
print "it sure does!"
1401
def parse_spec(spec):
1403
>>> parse_spec(None)
1405
>>> parse_spec("./")
1407
>>> parse_spec("../@")
1409
>>> parse_spec("../f/@35")
1411
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1412
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1417
parsed = spec.split('/@')
1418
assert len(parsed) == 2
1423
parsed[1] = int(parsed[1])
1425
pass # We can allow stuff like ./@revid:blahblahblah
1427
assert parsed[1] >=0
1429
parsed = [spec, None]
1434
class cmd_merge(Command):
1435
"""Perform a three-way merge of trees.
1437
The SPEC parameters are working tree or revision specifiers. Working trees
1438
are specified using standard paths or urls. No component of a directory
1439
path may begin with '@'.
1441
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1443
Revisions are specified using a dirname/@revno pair, where dirname is the
1444
branch directory and revno is the revision within that branch. If no revno
1445
is specified, the latest revision is used.
1447
Revision examples: './@127', 'foo/@', '../@1'
1449
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1450
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1453
merge refuses to run if there are any uncommitted changes, unless
1456
takes_args = ['other_spec', 'base_spec?']
1457
takes_options = ['force', 'merge-type']
1459
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1460
from bzrlib.merge import merge
1461
from bzrlib.merge_core import ApplyMerge3
1462
if merge_type is None:
1463
merge_type = ApplyMerge3
1464
merge(parse_spec(other_spec), parse_spec(base_spec),
1465
check_clean=(not force), merge_type=merge_type)
1468
class cmd_revert(Command):
1469
"""Reverse all changes since the last commit.
1471
Only versioned files are affected. Specify filenames to revert only
1472
those files. By default, any files that are changed will be backed up
1473
first. Backup files have a '~' appended to their name.
1475
takes_options = ['revision', 'no-backup']
1476
takes_args = ['file*']
1477
aliases = ['merge-revert']
1479
def run(self, revision=None, no_backup=False, file_list=None):
1480
from bzrlib.merge import merge
1481
if file_list is not None:
1482
if len(file_list) == 0:
1483
raise BzrCommandError("No files specified")
1484
if revision is None:
1486
elif len(revision) != 1:
1487
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1488
merge(('.', revision[0]), parse_spec('.'),
1491
backup_files=not no_backup,
1492
file_list=file_list)
1495
class cmd_assert_fail(Command):
1496
"""Test reporting of assertion failures"""
1499
assert False, "always fails"
1502
class cmd_help(Command):
1503
"""Show help on a command or other topic.
1505
For a list of all available commands, say 'bzr help commands'."""
1506
takes_args = ['topic?']
1509
def run(self, topic=None):
1516
class cmd_plugins(Command):
1520
import bzrlib.plugin
736
1521
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):
1522
from pprint import pprint
1523
for plugin in bzrlib.plugin.all_plugins:
1524
print plugin.__path__[0]
1527
print '\t', d.split('\n')[0]
1529
#pprint(bzrlib.plugin.all_plugins)
1533
# list of all available options; the rhs can be either None for an
1534
# option that takes no argument, or a constructor function that checks
1538
'diff-options': str,
1547
'revision': _parse_revision_str,
1558
'merge-type': get_merge_type,
1571
def parse_args(argv):
794
1572
"""Parse command line.
796
1574
Arguments and options are parsed at this level before being passed
797
1575
down to specific command handlers. This routine knows, from a
798
1576
lookup table, something about the available options, what optargs
799
1577
they take, and which commands will accept them.
1579
>>> parse_args('--help'.split())
1580
([], {'help': True})
1581
>>> parse_args('--version'.split())
1582
([], {'version': True})
1583
>>> parse_args('status --all'.split())
1584
(['status'], {'all': True})
1585
>>> parse_args('commit --message=biter'.split())
1586
(['commit'], {'message': u'biter'})
1587
>>> parse_args('log -r 500'.split())
1588
(['log'], {'revision': [500]})
1589
>>> parse_args('log -r500..600'.split())
1590
(['log'], {'revision': [500, 600]})
1591
>>> parse_args('log -vr500..600'.split())
1592
(['log'], {'verbose': True, 'revision': [500, 600]})
1593
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1594
(['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])
1599
# TODO: Maybe handle '--' to end options?
1604
# option names must not be unicode
1608
mutter(" got option %r" % a)
1610
optname, optarg = a[2:].split('=', 1)
1613
if optname not in OPTIONS:
1614
raise BzrError('unknown long option %r' % a)
1617
if shortopt in SHORT_OPTIONS:
1618
# Multi-character options must have a space to delimit
1620
optname = SHORT_OPTIONS[shortopt]
1622
# Single character short options, can be chained,
1623
# and have their value appended to their name
1625
if shortopt not in SHORT_OPTIONS:
1626
# We didn't find the multi-character name, and we
1627
# didn't find the single char name
1628
raise BzrError('unknown short option %r' % a)
1629
optname = SHORT_OPTIONS[shortopt]
1632
# There are extra things on this option
1633
# see if it is the value, or if it is another
1635
optargfn = OPTIONS[optname]
1636
if optargfn is None:
1637
# This option does not take an argument, so the
1638
# next entry is another short option, pack it back
1640
argv.insert(0, '-' + a[2:])
1642
# This option takes an argument, so pack it
1647
# XXX: Do we ever want to support this, e.g. for -r?
1648
raise BzrError('repeated option %r' % a)
1650
optargfn = OPTIONS[optname]
1654
raise BzrError('option %r needs an argument' % a)
1656
optarg = argv.pop(0)
1657
opts[optname] = optargfn(optarg)
1660
raise BzrError('option %r takes no argument' % optname)
1661
opts[optname] = True
811
1665
return args, opts
814
1670
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
