160
63
def _unsquish_command_name(cmd):
64
assert cmd.startswith("cmd_")
161
65
return cmd[4:].replace('_','-')
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
168
import bzrlib.builtins
169
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
170
builtin_command_registry.register(cmd_class)
171
bzrlib.builtins._register_lazy_builtins()
174
def _scan_module_for_commands(module):
176
for name, obj in module.__dict__.iteritems():
177
if name.startswith("cmd_"):
178
real_name = _unsquish_command_name(name)
183
def _list_bzr_commands(names):
184
"""Find commands from bzr's core and plugins.
186
This is not the public interface, just the default hook called by all_command_names.
188
# to eliminate duplicates
189
names.update(builtin_command_names())
190
names.update(plugin_command_names())
194
def all_command_names():
195
"""Return a set of all command names."""
197
for hook in Command.hooks['list_commands']:
200
raise AssertionError(
201
'hook %s returned None' % Command.hooks.get_hook_name(hook))
205
def builtin_command_names():
206
"""Return list of builtin command names.
208
Use of all_command_names() is encouraged rather than builtin_command_names
209
and/or plugin_command_names.
211
_register_builtin_commands()
212
return builtin_command_registry.keys()
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
217
return plugin_cmds.keys()
220
def get_cmd_object(cmd_name, plugins_override=True):
221
"""Return the command object for a command.
224
If true, plugin commands can override builtins.
227
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
233
"""Get a command object.
235
:param cmd_name: The name of the command.
236
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
239
:return: A Command object instance
240
:raises KeyError: If no command is found.
242
# We want only 'ascii' command names, but the user may have typed
243
# in a Unicode name. In that case, they should just get a
244
# 'command not found' error later.
245
# In the future, we may actually support Unicode command names.
248
for hook in Command.hooks['get_command']:
249
cmd = hook(cmd, cmd_name)
250
if cmd is not None and not plugins_override and not cmd.plugin_name():
251
# We've found a non-plugin command, don't permit it to be
254
if cmd is None and check_missing:
255
for hook in Command.hooks['get_missing_command']:
262
# Allow plugins to extend commands
263
for hook in Command.hooks['extend_command']:
265
if getattr(cmd, 'invoked_as', None) is None:
266
cmd.invoked_as = cmd_name
270
def _try_plugin_provider(cmd_name):
271
"""Probe for a plugin provider having cmd_name."""
273
plugin_metadata, provider = probe_for_provider(cmd_name)
274
raise errors.CommandAvailableInPlugin(cmd_name,
275
plugin_metadata, provider)
276
except errors.NoPluginAvailable:
280
def probe_for_provider(cmd_name):
281
"""Look for a provider for cmd_name.
283
:param cmd_name: The command name.
284
:return: plugin_metadata, provider for getting cmd_name.
285
:raises NoPluginAvailable: When no provider can supply the plugin.
287
# look for providers that provide this command but aren't installed
288
for provider in command_providers_registry:
290
return provider.plugin_for_command(cmd_name), provider
291
except errors.NoPluginAvailable:
293
raise errors.NoPluginAvailable(cmd_name)
296
def _get_bzr_command(cmd_or_None, cmd_name):
297
"""Get a command from bzr's core."""
299
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)
307
def _get_external_command(cmd_or_None, cmd_name):
308
"""Lookup a command that is a shell script."""
309
# Only do external command lookups when no command is found so far.
310
if cmd_or_None is not None:
312
from bzrlib.externalcommand import ExternalCommand
313
cmd_obj = ExternalCommand.find_command(cmd_name)
318
def _get_plugin_command(cmd_or_None, cmd_name):
319
"""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)
321
return plugin_cmds.get(cmd_name)()
196
return cmd, cmds[cmd]
324
for key in plugin_cmds.keys():
325
info = plugin_cmds.get_info(key)
326
if cmd_name in info.aliases:
327
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)
331
212
class Command(object):
332
213
"""Base class for commands.
334
Commands are the heart of the command-line bzr interface.
336
The command object mostly handles the mapping of command-line
337
parameters into one or more bzrlib operations, and of the results
340
Commands normally don't have any state. All their arguments are
341
passed in to the run method. (Subclasses may take a different
342
policy if the behaviour of the instance needs to depend on e.g. a
343
shell plugin and not just its Python class.)
345
215
The docstring for an actual command should give a single-line
346
216
summary, then a complete description of the command. A grammar
347
217
description will be inserted.
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
365
for commands intended for expert users.
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
220
List of argument forms, marked with whether they are optional,
224
List of options that may be given for this command.
227
If true, this command isn't advertised.
397
232
takes_options = []
398
encoding_type = 'strict'
405
"""Construct an instance of this command."""
406
# List of standard options directly supported
407
self.supported_std_options = []
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
"""Register a function to call after self.run returns or raises.
413
Functions will be called in LIFO order.
415
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
417
def cleanup_now(self):
418
"""Execute and empty pending cleanup functions immediately.
420
After cleanup_now all registered cleanups are forgotten. add_cleanup
421
may be called again after cleanup_now; these cleanups will be called
422
after self.run returns or raises (or when cleanup_now is next called).
424
This is useful for releasing expensive or contentious resources (such
425
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
430
self._operation.cleanup_now()
433
"""Return single-line grammar for this command.
435
Only describes arguments, not options.
437
s = 'bzr ' + self.name() + ' '
438
for aname in self.takes_args:
439
aname = aname.upper()
440
if aname[-1] in ['$', '+']:
441
aname = aname[:-1] + '...'
442
elif aname[-1] == '?':
443
aname = '[' + aname[:-1] + ']'
444
elif aname[-1] == '*':
445
aname = '[' + aname[:-1] + '...]'
447
s = s[:-1] # remove last space
450
def get_help_text(self, additional_see_also=None, plain=True,
451
see_also_as_links=False, verbose=True):
452
"""Return a text string with help for this command.
454
:param additional_see_also: Additional help topics to be
456
:param plain: if False, raw help (reStructuredText) is
457
returned instead of plain text.
458
:param see_also_as_links: if True, convert items in 'See also'
459
list to internal links (used by bzr_man rstx generator)
460
:param verbose: if True, display the full help, otherwise
461
leave out the descriptive sections and just display
462
usage help (e.g. Purpose, Usage, Options) with a
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
478
# Extract the summary (purpose) and sections out from the text
479
purpose,sections,order = self._get_help_parts(doc)
481
# If a custom usage section was provided, use it
482
if sections.has_key('Usage'):
483
usage = sections.pop('Usage')
485
usage = self._usage()
487
# The header is the purpose and usage
489
result += gettext(':Purpose: %s\n') % (purpose,)
490
if usage.find('\n') >= 0:
491
result += gettext(':Usage:\n%s\n') % (usage,)
493
result += gettext(':Usage: %s\n') % (usage,)
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
510
options = options.replace(' format:\n', ' format::\n\n', 1)
511
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
518
# Add the description, indenting it 2 spaces
519
# to match the indentation of the options
520
if sections.has_key(None):
521
text = sections.pop(None)
522
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
525
# Add the custom sections (e.g. Examples). Note that there's no need
526
# to indent these as they must be indented already in the source.
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
536
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
539
result += ', '.join(self.aliases) + '\n'
540
plugin_name = self.plugin_name()
541
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
543
see_also = self.get_see_also(additional_see_also)
545
if not plain and see_also_as_links:
547
for item in see_also:
549
# topics doesn't have an independent section
550
# so don't create a real link
551
see_also_links.append(item)
553
# Use a Sphinx link for this entry
554
link_text = gettext(":doc:`{0} <{1}-help>`").format(
556
see_also_links.append(link_text)
557
see_also = see_also_links
558
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
560
# If this will be rendered as plain text, convert it
562
import bzrlib.help_topics
563
result = bzrlib.help_topics.help_as_plain_text(result)
567
def _get_help_parts(text):
568
"""Split help text into a summary and named sections.
570
:return: (summary,sections,order) where summary is the top line and
571
sections is a dictionary of the rest indexed by section name.
572
order is the order the section appear in the text.
573
A section starts with a heading line of the form ":xxx:".
574
Indented text on following lines is the section value.
575
All text found outside a named section is assigned to the
576
default section which is given the key of None.
578
def save_section(sections, order, label, section):
580
if sections.has_key(label):
581
sections[label] += '\n' + section
584
sections[label] = section
586
lines = text.rstrip().splitlines()
587
summary = lines.pop(0)
590
label,section = None,''
592
if line.startswith(':') and line.endswith(':') and len(line) > 2:
593
save_section(sections, order, label, section)
594
label,section = line[1:-1],''
595
elif (label is not None) and len(line) > 1 and not line[0].isspace():
596
save_section(sections, order, label, section)
597
label,section = None,line
600
section += '\n' + line
603
save_section(sections, order, label, section)
604
return summary, sections, order
606
def get_help_topic(self):
607
"""Return the commands help topic - its name."""
610
def get_see_also(self, additional_terms=None):
611
"""Return a list of help topics that are related to this command.
613
The list is derived from the content of the _see_also attribute. Any
614
duplicates are removed and the result is in lexical order.
615
:param additional_terms: Additional help topics to cross-reference.
616
:return: A list of help topics.
618
see_also = set(getattr(self, '_see_also', []))
620
see_also.update(additional_terms)
621
return sorted(see_also)
624
"""Return dict of valid options for this command.
626
Maps from long option name to option object."""
627
r = Option.STD_OPTIONS.copy()
629
for o in self.takes_options:
630
if isinstance(o, basestring):
631
o = option.Option.OPTIONS[o]
633
if o.name in std_names:
634
self.supported_std_options.append(o.name)
637
def _setup_outf(self):
638
"""Return a file linked to stdout, which has proper encoding."""
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
642
def run_argv_aliases(self, argv, alias_argv=None):
643
"""Parse the command line and run with extra aliases in alias_argv."""
644
args, opts = parse_args(self, argv, alias_argv)
647
# Process the standard options
648
if 'help' in opts: # e.g. bzr add --help
649
self.outf.write(self.get_help_text())
651
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
654
trace.set_verbosity_level(option._verbosity_level)
655
if 'verbose' in self.supported_std_options:
656
opts['verbose'] = trace.is_verbose()
657
elif opts.has_key('verbose'):
659
if 'quiet' in self.supported_std_options:
660
opts['quiet'] = trace.is_quiet()
661
elif opts.has_key('quiet'):
663
# mix arguments and options into one dictionary
664
cmdargs = _match_argform(self.name(), self.takes_args, args)
666
for k, v in opts.items():
667
cmdopts[k.replace('-', '_')] = v
669
all_cmd_args = cmdargs.copy()
670
all_cmd_args.update(cmdopts)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
682
def _setup_run(self):
683
"""Wrap the defined run method on self with a cleanup.
685
This is called by __init__ to make the Command be able to be run
686
by just calling run(), as it could be before cleanups were added.
688
If a different form of cleanups are in use by your Command subclass,
689
you can override this method.
692
def run(*args, **kwargs):
693
for hook in Command.hooks['pre_command']:
695
self._operation = cleanup.OperationWithCleanups(class_run)
697
return self._operation.run_simple(*args, **kwargs)
700
for hook in Command.hooks['post_command']:
236
def __init__(self, options, arguments):
237
"""Construct and run the 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)
244
if self.__doc__ == Command.__doc__:
245
from warnings import warn
246
warn("No help message set for %r" % self)
247
self.status = self.run(**cmdargs)
248
if self.status is None:
705
"""Actually run the command.
253
"""Override this in sub-classes.
707
255
This is invoked with the options and arguments bound to
708
256
keyword parameters.
710
Return 0 or None if the command was successful, or a non-zero
711
shell error code if not. It's OK for this method to allow
712
an exception to raise up.
714
This method is automatically wrapped by Command.__init__ with a
715
cleanup operation, stored as self._operation. This can be used
716
via self.add_cleanup to perform automatic cleanups at the end of
719
The argument for run are assembled by introspection. So for instance,
720
if your command takes an argument files, you would declare::
722
def run(self, files=None):
258
Return 0 or None if the command was successful, or a shell
725
raise NotImplementedError('no implementation of command %r'
729
"""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
for pair in b.move(rel_names[:-1], rel_names[-1]):
589
print "%s => %s" % pair
591
if len(names_list) != 2:
592
raise BzrCommandError('to mv multiple files the destination '
593
'must be a versioned directory')
594
for pair in b.move(rel_names[0], rel_names[1]):
595
print "%s => %s" % pair
600
class cmd_pull(Command):
601
"""Pull any changes from another branch into the current one.
603
If the location is omitted, the last-used location will be used.
604
Both the revision history and the working directory will be
607
This command only works on branches that have not diverged. Branches are
608
considered diverged if both branches have had commits without first
609
pulling from the other.
611
If branches have diverged, you can use 'bzr merge' to pull the text changes
612
from one into the other.
614
takes_args = ['location?']
616
def run(self, location=None):
617
from bzrlib.merge import merge
619
from shutil import rmtree
622
br_to = find_branch('.')
625
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
627
if e.errno != errno.ENOENT:
630
if stored_loc is None:
631
raise BzrCommandError("No pull location known or specified.")
633
print "Using last location: %s" % stored_loc
634
location = stored_loc
635
cache_root = tempfile.mkdtemp()
636
from bzrlib.branch import DivergedBranches
637
br_from = find_branch(location)
638
location = pull_loc(br_from)
639
old_revno = br_to.revno()
641
from branch import find_cached_branch, DivergedBranches
642
br_from = find_cached_branch(location, cache_root)
643
location = pull_loc(br_from)
644
old_revno = br_to.revno()
646
br_to.update_revisions(br_from)
647
except DivergedBranches:
648
raise BzrCommandError("These branches have diverged."
651
merge(('.', -1), ('.', old_revno), check_clean=False)
652
if location != stored_loc:
653
br_to.controlfile("x-pull", "wb").write(location + "\n")
659
class cmd_branch(Command):
660
"""Create a new copy of a branch.
662
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
663
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
665
To retrieve the branch as of a particular revision, supply the --revision
666
parameter, as in "branch foo/bar -r 5".
668
takes_args = ['from_location', 'to_location?']
669
takes_options = ['revision']
670
aliases = ['get', 'clone']
672
def run(self, from_location, to_location=None, revision=None):
674
from bzrlib.merge import merge
675
from bzrlib.branch import DivergedBranches, \
676
find_cached_branch, Branch
677
from shutil import rmtree
678
from meta_store import CachedStore
680
cache_root = tempfile.mkdtemp()
684
elif len(revision) > 1:
685
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
689
br_from = find_cached_branch(from_location, cache_root)
691
if e.errno == errno.ENOENT:
692
raise BzrCommandError('Source location "%s" does not'
693
' exist.' % to_location)
697
if to_location is None:
698
to_location = os.path.basename(from_location.rstrip("/\\"))
701
os.mkdir(to_location)
703
if e.errno == errno.EEXIST:
704
raise BzrCommandError('Target directory "%s" already'
705
' exists.' % to_location)
706
if e.errno == errno.ENOENT:
707
raise BzrCommandError('Parent of "%s" does not exist.' %
711
br_to = Branch(to_location, init=True)
713
br_to.set_root_id(br_from.get_root_id())
716
if revision[0] is None:
717
revno = br_from.revno()
719
revno, rev_id = br_from.get_revision_info(revision[0])
721
br_to.update_revisions(br_from, stop_revision=revno)
722
except bzrlib.errors.NoSuchRevision:
724
msg = "The branch %s has no revision %d." % (from_location,
726
raise BzrCommandError(msg)
728
merge((to_location, -1), (to_location, 0), this_dir=to_location,
729
check_clean=False, ignore_zero=True)
730
from_location = pull_loc(br_from)
731
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
736
def pull_loc(branch):
737
# TODO: Should perhaps just make attribute be 'base' in
738
# RemoteBranch and Branch?
739
if hasattr(branch, "baseurl"):
740
return branch.baseurl
746
class cmd_renames(Command):
747
"""Show list of renamed files.
749
TODO: Option to show renames between two historical versions.
751
TODO: Only show renames under dir, rather than in the whole branch.
753
takes_args = ['dir?']
755
def run(self, dir='.'):
757
old_inv = b.basis_tree().inventory
758
new_inv = b.read_working_inventory()
760
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
762
for old_name, new_name in renames:
763
print "%s => %s" % (old_name, new_name)
766
class cmd_info(Command):
767
"""Show statistical information about a branch."""
768
takes_args = ['branch?']
770
def run(self, branch=None):
773
b = find_branch(branch)
777
class cmd_remove(Command):
778
"""Make a file unversioned.
780
This makes bzr stop tracking changes to a versioned file. It does
781
not delete the working copy.
783
takes_args = ['file+']
784
takes_options = ['verbose']
786
def run(self, file_list, verbose=False):
787
b = find_branch(file_list[0])
788
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
791
class cmd_file_id(Command):
792
"""Print file_id of a particular file or directory.
794
The file_id is assigned when the file is first added and remains the
795
same through all revisions where the file exists, even when it is
799
takes_args = ['filename']
800
def run(self, filename):
801
b = find_branch(filename)
802
i = b.inventory.path2id(b.relpath(filename))
804
raise BzrError("%r is not a versioned file" % filename)
809
class cmd_file_path(Command):
810
"""Print path of file_ids to a file or directory.
812
This prints one line for each directory down to the target,
813
starting at the branch root."""
815
takes_args = ['filename']
816
def run(self, filename):
817
b = find_branch(filename)
819
fid = inv.path2id(b.relpath(filename))
821
raise BzrError("%r is not a versioned file" % filename)
822
for fip in inv.get_idpath(fid):
826
class cmd_revision_history(Command):
827
"""Display list of revision ids on this branch."""
830
for patchid in find_branch('.').revision_history():
834
class cmd_directories(Command):
835
"""Display list of versioned directories in this branch."""
837
for name, ie in find_branch('.').read_working_inventory().directories():
844
class cmd_init(Command):
845
"""Make a directory into a versioned branch.
847
Use this to create an empty branch, or before importing an
850
Recipe for importing a tree of files:
855
bzr commit -m 'imported project'
858
from bzrlib.branch import Branch
859
Branch('.', init=True)
862
class cmd_diff(Command):
863
"""Show differences in working tree.
865
If files are listed, only the changes in those files are listed.
866
Otherwise, all changes for the tree are listed.
868
TODO: Allow diff across branches.
870
TODO: Option to use external diff command; could be GNU diff, wdiff,
873
TODO: Python difflib is not exactly the same as unidiff; should
874
either fix it up or prefer to use an external diff.
876
TODO: If a directory is given, diff everything under that.
878
TODO: Selected-file diff is inefficient and doesn't show you
881
TODO: This probably handles non-Unix newlines poorly.
889
takes_args = ['file*']
890
takes_options = ['revision', 'diff-options']
891
aliases = ['di', 'dif']
893
def run(self, revision=None, file_list=None, diff_options=None):
894
from bzrlib.diff import show_diff
897
b = find_branch(file_list[0])
898
file_list = [b.relpath(f) for f in file_list]
899
if file_list == ['']:
900
# just pointing to top-of-tree
905
if revision is not None:
906
if len(revision) == 1:
907
show_diff(b, revision[0], specific_files=file_list,
908
external_diff_options=diff_options)
909
elif len(revision) == 2:
910
show_diff(b, revision[0], specific_files=file_list,
911
external_diff_options=diff_options,
912
revision2=revision[1])
914
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
916
show_diff(b, None, specific_files=file_list,
917
external_diff_options=diff_options)
922
class cmd_deleted(Command):
923
"""List files deleted in the working tree.
925
TODO: Show files deleted since a previous revision, or between two revisions.
927
def run(self, show_ids=False):
930
new = b.working_tree()
932
## TODO: Much more efficient way to do this: read in new
933
## directories with readdir, rather than stating each one. Same
934
## level of effort but possibly much less IO. (Or possibly not,
935
## if the directories are very large...)
937
for path, ie in old.inventory.iter_entries():
938
if not new.has_id(ie.file_id):
940
print '%-50s %s' % (path, ie.file_id)
945
class cmd_modified(Command):
946
"""List files modified in working tree."""
949
from bzrlib.delta import compare_trees
952
td = compare_trees(b.basis_tree(), b.working_tree())
954
for path, id, kind in td.modified:
959
class cmd_added(Command):
960
"""List files added in working tree."""
964
wt = b.working_tree()
965
basis_inv = b.basis_tree().inventory
968
if file_id in basis_inv:
970
path = inv.id2path(file_id)
971
if not os.access(b.abspath(path), os.F_OK):
977
class cmd_root(Command):
978
"""Show the tree root directory.
980
The root is the nearest enclosing directory with a .bzr control
982
takes_args = ['filename?']
983
def run(self, filename=None):
984
"""Print the branch root."""
985
b = find_branch(filename)
986
print getattr(b, 'base', None) or getattr(b, 'baseurl')
989
class cmd_log(Command):
990
"""Show log of this branch.
992
To request a range of logs, you can use the command -r begin:end
993
-r revision requests a specific revision, -r :end or -r begin: are
996
--message allows you to give a regular expression, which will be evaluated
997
so that only matching entries will be displayed.
999
TODO: Make --revision support uuid: and hash: [future tag:] notation.
1003
takes_args = ['filename?']
1004
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
1005
'long', 'message', 'short',]
1007
def run(self, filename=None, timezone='original',
1015
from bzrlib.branch import find_branch
1016
from bzrlib.log import log_formatter, show_log
1019
direction = (forward and 'forward') or 'reverse'
1022
b = find_branch(filename)
1023
fp = b.relpath(filename)
1025
file_id = b.read_working_inventory().path2id(fp)
1027
file_id = None # points to branch root
1029
b = find_branch('.')
1032
if revision is None:
1035
elif len(revision) == 1:
1036
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1037
elif len(revision) == 2:
1038
rev1 = b.get_revision_info(revision[0])[0]
1039
rev2 = b.get_revision_info(revision[1])[0]
1041
raise BzrCommandError('bzr log --revision takes one or two values.')
1048
mutter('encoding log as %r' % bzrlib.user_encoding)
1050
# use 'replace' so that we don't abort if trying to write out
1051
# in e.g. the default C locale.
1052
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1057
log_format = 'short'
1058
lf = log_formatter(log_format,
1061
show_timezone=timezone)
1067
direction=direction,
1068
start_revision=rev1,
1074
class cmd_touching_revisions(Command):
1075
"""Return revision-ids which affected a particular file.
1077
A more user-friendly interface is "bzr log FILE"."""
1079
takes_args = ["filename"]
1080
def run(self, filename):
1081
b = find_branch(filename)
1082
inv = b.read_working_inventory()
1083
file_id = inv.path2id(b.relpath(filename))
1084
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1085
print "%6d %s" % (revno, what)
1088
class cmd_ls(Command):
1089
"""List files in a tree.
1091
TODO: Take a revision or remote path and list that tree instead.
1094
def run(self, revision=None, verbose=False):
1095
b = find_branch('.')
1096
if revision == None:
1097
tree = b.working_tree()
1099
tree = b.revision_tree(b.lookup_revision(revision))
1101
for fp, fc, kind, fid in tree.list_files():
1103
if kind == 'directory':
1105
elif kind == 'file':
1110
print '%-8s %s%s' % (fc, fp, kindch)
1116
class cmd_unknowns(Command):
1117
"""List unknown files."""
1119
from bzrlib.osutils import quotefn
1120
for f in find_branch('.').unknowns():
1125
class cmd_ignore(Command):
1126
"""Ignore a command or pattern.
1128
To remove patterns from the ignore list, edit the .bzrignore file.
1130
If the pattern contains a slash, it is compared to the whole path
1131
from the branch root. Otherwise, it is comapred to only the last
1132
component of the path.
1134
Ignore patterns are case-insensitive on case-insensitive systems.
1136
Note: wildcards must be quoted from the shell on Unix.
1139
bzr ignore ./Makefile
1140
bzr ignore '*.class'
1142
takes_args = ['name_pattern']
1144
def run(self, name_pattern):
1145
from bzrlib.atomicfile import AtomicFile
1148
b = find_branch('.')
1149
ifn = b.abspath('.bzrignore')
1151
if os.path.exists(ifn):
1154
igns = f.read().decode('utf-8')
1160
# TODO: If the file already uses crlf-style termination, maybe
1161
# we should use that for the newly added lines?
1163
if igns and igns[-1] != '\n':
1165
igns += name_pattern + '\n'
1168
f = AtomicFile(ifn, 'wt')
1169
f.write(igns.encode('utf-8'))
1174
inv = b.working_tree().inventory
1175
if inv.path2id('.bzrignore'):
1176
mutter('.bzrignore is already versioned')
1178
mutter('need to make new .bzrignore file versioned')
1179
b.add(['.bzrignore'])
1183
class cmd_ignored(Command):
1184
"""List ignored files and the patterns that matched them.
1186
See also: bzr ignore"""
1188
tree = find_branch('.').working_tree()
1189
for path, file_class, kind, file_id in tree.list_files():
1190
if file_class != 'I':
1192
## XXX: Slightly inefficient since this was already calculated
1193
pat = tree.is_ignored(path)
1194
print '%-50s %s' % (path, pat)
1197
class cmd_lookup_revision(Command):
1198
"""Lookup the revision-id from a revision-number
1201
bzr lookup-revision 33
1204
takes_args = ['revno']
1206
def run(self, revno):
1210
raise BzrCommandError("not a valid revision-number: %r" % revno)
1212
print find_branch('.').lookup_revision(revno)
1215
class cmd_export(Command):
1216
"""Export past revision to destination directory.
1218
If no revision is specified this exports the last committed revision.
1220
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1221
given, try to find the format with the extension. If no extension
1222
is found exports to a directory (equivalent to --format=dir).
1224
Root may be the top directory for tar, tgz and tbz2 formats. If none
1225
is given, the top directory will be the root name of the file."""
1226
# TODO: list known exporters
1227
takes_args = ['dest']
1228
takes_options = ['revision', 'format', 'root']
1229
def run(self, dest, revision=None, format=None, root=None):
1231
b = find_branch('.')
1232
if revision is None:
1233
rev_id = b.last_patch()
1235
if len(revision) != 1:
1236
raise BzrError('bzr export --revision takes exactly 1 argument')
1237
revno, rev_id = b.get_revision_info(revision[0])
1238
t = b.revision_tree(rev_id)
1239
root, ext = os.path.splitext(dest)
1241
if ext in (".tar",):
1243
elif ext in (".gz", ".tgz"):
1245
elif ext in (".bz2", ".tbz2"):
1249
t.export(dest, format, root)
1252
class cmd_cat(Command):
1253
"""Write a file's text from a previous revision."""
1255
takes_options = ['revision']
1256
takes_args = ['filename']
1258
def run(self, filename, revision=None):
1259
if revision == None:
1260
raise BzrCommandError("bzr cat requires a revision number")
1261
elif len(revision) != 1:
1262
raise BzrCommandError("bzr cat --revision takes exactly one number")
1263
b = find_branch('.')
1264
b.print_file(b.relpath(filename), revision[0])
1267
class cmd_local_time_offset(Command):
1268
"""Show the offset in seconds from GMT to local time."""
1271
print bzrlib.osutils.local_time_offset()
1275
class cmd_commit(Command):
1276
"""Commit changes into a new revision.
1278
If no arguments are given, the entire tree is committed.
1280
If selected files are specified, only changes to those files are
1281
committed. If a directory is specified then the directory and everything
1282
within it is committed.
1284
A selected-file commit may fail in some cases where the committed
1285
tree would be invalid, such as trying to commit a file in a
1286
newly-added directory that is not itself committed.
1288
TODO: Run hooks on tree to-be-committed, and after commit.
1290
TODO: Strict commit that fails if there are unknown or deleted files.
1292
takes_args = ['selected*']
1293
takes_options = ['message', 'file', 'verbose', 'unchanged']
1294
aliases = ['ci', 'checkin']
1296
# TODO: Give better message for -s, --summary, used by tla people
1298
def run(self, message=None, file=None, verbose=True, selected_list=None,
1300
from bzrlib.errors import PointlessCommit
1301
from bzrlib.osutils import get_text_message
1303
## Warning: shadows builtin file()
1304
if not message and not file:
1305
# FIXME: Ugly; change status code to send to a provided function?
1309
catcher = cStringIO.StringIO()
1310
sys.stdout = catcher
1311
cmd_status({"file_list":selected_list}, {})
1312
info = catcher.getvalue()
1314
message = get_text_message(info)
1317
raise BzrCommandError("please specify a commit message",
1318
["use either --message or --file"])
1319
elif message and file:
1320
raise BzrCommandError("please specify either --message or --file")
1324
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1326
b = find_branch('.')
1328
selected_list = [b.relpath(s) for s in selected_list]
1331
b.commit(message, verbose=verbose,
1332
specific_files=selected_list,
1333
allow_pointless=unchanged)
1334
except PointlessCommit:
1335
# FIXME: This should really happen before the file is read in;
1336
# perhaps prepare the commit; get the message; then actually commit
1337
raise BzrCommandError("no changes to commit",
1338
["use --unchanged to commit anyhow"])
1341
class cmd_check(Command):
1342
"""Validate consistency of branch history.
1344
This command checks various invariants about the branch storage to
1345
detect data corruption or bzr bugs.
1347
If given the --update flag, it will update some optional fields
1348
to help ensure data consistency.
1350
takes_args = ['dir?']
1352
def run(self, dir='.'):
1353
from bzrlib.check import check
1355
check(find_branch(dir))
1358
class cmd_scan_cache(Command):
1361
from bzrlib.hashcache import HashCache
1368
print '%6d stats' % c.stat_count
1369
print '%6d in hashcache' % len(c._cache)
1370
print '%6d files removed from cache' % c.removed_count
1371
print '%6d hashes updated' % c.update_count
1372
print '%6d files changed too recently to cache' % c.danger_count
1379
class cmd_upgrade(Command):
1380
"""Upgrade branch storage to current format.
1382
The check command or bzr developers may sometimes advise you to run
1385
takes_args = ['dir?']
1387
def run(self, dir='.'):
1388
from bzrlib.upgrade import upgrade
1389
upgrade(find_branch(dir))
1393
class cmd_whoami(Command):
1394
"""Show bzr user id."""
1395
takes_options = ['email']
1397
def run(self, email=False):
1399
b = bzrlib.branch.find_branch('.')
1404
print bzrlib.osutils.user_email(b)
1406
print bzrlib.osutils.username(b)
1409
class cmd_selftest(Command):
1410
"""Run internal test suite"""
1412
takes_options = ['verbose']
1413
def run(self, verbose=False):
1415
from bzrlib.selftest import selftest
1417
# we don't want progress meters from the tests to go to the
1418
# real output; and we don't want log messages cluttering up
1421
save_ui = bzrlib.ui.ui_factory
1422
bzrlib.trace.info('running tests...')
1424
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1425
result = selftest(verbose=verbose)
1427
bzrlib.trace.info('tests passed')
1429
bzrlib.trace.info('tests failed')
1430
return int(not result)
1432
bzrlib.ui.ui_factory = save_ui
1435
class cmd_version(Command):
1436
"""Show version of bzr."""
1441
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1442
# is bzrlib itself in a branch?
1443
bzrrev = bzrlib.get_bzr_revision()
1445
print " (bzr checkout, revision %d {%s})" % bzrrev
1446
print bzrlib.__copyright__
1447
print "http://bazaar-ng.org/"
1449
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1450
print "you may use, modify and redistribute it under the terms of the GNU"
1451
print "General Public License version 2 or later."
1454
class cmd_rocks(Command):
1455
"""Statement of optimism."""
1458
print "it sure does!"
1460
def parse_spec(spec):
1462
>>> parse_spec(None)
1464
>>> parse_spec("./")
1466
>>> parse_spec("../@")
1468
>>> parse_spec("../f/@35")
1470
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1471
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1476
parsed = spec.split('/@')
1477
assert len(parsed) == 2
1482
parsed[1] = int(parsed[1])
1484
pass # We can allow stuff like ./@revid:blahblahblah
1486
assert parsed[1] >=0
1488
parsed = [spec, None]
1493
class cmd_find_merge_base(Command):
1494
"""Find and print a base revision for merging two branches.
1496
TODO: Options to specify revisions on either side, as if
1497
merging only part of the history.
1499
takes_args = ['branch', 'other']
1502
def run(self, branch, other):
1503
branch1 = find_branch(branch)
1504
branch2 = find_branch(other)
1506
base_revno, base_revid = branch1.common_ancestor(branch2)
1508
if base_revno is None:
1509
raise bzrlib.errors.UnrelatedBranches()
1511
print 'merge base is revision %s' % base_revid
1512
print ' r%-6d in %s' % (base_revno, branch)
1514
other_revno = branch2.revision_id_to_revno(base_revid)
1516
print ' r%-6d in %s' % (other_revno, other)
1520
class cmd_merge(Command):
1521
"""Perform a three-way merge.
1523
The branch is the branch you will merge from. By default, it will merge
1524
the latest revision. If you specify a revision, that revision will be
1525
merged. If you specify two revisions, the first will be used as a BASE,
1526
and the second one as OTHER. Revision numbers are always relative to the
1531
To merge the latest revision from bzr.dev
1532
bzr merge ../bzr.dev
1534
To merge changes up to and including revision 82 from bzr.dev
1535
bzr merge -r 82 ../bzr.dev
1537
To merge the changes introduced by 82, without previous changes:
1538
bzr merge -r 81..82 ../bzr.dev
1540
merge refuses to run if there are any uncommitted changes, unless
1543
takes_args = ['branch?']
1544
takes_options = ['revision', 'force', 'merge-type']
1546
def run(self, branch='.', revision=None, force=False,
1548
from bzrlib.merge import merge
1549
from bzrlib.merge_core import ApplyMerge3
1550
if merge_type is None:
1551
merge_type = ApplyMerge3
1553
if revision is None or len(revision) < 1:
1555
other = (branch, -1)
1557
if len(revision) == 1:
1558
other = (branch, revision[0])
1561
assert len(revision) == 2
1562
if None in revision:
1563
raise BzrCommandError(
1564
"Merge doesn't permit that revision specifier.")
1565
base = (branch, revision[0])
1566
other = (branch, revision[1])
1568
merge(other, base, check_clean=(not force), merge_type=merge_type)
1571
class cmd_revert(Command):
1572
"""Reverse all changes since the last commit.
1574
Only versioned files are affected. Specify filenames to revert only
1575
those files. By default, any files that are changed will be backed up
1576
first. Backup files have a '~' appended to their name.
1578
takes_options = ['revision', 'no-backup']
1579
takes_args = ['file*']
1580
aliases = ['merge-revert']
1582
def run(self, revision=None, no_backup=False, file_list=None):
1583
from bzrlib.merge import merge
1584
if file_list is not None:
1585
if len(file_list) == 0:
1586
raise BzrCommandError("No files specified")
1587
if revision is None:
1589
elif len(revision) != 1:
1590
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1591
merge(('.', revision[0]), parse_spec('.'),
1594
backup_files=not no_backup,
1595
file_list=file_list)
1598
class cmd_assert_fail(Command):
1599
"""Test reporting of assertion failures"""
1602
assert False, "always fails"
1605
class cmd_help(Command):
1606
"""Show help on a command or other topic.
1608
For a list of all available commands, say 'bzr help commands'."""
1609
takes_options = ['long']
1610
takes_args = ['topic?']
1613
def run(self, topic=None, long=False):
1615
if topic is None and long:
1620
class cmd_shell_complete(Command):
1621
"""Show appropriate completions for context.
1623
For a list of all available commands, say 'bzr shell-complete'."""
1624
takes_args = ['context?']
1628
def run(self, context=None):
1629
import shellcomplete
1630
shellcomplete.shellcomplete(context)
1633
class cmd_missing(Command):
1634
"""What is missing in this branch relative to other branch.
1636
takes_args = ['remote?']
1637
aliases = ['mis', 'miss']
1638
# We don't have to add quiet to the list, because
1639
# unknown options are parsed as booleans
1640
takes_options = ['verbose', 'quiet']
1642
def run(self, remote=None, verbose=False, quiet=False):
1643
from bzrlib.branch import find_branch, DivergedBranches
1644
from bzrlib.errors import BzrCommandError
1645
from bzrlib.missing import get_parent, show_missing
1647
if verbose and quiet:
1648
raise BzrCommandError('Cannot pass both quiet and verbose')
1650
b = find_branch('.')
1651
parent = get_parent(b)
1654
raise BzrCommandError("No missing location known or specified.")
1657
print "Using last location: %s" % parent
1659
elif parent is None:
1660
# We only update x-pull if it did not exist, missing should not change the parent
1661
b.controlfile('x-pull', 'wb').write(remote + '\n')
1662
br_remote = find_branch(remote)
1664
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1668
class cmd_plugins(Command):
1672
import bzrlib.plugin
730
1673
from inspect import getdoc
731
if self.__doc__ is Command.__doc__:
735
def gettext(self, message):
736
"""Returns the gettext function used to translate this command's help.
738
Commands provided by plugins should override this to use their
741
return i18n.gettext_per_paragraph(message)
744
"""Return the canonical name for this command.
746
The name under which it was actually invoked is available in invoked_as.
748
return _unsquish_command_name(self.__class__.__name__)
750
def plugin_name(self):
751
"""Get the name of the plugin that provides this command.
753
:return: The name of the plugin or None if the command is builtin.
755
mod_parts = self.__module__.split('.')
756
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
762
class CommandHooks(Hooks):
763
"""Hooks related to Command object creation/enumeration."""
766
"""Create the default hooks.
768
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
773
"Called after creating a command object to allow modifications "
774
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
777
"Called when creating a single command. Called with "
778
"(cmd_or_None, command_name). get_command should either return "
779
"the cmd_or_None parameter, or a replacement Command object that "
780
"should be used for the command. Note that the Command.hooks "
781
"hooks are core infrastructure. Many users will prefer to use "
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
785
"Called when creating a single command if no command could be "
786
"found. Called with (command_name). get_missing_command should "
787
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
790
"Called when enumerating commands. Called with a set of "
791
"cmd_name strings for all the commands found so far. This set "
792
" is safe to mutate - e.g. to remove a command. "
793
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
802
Command.hooks = CommandHooks()
805
def parse_args(command, argv, alias_argv=None):
1674
from pprint import pprint
1675
for plugin in bzrlib.plugin.all_plugins:
1676
if hasattr(plugin, '__path__'):
1677
print plugin.__path__[0]
1682
print '\t', d.split('\n')[0]
1684
#pprint(bzrlib.plugin.all_plugins)
1688
# list of all available options; the rhs can be either None for an
1689
# option that takes no argument, or a constructor function that checks
1693
'diff-options': str,
1702
'revision': _parse_revision_str,
1714
'merge-type': get_merge_type,
1727
def parse_args(argv):
806
1728
"""Parse command line.
808
1730
Arguments and options are parsed at this level before being passed
809
1731
down to specific command handlers. This routine knows, from a
810
1732
lookup table, something about the available options, what optargs
811
1733
they take, and which commands will accept them.
1735
>>> parse_args('--help'.split())
1736
([], {'help': True})
1737
>>> parse_args('--version'.split())
1738
([], {'version': True})
1739
>>> parse_args('status --all'.split())
1740
(['status'], {'all': True})
1741
>>> parse_args('commit --message=biter'.split())
1742
(['commit'], {'message': u'biter'})
1743
>>> parse_args('log -r 500'.split())
1744
(['log'], {'revision': [500]})
1745
>>> parse_args('log -r500..600'.split())
1746
(['log'], {'revision': [500, 600]})
1747
>>> parse_args('log -vr500..600'.split())
1748
(['log'], {'verbose': True, 'revision': [500, 600]})
1749
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1750
(['log'], {'revision': ['v500', 600]})
813
# TODO: make it a method of the Command?
814
parser = option.get_optparser(command.options())
815
if alias_argv is not None:
816
args = alias_argv + argv
820
# for python 2.5 and later, optparse raises this exception if a non-ascii
821
# option name is given. See http://bugs.python.org/issue2931
823
options, args = parser.parse_args(args)
824
except UnicodeEncodeError,e:
825
raise errors.BzrCommandError(
826
gettext('Only ASCII permitted in option names'))
828
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
v is not option.OptionParser.DEFAULT_VALUE])
1755
# TODO: Maybe handle '--' to end options?
1760
# option names must not be unicode
1764
mutter(" got option %r" % a)
1766
optname, optarg = a[2:].split('=', 1)
1769
if optname not in OPTIONS:
1770
raise BzrError('unknown long option %r' % a)
1773
if shortopt in SHORT_OPTIONS:
1774
# Multi-character options must have a space to delimit
1776
optname = SHORT_OPTIONS[shortopt]
1778
# Single character short options, can be chained,
1779
# and have their value appended to their name
1781
if shortopt not in SHORT_OPTIONS:
1782
# We didn't find the multi-character name, and we
1783
# didn't find the single char name
1784
raise BzrError('unknown short option %r' % a)
1785
optname = SHORT_OPTIONS[shortopt]
1788
# There are extra things on this option
1789
# see if it is the value, or if it is another
1791
optargfn = OPTIONS[optname]
1792
if optargfn is None:
1793
# This option does not take an argument, so the
1794
# next entry is another short option, pack it back
1796
argv.insert(0, '-' + a[2:])
1798
# This option takes an argument, so pack it
1803
# XXX: Do we ever want to support this, e.g. for -r?
1804
raise BzrError('repeated option %r' % a)
1806
optargfn = OPTIONS[optname]
1810
raise BzrError('option %r needs an argument' % a)
1812
optarg = argv.pop(0)
1813
opts[optname] = optargfn(optarg)
1816
raise BzrError('option %r takes no argument' % optname)
1817
opts[optname] = True
830
1821
return args, opts
833
1826
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
