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):
496
class cmd_relpath(Command):
497
"""Show path of a file relative to root"""
498
takes_args = ['filename']
501
def run(self, filename):
502
print find_branch(filename).relpath(filename)
506
class cmd_inventory(Command):
507
"""Show inventory of the current working copy or a revision."""
508
takes_options = ['revision', 'show-ids']
510
def run(self, revision=None, show_ids=False):
513
inv = b.read_working_inventory()
515
if len(revision) > 1:
516
raise BzrCommandError('bzr inventory --revision takes'
517
' exactly one revision identifier')
518
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
520
for path, entry in inv.entries():
522
print '%-50s %s' % (path, entry.file_id)
527
class cmd_move(Command):
528
"""Move files to a different directory.
533
The destination must be a versioned directory in the same branch.
535
takes_args = ['source$', 'dest']
536
def run(self, source_list, dest):
539
# TODO: glob expansion on windows?
540
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
543
class cmd_rename(Command):
544
"""Change the name of an entry.
547
bzr rename frob.c frobber.c
548
bzr rename src/frob.c lib/frob.c
550
It is an error if the destination name exists.
552
See also the 'move' command, which moves files into a different
553
directory without changing their name.
555
TODO: Some way to rename multiple files without invoking bzr for each
557
takes_args = ['from_name', 'to_name']
559
def run(self, from_name, to_name):
561
b.rename_one(b.relpath(from_name), b.relpath(to_name))
565
class cmd_mv(Command):
566
"""Move or rename a file.
569
bzr mv OLDNAME NEWNAME
570
bzr mv SOURCE... DESTINATION
572
If the last argument is a versioned directory, all the other names
573
are moved into it. Otherwise, there must be exactly two arguments
574
and the file is changed to a new name, which must not already exist.
576
Files cannot be moved between branches.
578
takes_args = ['names*']
579
def run(self, names_list):
580
if len(names_list) < 2:
581
raise BzrCommandError("missing file argument")
582
b = find_branch(names_list[0])
584
rel_names = [b.relpath(x) for x in names_list]
586
if os.path.isdir(names_list[-1]):
587
# move into existing directory
588
b.move(rel_names[:-1], rel_names[-1])
590
if len(names_list) != 2:
591
raise BzrCommandError('to mv multiple files the destination '
592
'must be a versioned directory')
593
b.move(rel_names[0], rel_names[1])
598
class cmd_pull(Command):
599
"""Pull any changes from another branch into the current one.
601
If the location is omitted, the last-used location will be used.
602
Both the revision history and the working directory will be
605
This command only works on branches that have not diverged. Branches are
606
considered diverged if both branches have had commits without first
607
pulling from the other.
609
If branches have diverged, you can use 'bzr merge' to pull the text changes
610
from one into the other.
612
takes_args = ['location?']
614
def run(self, location=None):
615
from bzrlib.merge import merge
617
from shutil import rmtree
620
br_to = find_branch('.')
623
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
625
if e.errno != errno.ENOENT:
628
if stored_loc is None:
629
raise BzrCommandError("No pull location known or specified.")
631
print "Using last location: %s" % stored_loc
632
location = stored_loc
633
cache_root = tempfile.mkdtemp()
634
from bzrlib.branch import DivergedBranches
635
br_from = find_branch(location)
636
location = pull_loc(br_from)
637
old_revno = br_to.revno()
639
from branch import find_cached_branch, DivergedBranches
640
br_from = find_cached_branch(location, cache_root)
641
location = pull_loc(br_from)
642
old_revno = br_to.revno()
644
br_to.update_revisions(br_from)
645
except DivergedBranches:
646
raise BzrCommandError("These branches have diverged."
649
merge(('.', -1), ('.', old_revno), check_clean=False)
650
if location != stored_loc:
651
br_to.controlfile("x-pull", "wb").write(location + "\n")
657
class cmd_branch(Command):
658
"""Create a new copy of a branch.
660
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
661
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
663
To retrieve the branch as of a particular revision, supply the --revision
664
parameter, as in "branch foo/bar -r 5".
666
takes_args = ['from_location', 'to_location?']
667
takes_options = ['revision']
668
aliases = ['get', 'clone']
670
def run(self, from_location, to_location=None, revision=None):
672
from bzrlib.merge import merge
673
from bzrlib.branch import DivergedBranches, \
674
find_cached_branch, Branch
675
from shutil import rmtree
676
from meta_store import CachedStore
678
cache_root = tempfile.mkdtemp()
682
elif len(revision) > 1:
683
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
687
br_from = find_cached_branch(from_location, cache_root)
689
if e.errno == errno.ENOENT:
690
raise BzrCommandError('Source location "%s" does not'
691
' exist.' % to_location)
695
if to_location is None:
696
to_location = os.path.basename(from_location.rstrip("/\\"))
699
os.mkdir(to_location)
701
if e.errno == errno.EEXIST:
702
raise BzrCommandError('Target directory "%s" already'
703
' exists.' % to_location)
704
if e.errno == errno.ENOENT:
705
raise BzrCommandError('Parent of "%s" does not exist.' %
709
br_to = Branch(to_location, init=True)
711
br_to.set_root_id(br_from.get_root_id())
714
if revision[0] is None:
715
revno = br_from.revno()
717
revno, rev_id = br_from.get_revision_info(revision[0])
719
br_to.update_revisions(br_from, stop_revision=revno)
720
except bzrlib.errors.NoSuchRevision:
722
msg = "The branch %s has no revision %d." % (from_location,
724
raise BzrCommandError(msg)
726
merge((to_location, -1), (to_location, 0), this_dir=to_location,
727
check_clean=False, ignore_zero=True)
728
from_location = pull_loc(br_from)
729
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
734
def pull_loc(branch):
735
# TODO: Should perhaps just make attribute be 'base' in
736
# RemoteBranch and Branch?
737
if hasattr(branch, "baseurl"):
738
return branch.baseurl
744
class cmd_renames(Command):
745
"""Show list of renamed files.
747
TODO: Option to show renames between two historical versions.
749
TODO: Only show renames under dir, rather than in the whole branch.
751
takes_args = ['dir?']
753
def run(self, dir='.'):
755
old_inv = b.basis_tree().inventory
756
new_inv = b.read_working_inventory()
758
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
760
for old_name, new_name in renames:
761
print "%s => %s" % (old_name, new_name)
764
class cmd_info(Command):
765
"""Show statistical information about a branch."""
766
takes_args = ['branch?']
768
def run(self, branch=None):
771
b = find_branch(branch)
775
class cmd_remove(Command):
776
"""Make a file unversioned.
778
This makes bzr stop tracking changes to a versioned file. It does
779
not delete the working copy.
781
takes_args = ['file+']
782
takes_options = ['verbose']
784
def run(self, file_list, verbose=False):
785
b = find_branch(file_list[0])
786
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
789
class cmd_file_id(Command):
790
"""Print file_id of a particular file or directory.
792
The file_id is assigned when the file is first added and remains the
793
same through all revisions where the file exists, even when it is
797
takes_args = ['filename']
798
def run(self, filename):
799
b = find_branch(filename)
800
i = b.inventory.path2id(b.relpath(filename))
802
raise BzrError("%r is not a versioned file" % filename)
807
class cmd_file_path(Command):
808
"""Print path of file_ids to a file or directory.
810
This prints one line for each directory down to the target,
811
starting at the branch root."""
813
takes_args = ['filename']
814
def run(self, filename):
815
b = find_branch(filename)
817
fid = inv.path2id(b.relpath(filename))
819
raise BzrError("%r is not a versioned file" % filename)
820
for fip in inv.get_idpath(fid):
824
class cmd_revision_history(Command):
825
"""Display list of revision ids on this branch."""
828
for patchid in find_branch('.').revision_history():
832
class cmd_directories(Command):
833
"""Display list of versioned directories in this branch."""
835
for name, ie in find_branch('.').read_working_inventory().directories():
842
class cmd_init(Command):
843
"""Make a directory into a versioned branch.
845
Use this to create an empty branch, or before importing an
848
Recipe for importing a tree of files:
853
bzr commit -m 'imported project'
856
from bzrlib.branch import Branch
857
Branch('.', init=True)
860
class cmd_diff(Command):
861
"""Show differences in working tree.
863
If files are listed, only the changes in those files are listed.
864
Otherwise, all changes for the tree are listed.
866
TODO: Allow diff across branches.
868
TODO: Option to use external diff command; could be GNU diff, wdiff,
871
TODO: Python difflib is not exactly the same as unidiff; should
872
either fix it up or prefer to use an external diff.
874
TODO: If a directory is given, diff everything under that.
876
TODO: Selected-file diff is inefficient and doesn't show you
879
TODO: This probably handles non-Unix newlines poorly.
887
takes_args = ['file*']
888
takes_options = ['revision', 'diff-options']
889
aliases = ['di', 'dif']
891
def run(self, revision=None, file_list=None, diff_options=None):
892
from bzrlib.diff import show_diff
895
b = find_branch(file_list[0])
896
file_list = [b.relpath(f) for f in file_list]
897
if file_list == ['']:
898
# just pointing to top-of-tree
903
if revision is not None:
904
if len(revision) == 1:
905
show_diff(b, revision[0], specific_files=file_list,
906
external_diff_options=diff_options)
907
elif len(revision) == 2:
908
show_diff(b, revision[0], specific_files=file_list,
909
external_diff_options=diff_options,
910
revision2=revision[1])
912
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
914
show_diff(b, None, specific_files=file_list,
915
external_diff_options=diff_options)
920
class cmd_deleted(Command):
921
"""List files deleted in the working tree.
923
TODO: Show files deleted since a previous revision, or between two revisions.
925
def run(self, show_ids=False):
928
new = b.working_tree()
930
## TODO: Much more efficient way to do this: read in new
931
## directories with readdir, rather than stating each one. Same
932
## level of effort but possibly much less IO. (Or possibly not,
933
## if the directories are very large...)
935
for path, ie in old.inventory.iter_entries():
936
if not new.has_id(ie.file_id):
938
print '%-50s %s' % (path, ie.file_id)
943
class cmd_modified(Command):
944
"""List files modified in working tree."""
947
from bzrlib.delta import compare_trees
950
td = compare_trees(b.basis_tree(), b.working_tree())
952
for path, id, kind in td.modified:
957
class cmd_added(Command):
958
"""List files added in working tree."""
962
wt = b.working_tree()
963
basis_inv = b.basis_tree().inventory
966
if file_id in basis_inv:
968
path = inv.id2path(file_id)
969
if not os.access(b.abspath(path), os.F_OK):
975
class cmd_root(Command):
976
"""Show the tree root directory.
978
The root is the nearest enclosing directory with a .bzr control
980
takes_args = ['filename?']
981
def run(self, filename=None):
982
"""Print the branch root."""
983
b = find_branch(filename)
984
print getattr(b, 'base', None) or getattr(b, 'baseurl')
987
class cmd_log(Command):
988
"""Show log of this branch.
990
To request a range of logs, you can use the command -r begin:end
991
-r revision requests a specific revision, -r :end or -r begin: are
994
--message allows you to give a regular expression, which will be evaluated
995
so that only matching entries will be displayed.
997
TODO: Make --revision support uuid: and hash: [future tag:] notation.
1001
takes_args = ['filename?']
1002
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
1003
'long', 'message', 'short',]
1005
def run(self, filename=None, timezone='original',
1013
from bzrlib.branch import find_branch
1014
from bzrlib.log import log_formatter, show_log
1017
direction = (forward and 'forward') or 'reverse'
1020
b = find_branch(filename)
1021
fp = b.relpath(filename)
1023
file_id = b.read_working_inventory().path2id(fp)
1025
file_id = None # points to branch root
1027
b = find_branch('.')
1030
if revision is None:
1033
elif len(revision) == 1:
1034
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1035
elif len(revision) == 2:
1036
rev1 = b.get_revision_info(revision[0])[0]
1037
rev2 = b.get_revision_info(revision[1])[0]
1039
raise BzrCommandError('bzr log --revision takes one or two values.')
1046
mutter('encoding log as %r' % bzrlib.user_encoding)
1048
# use 'replace' so that we don't abort if trying to write out
1049
# in e.g. the default C locale.
1050
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1055
log_format = 'short'
1056
lf = log_formatter(log_format,
1059
show_timezone=timezone)
1065
direction=direction,
1066
start_revision=rev1,
1072
class cmd_touching_revisions(Command):
1073
"""Return revision-ids which affected a particular file.
1075
A more user-friendly interface is "bzr log FILE"."""
1077
takes_args = ["filename"]
1078
def run(self, filename):
1079
b = find_branch(filename)
1080
inv = b.read_working_inventory()
1081
file_id = inv.path2id(b.relpath(filename))
1082
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1083
print "%6d %s" % (revno, what)
1086
class cmd_ls(Command):
1087
"""List files in a tree.
1089
TODO: Take a revision or remote path and list that tree instead.
1092
def run(self, revision=None, verbose=False):
1093
b = find_branch('.')
1094
if revision == None:
1095
tree = b.working_tree()
1097
tree = b.revision_tree(b.lookup_revision(revision))
1099
for fp, fc, kind, fid in tree.list_files():
1101
if kind == 'directory':
1103
elif kind == 'file':
1108
print '%-8s %s%s' % (fc, fp, kindch)
1114
class cmd_unknowns(Command):
1115
"""List unknown files."""
1117
from bzrlib.osutils import quotefn
1118
for f in find_branch('.').unknowns():
1123
class cmd_ignore(Command):
1124
"""Ignore a command or pattern.
1126
To remove patterns from the ignore list, edit the .bzrignore file.
1128
If the pattern contains a slash, it is compared to the whole path
1129
from the branch root. Otherwise, it is comapred to only the last
1130
component of the path.
1132
Ignore patterns are case-insensitive on case-insensitive systems.
1134
Note: wildcards must be quoted from the shell on Unix.
1137
bzr ignore ./Makefile
1138
bzr ignore '*.class'
1140
takes_args = ['name_pattern']
1142
def run(self, name_pattern):
1143
from bzrlib.atomicfile import AtomicFile
1146
b = find_branch('.')
1147
ifn = b.abspath('.bzrignore')
1149
if os.path.exists(ifn):
1152
igns = f.read().decode('utf-8')
1158
# TODO: If the file already uses crlf-style termination, maybe
1159
# we should use that for the newly added lines?
1161
if igns and igns[-1] != '\n':
1163
igns += name_pattern + '\n'
1166
f = AtomicFile(ifn, 'wt')
1167
f.write(igns.encode('utf-8'))
1172
inv = b.working_tree().inventory
1173
if inv.path2id('.bzrignore'):
1174
mutter('.bzrignore is already versioned')
1176
mutter('need to make new .bzrignore file versioned')
1177
b.add(['.bzrignore'])
1181
class cmd_ignored(Command):
1182
"""List ignored files and the patterns that matched them.
1184
See also: bzr ignore"""
1186
tree = find_branch('.').working_tree()
1187
for path, file_class, kind, file_id in tree.list_files():
1188
if file_class != 'I':
1190
## XXX: Slightly inefficient since this was already calculated
1191
pat = tree.is_ignored(path)
1192
print '%-50s %s' % (path, pat)
1195
class cmd_lookup_revision(Command):
1196
"""Lookup the revision-id from a revision-number
1199
bzr lookup-revision 33
1202
takes_args = ['revno']
1204
def run(self, revno):
1208
raise BzrCommandError("not a valid revision-number: %r" % revno)
1210
print find_branch('.').lookup_revision(revno)
1213
class cmd_export(Command):
1214
"""Export past revision to destination directory.
1216
If no revision is specified this exports the last committed revision.
1218
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1219
given, try to find the format with the extension. If no extension
1220
is found exports to a directory (equivalent to --format=dir).
1222
Root may be the top directory for tar, tgz and tbz2 formats. If none
1223
is given, the top directory will be the root name of the file."""
1224
# TODO: list known exporters
1225
takes_args = ['dest']
1226
takes_options = ['revision', 'format', 'root']
1227
def run(self, dest, revision=None, format=None, root=None):
1229
b = find_branch('.')
1230
if revision is None:
1231
rev_id = b.last_patch()
1233
if len(revision) != 1:
1234
raise BzrError('bzr export --revision takes exactly 1 argument')
1235
revno, rev_id = b.get_revision_info(revision[0])
1236
t = b.revision_tree(rev_id)
1237
root, ext = os.path.splitext(dest)
1239
if ext in (".tar",):
1241
elif ext in (".gz", ".tgz"):
1243
elif ext in (".bz2", ".tbz2"):
1247
t.export(dest, format, root)
1250
class cmd_cat(Command):
1251
"""Write a file's text from a previous revision."""
1253
takes_options = ['revision']
1254
takes_args = ['filename']
1256
def run(self, filename, revision=None):
1257
if revision == None:
1258
raise BzrCommandError("bzr cat requires a revision number")
1259
elif len(revision) != 1:
1260
raise BzrCommandError("bzr cat --revision takes exactly one number")
1261
b = find_branch('.')
1262
b.print_file(b.relpath(filename), revision[0])
1265
class cmd_local_time_offset(Command):
1266
"""Show the offset in seconds from GMT to local time."""
1269
print bzrlib.osutils.local_time_offset()
1273
class cmd_commit(Command):
1274
"""Commit changes into a new revision.
1276
If no arguments are given, the entire tree is committed.
1278
If selected files are specified, only changes to those files are
1279
committed. If a directory is specified then the directory and everything
1280
within it is committed.
1282
A selected-file commit may fail in some cases where the committed
1283
tree would be invalid, such as trying to commit a file in a
1284
newly-added directory that is not itself committed.
1286
TODO: Run hooks on tree to-be-committed, and after commit.
1288
TODO: Strict commit that fails if there are unknown or deleted files.
1290
takes_args = ['selected*']
1291
takes_options = ['message', 'file', 'verbose', 'unchanged']
1292
aliases = ['ci', 'checkin']
1294
# TODO: Give better message for -s, --summary, used by tla people
1296
def run(self, message=None, file=None, verbose=True, selected_list=None,
1298
from bzrlib.errors import PointlessCommit
1299
from bzrlib.osutils import get_text_message
1301
## Warning: shadows builtin file()
1302
if not message and not file:
1303
# FIXME: Ugly; change status code to send to a provided function?
1307
catcher = cStringIO.StringIO()
1308
sys.stdout = catcher
1309
cmd_status({"file_list":selected_list}, {})
1310
info = catcher.getvalue()
1312
message = get_text_message(info)
1315
raise BzrCommandError("please specify a commit message",
1316
["use either --message or --file"])
1317
elif message and file:
1318
raise BzrCommandError("please specify either --message or --file")
1322
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1324
b = find_branch('.')
1326
selected_list = [b.relpath(s) for s in selected_list]
1329
b.commit(message, verbose=verbose,
1330
specific_files=selected_list,
1331
allow_pointless=unchanged)
1332
except PointlessCommit:
1333
# FIXME: This should really happen before the file is read in;
1334
# perhaps prepare the commit; get the message; then actually commit
1335
raise BzrCommandError("no changes to commit",
1336
["use --unchanged to commit anyhow"])
1339
class cmd_check(Command):
1340
"""Validate consistency of branch history.
1342
This command checks various invariants about the branch storage to
1343
detect data corruption or bzr bugs.
1345
If given the --update flag, it will update some optional fields
1346
to help ensure data consistency.
1348
takes_args = ['dir?']
1350
def run(self, dir='.'):
1351
from bzrlib.check import check
1353
check(find_branch(dir))
1356
class cmd_scan_cache(Command):
1359
from bzrlib.hashcache import HashCache
1366
print '%6d stats' % c.stat_count
1367
print '%6d in hashcache' % len(c._cache)
1368
print '%6d files removed from cache' % c.removed_count
1369
print '%6d hashes updated' % c.update_count
1370
print '%6d files changed too recently to cache' % c.danger_count
1377
class cmd_upgrade(Command):
1378
"""Upgrade branch storage to current format.
1380
The check command or bzr developers may sometimes advise you to run
1383
takes_args = ['dir?']
1385
def run(self, dir='.'):
1386
from bzrlib.upgrade import upgrade
1387
upgrade(find_branch(dir))
1391
class cmd_whoami(Command):
1392
"""Show bzr user id."""
1393
takes_options = ['email']
1395
def run(self, email=False):
1397
b = bzrlib.branch.find_branch('.')
1402
print bzrlib.osutils.user_email(b)
1404
print bzrlib.osutils.username(b)
1407
class cmd_selftest(Command):
1408
"""Run internal test suite"""
1410
takes_options = ['verbose']
1411
def run(self, verbose=False):
1413
from bzrlib.selftest import selftest
1415
# we don't want progress meters from the tests to go to the
1416
# real output; and we don't want log messages cluttering up
1419
save_ui = bzrlib.ui.ui_factory
1420
bzrlib.trace.info('running tests...')
1422
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1423
result = selftest(verbose=verbose)
1425
bzrlib.trace.info('tests passed')
1427
bzrlib.trace.info('tests failed')
1428
return int(not result)
1430
bzrlib.ui.ui_factory = save_ui
1433
class cmd_version(Command):
1434
"""Show version of bzr."""
1439
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1440
# is bzrlib itself in a branch?
1441
bzrrev = bzrlib.get_bzr_revision()
1443
print " (bzr checkout, revision %d {%s})" % bzrrev
1444
print bzrlib.__copyright__
1445
print "http://bazaar-ng.org/"
1447
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1448
print "you may use, modify and redistribute it under the terms of the GNU"
1449
print "General Public License version 2 or later."
1452
class cmd_rocks(Command):
1453
"""Statement of optimism."""
1456
print "it sure does!"
1458
def parse_spec(spec):
1460
>>> parse_spec(None)
1462
>>> parse_spec("./")
1464
>>> parse_spec("../@")
1466
>>> parse_spec("../f/@35")
1468
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1469
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1474
parsed = spec.split('/@')
1475
assert len(parsed) == 2
1480
parsed[1] = int(parsed[1])
1482
pass # We can allow stuff like ./@revid:blahblahblah
1484
assert parsed[1] >=0
1486
parsed = [spec, None]
1491
class cmd_find_merge_base(Command):
1492
"""Find and print a base revision for merging two branches.
1494
TODO: Options to specify revisions on either side, as if
1495
merging only part of the history.
1497
takes_args = ['branch', 'other']
1500
def run(self, branch, other):
1501
branch1 = find_branch(branch)
1502
branch2 = find_branch(other)
1504
base_revno, base_revid = branch1.common_ancestor(branch2)
1506
if base_revno is None:
1507
raise bzrlib.errors.UnrelatedBranches()
1509
print 'merge base is revision %s' % base_revid
1510
print ' r%-6d in %s' % (base_revno, branch)
1512
other_revno = branch2.revision_id_to_revno(base_revid)
1514
print ' r%-6d in %s' % (other_revno, other)
1518
class cmd_merge(Command):
1519
"""Perform a three-way merge.
1521
The branch is the branch you will merge from. By default, it will merge
1522
the latest revision. If you specify a revision, that revision will be
1523
merged. If you specify two revisions, the first will be used as a BASE,
1524
and the second one as OTHER. Revision numbers are always relative to the
1529
To merge the latest revision from bzr.dev
1530
bzr merge ../bzr.dev
1532
To merge changes up to and including revision 82 from bzr.dev
1533
bzr merge -r 82 ../bzr.dev
1535
To merge the changes introduced by 82, without previous changes:
1536
bzr merge -r 81..82 ../bzr.dev
1538
merge refuses to run if there are any uncommitted changes, unless
1541
takes_args = ['branch?']
1542
takes_options = ['revision', 'force', 'merge-type']
1544
def run(self, branch='.', revision=None, force=False,
1546
from bzrlib.merge import merge
1547
from bzrlib.merge_core import ApplyMerge3
1548
if merge_type is None:
1549
merge_type = ApplyMerge3
1551
if revision is None or len(revision) < 1:
1553
other = (branch, -1)
1555
if len(revision) == 1:
1556
other = (branch, revision[0])
1559
assert len(revision) == 2
1560
if None in revision:
1561
raise BzrCommandError(
1562
"Merge doesn't permit that revision specifier.")
1563
base = (branch, revision[0])
1564
other = (branch, revision[1])
1566
merge(other, base, check_clean=(not force), merge_type=merge_type)
1569
class cmd_revert(Command):
1570
"""Reverse all changes since the last commit.
1572
Only versioned files are affected. Specify filenames to revert only
1573
those files. By default, any files that are changed will be backed up
1574
first. Backup files have a '~' appended to their name.
1576
takes_options = ['revision', 'no-backup']
1577
takes_args = ['file*']
1578
aliases = ['merge-revert']
1580
def run(self, revision=None, no_backup=False, file_list=None):
1581
from bzrlib.merge import merge
1582
if file_list is not None:
1583
if len(file_list) == 0:
1584
raise BzrCommandError("No files specified")
1585
if revision is None:
1587
elif len(revision) != 1:
1588
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1589
merge(('.', revision[0]), parse_spec('.'),
1592
backup_files=not no_backup,
1593
file_list=file_list)
1596
class cmd_assert_fail(Command):
1597
"""Test reporting of assertion failures"""
1600
assert False, "always fails"
1603
class cmd_help(Command):
1604
"""Show help on a command or other topic.
1606
For a list of all available commands, say 'bzr help commands'."""
1607
takes_options = ['long']
1608
takes_args = ['topic?']
1611
def run(self, topic=None, long=False):
1613
if topic is None and long:
1618
class cmd_shell_complete(Command):
1619
"""Show appropriate completions for context.
1621
For a list of all available commands, say 'bzr shell-complete'."""
1622
takes_args = ['context?']
1626
def run(self, context=None):
1627
import shellcomplete
1628
shellcomplete.shellcomplete(context)
1631
class cmd_missing(Command):
1632
"""What is missing in this branch relative to other branch.
1634
takes_args = ['remote?']
1635
aliases = ['mis', 'miss']
1636
# We don't have to add quiet to the list, because
1637
# unknown options are parsed as booleans
1638
takes_options = ['verbose', 'quiet']
1640
def run(self, remote=None, verbose=False, quiet=False):
1641
from bzrlib.branch import find_branch, DivergedBranches
1642
from bzrlib.errors import BzrCommandError
1643
from bzrlib.missing import get_parent, show_missing
1645
if verbose and quiet:
1646
raise BzrCommandError('Cannot pass both quiet and verbose')
1648
b = find_branch('.')
1649
parent = get_parent(b)
1652
raise BzrCommandError("No missing location known or specified.")
1655
print "Using last location: %s" % parent
1657
elif parent is None:
1658
# We only update x-pull if it did not exist, missing should not change the parent
1659
b.controlfile('x-pull', 'wb').write(remote + '\n')
1660
br_remote = find_branch(remote)
1662
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1666
class cmd_plugins(Command):
1670
import bzrlib.plugin
736
1671
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):
1672
from pprint import pprint
1673
for plugin in bzrlib.plugin.all_plugins:
1674
print plugin.__path__[0]
1677
print '\t', d.split('\n')[0]
1679
#pprint(bzrlib.plugin.all_plugins)
1683
# list of all available options; the rhs can be either None for an
1684
# option that takes no argument, or a constructor function that checks
1688
'diff-options': str,
1697
'revision': _parse_revision_str,
1709
'merge-type': get_merge_type,
1722
def parse_args(argv):
794
1723
"""Parse command line.
796
1725
Arguments and options are parsed at this level before being passed
797
1726
down to specific command handlers. This routine knows, from a
798
1727
lookup table, something about the available options, what optargs
799
1728
they take, and which commands will accept them.
1730
>>> parse_args('--help'.split())
1731
([], {'help': True})
1732
>>> parse_args('--version'.split())
1733
([], {'version': True})
1734
>>> parse_args('status --all'.split())
1735
(['status'], {'all': True})
1736
>>> parse_args('commit --message=biter'.split())
1737
(['commit'], {'message': u'biter'})
1738
>>> parse_args('log -r 500'.split())
1739
(['log'], {'revision': [500]})
1740
>>> parse_args('log -r500..600'.split())
1741
(['log'], {'revision': [500, 600]})
1742
>>> parse_args('log -vr500..600'.split())
1743
(['log'], {'verbose': True, 'revision': [500, 600]})
1744
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1745
(['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])
1750
# TODO: Maybe handle '--' to end options?
1755
# option names must not be unicode
1759
mutter(" got option %r" % a)
1761
optname, optarg = a[2:].split('=', 1)
1764
if optname not in OPTIONS:
1765
raise BzrError('unknown long option %r' % a)
1768
if shortopt in SHORT_OPTIONS:
1769
# Multi-character options must have a space to delimit
1771
optname = SHORT_OPTIONS[shortopt]
1773
# Single character short options, can be chained,
1774
# and have their value appended to their name
1776
if shortopt not in SHORT_OPTIONS:
1777
# We didn't find the multi-character name, and we
1778
# didn't find the single char name
1779
raise BzrError('unknown short option %r' % a)
1780
optname = SHORT_OPTIONS[shortopt]
1783
# There are extra things on this option
1784
# see if it is the value, or if it is another
1786
optargfn = OPTIONS[optname]
1787
if optargfn is None:
1788
# This option does not take an argument, so the
1789
# next entry is another short option, pack it back
1791
argv.insert(0, '-' + a[2:])
1793
# This option takes an argument, so pack it
1798
# XXX: Do we ever want to support this, e.g. for -r?
1799
raise BzrError('repeated option %r' % a)
1801
optargfn = OPTIONS[optname]
1805
raise BzrError('option %r needs an argument' % a)
1807
optarg = argv.pop(0)
1808
opts[optname] = optargfn(optarg)
1811
raise BzrError('option %r takes no argument' % optname)
1812
opts[optname] = True
811
1816
return args, opts
814
1821
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
