164
63
def _unsquish_command_name(cmd):
64
assert cmd.startswith("cmd_")
165
65
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)
68
def _parse_revision_str(revstr):
69
"""This handles a revision string -> revno.
71
This always returns a list. The list will have one element for
73
It supports integers directly, but everything else it
74
defers for passing to Branch.get_revision_info()
76
>>> _parse_revision_str('234')
78
>>> _parse_revision_str('234..567')
80
>>> _parse_revision_str('..')
82
>>> _parse_revision_str('..234')
84
>>> _parse_revision_str('234..')
86
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
88
>>> _parse_revision_str('234....789') # Error?
90
>>> _parse_revision_str('revid:test@other.com-234234')
91
['revid:test@other.com-234234']
92
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
93
['revid:test@other.com-234234', 'revid:test@other.com-234235']
94
>>> _parse_revision_str('revid:test@other.com-234234..23')
95
['revid:test@other.com-234234', 23]
96
>>> _parse_revision_str('date:2005-04-12')
98
>>> _parse_revision_str('date:2005-04-12 12:24:33')
99
['date:2005-04-12 12:24:33']
100
>>> _parse_revision_str('date:2005-04-12T12:24:33')
101
['date:2005-04-12T12:24:33']
102
>>> _parse_revision_str('date:2005-04-12,12:24:33')
103
['date:2005-04-12,12:24:33']
104
>>> _parse_revision_str('-5..23')
106
>>> _parse_revision_str('-5')
108
>>> _parse_revision_str('123a')
110
>>> _parse_revision_str('abc')
114
old_format_re = re.compile('\d*:\d*')
115
m = old_format_re.match(revstr)
117
warning('Colon separator for revision numbers is deprecated.'
120
for rev in revstr.split(':'):
122
revs.append(int(rev))
127
for x in revstr.split('..'):
138
def get_merge_type(typestring):
139
"""Attempt to find the merge class/factory associated with a string."""
140
from merge import merge_types
142
return merge_types[typestring][0]
144
templ = '%s%%7s: %%s' % (' '*12)
145
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
146
type_list = '\n'.join(lines)
147
msg = "No known merge type %s. Supported types are:\n%s" %\
148
(typestring, type_list)
149
raise BzrCommandError(msg)
152
def get_merge_type(typestring):
153
"""Attempt to find the merge class/factory associated with a string."""
154
from merge import merge_types
156
return merge_types[typestring][0]
158
templ = '%s%%7s: %%s' % (' '*12)
159
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
160
type_list = '\n'.join(lines)
161
msg = "No known merge type %s. Supported types are:\n%s" %\
162
(typestring, type_list)
163
raise BzrCommandError(msg)
167
def _get_cmd_dict(plugins_override=True):
169
for k, v in globals().iteritems():
170
if k.startswith("cmd_"):
171
d[_unsquish_command_name(k)] = v
172
# If we didn't load plugins, the plugin_cmds dict will be empty
174
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."""
176
d2 = plugin_cmds.copy()
182
def get_all_cmds(plugins_override=True):
183
"""Return canonical name and class for all registered commands."""
184
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
188
def get_cmd_class(cmd, plugins_override=True):
189
"""Return the canonical name and command class for a command.
191
cmd = str(cmd) # not unicode
193
# first look up this command under the specified name
194
cmds = _get_cmd_dict(plugins_override=plugins_override)
332
return plugin_cmds.get(cmd_name)()
196
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)()
200
# look for any command which claims this as an alias
201
for cmdname, cmdclass in cmds.iteritems():
202
if cmd in cmdclass.aliases:
203
return cmdname, cmdclass
205
cmdclass = ExternalCommand.find_command(cmd)
209
raise BzrCommandError("unknown command %r" % cmd)
342
212
class Command(object):
343
213
"""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
215
The docstring for an actual command should give a single-line
357
216
summary, then a complete description of the command. A grammar
358
217
description will be inserted.
361
Other accepted names for this command.
364
220
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().
224
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.
227
If true, this command isn't advertised.
403
232
takes_options = []
404
encoding_type = 'strict'
236
def __init__(self, options, arguments):
237
"""Construct and run the command.
409
"""Construct an instance of this command."""
239
Sets self.status to the return value of run()."""
240
assert isinstance(options, dict)
241
assert isinstance(arguments, dict)
242
cmdargs = options.copy()
243
cmdargs.update(arguments)
410
244
if self.__doc__ == Command.__doc__:
245
from warnings import warn
411
246
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)
247
self.status = self.run(**cmdargs)
248
if self.status is None:
711
"""Actually run the command.
253
"""Override this in sub-classes.
713
255
This is invoked with the options and arguments bound to
714
256
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):
258
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."""
264
class ExternalCommand(Command):
265
"""Class to wrap external commands.
267
We cheat a little here, when get_cmd_class() calls us we actually
268
give it back an object we construct that has the appropriate path,
269
help, options etc for the specified command.
271
When run_bzr() tries to instantiate that 'class' it gets caught by
272
the __call__ method, which we override to call the Command.__init__
273
method. That then calls our run method which is pretty straight
276
The only wrinkle is that we have to map bzr's dictionary of options
277
and arguments back into command line options and arguments for the
281
def find_command(cls, cmd):
283
bzrpath = os.environ.get('BZRPATH', '')
285
for dir in bzrpath.split(os.pathsep):
286
path = os.path.join(dir, cmd)
287
if os.path.isfile(path):
288
return ExternalCommand(path)
292
find_command = classmethod(find_command)
294
def __init__(self, path):
297
pipe = os.popen('%s --bzr-usage' % path, 'r')
298
self.takes_options = pipe.readline().split()
300
for opt in self.takes_options:
301
if not opt in OPTIONS:
302
raise BzrError("Unknown option '%s' returned by external command %s"
305
# TODO: Is there any way to check takes_args is valid here?
306
self.takes_args = pipe.readline().split()
308
if pipe.close() is not None:
309
raise BzrError("Failed funning '%s --bzr-usage'" % path)
311
pipe = os.popen('%s --bzr-help' % path, 'r')
312
self.__doc__ = pipe.read()
313
if pipe.close() is not None:
314
raise BzrError("Failed funning '%s --bzr-help'" % path)
316
def __call__(self, options, arguments):
317
Command.__init__(self, options, arguments)
320
def run(self, **kargs):
327
optname = name.replace('_','-')
329
if OPTIONS.has_key(optname):
331
opts.append('--%s' % optname)
332
if value is not None and value is not True:
333
opts.append(str(value))
335
# it's an arg, or arg list
336
if type(value) is not list:
342
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
346
class cmd_status(Command):
347
"""Display status summary.
349
This reports on versioned and unknown files, reporting them
350
grouped by state. Possible states are:
353
Versioned in the working copy but not in the previous revision.
356
Versioned in the previous revision but removed or deleted
360
Path of this file changed from the previous revision;
361
the text may also have changed. This includes files whose
362
parent directory was renamed.
365
Text has changed since the previous revision.
368
Nothing about this file has changed since the previous revision.
369
Only shown with --all.
372
Not versioned and not matching an ignore pattern.
374
To see ignored files use 'bzr ignored'. For details in the
375
changes to file texts, use 'bzr diff'.
377
If no arguments are specified, the status of the entire working
378
directory is shown. Otherwise, only the status of the specified
379
files or directories is reported. If a directory is given, status
380
is reported for everything inside that directory.
382
If a revision is specified, the changes since that revision are shown.
384
takes_args = ['file*']
385
takes_options = ['all', 'show-ids', 'revision']
386
aliases = ['st', 'stat']
388
def run(self, all=False, show_ids=False, file_list=None):
390
b = find_branch(file_list[0])
391
file_list = [b.relpath(x) for x in file_list]
392
# special case: only one path was given and it's the root
394
if file_list == ['']:
399
from bzrlib.status import show_status
400
show_status(b, show_unchanged=all, show_ids=show_ids,
401
specific_files=file_list)
404
class cmd_cat_revision(Command):
405
"""Write out metadata for a revision."""
408
takes_args = ['revision_id']
410
def run(self, revision_id):
411
from bzrlib.xml import pack_xml
412
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
415
class cmd_revno(Command):
416
"""Show current revision number.
418
This is equal to the number of revisions on this branch."""
420
print find_branch('.').revno()
422
class cmd_revision_info(Command):
423
"""Show revision number and revision id for a given revision identifier.
426
takes_args = ['revision_info*']
427
takes_options = ['revision']
428
def run(self, revision=None, revision_info_list=None):
429
from bzrlib.branch import find_branch
432
if revision is not None:
433
revs.extend(revision)
434
if revision_info_list is not None:
435
revs.extend(revision_info_list)
437
raise BzrCommandError('You must supply a revision identifier')
442
print '%4d %s' % b.get_revision_info(rev)
445
class cmd_add(Command):
446
"""Add specified files or directories.
448
In non-recursive mode, all the named items are added, regardless
449
of whether they were previously ignored. A warning is given if
450
any of the named files are already versioned.
452
In recursive mode (the default), files are treated the same way
453
but the behaviour for directories is different. Directories that
454
are already versioned do not give a warning. All directories,
455
whether already versioned or not, are searched for files or
456
subdirectories that are neither versioned or ignored, and these
457
are added. This search proceeds recursively into versioned
458
directories. If no names are given '.' is assumed.
460
Therefore simply saying 'bzr add' will version all files that
461
are currently unknown.
463
TODO: Perhaps adding a file whose directly is not versioned should
464
recursively add that parent, rather than giving an error?
466
takes_args = ['file*']
467
takes_options = ['verbose', 'no-recurse']
469
def run(self, file_list, verbose=False, no_recurse=False):
470
from bzrlib.add import smart_add
472
recurse = not no_recurse
473
for path, kind, file_id in smart_add(file_list, verbose, recurse):
478
class cmd_mkdir(Command):
479
"""Create a new versioned directory.
481
This is equivalent to creating the directory and then adding it.
483
takes_args = ['dir+']
485
def run(self, dir_list):
492
b.add([d], verbose=True)
495
class cmd_relpath(Command):
496
"""Show path of a file relative to root"""
497
takes_args = ['filename']
500
def run(self, filename):
501
print find_branch(filename).relpath(filename)
505
class cmd_inventory(Command):
506
"""Show inventory of the current working copy or a revision."""
507
takes_options = ['revision', 'show-ids']
509
def run(self, revision=None, show_ids=False):
512
inv = b.read_working_inventory()
514
if len(revision) > 1:
515
raise BzrCommandError('bzr inventory --revision takes'
516
' exactly one revision identifier')
517
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
519
for path, entry in inv.entries():
521
print '%-50s %s' % (path, entry.file_id)
526
class cmd_move(Command):
527
"""Move files to a different directory.
532
The destination must be a versioned directory in the same branch.
534
takes_args = ['source$', 'dest']
535
def run(self, source_list, dest):
538
# TODO: glob expansion on windows?
539
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
542
class cmd_rename(Command):
543
"""Change the name of an entry.
546
bzr rename frob.c frobber.c
547
bzr rename src/frob.c lib/frob.c
549
It is an error if the destination name exists.
551
See also the 'move' command, which moves files into a different
552
directory without changing their name.
554
TODO: Some way to rename multiple files without invoking bzr for each
556
takes_args = ['from_name', 'to_name']
558
def run(self, from_name, to_name):
560
b.rename_one(b.relpath(from_name), b.relpath(to_name))
564
class cmd_mv(Command):
565
"""Move or rename a file.
568
bzr mv OLDNAME NEWNAME
569
bzr mv SOURCE... DESTINATION
571
If the last argument is a versioned directory, all the other names
572
are moved into it. Otherwise, there must be exactly two arguments
573
and the file is changed to a new name, which must not already exist.
575
Files cannot be moved between branches.
577
takes_args = ['names*']
578
def run(self, names_list):
579
if len(names_list) < 2:
580
raise BzrCommandError("missing file argument")
581
b = find_branch(names_list[0])
583
rel_names = [b.relpath(x) for x in names_list]
585
if os.path.isdir(names_list[-1]):
586
# move into existing directory
587
b.move(rel_names[:-1], rel_names[-1])
589
if len(names_list) != 2:
590
raise BzrCommandError('to mv multiple files the destination '
591
'must be a versioned directory')
592
b.move(rel_names[0], rel_names[1])
597
class cmd_pull(Command):
598
"""Pull any changes from another branch into the current one.
600
If the location is omitted, the last-used location will be used.
601
Both the revision history and the working directory will be
604
This command only works on branches that have not diverged. Branches are
605
considered diverged if both branches have had commits without first
606
pulling from the other.
608
If branches have diverged, you can use 'bzr merge' to pull the text changes
609
from one into the other.
611
takes_args = ['location?']
613
def run(self, location=None):
614
from bzrlib.merge import merge
616
from shutil import rmtree
619
br_to = find_branch('.')
622
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
624
if e.errno != errno.ENOENT:
627
if stored_loc is None:
628
raise BzrCommandError("No pull location known or specified.")
630
print "Using last location: %s" % stored_loc
631
location = stored_loc
632
cache_root = tempfile.mkdtemp()
633
from bzrlib.branch import DivergedBranches
634
br_from = find_branch(location)
635
location = pull_loc(br_from)
636
old_revno = br_to.revno()
638
from branch import find_cached_branch, DivergedBranches
639
br_from = find_cached_branch(location, cache_root)
640
location = pull_loc(br_from)
641
old_revno = br_to.revno()
643
br_to.update_revisions(br_from)
644
except DivergedBranches:
645
raise BzrCommandError("These branches have diverged."
648
merge(('.', -1), ('.', old_revno), check_clean=False)
649
if location != stored_loc:
650
br_to.controlfile("x-pull", "wb").write(location + "\n")
656
class cmd_branch(Command):
657
"""Create a new copy of a branch.
659
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
660
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
662
To retrieve the branch as of a particular revision, supply the --revision
663
parameter, as in "branch foo/bar -r 5".
665
takes_args = ['from_location', 'to_location?']
666
takes_options = ['revision']
667
aliases = ['get', 'clone']
669
def run(self, from_location, to_location=None, revision=None):
671
from bzrlib.merge import merge
672
from bzrlib.branch import DivergedBranches, \
673
find_cached_branch, Branch
674
from shutil import rmtree
675
from meta_store import CachedStore
677
cache_root = tempfile.mkdtemp()
681
elif len(revision) > 1:
682
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
686
br_from = find_cached_branch(from_location, cache_root)
688
if e.errno == errno.ENOENT:
689
raise BzrCommandError('Source location "%s" does not'
690
' exist.' % to_location)
694
if to_location is None:
695
to_location = os.path.basename(from_location.rstrip("/\\"))
698
os.mkdir(to_location)
700
if e.errno == errno.EEXIST:
701
raise BzrCommandError('Target directory "%s" already'
702
' exists.' % to_location)
703
if e.errno == errno.ENOENT:
704
raise BzrCommandError('Parent of "%s" does not exist.' %
708
br_to = Branch(to_location, init=True)
710
br_to.set_root_id(br_from.get_root_id())
713
if revision[0] is None:
714
revno = br_from.revno()
716
revno, rev_id = br_from.get_revision_info(revision[0])
718
br_to.update_revisions(br_from, stop_revision=revno)
719
except bzrlib.errors.NoSuchRevision:
721
msg = "The branch %s has no revision %d." % (from_location,
723
raise BzrCommandError(msg)
725
merge((to_location, -1), (to_location, 0), this_dir=to_location,
726
check_clean=False, ignore_zero=True)
727
from_location = pull_loc(br_from)
728
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
733
def pull_loc(branch):
734
# TODO: Should perhaps just make attribute be 'base' in
735
# RemoteBranch and Branch?
736
if hasattr(branch, "baseurl"):
737
return branch.baseurl
743
class cmd_renames(Command):
744
"""Show list of renamed files.
746
TODO: Option to show renames between two historical versions.
748
TODO: Only show renames under dir, rather than in the whole branch.
750
takes_args = ['dir?']
752
def run(self, dir='.'):
754
old_inv = b.basis_tree().inventory
755
new_inv = b.read_working_inventory()
757
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
759
for old_name, new_name in renames:
760
print "%s => %s" % (old_name, new_name)
763
class cmd_info(Command):
764
"""Show statistical information about a branch."""
765
takes_args = ['branch?']
767
def run(self, branch=None):
770
b = find_branch(branch)
774
class cmd_remove(Command):
775
"""Make a file unversioned.
777
This makes bzr stop tracking changes to a versioned file. It does
778
not delete the working copy.
780
takes_args = ['file+']
781
takes_options = ['verbose']
783
def run(self, file_list, verbose=False):
784
b = find_branch(file_list[0])
785
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
788
class cmd_file_id(Command):
789
"""Print file_id of a particular file or directory.
791
The file_id is assigned when the file is first added and remains the
792
same through all revisions where the file exists, even when it is
796
takes_args = ['filename']
797
def run(self, filename):
798
b = find_branch(filename)
799
i = b.inventory.path2id(b.relpath(filename))
801
raise BzrError("%r is not a versioned file" % filename)
806
class cmd_file_path(Command):
807
"""Print path of file_ids to a file or directory.
809
This prints one line for each directory down to the target,
810
starting at the branch root."""
812
takes_args = ['filename']
813
def run(self, filename):
814
b = find_branch(filename)
816
fid = inv.path2id(b.relpath(filename))
818
raise BzrError("%r is not a versioned file" % filename)
819
for fip in inv.get_idpath(fid):
823
class cmd_revision_history(Command):
824
"""Display list of revision ids on this branch."""
827
for patchid in find_branch('.').revision_history():
831
class cmd_directories(Command):
832
"""Display list of versioned directories in this branch."""
834
for name, ie in find_branch('.').read_working_inventory().directories():
841
class cmd_init(Command):
842
"""Make a directory into a versioned branch.
844
Use this to create an empty branch, or before importing an
847
Recipe for importing a tree of files:
852
bzr commit -m 'imported project'
855
from bzrlib.branch import Branch
856
Branch('.', init=True)
859
class cmd_diff(Command):
860
"""Show differences in working tree.
862
If files are listed, only the changes in those files are listed.
863
Otherwise, all changes for the tree are listed.
865
TODO: Allow diff across branches.
867
TODO: Option to use external diff command; could be GNU diff, wdiff,
870
TODO: Python difflib is not exactly the same as unidiff; should
871
either fix it up or prefer to use an external diff.
873
TODO: If a directory is given, diff everything under that.
875
TODO: Selected-file diff is inefficient and doesn't show you
878
TODO: This probably handles non-Unix newlines poorly.
886
takes_args = ['file*']
887
takes_options = ['revision', 'diff-options']
888
aliases = ['di', 'dif']
890
def run(self, revision=None, file_list=None, diff_options=None):
891
from bzrlib.diff import show_diff
894
b = find_branch(file_list[0])
895
file_list = [b.relpath(f) for f in file_list]
896
if file_list == ['']:
897
# just pointing to top-of-tree
902
if revision is not None:
903
if len(revision) == 1:
904
show_diff(b, revision[0], specific_files=file_list,
905
external_diff_options=diff_options)
906
elif len(revision) == 2:
907
show_diff(b, revision[0], specific_files=file_list,
908
external_diff_options=diff_options,
909
revision2=revision[1])
911
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
913
show_diff(b, None, specific_files=file_list,
914
external_diff_options=diff_options)
919
class cmd_deleted(Command):
920
"""List files deleted in the working tree.
922
TODO: Show files deleted since a previous revision, or between two revisions.
924
def run(self, show_ids=False):
927
new = b.working_tree()
929
## TODO: Much more efficient way to do this: read in new
930
## directories with readdir, rather than stating each one. Same
931
## level of effort but possibly much less IO. (Or possibly not,
932
## if the directories are very large...)
934
for path, ie in old.inventory.iter_entries():
935
if not new.has_id(ie.file_id):
937
print '%-50s %s' % (path, ie.file_id)
942
class cmd_modified(Command):
943
"""List files modified in working tree."""
946
from bzrlib.delta import compare_trees
949
td = compare_trees(b.basis_tree(), b.working_tree())
951
for path, id, kind in td.modified:
956
class cmd_added(Command):
957
"""List files added in working tree."""
961
wt = b.working_tree()
962
basis_inv = b.basis_tree().inventory
965
if file_id in basis_inv:
967
path = inv.id2path(file_id)
968
if not os.access(b.abspath(path), os.F_OK):
974
class cmd_root(Command):
975
"""Show the tree root directory.
977
The root is the nearest enclosing directory with a .bzr control
979
takes_args = ['filename?']
980
def run(self, filename=None):
981
"""Print the branch root."""
982
b = find_branch(filename)
983
print getattr(b, 'base', None) or getattr(b, 'baseurl')
986
class cmd_log(Command):
987
"""Show log of this branch.
989
To request a range of logs, you can use the command -r begin:end
990
-r revision requests a specific revision, -r :end or -r begin: are
993
--message allows you to give a regular expression, which will be evaluated
994
so that only matching entries will be displayed.
996
TODO: Make --revision support uuid: and hash: [future tag:] notation.
1000
takes_args = ['filename?']
1001
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
1002
'long', 'message', 'short',]
1004
def run(self, filename=None, timezone='original',
1012
from bzrlib.branch import find_branch
1013
from bzrlib.log import log_formatter, show_log
1016
direction = (forward and 'forward') or 'reverse'
1019
b = find_branch(filename)
1020
fp = b.relpath(filename)
1022
file_id = b.read_working_inventory().path2id(fp)
1024
file_id = None # points to branch root
1026
b = find_branch('.')
1029
if revision is None:
1032
elif len(revision) == 1:
1033
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1034
elif len(revision) == 2:
1035
rev1 = b.get_revision_info(revision[0])[0]
1036
rev2 = b.get_revision_info(revision[1])[0]
1038
raise BzrCommandError('bzr log --revision takes one or two values.')
1045
mutter('encoding log as %r' % bzrlib.user_encoding)
1047
# use 'replace' so that we don't abort if trying to write out
1048
# in e.g. the default C locale.
1049
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1054
log_format = 'short'
1055
lf = log_formatter(log_format,
1058
show_timezone=timezone)
1064
direction=direction,
1065
start_revision=rev1,
1071
class cmd_touching_revisions(Command):
1072
"""Return revision-ids which affected a particular file.
1074
A more user-friendly interface is "bzr log FILE"."""
1076
takes_args = ["filename"]
1077
def run(self, filename):
1078
b = find_branch(filename)
1079
inv = b.read_working_inventory()
1080
file_id = inv.path2id(b.relpath(filename))
1081
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1082
print "%6d %s" % (revno, what)
1085
class cmd_ls(Command):
1086
"""List files in a tree.
1088
TODO: Take a revision or remote path and list that tree instead.
1091
def run(self, revision=None, verbose=False):
1092
b = find_branch('.')
1093
if revision == None:
1094
tree = b.working_tree()
1096
tree = b.revision_tree(b.lookup_revision(revision))
1098
for fp, fc, kind, fid in tree.list_files():
1100
if kind == 'directory':
1102
elif kind == 'file':
1107
print '%-8s %s%s' % (fc, fp, kindch)
1113
class cmd_unknowns(Command):
1114
"""List unknown files."""
1116
from bzrlib.osutils import quotefn
1117
for f in find_branch('.').unknowns():
1122
class cmd_ignore(Command):
1123
"""Ignore a command or pattern.
1125
To remove patterns from the ignore list, edit the .bzrignore file.
1127
If the pattern contains a slash, it is compared to the whole path
1128
from the branch root. Otherwise, it is comapred to only the last
1129
component of the path.
1131
Ignore patterns are case-insensitive on case-insensitive systems.
1133
Note: wildcards must be quoted from the shell on Unix.
1136
bzr ignore ./Makefile
1137
bzr ignore '*.class'
1139
takes_args = ['name_pattern']
1141
def run(self, name_pattern):
1142
from bzrlib.atomicfile import AtomicFile
1145
b = find_branch('.')
1146
ifn = b.abspath('.bzrignore')
1148
if os.path.exists(ifn):
1151
igns = f.read().decode('utf-8')
1157
# TODO: If the file already uses crlf-style termination, maybe
1158
# we should use that for the newly added lines?
1160
if igns and igns[-1] != '\n':
1162
igns += name_pattern + '\n'
1165
f = AtomicFile(ifn, 'wt')
1166
f.write(igns.encode('utf-8'))
1171
inv = b.working_tree().inventory
1172
if inv.path2id('.bzrignore'):
1173
mutter('.bzrignore is already versioned')
1175
mutter('need to make new .bzrignore file versioned')
1176
b.add(['.bzrignore'])
1180
class cmd_ignored(Command):
1181
"""List ignored files and the patterns that matched them.
1183
See also: bzr ignore"""
1185
tree = find_branch('.').working_tree()
1186
for path, file_class, kind, file_id in tree.list_files():
1187
if file_class != 'I':
1189
## XXX: Slightly inefficient since this was already calculated
1190
pat = tree.is_ignored(path)
1191
print '%-50s %s' % (path, pat)
1194
class cmd_lookup_revision(Command):
1195
"""Lookup the revision-id from a revision-number
1198
bzr lookup-revision 33
1201
takes_args = ['revno']
1203
def run(self, revno):
1207
raise BzrCommandError("not a valid revision-number: %r" % revno)
1209
print find_branch('.').lookup_revision(revno)
1212
class cmd_export(Command):
1213
"""Export past revision to destination directory.
1215
If no revision is specified this exports the last committed revision.
1217
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1218
given, try to find the format with the extension. If no extension
1219
is found exports to a directory (equivalent to --format=dir).
1221
Root may be the top directory for tar, tgz and tbz2 formats. If none
1222
is given, the top directory will be the root name of the file."""
1223
# TODO: list known exporters
1224
takes_args = ['dest']
1225
takes_options = ['revision', 'format', 'root']
1226
def run(self, dest, revision=None, format=None, root=None):
1228
b = find_branch('.')
1229
if revision is None:
1230
rev_id = b.last_patch()
1232
if len(revision) != 1:
1233
raise BzrError('bzr export --revision takes exactly 1 argument')
1234
revno, rev_id = b.get_revision_info(revision[0])
1235
t = b.revision_tree(rev_id)
1236
root, ext = os.path.splitext(dest)
1238
if ext in (".tar",):
1240
elif ext in (".gz", ".tgz"):
1242
elif ext in (".bz2", ".tbz2"):
1246
t.export(dest, format, root)
1249
class cmd_cat(Command):
1250
"""Write a file's text from a previous revision."""
1252
takes_options = ['revision']
1253
takes_args = ['filename']
1255
def run(self, filename, revision=None):
1256
if revision == None:
1257
raise BzrCommandError("bzr cat requires a revision number")
1258
elif len(revision) != 1:
1259
raise BzrCommandError("bzr cat --revision takes exactly one number")
1260
b = find_branch('.')
1261
b.print_file(b.relpath(filename), revision[0])
1264
class cmd_local_time_offset(Command):
1265
"""Show the offset in seconds from GMT to local time."""
1268
print bzrlib.osutils.local_time_offset()
1272
class cmd_commit(Command):
1273
"""Commit changes into a new revision.
1275
If no arguments are given, the entire tree is committed.
1277
If selected files are specified, only changes to those files are
1278
committed. If a directory is specified then the directory and everything
1279
within it is committed.
1281
A selected-file commit may fail in some cases where the committed
1282
tree would be invalid, such as trying to commit a file in a
1283
newly-added directory that is not itself committed.
1285
TODO: Run hooks on tree to-be-committed, and after commit.
1287
TODO: Strict commit that fails if there are unknown or deleted files.
1289
takes_args = ['selected*']
1290
takes_options = ['message', 'file', 'verbose', 'unchanged']
1291
aliases = ['ci', 'checkin']
1293
# TODO: Give better message for -s, --summary, used by tla people
1295
def run(self, message=None, file=None, verbose=True, selected_list=None,
1297
from bzrlib.errors import PointlessCommit
1298
from bzrlib.osutils import get_text_message
1300
## Warning: shadows builtin file()
1301
if not message and not file:
1302
# FIXME: Ugly; change status code to send to a provided function?
1306
catcher = cStringIO.StringIO()
1307
sys.stdout = catcher
1308
cmd_status({"file_list":selected_list}, {})
1309
info = catcher.getvalue()
1311
message = get_text_message(info)
1314
raise BzrCommandError("please specify a commit message",
1315
["use either --message or --file"])
1316
elif message and file:
1317
raise BzrCommandError("please specify either --message or --file")
1321
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1323
b = find_branch('.')
1325
selected_list = [b.relpath(s) for s in selected_list]
1328
b.commit(message, verbose=verbose,
1329
specific_files=selected_list,
1330
allow_pointless=unchanged)
1331
except PointlessCommit:
1332
# FIXME: This should really happen before the file is read in;
1333
# perhaps prepare the commit; get the message; then actually commit
1334
raise BzrCommandError("no changes to commit",
1335
["use --unchanged to commit anyhow"])
1338
class cmd_check(Command):
1339
"""Validate consistency of branch history.
1341
This command checks various invariants about the branch storage to
1342
detect data corruption or bzr bugs.
1344
If given the --update flag, it will update some optional fields
1345
to help ensure data consistency.
1347
takes_args = ['dir?']
1349
def run(self, dir='.'):
1350
from bzrlib.check import check
1352
check(find_branch(dir))
1355
class cmd_scan_cache(Command):
1358
from bzrlib.hashcache import HashCache
1365
print '%6d stats' % c.stat_count
1366
print '%6d in hashcache' % len(c._cache)
1367
print '%6d files removed from cache' % c.removed_count
1368
print '%6d hashes updated' % c.update_count
1369
print '%6d files changed too recently to cache' % c.danger_count
1376
class cmd_upgrade(Command):
1377
"""Upgrade branch storage to current format.
1379
The check command or bzr developers may sometimes advise you to run
1382
takes_args = ['dir?']
1384
def run(self, dir='.'):
1385
from bzrlib.upgrade import upgrade
1386
upgrade(find_branch(dir))
1390
class cmd_whoami(Command):
1391
"""Show bzr user id."""
1392
takes_options = ['email']
1394
def run(self, email=False):
1396
b = bzrlib.branch.find_branch('.')
1401
print bzrlib.osutils.user_email(b)
1403
print bzrlib.osutils.username(b)
1406
class cmd_selftest(Command):
1407
"""Run internal test suite"""
1409
takes_options = ['verbose']
1410
def run(self, verbose=False):
1412
from bzrlib.selftest import selftest
1414
# we don't want progress meters from the tests to go to the
1415
# real output; and we don't want log messages cluttering up
1418
save_ui = bzrlib.ui.ui_factory
1419
bzrlib.trace.info('running tests...')
1421
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1422
result = selftest(verbose=verbose)
1424
bzrlib.trace.info('tests passed')
1426
bzrlib.trace.info('tests failed')
1427
return int(not result)
1429
bzrlib.ui.ui_factory = save_ui
1432
class cmd_version(Command):
1433
"""Show version of bzr."""
1438
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1439
# is bzrlib itself in a branch?
1440
bzrrev = bzrlib.get_bzr_revision()
1442
print " (bzr checkout, revision %d {%s})" % bzrrev
1443
print bzrlib.__copyright__
1444
print "http://bazaar-ng.org/"
1446
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1447
print "you may use, modify and redistribute it under the terms of the GNU"
1448
print "General Public License version 2 or later."
1451
class cmd_rocks(Command):
1452
"""Statement of optimism."""
1455
print "it sure does!"
1457
def parse_spec(spec):
1459
>>> parse_spec(None)
1461
>>> parse_spec("./")
1463
>>> parse_spec("../@")
1465
>>> parse_spec("../f/@35")
1467
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1468
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1473
parsed = spec.split('/@')
1474
assert len(parsed) == 2
1479
parsed[1] = int(parsed[1])
1481
pass # We can allow stuff like ./@revid:blahblahblah
1483
assert parsed[1] >=0
1485
parsed = [spec, None]
1490
class cmd_find_merge_base(Command):
1491
"""Find and print a base revision for merging two branches.
1493
TODO: Options to specify revisions on either side, as if
1494
merging only part of the history.
1496
takes_args = ['branch', 'other']
1499
def run(self, branch, other):
1500
branch1 = find_branch(branch)
1501
branch2 = find_branch(other)
1503
base_revno, base_revid = branch1.common_ancestor(branch2)
1505
if base_revno is None:
1506
raise bzrlib.errors.UnrelatedBranches()
1508
print 'merge base is revision %s' % base_revid
1509
print ' r%-6d in %s' % (base_revno, branch)
1511
other_revno = branch2.revision_id_to_revno(base_revid)
1513
print ' r%-6d in %s' % (other_revno, other)
1517
class cmd_merge(Command):
1518
"""Perform a three-way merge.
1520
The branch is the branch you will merge from. By default, it will merge
1521
the latest revision. If you specify a revision, that revision will be
1522
merged. If you specify two revisions, the first will be used as a BASE,
1523
and the second one as OTHER. Revision numbers are always relative to the
1528
To merge the latest revision from bzr.dev
1529
bzr merge ../bzr.dev
1531
To merge changes up to and including revision 82 from bzr.dev
1532
bzr merge -r 82 ../bzr.dev
1534
To merge the changes introduced by 82, without previous changes:
1535
bzr merge -r 81..82 ../bzr.dev
1537
merge refuses to run if there are any uncommitted changes, unless
1540
takes_args = ['branch?']
1541
takes_options = ['revision', 'force', 'merge-type']
1543
def run(self, branch='.', revision=None, force=False,
1545
from bzrlib.merge import merge
1546
from bzrlib.merge_core import ApplyMerge3
1547
if merge_type is None:
1548
merge_type = ApplyMerge3
1550
if revision is None or len(revision) < 1:
1552
other = (branch, -1)
1554
if len(revision) == 1:
1555
other = (branch, revision[0])
1558
assert len(revision) == 2
1559
if None in revision:
1560
raise BzrCommandError(
1561
"Merge doesn't permit that revision specifier.")
1562
base = (branch, revision[0])
1563
other = (branch, revision[1])
1565
merge(other, base, check_clean=(not force), merge_type=merge_type)
1568
class cmd_revert(Command):
1569
"""Reverse all changes since the last commit.
1571
Only versioned files are affected. Specify filenames to revert only
1572
those files. By default, any files that are changed will be backed up
1573
first. Backup files have a '~' appended to their name.
1575
takes_options = ['revision', 'no-backup']
1576
takes_args = ['file*']
1577
aliases = ['merge-revert']
1579
def run(self, revision=None, no_backup=False, file_list=None):
1580
from bzrlib.merge import merge
1581
if file_list is not None:
1582
if len(file_list) == 0:
1583
raise BzrCommandError("No files specified")
1584
if revision is None:
1586
elif len(revision) != 1:
1587
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1588
merge(('.', revision[0]), parse_spec('.'),
1591
backup_files=not no_backup,
1592
file_list=file_list)
1595
class cmd_assert_fail(Command):
1596
"""Test reporting of assertion failures"""
1599
assert False, "always fails"
1602
class cmd_help(Command):
1603
"""Show help on a command or other topic.
1605
For a list of all available commands, say 'bzr help commands'."""
1606
takes_options = ['long']
1607
takes_args = ['topic?']
1610
def run(self, topic=None, long=False):
1612
if topic is None and long:
1617
class cmd_shell_complete(Command):
1618
"""Show appropriate completions for context.
1620
For a list of all available commands, say 'bzr shell-complete'."""
1621
takes_args = ['context?']
1625
def run(self, context=None):
1626
import shellcomplete
1627
shellcomplete.shellcomplete(context)
1630
class cmd_missing(Command):
1631
"""What is missing in this branch relative to other branch.
1633
takes_args = ['remote?']
1634
aliases = ['mis', 'miss']
1635
# We don't have to add quiet to the list, because
1636
# unknown options are parsed as booleans
1637
takes_options = ['verbose', 'quiet']
1639
def run(self, remote=None, verbose=False, quiet=False):
1640
from bzrlib.branch import find_branch, DivergedBranches
1641
from bzrlib.errors import BzrCommandError
1642
from bzrlib.missing import get_parent, show_missing
1644
if verbose and quiet:
1645
raise BzrCommandError('Cannot pass both quiet and verbose')
1647
b = find_branch('.')
1648
parent = get_parent(b)
1651
raise BzrCommandError("No missing location known or specified.")
1654
print "Using last location: %s" % parent
1656
elif parent is None:
1657
# We only update x-pull if it did not exist, missing should not change the parent
1658
b.controlfile('x-pull', 'wb').write(remote + '\n')
1659
br_remote = find_branch(remote)
1661
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1665
class cmd_plugins(Command):
1669
import bzrlib.plugin
736
1670
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):
1671
from pprint import pprint
1672
for plugin in bzrlib.plugin.all_plugins:
1673
print plugin.__path__[0]
1676
print '\t', d.split('\n')[0]
1678
#pprint(bzrlib.plugin.all_plugins)
1682
# list of all available options; the rhs can be either None for an
1683
# option that takes no argument, or a constructor function that checks
1687
'diff-options': str,
1696
'revision': _parse_revision_str,
1708
'merge-type': get_merge_type,
1721
def parse_args(argv):
794
1722
"""Parse command line.
796
1724
Arguments and options are parsed at this level before being passed
797
1725
down to specific command handlers. This routine knows, from a
798
1726
lookup table, something about the available options, what optargs
799
1727
they take, and which commands will accept them.
1729
>>> parse_args('--help'.split())
1730
([], {'help': True})
1731
>>> parse_args('--version'.split())
1732
([], {'version': True})
1733
>>> parse_args('status --all'.split())
1734
(['status'], {'all': True})
1735
>>> parse_args('commit --message=biter'.split())
1736
(['commit'], {'message': u'biter'})
1737
>>> parse_args('log -r 500'.split())
1738
(['log'], {'revision': [500]})
1739
>>> parse_args('log -r500..600'.split())
1740
(['log'], {'revision': [500, 600]})
1741
>>> parse_args('log -vr500..600'.split())
1742
(['log'], {'verbose': True, 'revision': [500, 600]})
1743
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1744
(['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])
1749
# TODO: Maybe handle '--' to end options?
1754
# option names must not be unicode
1758
mutter(" got option %r" % a)
1760
optname, optarg = a[2:].split('=', 1)
1763
if optname not in OPTIONS:
1764
raise BzrError('unknown long option %r' % a)
1767
if shortopt in SHORT_OPTIONS:
1768
# Multi-character options must have a space to delimit
1770
optname = SHORT_OPTIONS[shortopt]
1772
# Single character short options, can be chained,
1773
# and have their value appended to their name
1775
if shortopt not in SHORT_OPTIONS:
1776
# We didn't find the multi-character name, and we
1777
# didn't find the single char name
1778
raise BzrError('unknown short option %r' % a)
1779
optname = SHORT_OPTIONS[shortopt]
1782
# There are extra things on this option
1783
# see if it is the value, or if it is another
1785
optargfn = OPTIONS[optname]
1786
if optargfn is None:
1787
# This option does not take an argument, so the
1788
# next entry is another short option, pack it back
1790
argv.insert(0, '-' + a[2:])
1792
# This option takes an argument, so pack it
1797
# XXX: Do we ever want to support this, e.g. for -r?
1798
raise BzrError('repeated option %r' % a)
1800
optargfn = OPTIONS[optname]
1804
raise BzrError('option %r needs an argument' % a)
1806
optarg = argv.pop(0)
1807
opts[optname] = optargfn(optarg)
1810
raise BzrError('option %r takes no argument' % optname)
1811
opts[optname] = True
811
1815
return args, opts
814
1820
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
