164
62
def _unsquish_command_name(cmd):
63
assert cmd.startswith("cmd_")
165
64
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)
67
def _parse_revision_str(revstr):
68
"""This handles a revision string -> revno.
70
This always returns a list. The list will have one element for
72
It supports integers directly, but everything else it
73
defers for passing to Branch.get_revision_info()
75
>>> _parse_revision_str('234')
77
>>> _parse_revision_str('234..567')
79
>>> _parse_revision_str('..')
81
>>> _parse_revision_str('..234')
83
>>> _parse_revision_str('234..')
85
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
>>> _parse_revision_str('234....789') # Error?
89
>>> _parse_revision_str('revid:test@other.com-234234')
90
['revid:test@other.com-234234']
91
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
92
['revid:test@other.com-234234', 'revid:test@other.com-234235']
93
>>> _parse_revision_str('revid:test@other.com-234234..23')
94
['revid:test@other.com-234234', 23]
95
>>> _parse_revision_str('date:2005-04-12')
97
>>> _parse_revision_str('date:2005-04-12 12:24:33')
98
['date:2005-04-12 12:24:33']
99
>>> _parse_revision_str('date:2005-04-12T12:24:33')
100
['date:2005-04-12T12:24:33']
101
>>> _parse_revision_str('date:2005-04-12,12:24:33')
102
['date:2005-04-12,12:24:33']
103
>>> _parse_revision_str('-5..23')
105
>>> _parse_revision_str('-5')
107
>>> _parse_revision_str('123a')
109
>>> _parse_revision_str('abc')
113
old_format_re = re.compile('\d*:\d*')
114
m = old_format_re.match(revstr)
116
warning('Colon separator for revision numbers is deprecated.'
119
for rev in revstr.split(':'):
121
revs.append(int(rev))
126
for x in revstr.split('..'):
137
def get_merge_type(typestring):
138
"""Attempt to find the merge class/factory associated with a string."""
139
from merge import merge_types
141
return merge_types[typestring][0]
143
templ = '%s%%7s: %%s' % (' '*12)
144
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
145
type_list = '\n'.join(lines)
146
msg = "No known merge type %s. Supported types are:\n%s" %\
147
(typestring, type_list)
148
raise BzrCommandError(msg)
151
def get_merge_type(typestring):
152
"""Attempt to find the merge class/factory associated with a string."""
153
from merge import merge_types
155
return merge_types[typestring][0]
157
templ = '%s%%7s: %%s' % (' '*12)
158
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
159
type_list = '\n'.join(lines)
160
msg = "No known merge type %s. Supported types are:\n%s" %\
161
(typestring, type_list)
162
raise BzrCommandError(msg)
166
def _get_cmd_dict(plugins_override=True):
168
for k, v in globals().iteritems():
169
if k.startswith("cmd_"):
170
d[_unsquish_command_name(k)] = v
171
# If we didn't load plugins, the plugin_cmds dict will be empty
173
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."""
175
d2 = plugin_cmds.copy()
181
def get_all_cmds(plugins_override=True):
182
"""Return canonical name and class for all registered commands."""
183
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
187
def get_cmd_class(cmd, plugins_override=True):
188
"""Return the canonical name and command class for a command.
190
cmd = str(cmd) # not unicode
192
# first look up this command under the specified name
193
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
195
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)()
199
# look for any command which claims this as an alias
200
for cmdname, cmdclass in cmds.iteritems():
201
if cmd in cmdclass.aliases:
202
return cmdname, cmdclass
204
cmdclass = ExternalCommand.find_command(cmd)
208
raise BzrCommandError("unknown command %r" % cmd)
342
211
class Command(object):
343
212
"""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
214
The docstring for an actual command should give a single-line
357
215
summary, then a complete description of the command. A grammar
358
216
description will be inserted.
361
Other accepted names for this command.
364
219
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().
223
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.
226
If true, this command isn't advertised.
403
231
takes_options = []
404
encoding_type = 'strict'
235
def __init__(self, options, arguments):
236
"""Construct and run the command.
409
"""Construct an instance of this command."""
238
Sets self.status to the return value of run()."""
239
assert isinstance(options, dict)
240
assert isinstance(arguments, dict)
241
cmdargs = options.copy()
242
cmdargs.update(arguments)
410
243
if self.__doc__ == Command.__doc__:
244
from warnings import warn
411
245
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)
246
self.status = self.run(**cmdargs)
247
if self.status is None:
711
"""Actually run the command.
252
"""Override this in sub-classes.
713
254
This is invoked with the options and arguments bound to
714
255
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):
257
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."""
263
class ExternalCommand(Command):
264
"""Class to wrap external commands.
266
We cheat a little here, when get_cmd_class() calls us we actually
267
give it back an object we construct that has the appropriate path,
268
help, options etc for the specified command.
270
When run_bzr() tries to instantiate that 'class' it gets caught by
271
the __call__ method, which we override to call the Command.__init__
272
method. That then calls our run method which is pretty straight
275
The only wrinkle is that we have to map bzr's dictionary of options
276
and arguments back into command line options and arguments for the
280
def find_command(cls, cmd):
282
bzrpath = os.environ.get('BZRPATH', '')
284
for dir in bzrpath.split(os.pathsep):
285
path = os.path.join(dir, cmd)
286
if os.path.isfile(path):
287
return ExternalCommand(path)
291
find_command = classmethod(find_command)
293
def __init__(self, path):
296
pipe = os.popen('%s --bzr-usage' % path, 'r')
297
self.takes_options = pipe.readline().split()
299
for opt in self.takes_options:
300
if not opt in OPTIONS:
301
raise BzrError("Unknown option '%s' returned by external command %s"
304
# TODO: Is there any way to check takes_args is valid here?
305
self.takes_args = pipe.readline().split()
307
if pipe.close() is not None:
308
raise BzrError("Failed funning '%s --bzr-usage'" % path)
310
pipe = os.popen('%s --bzr-help' % path, 'r')
311
self.__doc__ = pipe.read()
312
if pipe.close() is not None:
313
raise BzrError("Failed funning '%s --bzr-help'" % path)
315
def __call__(self, options, arguments):
316
Command.__init__(self, options, arguments)
319
def run(self, **kargs):
326
optname = name.replace('_','-')
328
if OPTIONS.has_key(optname):
330
opts.append('--%s' % optname)
331
if value is not None and value is not True:
332
opts.append(str(value))
334
# it's an arg, or arg list
335
if type(value) is not list:
341
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
345
class cmd_status(Command):
346
"""Display status summary.
348
This reports on versioned and unknown files, reporting them
349
grouped by state. Possible states are:
352
Versioned in the working copy but not in the previous revision.
355
Versioned in the previous revision but removed or deleted
359
Path of this file changed from the previous revision;
360
the text may also have changed. This includes files whose
361
parent directory was renamed.
364
Text has changed since the previous revision.
367
Nothing about this file has changed since the previous revision.
368
Only shown with --all.
371
Not versioned and not matching an ignore pattern.
373
To see ignored files use 'bzr ignored'. For details in the
374
changes to file texts, use 'bzr diff'.
376
If no arguments are specified, the status of the entire working
377
directory is shown. Otherwise, only the status of the specified
378
files or directories is reported. If a directory is given, status
379
is reported for everything inside that directory.
381
If a revision is specified, the changes since that revision are shown.
383
takes_args = ['file*']
384
takes_options = ['all', 'show-ids', 'revision']
385
aliases = ['st', 'stat']
387
def run(self, all=False, show_ids=False, file_list=None):
389
b = find_branch(file_list[0])
390
file_list = [b.relpath(x) for x in file_list]
391
# special case: only one path was given and it's the root
393
if file_list == ['']:
398
from bzrlib.status import show_status
399
show_status(b, show_unchanged=all, show_ids=show_ids,
400
specific_files=file_list)
403
class cmd_cat_revision(Command):
404
"""Write out metadata for a revision."""
407
takes_args = ['revision_id']
409
def run(self, revision_id):
410
from bzrlib.xml import pack_xml
411
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
414
class cmd_revno(Command):
415
"""Show current revision number.
417
This is equal to the number of revisions on this branch."""
419
print find_branch('.').revno()
421
class cmd_revision_info(Command):
422
"""Show revision number and revision id for a given revision identifier.
425
takes_args = ['revision_info*']
426
takes_options = ['revision']
427
def run(self, revision=None, revision_info_list=None):
428
from bzrlib.branch import find_branch
431
if revision is not None:
432
revs.extend(revision)
433
if revision_info_list is not None:
434
revs.extend(revision_info_list)
436
raise BzrCommandError('You must supply a revision identifier')
441
print '%4d %s' % b.get_revision_info(rev)
444
class cmd_add(Command):
445
"""Add specified files or directories.
447
In non-recursive mode, all the named items are added, regardless
448
of whether they were previously ignored. A warning is given if
449
any of the named files are already versioned.
451
In recursive mode (the default), files are treated the same way
452
but the behaviour for directories is different. Directories that
453
are already versioned do not give a warning. All directories,
454
whether already versioned or not, are searched for files or
455
subdirectories that are neither versioned or ignored, and these
456
are added. This search proceeds recursively into versioned
457
directories. If no names are given '.' is assumed.
459
Therefore simply saying 'bzr add' will version all files that
460
are currently unknown.
462
TODO: Perhaps adding a file whose directly is not versioned should
463
recursively add that parent, rather than giving an error?
465
takes_args = ['file*']
466
takes_options = ['verbose', 'no-recurse']
468
def run(self, file_list, verbose=False, no_recurse=False):
469
from bzrlib.add import smart_add, _PrintAddCallback
470
smart_add(file_list, verbose, not no_recurse,
471
callback=_PrintAddCallback)
475
class cmd_mkdir(Command):
476
"""Create a new versioned directory.
478
This is equivalent to creating the directory and then adding it.
480
takes_args = ['dir+']
482
def run(self, dir_list):
489
b.add([d], verbose=True)
492
class cmd_relpath(Command):
493
"""Show path of a file relative to root"""
494
takes_args = ['filename']
497
def run(self, filename):
498
print find_branch(filename).relpath(filename)
502
class cmd_inventory(Command):
503
"""Show inventory of the current working copy or a revision."""
504
takes_options = ['revision', 'show-ids']
506
def run(self, revision=None, show_ids=False):
509
inv = b.read_working_inventory()
511
if len(revision) > 1:
512
raise BzrCommandError('bzr inventory --revision takes'
513
' exactly one revision identifier')
514
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
516
for path, entry in inv.entries():
518
print '%-50s %s' % (path, entry.file_id)
523
class cmd_move(Command):
524
"""Move files to a different directory.
529
The destination must be a versioned directory in the same branch.
531
takes_args = ['source$', 'dest']
532
def run(self, source_list, dest):
535
# TODO: glob expansion on windows?
536
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
539
class cmd_rename(Command):
540
"""Change the name of an entry.
543
bzr rename frob.c frobber.c
544
bzr rename src/frob.c lib/frob.c
546
It is an error if the destination name exists.
548
See also the 'move' command, which moves files into a different
549
directory without changing their name.
551
TODO: Some way to rename multiple files without invoking bzr for each
553
takes_args = ['from_name', 'to_name']
555
def run(self, from_name, to_name):
557
b.rename_one(b.relpath(from_name), b.relpath(to_name))
561
class cmd_mv(Command):
562
"""Move or rename a file.
565
bzr mv OLDNAME NEWNAME
566
bzr mv SOURCE... DESTINATION
568
If the last argument is a versioned directory, all the other names
569
are moved into it. Otherwise, there must be exactly two arguments
570
and the file is changed to a new name, which must not already exist.
572
Files cannot be moved between branches.
574
takes_args = ['names*']
575
def run(self, names_list):
576
if len(names_list) < 2:
577
raise BzrCommandError("missing file argument")
578
b = find_branch(names_list[0])
580
rel_names = [b.relpath(x) for x in names_list]
582
if os.path.isdir(names_list[-1]):
583
# move into existing directory
584
b.move(rel_names[:-1], rel_names[-1])
586
if len(names_list) != 2:
587
raise BzrCommandError('to mv multiple files the destination '
588
'must be a versioned directory')
589
b.move(rel_names[0], rel_names[1])
594
class cmd_pull(Command):
595
"""Pull any changes from another branch into the current one.
597
If the location is omitted, the last-used location will be used.
598
Both the revision history and the working directory will be
601
This command only works on branches that have not diverged. Branches are
602
considered diverged if both branches have had commits without first
603
pulling from the other.
605
If branches have diverged, you can use 'bzr merge' to pull the text changes
606
from one into the other.
608
takes_args = ['location?']
610
def run(self, location=None):
611
from bzrlib.merge import merge
613
from shutil import rmtree
615
from bzrlib.branch import pull_loc
617
br_to = find_branch('.')
620
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
622
if e.errno != errno.ENOENT:
625
if stored_loc is None:
626
raise BzrCommandError("No pull location known or specified.")
628
print "Using last location: %s" % stored_loc
629
location = stored_loc
630
cache_root = tempfile.mkdtemp()
631
from bzrlib.branch import DivergedBranches
632
br_from = find_branch(location)
633
location = pull_loc(br_from)
634
old_revno = br_to.revno()
636
from branch import find_cached_branch, DivergedBranches
637
br_from = find_cached_branch(location, cache_root)
638
location = pull_loc(br_from)
639
old_revno = br_to.revno()
641
br_to.update_revisions(br_from)
642
except DivergedBranches:
643
raise BzrCommandError("These branches have diverged."
646
merge(('.', -1), ('.', old_revno), check_clean=False)
647
if location != stored_loc:
648
br_to.controlfile("x-pull", "wb").write(location + "\n")
654
class cmd_branch(Command):
655
"""Create a new copy of a branch.
657
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
658
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
660
To retrieve the branch as of a particular revision, supply the --revision
661
parameter, as in "branch foo/bar -r 5".
663
takes_args = ['from_location', 'to_location?']
664
takes_options = ['revision']
665
aliases = ['get', 'clone']
667
def run(self, from_location, to_location=None, revision=None):
668
from bzrlib.branch import copy_branch, find_cached_branch
671
from shutil import rmtree
672
cache_root = tempfile.mkdtemp()
676
elif len(revision) > 1:
677
raise BzrCommandError(
678
'bzr branch --revision takes exactly 1 revision value')
680
br_from = find_cached_branch(from_location, cache_root)
682
if e.errno == errno.ENOENT:
683
raise BzrCommandError('Source location "%s" does not'
684
' exist.' % to_location)
687
if to_location is None:
688
to_location = os.path.basename(from_location.rstrip("/\\"))
690
os.mkdir(to_location)
692
if e.errno == errno.EEXIST:
693
raise BzrCommandError('Target directory "%s" already'
694
' exists.' % to_location)
695
if e.errno == errno.ENOENT:
696
raise BzrCommandError('Parent of "%s" does not exist.' %
701
copy_branch(br_from, to_location, revision[0])
702
except bzrlib.errors.NoSuchRevision:
704
msg = "The branch %s has no revision %d." % (from_location, revision[0])
705
raise BzrCommandError(msg)
710
class cmd_renames(Command):
711
"""Show list of renamed files.
713
TODO: Option to show renames between two historical versions.
715
TODO: Only show renames under dir, rather than in the whole branch.
717
takes_args = ['dir?']
719
def run(self, dir='.'):
721
old_inv = b.basis_tree().inventory
722
new_inv = b.read_working_inventory()
724
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
726
for old_name, new_name in renames:
727
print "%s => %s" % (old_name, new_name)
730
class cmd_info(Command):
731
"""Show statistical information about a branch."""
732
takes_args = ['branch?']
734
def run(self, branch=None):
737
b = find_branch(branch)
741
class cmd_remove(Command):
742
"""Make a file unversioned.
744
This makes bzr stop tracking changes to a versioned file. It does
745
not delete the working copy.
747
takes_args = ['file+']
748
takes_options = ['verbose']
750
def run(self, file_list, verbose=False):
751
b = find_branch(file_list[0])
752
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
755
class cmd_file_id(Command):
756
"""Print file_id of a particular file or directory.
758
The file_id is assigned when the file is first added and remains the
759
same through all revisions where the file exists, even when it is
763
takes_args = ['filename']
764
def run(self, filename):
765
b = find_branch(filename)
766
i = b.inventory.path2id(b.relpath(filename))
768
raise BzrError("%r is not a versioned file" % filename)
773
class cmd_file_path(Command):
774
"""Print path of file_ids to a file or directory.
776
This prints one line for each directory down to the target,
777
starting at the branch root."""
779
takes_args = ['filename']
780
def run(self, filename):
781
b = find_branch(filename)
783
fid = inv.path2id(b.relpath(filename))
785
raise BzrError("%r is not a versioned file" % filename)
786
for fip in inv.get_idpath(fid):
790
class cmd_revision_history(Command):
791
"""Display list of revision ids on this branch."""
794
for patchid in find_branch('.').revision_history():
798
class cmd_directories(Command):
799
"""Display list of versioned directories in this branch."""
801
for name, ie in find_branch('.').read_working_inventory().directories():
808
class cmd_init(Command):
809
"""Make a directory into a versioned branch.
811
Use this to create an empty branch, or before importing an
814
Recipe for importing a tree of files:
819
bzr commit -m 'imported project'
822
from bzrlib.branch import Branch
823
Branch('.', init=True)
826
class cmd_diff(Command):
827
"""Show differences in working tree.
829
If files are listed, only the changes in those files are listed.
830
Otherwise, all changes for the tree are listed.
832
TODO: Allow diff across branches.
834
TODO: Option to use external diff command; could be GNU diff, wdiff,
837
TODO: Python difflib is not exactly the same as unidiff; should
838
either fix it up or prefer to use an external diff.
840
TODO: If a directory is given, diff everything under that.
842
TODO: Selected-file diff is inefficient and doesn't show you
845
TODO: This probably handles non-Unix newlines poorly.
853
takes_args = ['file*']
854
takes_options = ['revision', 'diff-options']
855
aliases = ['di', 'dif']
857
def run(self, revision=None, file_list=None, diff_options=None):
858
from bzrlib.diff import show_diff
861
b = find_branch(file_list[0])
862
file_list = [b.relpath(f) for f in file_list]
863
if file_list == ['']:
864
# just pointing to top-of-tree
869
if revision is not None:
870
if len(revision) == 1:
871
show_diff(b, revision[0], specific_files=file_list,
872
external_diff_options=diff_options)
873
elif len(revision) == 2:
874
show_diff(b, revision[0], specific_files=file_list,
875
external_diff_options=diff_options,
876
revision2=revision[1])
878
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
880
show_diff(b, None, specific_files=file_list,
881
external_diff_options=diff_options)
886
class cmd_deleted(Command):
887
"""List files deleted in the working tree.
889
TODO: Show files deleted since a previous revision, or between two revisions.
891
def run(self, show_ids=False):
894
new = b.working_tree()
896
## TODO: Much more efficient way to do this: read in new
897
## directories with readdir, rather than stating each one. Same
898
## level of effort but possibly much less IO. (Or possibly not,
899
## if the directories are very large...)
901
for path, ie in old.inventory.iter_entries():
902
if not new.has_id(ie.file_id):
904
print '%-50s %s' % (path, ie.file_id)
909
class cmd_modified(Command):
910
"""List files modified in working tree."""
913
from bzrlib.delta import compare_trees
916
td = compare_trees(b.basis_tree(), b.working_tree())
918
for path, id, kind in td.modified:
923
class cmd_added(Command):
924
"""List files added in working tree."""
928
wt = b.working_tree()
929
basis_inv = b.basis_tree().inventory
932
if file_id in basis_inv:
934
path = inv.id2path(file_id)
935
if not os.access(b.abspath(path), os.F_OK):
941
class cmd_root(Command):
942
"""Show the tree root directory.
944
The root is the nearest enclosing directory with a .bzr control
946
takes_args = ['filename?']
947
def run(self, filename=None):
948
"""Print the branch root."""
949
b = find_branch(filename)
950
print getattr(b, 'base', None) or getattr(b, 'baseurl')
953
class cmd_log(Command):
954
"""Show log of this branch.
956
To request a range of logs, you can use the command -r begin:end
957
-r revision requests a specific revision, -r :end or -r begin: are
960
--message allows you to give a regular expression, which will be evaluated
961
so that only matching entries will be displayed.
963
TODO: Make --revision support uuid: and hash: [future tag:] notation.
967
takes_args = ['filename?']
968
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
969
'long', 'message', 'short',]
971
def run(self, filename=None, timezone='original',
979
from bzrlib.branch import find_branch
980
from bzrlib.log import log_formatter, show_log
983
direction = (forward and 'forward') or 'reverse'
986
b = find_branch(filename)
987
fp = b.relpath(filename)
989
file_id = b.read_working_inventory().path2id(fp)
991
file_id = None # points to branch root
999
elif len(revision) == 1:
1000
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1001
elif len(revision) == 2:
1002
rev1 = b.get_revision_info(revision[0])[0]
1003
rev2 = b.get_revision_info(revision[1])[0]
1005
raise BzrCommandError('bzr log --revision takes one or two values.')
1012
mutter('encoding log as %r' % bzrlib.user_encoding)
1014
# use 'replace' so that we don't abort if trying to write out
1015
# in e.g. the default C locale.
1016
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1021
log_format = 'short'
1022
lf = log_formatter(log_format,
1025
show_timezone=timezone)
1031
direction=direction,
1032
start_revision=rev1,
1038
class cmd_touching_revisions(Command):
1039
"""Return revision-ids which affected a particular file.
1041
A more user-friendly interface is "bzr log FILE"."""
1043
takes_args = ["filename"]
1044
def run(self, filename):
1045
b = find_branch(filename)
1046
inv = b.read_working_inventory()
1047
file_id = inv.path2id(b.relpath(filename))
1048
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1049
print "%6d %s" % (revno, what)
1052
class cmd_ls(Command):
1053
"""List files in a tree.
1055
TODO: Take a revision or remote path and list that tree instead.
1058
def run(self, revision=None, verbose=False):
1059
b = find_branch('.')
1060
if revision == None:
1061
tree = b.working_tree()
1063
tree = b.revision_tree(b.lookup_revision(revision))
1065
for fp, fc, kind, fid in tree.list_files():
1067
if kind == 'directory':
1069
elif kind == 'file':
1074
print '%-8s %s%s' % (fc, fp, kindch)
1080
class cmd_unknowns(Command):
1081
"""List unknown files."""
1083
from bzrlib.osutils import quotefn
1084
for f in find_branch('.').unknowns():
1089
class cmd_ignore(Command):
1090
"""Ignore a command or pattern.
1092
To remove patterns from the ignore list, edit the .bzrignore file.
1094
If the pattern contains a slash, it is compared to the whole path
1095
from the branch root. Otherwise, it is comapred to only the last
1096
component of the path.
1098
Ignore patterns are case-insensitive on case-insensitive systems.
1100
Note: wildcards must be quoted from the shell on Unix.
1103
bzr ignore ./Makefile
1104
bzr ignore '*.class'
1106
takes_args = ['name_pattern']
1108
def run(self, name_pattern):
1109
from bzrlib.atomicfile import AtomicFile
1112
b = find_branch('.')
1113
ifn = b.abspath('.bzrignore')
1115
if os.path.exists(ifn):
1118
igns = f.read().decode('utf-8')
1124
# TODO: If the file already uses crlf-style termination, maybe
1125
# we should use that for the newly added lines?
1127
if igns and igns[-1] != '\n':
1129
igns += name_pattern + '\n'
1132
f = AtomicFile(ifn, 'wt')
1133
f.write(igns.encode('utf-8'))
1138
inv = b.working_tree().inventory
1139
if inv.path2id('.bzrignore'):
1140
mutter('.bzrignore is already versioned')
1142
mutter('need to make new .bzrignore file versioned')
1143
b.add(['.bzrignore'])
1147
class cmd_ignored(Command):
1148
"""List ignored files and the patterns that matched them.
1150
See also: bzr ignore"""
1152
tree = find_branch('.').working_tree()
1153
for path, file_class, kind, file_id in tree.list_files():
1154
if file_class != 'I':
1156
## XXX: Slightly inefficient since this was already calculated
1157
pat = tree.is_ignored(path)
1158
print '%-50s %s' % (path, pat)
1161
class cmd_lookup_revision(Command):
1162
"""Lookup the revision-id from a revision-number
1165
bzr lookup-revision 33
1168
takes_args = ['revno']
1170
def run(self, revno):
1174
raise BzrCommandError("not a valid revision-number: %r" % revno)
1176
print find_branch('.').lookup_revision(revno)
1179
class cmd_export(Command):
1180
"""Export past revision to destination directory.
1182
If no revision is specified this exports the last committed revision.
1184
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1185
given, try to find the format with the extension. If no extension
1186
is found exports to a directory (equivalent to --format=dir).
1188
Root may be the top directory for tar, tgz and tbz2 formats. If none
1189
is given, the top directory will be the root name of the file."""
1190
# TODO: list known exporters
1191
takes_args = ['dest']
1192
takes_options = ['revision', 'format', 'root']
1193
def run(self, dest, revision=None, format=None, root=None):
1195
b = find_branch('.')
1196
if revision is None:
1197
rev_id = b.last_patch()
1199
if len(revision) != 1:
1200
raise BzrError('bzr export --revision takes exactly 1 argument')
1201
revno, rev_id = b.get_revision_info(revision[0])
1202
t = b.revision_tree(rev_id)
1203
root, ext = os.path.splitext(dest)
1205
if ext in (".tar",):
1207
elif ext in (".gz", ".tgz"):
1209
elif ext in (".bz2", ".tbz2"):
1213
t.export(dest, format, root)
1216
class cmd_cat(Command):
1217
"""Write a file's text from a previous revision."""
1219
takes_options = ['revision']
1220
takes_args = ['filename']
1222
def run(self, filename, revision=None):
1223
if revision == None:
1224
raise BzrCommandError("bzr cat requires a revision number")
1225
elif len(revision) != 1:
1226
raise BzrCommandError("bzr cat --revision takes exactly one number")
1227
b = find_branch('.')
1228
b.print_file(b.relpath(filename), revision[0])
1231
class cmd_local_time_offset(Command):
1232
"""Show the offset in seconds from GMT to local time."""
1235
print bzrlib.osutils.local_time_offset()
1239
class cmd_commit(Command):
1240
"""Commit changes into a new revision.
1242
If no arguments are given, the entire tree is committed.
1244
If selected files are specified, only changes to those files are
1245
committed. If a directory is specified then the directory and everything
1246
within it is committed.
1248
A selected-file commit may fail in some cases where the committed
1249
tree would be invalid, such as trying to commit a file in a
1250
newly-added directory that is not itself committed.
1252
TODO: Run hooks on tree to-be-committed, and after commit.
1254
TODO: Strict commit that fails if there are unknown or deleted files.
1256
takes_args = ['selected*']
1257
takes_options = ['message', 'file', 'verbose', 'unchanged']
1258
aliases = ['ci', 'checkin']
1260
# TODO: Give better message for -s, --summary, used by tla people
1262
def run(self, message=None, file=None, verbose=True, selected_list=None,
1264
from bzrlib.errors import PointlessCommit
1265
from bzrlib.osutils import get_text_message
1267
## Warning: shadows builtin file()
1268
if not message and not file:
1269
# FIXME: Ugly; change status code to send to a provided function?
1273
catcher = cStringIO.StringIO()
1274
sys.stdout = catcher
1275
cmd_status({"file_list":selected_list}, {})
1276
info = catcher.getvalue()
1278
message = get_text_message(info)
1281
raise BzrCommandError("please specify a commit message",
1282
["use either --message or --file"])
1283
elif message and file:
1284
raise BzrCommandError("please specify either --message or --file")
1288
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1290
b = find_branch('.')
1292
selected_list = [b.relpath(s) for s in selected_list]
1295
b.commit(message, verbose=verbose,
1296
specific_files=selected_list,
1297
allow_pointless=unchanged)
1298
except PointlessCommit:
1299
# FIXME: This should really happen before the file is read in;
1300
# perhaps prepare the commit; get the message; then actually commit
1301
raise BzrCommandError("no changes to commit",
1302
["use --unchanged to commit anyhow"])
1305
class cmd_check(Command):
1306
"""Validate consistency of branch history.
1308
This command checks various invariants about the branch storage to
1309
detect data corruption or bzr bugs.
1311
If given the --update flag, it will update some optional fields
1312
to help ensure data consistency.
1314
takes_args = ['dir?']
1316
def run(self, dir='.'):
1317
from bzrlib.check import check
1319
check(find_branch(dir))
1322
class cmd_scan_cache(Command):
1325
from bzrlib.hashcache import HashCache
1332
print '%6d stats' % c.stat_count
1333
print '%6d in hashcache' % len(c._cache)
1334
print '%6d files removed from cache' % c.removed_count
1335
print '%6d hashes updated' % c.update_count
1336
print '%6d files changed too recently to cache' % c.danger_count
1343
class cmd_upgrade(Command):
1344
"""Upgrade branch storage to current format.
1346
This should normally be used only after the check command tells
1349
takes_args = ['dir?']
1351
def run(self, dir='.'):
1352
from bzrlib.upgrade import upgrade
1353
upgrade(find_branch(dir))
1357
class cmd_whoami(Command):
1358
"""Show bzr user id."""
1359
takes_options = ['email']
1361
def run(self, email=False):
1363
b = bzrlib.branch.find_branch('.')
1368
print bzrlib.osutils.user_email(b)
1370
print bzrlib.osutils.username(b)
1373
class cmd_selftest(Command):
1374
"""Run internal test suite"""
1376
takes_options = ['verbose', 'pattern']
1377
def run(self, verbose=False, pattern=".*"):
1379
from bzrlib.selftest import selftest
1380
# we don't want progress meters from the tests to go to the
1382
save_ui = bzrlib.ui.ui_factory
1384
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1385
return int(not selftest(verbose=verbose, pattern=pattern))
1387
bzrlib.ui.ui_factory = save_ui
1390
class cmd_version(Command):
1391
"""Show version of bzr."""
1396
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1397
# is bzrlib itself in a branch?
1398
bzrrev = bzrlib.get_bzr_revision()
1400
print " (bzr checkout, revision %d {%s})" % bzrrev
1401
print bzrlib.__copyright__
1402
print "http://bazaar-ng.org/"
1404
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1405
print "you may use, modify and redistribute it under the terms of the GNU"
1406
print "General Public License version 2 or later."
1409
class cmd_rocks(Command):
1410
"""Statement of optimism."""
1413
print "it sure does!"
1415
def parse_spec(spec):
1417
>>> parse_spec(None)
1419
>>> parse_spec("./")
1421
>>> parse_spec("../@")
1423
>>> parse_spec("../f/@35")
1425
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1426
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1431
parsed = spec.split('/@')
1432
assert len(parsed) == 2
1437
parsed[1] = int(parsed[1])
1439
pass # We can allow stuff like ./@revid:blahblahblah
1441
assert parsed[1] >=0
1443
parsed = [spec, None]
1448
class cmd_find_merge_base(Command):
1449
"""Find and print a base revision for merging two branches.
1451
TODO: Options to specify revisions on either side, as if
1452
merging only part of the history.
1454
takes_args = ['branch', 'other']
1457
def run(self, branch, other):
1458
branch1 = find_branch(branch)
1459
branch2 = find_branch(other)
1461
base_revno, base_revid = branch1.common_ancestor(branch2)
1463
if base_revno is None:
1464
raise bzrlib.errors.UnrelatedBranches()
1466
print 'merge base is revision %s' % base_revid
1467
print ' r%-6d in %s' % (base_revno, branch)
1469
other_revno = branch2.revision_id_to_revno(base_revid)
1471
print ' r%-6d in %s' % (other_revno, other)
1475
class cmd_merge(Command):
1476
"""Perform a three-way merge.
1478
The branch is the branch you will merge from. By default, it will merge
1479
the latest revision. If you specify a revision, that revision will be
1480
merged. If you specify two revisions, the first will be used as a BASE,
1481
and the second one as OTHER. Revision numbers are always relative to the
1486
To merge the latest revision from bzr.dev
1487
bzr merge ../bzr.dev
1489
To merge changes up to and including revision 82 from bzr.dev
1490
bzr merge -r 82 ../bzr.dev
1492
To merge the changes introduced by 82, without previous changes:
1493
bzr merge -r 81..82 ../bzr.dev
1495
merge refuses to run if there are any uncommitted changes, unless
1498
takes_args = ['branch?']
1499
takes_options = ['revision', 'force', 'merge-type']
1501
def run(self, branch='.', revision=None, force=False,
1503
from bzrlib.merge import merge
1504
from bzrlib.merge_core import ApplyMerge3
1505
if merge_type is None:
1506
merge_type = ApplyMerge3
1508
if revision is None or len(revision) < 1:
1510
other = (branch, -1)
1512
if len(revision) == 1:
1513
other = (branch, revision[0])
1516
assert len(revision) == 2
1517
if None in revision:
1518
raise BzrCommandError(
1519
"Merge doesn't permit that revision specifier.")
1520
base = (branch, revision[0])
1521
other = (branch, revision[1])
1523
merge(other, base, check_clean=(not force), merge_type=merge_type)
1526
class cmd_revert(Command):
1527
"""Reverse all changes since the last commit.
1529
Only versioned files are affected. Specify filenames to revert only
1530
those files. By default, any files that are changed will be backed up
1531
first. Backup files have a '~' appended to their name.
1533
takes_options = ['revision', 'no-backup']
1534
takes_args = ['file*']
1535
aliases = ['merge-revert']
1537
def run(self, revision=None, no_backup=False, file_list=None):
1538
from bzrlib.merge import merge
1539
if file_list is not None:
1540
if len(file_list) == 0:
1541
raise BzrCommandError("No files specified")
1542
if revision is None:
1544
elif len(revision) != 1:
1545
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1546
merge(('.', revision[0]), parse_spec('.'),
1549
backup_files=not no_backup,
1550
file_list=file_list)
1553
class cmd_assert_fail(Command):
1554
"""Test reporting of assertion failures"""
1557
assert False, "always fails"
1560
class cmd_help(Command):
1561
"""Show help on a command or other topic.
1563
For a list of all available commands, say 'bzr help commands'."""
1564
takes_options = ['long']
1565
takes_args = ['topic?']
1568
def run(self, topic=None, long=False):
1570
if topic is None and long:
1575
class cmd_shell_complete(Command):
1576
"""Show appropriate completions for context.
1578
For a list of all available commands, say 'bzr shell-complete'."""
1579
takes_args = ['context?']
1583
def run(self, context=None):
1584
import shellcomplete
1585
shellcomplete.shellcomplete(context)
1588
class cmd_missing(Command):
1589
"""What is missing in this branch relative to other branch.
1591
takes_args = ['remote?']
1592
aliases = ['mis', 'miss']
1593
# We don't have to add quiet to the list, because
1594
# unknown options are parsed as booleans
1595
takes_options = ['verbose', 'quiet']
1597
def run(self, remote=None, verbose=False, quiet=False):
1598
from bzrlib.branch import find_branch, DivergedBranches
1599
from bzrlib.errors import BzrCommandError
1600
from bzrlib.missing import get_parent, show_missing
1602
if verbose and quiet:
1603
raise BzrCommandError('Cannot pass both quiet and verbose')
1605
b = find_branch('.')
1606
parent = get_parent(b)
1609
raise BzrCommandError("No missing location known or specified.")
1612
print "Using last location: %s" % parent
1614
elif parent is None:
1615
# We only update x-pull if it did not exist, missing should not change the parent
1616
b.controlfile('x-pull', 'wb').write(remote + '\n')
1617
br_remote = find_branch(remote)
1619
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1623
class cmd_plugins(Command):
1627
import bzrlib.plugin
736
1628
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):
1629
from pprint import pprint
1630
for plugin in bzrlib.plugin.all_plugins:
1631
print plugin.__path__[0]
1634
print '\t', d.split('\n')[0]
1636
#pprint(bzrlib.plugin.all_plugins)
1640
# list of all available options; the rhs can be either None for an
1641
# option that takes no argument, or a constructor function that checks
1645
'diff-options': str,
1654
'revision': _parse_revision_str,
1666
'merge-type': get_merge_type,
1680
def parse_args(argv):
794
1681
"""Parse command line.
796
1683
Arguments and options are parsed at this level before being passed
797
1684
down to specific command handlers. This routine knows, from a
798
1685
lookup table, something about the available options, what optargs
799
1686
they take, and which commands will accept them.
1688
>>> parse_args('--help'.split())
1689
([], {'help': True})
1690
>>> parse_args('--version'.split())
1691
([], {'version': True})
1692
>>> parse_args('status --all'.split())
1693
(['status'], {'all': True})
1694
>>> parse_args('commit --message=biter'.split())
1695
(['commit'], {'message': u'biter'})
1696
>>> parse_args('log -r 500'.split())
1697
(['log'], {'revision': [500]})
1698
>>> parse_args('log -r500..600'.split())
1699
(['log'], {'revision': [500, 600]})
1700
>>> parse_args('log -vr500..600'.split())
1701
(['log'], {'verbose': True, 'revision': [500, 600]})
1702
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1703
(['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])
1708
# TODO: Maybe handle '--' to end options?
1713
# option names must not be unicode
1717
mutter(" got option %r" % a)
1719
optname, optarg = a[2:].split('=', 1)
1722
if optname not in OPTIONS:
1723
raise BzrError('unknown long option %r' % a)
1726
if shortopt in SHORT_OPTIONS:
1727
# Multi-character options must have a space to delimit
1729
optname = SHORT_OPTIONS[shortopt]
1731
# Single character short options, can be chained,
1732
# and have their value appended to their name
1734
if shortopt not in SHORT_OPTIONS:
1735
# We didn't find the multi-character name, and we
1736
# didn't find the single char name
1737
raise BzrError('unknown short option %r' % a)
1738
optname = SHORT_OPTIONS[shortopt]
1741
# There are extra things on this option
1742
# see if it is the value, or if it is another
1744
optargfn = OPTIONS[optname]
1745
if optargfn is None:
1746
# This option does not take an argument, so the
1747
# next entry is another short option, pack it back
1749
argv.insert(0, '-' + a[2:])
1751
# This option takes an argument, so pack it
1756
# XXX: Do we ever want to support this, e.g. for -r?
1757
raise BzrError('repeated option %r' % a)
1759
optargfn = OPTIONS[optname]
1763
raise BzrError('option %r needs an argument' % a)
1765
optarg = argv.pop(0)
1766
opts[optname] = optargfn(optarg)
1769
raise BzrError('option %r takes no argument' % optname)
1770
opts[optname] = True
811
1774
return args, opts
814
1779
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
