55
138
def _unsquish_command_name(cmd):
56
assert cmd.startswith("cmd_")
57
139
return cmd[4:].replace('_','-')
60
def _parse_revision_str(revstr):
61
"""This handles a revision string -> revno.
63
This always returns a list. The list will have one element for
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
68
>>> _parse_revision_str('234')
70
>>> _parse_revision_str('234..567')
72
>>> _parse_revision_str('..')
74
>>> _parse_revision_str('..234')
76
>>> _parse_revision_str('234..')
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
80
>>> _parse_revision_str('234....789') # Error?
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
98
>>> _parse_revision_str('-5')
100
>>> _parse_revision_str('123a')
102
>>> _parse_revision_str('abc')
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
109
warning('Colon separator for revision numbers is deprecated.'
112
for rev in revstr.split(':'):
114
revs.append(int(rev))
119
for x in revstr.split('..'):
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
134
return merge_types[typestring][0]
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
148
return merge_types[typestring][0]
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
159
def _get_cmd_dict(plugins_override=True):
161
for k, v in globals().iteritems():
162
if k.startswith("cmd_"):
163
d[_unsquish_command_name(k)] = v
164
# If we didn't load plugins, the plugin_cmds dict will be empty
142
def _builtin_commands():
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
150
if name.startswith("cmd_"):
151
real_name = _unsquish_command_name(name)
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
181
return _builtin_commands().keys()
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
return plugin_cmds.keys()
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
199
d = _builtin_commands()
165
200
if plugins_override:
166
d.update(plugin_cmds)
168
d2 = plugin_cmds.copy()
174
def get_all_cmds(plugins_override=True):
175
"""Return canonical name and class for all registered commands."""
176
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
180
def get_cmd_class(cmd, plugins_override=True):
181
"""Return the canonical name and command class for a command.
183
cmd = str(cmd) # not unicode
185
# first look up this command under the specified name
186
cmds = _get_cmd_dict(plugins_override=plugins_override)
188
return cmd, cmds[cmd]
206
def get_cmd_object(cmd_name, plugins_override=True):
207
"""Return the command object for a command.
210
If true, plugin commands can override builtins.
213
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
219
"""Get a command object.
221
:param cmd_name: The name of the command.
222
:param plugins_override: Allow plugins to override builtins.
223
:return: A Command object instance
224
:raises KeyError: If no command is found.
226
# We want only 'ascii' command names, but the user may have typed
227
# in a Unicode name. In that case, they should just get a
228
# 'command not found' error later.
229
# In the future, we may actually support Unicode command names.
232
for hook in Command.hooks['get_command']:
233
cmd = hook(cmd, cmd_name)
234
if cmd is not None and not plugins_override and not cmd.plugin_name():
235
# We've found a non-plugin command, don't permit it to be
239
for hook in Command.hooks['get_missing_command']:
246
# Allow plugins to extend commands
247
for hook in Command.hooks['extend_command']:
252
def _try_plugin_provider(cmd_name):
253
"""Probe for a plugin provider having cmd_name."""
255
plugin_metadata, provider = probe_for_provider(cmd_name)
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
262
def probe_for_provider(cmd_name):
263
"""Look for a provider for cmd_name.
265
:param cmd_name: The command name.
266
:return: plugin_metadata, provider for getting cmd_name.
267
:raises NoPluginAvailable: When no provider can supply the plugin.
269
# look for providers that provide this command but aren't installed
270
for provider in command_providers_registry:
272
return provider.plugin_for_command(cmd_name), provider
273
except errors.NoPluginAvailable:
275
raise errors.NoPluginAvailable(cmd_name)
278
def _get_bzr_command(cmd_or_None, cmd_name):
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
282
return cmds[cmd_name]()
192
285
# look for any command which claims this as an alias
193
for cmdname, cmdclass in cmds.iteritems():
194
if cmd in cmdclass.aliases:
195
return cmdname, cmdclass
197
cmdclass = ExternalCommand.find_command(cmd)
201
raise BzrCommandError("unknown command %r" % cmd)
286
for real_cmd_name, cmd_class in cmds.iteritems():
287
if cmd_name in cmd_class.aliases:
292
def _get_external_command(cmd_or_None, cmd_name):
293
"""Lookup a command that is a shell script."""
294
# Only do external command lookups when no command is found so far.
295
if cmd_or_None is not None:
297
from bzrlib.externalcommand import ExternalCommand
298
cmd_obj = ExternalCommand.find_command(cmd_name)
303
def _get_plugin_command(cmd_or_None, cmd_name):
304
"""Get a command from bzr's plugins."""
306
return plugin_cmds.get(cmd_name)()
309
for key in plugin_cmds.keys():
310
info = plugin_cmds.get_info(key)
311
if cmd_name in info.aliases:
312
return plugin_cmds.get(key)()
204
316
class Command(object):
205
317
"""Base class for commands.
319
Commands are the heart of the command-line bzr interface.
321
The command object mostly handles the mapping of command-line
322
parameters into one or more bzrlib operations, and of the results
325
Commands normally don't have any state. All their arguments are
326
passed in to the run method. (Subclasses may take a different
327
policy if the behaviour of the instance needs to depend on e.g. a
328
shell plugin and not just its Python class.)
207
330
The docstring for an actual command should give a single-line
208
331
summary, then a complete description of the command. A grammar
209
332
description will be inserted.
335
Other accepted names for this command.
212
338
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
216
List of options that may be given for this command.
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
219
If true, this command isn't advertised.
355
If true, this command isn't advertised. This is typically
356
for commands intended for expert users.
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
373
:cvar hooks: An instance of CommandHooks.
224
377
takes_options = []
378
encoding_type = 'strict'
228
def __init__(self, options, arguments):
229
"""Construct and run the command.
231
Sets self.status to the return value of run()."""
232
assert isinstance(options, dict)
233
assert isinstance(arguments, dict)
234
cmdargs = options.copy()
235
cmdargs.update(arguments)
383
"""Construct an instance of this command."""
236
384
if self.__doc__ == Command.__doc__:
237
from warnings import warn
238
385
warn("No help message set for %r" % self)
239
self.status = self.run(**cmdargs)
240
if self.status is None:
386
# List of standard options directly supported
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
"""Register a function to call after self.run returns or raises.
393
Functions will be called in LIFO order.
395
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
397
def cleanup_now(self):
398
"""Execute and empty pending cleanup functions immediately.
400
After cleanup_now all registered cleanups are forgotten. add_cleanup
401
may be called again after cleanup_now; these cleanups will be called
402
after self.run returns or raises (or when cleanup_now is next called).
404
This is useful for releasing expensive or contentious resources (such
405
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
424
"""Return single-line grammar for this command.
426
Only describes arguments, not options.
428
s = 'bzr ' + self.name() + ' '
429
for aname in self.takes_args:
430
aname = aname.upper()
431
if aname[-1] in ['$', '+']:
432
aname = aname[:-1] + '...'
433
elif aname[-1] == '?':
434
aname = '[' + aname[:-1] + ']'
435
elif aname[-1] == '*':
436
aname = '[' + aname[:-1] + '...]'
438
s = s[:-1] # remove last space
441
def get_help_text(self, additional_see_also=None, plain=True,
442
see_also_as_links=False, verbose=True):
443
"""Return a text string with help for this command.
445
:param additional_see_also: Additional help topics to be
447
:param plain: if False, raw help (reStructuredText) is
448
returned instead of plain text.
449
:param see_also_as_links: if True, convert items in 'See also'
450
list to internal links (used by bzr_man rstx generator)
451
:param verbose: if True, display the full help, otherwise
452
leave out the descriptive sections and just display
453
usage help (e.g. Purpose, Usage, Options) with a
454
message explaining how to obtain full help.
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
460
# Extract the summary (purpose) and sections out from the text
461
purpose,sections,order = self._get_help_parts(doc)
463
# If a custom usage section was provided, use it
464
if sections.has_key('Usage'):
465
usage = sections.pop('Usage')
467
usage = self._usage()
469
# The header is the purpose and usage
471
result += ':Purpose: %s\n' % purpose
472
if usage.find('\n') >= 0:
473
result += ':Usage:\n%s\n' % usage
475
result += ':Usage: %s\n' % usage
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
490
options = options.replace(' format:\n', ' format::\n\n', 1)
491
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
501
# Add the description, indenting it 2 spaces
502
# to match the indentation of the options
503
if sections.has_key(None):
504
text = sections.pop(None)
505
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
508
# Add the custom sections (e.g. Examples). Note that there's no need
509
# to indent these as they must be indented already in the source.
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
519
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
522
result += ', '.join(self.aliases) + '\n'
523
plugin_name = self.plugin_name()
524
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
526
see_also = self.get_see_also(additional_see_also)
528
if not plain and see_also_as_links:
530
for item in see_also:
532
# topics doesn't have an independent section
533
# so don't create a real link
534
see_also_links.append(item)
536
# Use a Sphinx link for this entry
537
link_text = ":doc:`%s <%s-help>`" % (item, item)
538
see_also_links.append(link_text)
539
see_also = see_also_links
540
result += ':See also: '
541
result += ', '.join(see_also) + '\n'
543
# If this will be rendered as plain text, convert it
545
import bzrlib.help_topics
546
result = bzrlib.help_topics.help_as_plain_text(result)
550
def _get_help_parts(text):
551
"""Split help text into a summary and named sections.
553
:return: (summary,sections,order) where summary is the top line and
554
sections is a dictionary of the rest indexed by section name.
555
order is the order the section appear in the text.
556
A section starts with a heading line of the form ":xxx:".
557
Indented text on following lines is the section value.
558
All text found outside a named section is assigned to the
559
default section which is given the key of None.
561
def save_section(sections, order, label, section):
563
if sections.has_key(label):
564
sections[label] += '\n' + section
567
sections[label] = section
569
lines = text.rstrip().splitlines()
570
summary = lines.pop(0)
573
label,section = None,''
575
if line.startswith(':') and line.endswith(':') and len(line) > 2:
576
save_section(sections, order, label, section)
577
label,section = line[1:-1],''
578
elif (label is not None) and len(line) > 1 and not line[0].isspace():
579
save_section(sections, order, label, section)
580
label,section = None,line
583
section += '\n' + line
586
save_section(sections, order, label, section)
587
return summary, sections, order
589
def get_help_topic(self):
590
"""Return the commands help topic - its name."""
593
def get_see_also(self, additional_terms=None):
594
"""Return a list of help topics that are related to this command.
596
The list is derived from the content of the _see_also attribute. Any
597
duplicates are removed and the result is in lexical order.
598
:param additional_terms: Additional help topics to cross-reference.
599
:return: A list of help topics.
601
see_also = set(getattr(self, '_see_also', []))
603
see_also.update(additional_terms)
604
return sorted(see_also)
607
"""Return dict of valid options for this command.
609
Maps from long option name to option object."""
610
r = Option.STD_OPTIONS.copy()
612
for o in self.takes_options:
613
if isinstance(o, basestring):
614
o = option.Option.OPTIONS[o]
616
if o.name in std_names:
617
self.supported_std_options.append(o.name)
620
def _setup_outf(self):
621
"""Return a file linked to stdout, which has proper encoding."""
622
self.outf = ui.ui_factory.make_output_stream(
623
encoding_type=self.encoding_type)
625
def run_argv_aliases(self, argv, alias_argv=None):
626
"""Parse the command line and run with extra aliases in alias_argv."""
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
629
DeprecationWarning, stacklevel=2)
631
args, opts = parse_args(self, argv, alias_argv)
633
# Process the standard options
634
if 'help' in opts: # e.g. bzr add --help
635
sys.stdout.write(self.get_help_text())
637
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
640
trace.set_verbosity_level(option._verbosity_level)
641
if 'verbose' in self.supported_std_options:
642
opts['verbose'] = trace.is_verbose()
643
elif opts.has_key('verbose'):
645
if 'quiet' in self.supported_std_options:
646
opts['quiet'] = trace.is_quiet()
647
elif opts.has_key('quiet'):
650
# mix arguments and options into one dictionary
651
cmdargs = _match_argform(self.name(), self.takes_args, args)
653
for k, v in opts.items():
654
cmdopts[k.replace('-', '_')] = v
656
all_cmd_args = cmdargs.copy()
657
all_cmd_args.update(cmdopts)
661
return self.run_direct(**all_cmd_args)
663
def run_direct(self, *args, **kwargs):
664
"""Call run directly with objects (without parsing an argv list)."""
665
return self._operation.run_simple(*args, **kwargs)
245
"""Override this in sub-classes.
668
"""Actually run the command.
247
670
This is invoked with the options and arguments bound to
248
671
keyword parameters.
250
Return 0 or None if the command was successful, or a shell
673
Return 0 or None if the command was successful, or a non-zero
674
shell error code if not. It's OK for this method to allow
675
an exception to raise up.
256
class ExternalCommand(Command):
257
"""Class to wrap external commands.
259
We cheat a little here, when get_cmd_class() calls us we actually
260
give it back an object we construct that has the appropriate path,
261
help, options etc for the specified command.
263
When run_bzr() tries to instantiate that 'class' it gets caught by
264
the __call__ method, which we override to call the Command.__init__
265
method. That then calls our run method which is pretty straight
268
The only wrinkle is that we have to map bzr's dictionary of options
269
and arguments back into command line options and arguments for the
273
def find_command(cls, cmd):
275
bzrpath = os.environ.get('BZRPATH', '')
277
for dir in bzrpath.split(os.pathsep):
278
path = os.path.join(dir, cmd)
279
if os.path.isfile(path):
280
return ExternalCommand(path)
284
find_command = classmethod(find_command)
286
def __init__(self, path):
289
pipe = os.popen('%s --bzr-usage' % path, 'r')
290
self.takes_options = pipe.readline().split()
292
for opt in self.takes_options:
293
if not opt in OPTIONS:
294
raise BzrError("Unknown option '%s' returned by external command %s"
297
# TODO: Is there any way to check takes_args is valid here?
298
self.takes_args = pipe.readline().split()
300
if pipe.close() is not None:
301
raise BzrError("Failed funning '%s --bzr-usage'" % path)
303
pipe = os.popen('%s --bzr-help' % path, 'r')
304
self.__doc__ = pipe.read()
305
if pipe.close() is not None:
306
raise BzrError("Failed funning '%s --bzr-help'" % path)
308
def __call__(self, options, arguments):
309
Command.__init__(self, options, arguments)
312
def run(self, **kargs):
319
optname = name.replace('_','-')
321
if OPTIONS.has_key(optname):
323
opts.append('--%s' % optname)
324
if value is not None and value is not True:
325
opts.append(str(value))
327
# it's an arg, or arg list
328
if type(value) is not list:
334
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
338
class cmd_status(Command):
339
"""Display status summary.
341
This reports on versioned and unknown files, reporting them
342
grouped by state. Possible states are:
345
Versioned in the working copy but not in the previous revision.
348
Versioned in the previous revision but removed or deleted
352
Path of this file changed from the previous revision;
353
the text may also have changed. This includes files whose
354
parent directory was renamed.
357
Text has changed since the previous revision.
360
Nothing about this file has changed since the previous revision.
361
Only shown with --all.
364
Not versioned and not matching an ignore pattern.
366
To see ignored files use 'bzr ignored'. For details in the
367
changes to file texts, use 'bzr diff'.
369
If no arguments are specified, the status of the entire working
370
directory is shown. Otherwise, only the status of the specified
371
files or directories is reported. If a directory is given, status
372
is reported for everything inside that directory.
374
If a revision is specified, the changes since that revision are shown.
376
takes_args = ['file*']
377
takes_options = ['all', 'show-ids', 'revision']
378
aliases = ['st', 'stat']
380
def run(self, all=False, show_ids=False, file_list=None):
382
b = find_branch(file_list[0])
383
file_list = [b.relpath(x) for x in file_list]
384
# special case: only one path was given and it's the root
386
if file_list == ['']:
391
from bzrlib.status import show_status
392
show_status(b, show_unchanged=all, show_ids=show_ids,
393
specific_files=file_list)
396
class cmd_cat_revision(Command):
397
"""Write out metadata for a revision."""
400
takes_args = ['revision_id']
402
def run(self, revision_id):
403
from bzrlib.xml import pack_xml
404
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
407
class cmd_revno(Command):
408
"""Show current revision number.
410
This is equal to the number of revisions on this branch."""
412
print find_branch('.').revno()
414
class cmd_revision_info(Command):
415
"""Show revision number and revision id for a given revision identifier.
418
takes_args = ['revision_info*']
419
takes_options = ['revision']
420
def run(self, revision=None, revision_info_list=None):
421
from bzrlib.branch import find_branch
424
if revision is not None:
425
revs.extend(revision)
426
if revision_info_list is not None:
427
revs.extend(revision_info_list)
429
raise BzrCommandError('You must supply a revision identifier')
434
print '%4d %s' % b.get_revision_info(rev)
437
class cmd_add(Command):
438
"""Add specified files or directories.
440
In non-recursive mode, all the named items are added, regardless
441
of whether they were previously ignored. A warning is given if
442
any of the named files are already versioned.
444
In recursive mode (the default), files are treated the same way
445
but the behaviour for directories is different. Directories that
446
are already versioned do not give a warning. All directories,
447
whether already versioned or not, are searched for files or
448
subdirectories that are neither versioned or ignored, and these
449
are added. This search proceeds recursively into versioned
450
directories. If no names are given '.' is assumed.
452
Therefore simply saying 'bzr add' will version all files that
453
are currently unknown.
455
TODO: Perhaps adding a file whose directly is not versioned should
456
recursively add that parent, rather than giving an error?
458
takes_args = ['file*']
459
takes_options = ['verbose', 'no-recurse']
461
def run(self, file_list, verbose=False, no_recurse=False):
462
from bzrlib.add import smart_add
463
smart_add(file_list, verbose, not no_recurse)
467
class cmd_mkdir(Command):
468
"""Create a new versioned directory.
470
This is equivalent to creating the directory and then adding it.
472
takes_args = ['dir+']
474
def run(self, dir_list):
481
b.add([d], verbose=True)
484
class cmd_relpath(Command):
485
"""Show path of a file relative to root"""
486
takes_args = ['filename']
489
def run(self, filename):
490
print find_branch(filename).relpath(filename)
494
class cmd_inventory(Command):
495
"""Show inventory of the current working copy or a revision."""
496
takes_options = ['revision', 'show-ids']
498
def run(self, revision=None, show_ids=False):
501
inv = b.read_working_inventory()
503
if len(revision) > 1:
504
raise BzrCommandError('bzr inventory --revision takes'
505
' exactly one revision identifier')
506
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
508
for path, entry in inv.entries():
510
print '%-50s %s' % (path, entry.file_id)
515
class cmd_move(Command):
516
"""Move files to a different directory.
521
The destination must be a versioned directory in the same branch.
523
takes_args = ['source$', 'dest']
524
def run(self, source_list, dest):
527
# TODO: glob expansion on windows?
528
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
531
class cmd_rename(Command):
532
"""Change the name of an entry.
535
bzr rename frob.c frobber.c
536
bzr rename src/frob.c lib/frob.c
538
It is an error if the destination name exists.
540
See also the 'move' command, which moves files into a different
541
directory without changing their name.
543
TODO: Some way to rename multiple files without invoking bzr for each
545
takes_args = ['from_name', 'to_name']
547
def run(self, from_name, to_name):
549
b.rename_one(b.relpath(from_name), b.relpath(to_name))
553
class cmd_mv(Command):
554
"""Move or rename a file.
557
bzr mv OLDNAME NEWNAME
558
bzr mv SOURCE... DESTINATION
560
If the last argument is a versioned directory, all the other names
561
are moved into it. Otherwise, there must be exactly two arguments
562
and the file is changed to a new name, which must not already exist.
564
Files cannot be moved between branches.
566
takes_args = ['names*']
567
def run(self, names_list):
568
if len(names_list) < 2:
569
raise BzrCommandError("missing file argument")
570
b = find_branch(names_list[0])
572
rel_names = [b.relpath(x) for x in names_list]
574
if os.path.isdir(names_list[-1]):
575
# move into existing directory
576
b.move(rel_names[:-1], rel_names[-1])
578
if len(names_list) != 2:
579
raise BzrCommandError('to mv multiple files the destination '
580
'must be a versioned directory')
581
b.move(rel_names[0], rel_names[1])
586
class cmd_pull(Command):
587
"""Pull any changes from another branch into the current one.
589
If the location is omitted, the last-used location will be used.
590
Both the revision history and the working directory will be
593
This command only works on branches that have not diverged. Branches are
594
considered diverged if both branches have had commits without first
595
pulling from the other.
597
If branches have diverged, you can use 'bzr merge' to pull the text changes
598
from one into the other.
600
takes_args = ['location?']
602
def run(self, location=None):
603
from bzrlib.merge import merge
605
from shutil import rmtree
608
br_to = find_branch('.')
611
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
613
if e.errno != errno.ENOENT:
616
if stored_loc is None:
617
raise BzrCommandError("No pull location known or specified.")
619
print "Using last location: %s" % stored_loc
620
location = stored_loc
621
cache_root = tempfile.mkdtemp()
622
from bzrlib.branch import DivergedBranches
623
br_from = find_branch(location)
624
location = pull_loc(br_from)
625
old_revno = br_to.revno()
627
from branch import find_cached_branch, DivergedBranches
628
br_from = find_cached_branch(location, cache_root)
629
location = pull_loc(br_from)
630
old_revno = br_to.revno()
632
br_to.update_revisions(br_from)
633
except DivergedBranches:
634
raise BzrCommandError("These branches have diverged."
637
merge(('.', -1), ('.', old_revno), check_clean=False)
638
if location != stored_loc:
639
br_to.controlfile("x-pull", "wb").write(location + "\n")
645
class cmd_branch(Command):
646
"""Create a new copy of a branch.
648
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
649
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
651
To retrieve the branch as of a particular revision, supply the --revision
652
parameter, as in "branch foo/bar -r 5".
654
takes_args = ['from_location', 'to_location?']
655
takes_options = ['revision']
656
aliases = ['get', 'clone']
658
def run(self, from_location, to_location=None, revision=None):
660
from bzrlib.merge import merge
661
from bzrlib.branch import DivergedBranches, \
662
find_cached_branch, Branch
663
from shutil import rmtree
664
from meta_store import CachedStore
666
cache_root = tempfile.mkdtemp()
670
elif len(revision) > 1:
671
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
675
br_from = find_cached_branch(from_location, cache_root)
677
if e.errno == errno.ENOENT:
678
raise BzrCommandError('Source location "%s" does not'
679
' exist.' % to_location)
683
if to_location is None:
684
to_location = os.path.basename(from_location.rstrip("/\\"))
687
os.mkdir(to_location)
689
if e.errno == errno.EEXIST:
690
raise BzrCommandError('Target directory "%s" already'
691
' exists.' % to_location)
692
if e.errno == errno.ENOENT:
693
raise BzrCommandError('Parent of "%s" does not exist.' %
697
br_to = Branch(to_location, init=True)
699
br_to.set_root_id(br_from.get_root_id())
702
if revision[0] is None:
703
revno = br_from.revno()
705
revno, rev_id = br_from.get_revision_info(revision[0])
707
br_to.update_revisions(br_from, stop_revision=revno)
708
except bzrlib.errors.NoSuchRevision:
710
msg = "The branch %s has no revision %d." % (from_location,
712
raise BzrCommandError(msg)
714
merge((to_location, -1), (to_location, 0), this_dir=to_location,
715
check_clean=False, ignore_zero=True)
716
from_location = pull_loc(br_from)
717
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
722
def pull_loc(branch):
723
# TODO: Should perhaps just make attribute be 'base' in
724
# RemoteBranch and Branch?
725
if hasattr(branch, "baseurl"):
726
return branch.baseurl
732
class cmd_renames(Command):
733
"""Show list of renamed files.
735
TODO: Option to show renames between two historical versions.
737
TODO: Only show renames under dir, rather than in the whole branch.
739
takes_args = ['dir?']
741
def run(self, dir='.'):
743
old_inv = b.basis_tree().inventory
744
new_inv = b.read_working_inventory()
746
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
748
for old_name, new_name in renames:
749
print "%s => %s" % (old_name, new_name)
752
class cmd_info(Command):
753
"""Show statistical information about a branch."""
754
takes_args = ['branch?']
756
def run(self, branch=None):
759
b = find_branch(branch)
763
class cmd_remove(Command):
764
"""Make a file unversioned.
766
This makes bzr stop tracking changes to a versioned file. It does
767
not delete the working copy.
769
takes_args = ['file+']
770
takes_options = ['verbose']
772
def run(self, file_list, verbose=False):
773
b = find_branch(file_list[0])
774
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
777
class cmd_file_id(Command):
778
"""Print file_id of a particular file or directory.
780
The file_id is assigned when the file is first added and remains the
781
same through all revisions where the file exists, even when it is
785
takes_args = ['filename']
786
def run(self, filename):
787
b = find_branch(filename)
788
i = b.inventory.path2id(b.relpath(filename))
790
raise BzrError("%r is not a versioned file" % filename)
795
class cmd_file_path(Command):
796
"""Print path of file_ids to a file or directory.
798
This prints one line for each directory down to the target,
799
starting at the branch root."""
801
takes_args = ['filename']
802
def run(self, filename):
803
b = find_branch(filename)
805
fid = inv.path2id(b.relpath(filename))
807
raise BzrError("%r is not a versioned file" % filename)
808
for fip in inv.get_idpath(fid):
812
class cmd_revision_history(Command):
813
"""Display list of revision ids on this branch."""
816
for patchid in find_branch('.').revision_history():
820
class cmd_directories(Command):
821
"""Display list of versioned directories in this branch."""
823
for name, ie in find_branch('.').read_working_inventory().directories():
830
class cmd_init(Command):
831
"""Make a directory into a versioned branch.
833
Use this to create an empty branch, or before importing an
836
Recipe for importing a tree of files:
841
bzr commit -m 'imported project'
844
from bzrlib.branch import Branch
845
Branch('.', init=True)
848
class cmd_diff(Command):
849
"""Show differences in working tree.
851
If files are listed, only the changes in those files are listed.
852
Otherwise, all changes for the tree are listed.
854
TODO: Allow diff across branches.
856
TODO: Option to use external diff command; could be GNU diff, wdiff,
859
TODO: Python difflib is not exactly the same as unidiff; should
860
either fix it up or prefer to use an external diff.
862
TODO: If a directory is given, diff everything under that.
864
TODO: Selected-file diff is inefficient and doesn't show you
867
TODO: This probably handles non-Unix newlines poorly.
875
takes_args = ['file*']
876
takes_options = ['revision', 'diff-options']
877
aliases = ['di', 'dif']
879
def run(self, revision=None, file_list=None, diff_options=None):
880
from bzrlib.diff import show_diff
883
b = find_branch(file_list[0])
884
file_list = [b.relpath(f) for f in file_list]
885
if file_list == ['']:
886
# just pointing to top-of-tree
891
if revision is not None:
892
if len(revision) == 1:
893
show_diff(b, revision[0], specific_files=file_list,
894
external_diff_options=diff_options)
895
elif len(revision) == 2:
896
show_diff(b, revision[0], specific_files=file_list,
897
external_diff_options=diff_options,
898
revision2=revision[1])
900
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
902
show_diff(b, None, specific_files=file_list,
903
external_diff_options=diff_options)
908
class cmd_deleted(Command):
909
"""List files deleted in the working tree.
911
TODO: Show files deleted since a previous revision, or between two revisions.
913
def run(self, show_ids=False):
916
new = b.working_tree()
918
## TODO: Much more efficient way to do this: read in new
919
## directories with readdir, rather than stating each one. Same
920
## level of effort but possibly much less IO. (Or possibly not,
921
## if the directories are very large...)
923
for path, ie in old.inventory.iter_entries():
924
if not new.has_id(ie.file_id):
926
print '%-50s %s' % (path, ie.file_id)
931
class cmd_modified(Command):
932
"""List files modified in working tree."""
935
from bzrlib.delta import compare_trees
938
td = compare_trees(b.basis_tree(), b.working_tree())
940
for path, id, kind in td.modified:
945
class cmd_added(Command):
946
"""List files added in working tree."""
950
wt = b.working_tree()
951
basis_inv = b.basis_tree().inventory
954
if file_id in basis_inv:
956
path = inv.id2path(file_id)
957
if not os.access(b.abspath(path), os.F_OK):
963
class cmd_root(Command):
964
"""Show the tree root directory.
966
The root is the nearest enclosing directory with a .bzr control
968
takes_args = ['filename?']
969
def run(self, filename=None):
970
"""Print the branch root."""
971
b = find_branch(filename)
972
print getattr(b, 'base', None) or getattr(b, 'baseurl')
975
class cmd_log(Command):
976
"""Show log of this branch.
978
To request a range of logs, you can use the command -r begin:end
979
-r revision requests a specific revision, -r :end or -r begin: are
982
--message allows you to give a regular expression, which will be evaluated
983
so that only matching entries will be displayed.
985
TODO: Make --revision support uuid: and hash: [future tag:] notation.
989
takes_args = ['filename?']
990
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
'long', 'message', 'short',]
993
def run(self, filename=None, timezone='original',
1001
from bzrlib.branch import find_branch
1002
from bzrlib.log import log_formatter, show_log
1005
direction = (forward and 'forward') or 'reverse'
1008
b = find_branch(filename)
1009
fp = b.relpath(filename)
1011
file_id = b.read_working_inventory().path2id(fp)
1013
file_id = None # points to branch root
1015
b = find_branch('.')
1018
if revision is None:
1021
elif len(revision) == 1:
1022
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1023
elif len(revision) == 2:
1024
rev1 = b.get_revision_info(revision[0])[0]
1025
rev2 = b.get_revision_info(revision[1])[0]
1027
raise BzrCommandError('bzr log --revision takes one or two values.')
1034
mutter('encoding log as %r' % bzrlib.user_encoding)
1036
# use 'replace' so that we don't abort if trying to write out
1037
# in e.g. the default C locale.
1038
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1043
log_format = 'short'
1044
lf = log_formatter(log_format,
1047
show_timezone=timezone)
1053
direction=direction,
1054
start_revision=rev1,
1060
class cmd_touching_revisions(Command):
1061
"""Return revision-ids which affected a particular file.
1063
A more user-friendly interface is "bzr log FILE"."""
1065
takes_args = ["filename"]
1066
def run(self, filename):
1067
b = find_branch(filename)
1068
inv = b.read_working_inventory()
1069
file_id = inv.path2id(b.relpath(filename))
1070
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1071
print "%6d %s" % (revno, what)
1074
class cmd_ls(Command):
1075
"""List files in a tree.
1077
TODO: Take a revision or remote path and list that tree instead.
1080
def run(self, revision=None, verbose=False):
1081
b = find_branch('.')
1082
if revision == None:
1083
tree = b.working_tree()
1085
tree = b.revision_tree(b.lookup_revision(revision))
1087
for fp, fc, kind, fid in tree.list_files():
1089
if kind == 'directory':
1091
elif kind == 'file':
1096
print '%-8s %s%s' % (fc, fp, kindch)
1102
class cmd_unknowns(Command):
1103
"""List unknown files."""
1105
from bzrlib.osutils import quotefn
1106
for f in find_branch('.').unknowns():
1111
class cmd_ignore(Command):
1112
"""Ignore a command or pattern.
1114
To remove patterns from the ignore list, edit the .bzrignore file.
1116
If the pattern contains a slash, it is compared to the whole path
1117
from the branch root. Otherwise, it is comapred to only the last
1118
component of the path.
1120
Ignore patterns are case-insensitive on case-insensitive systems.
1122
Note: wildcards must be quoted from the shell on Unix.
1125
bzr ignore ./Makefile
1126
bzr ignore '*.class'
1128
takes_args = ['name_pattern']
1130
def run(self, name_pattern):
1131
from bzrlib.atomicfile import AtomicFile
1134
b = find_branch('.')
1135
ifn = b.abspath('.bzrignore')
1137
if os.path.exists(ifn):
1140
igns = f.read().decode('utf-8')
1146
# TODO: If the file already uses crlf-style termination, maybe
1147
# we should use that for the newly added lines?
1149
if igns and igns[-1] != '\n':
1151
igns += name_pattern + '\n'
1154
f = AtomicFile(ifn, 'wt')
1155
f.write(igns.encode('utf-8'))
1160
inv = b.working_tree().inventory
1161
if inv.path2id('.bzrignore'):
1162
mutter('.bzrignore is already versioned')
1164
mutter('need to make new .bzrignore file versioned')
1165
b.add(['.bzrignore'])
1169
class cmd_ignored(Command):
1170
"""List ignored files and the patterns that matched them.
1172
See also: bzr ignore"""
1174
tree = find_branch('.').working_tree()
1175
for path, file_class, kind, file_id in tree.list_files():
1176
if file_class != 'I':
1178
## XXX: Slightly inefficient since this was already calculated
1179
pat = tree.is_ignored(path)
1180
print '%-50s %s' % (path, pat)
1183
class cmd_lookup_revision(Command):
1184
"""Lookup the revision-id from a revision-number
1187
bzr lookup-revision 33
1190
takes_args = ['revno']
1192
def run(self, revno):
1196
raise BzrCommandError("not a valid revision-number: %r" % revno)
1198
print find_branch('.').lookup_revision(revno)
1201
class cmd_export(Command):
1202
"""Export past revision to destination directory.
1204
If no revision is specified this exports the last committed revision.
1206
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1207
given, try to find the format with the extension. If no extension
1208
is found exports to a directory (equivalent to --format=dir).
1210
Root may be the top directory for tar, tgz and tbz2 formats. If none
1211
is given, the top directory will be the root name of the file."""
1212
# TODO: list known exporters
1213
takes_args = ['dest']
1214
takes_options = ['revision', 'format', 'root']
1215
def run(self, dest, revision=None, format=None, root=None):
1217
b = find_branch('.')
1218
if revision is None:
1219
rev_id = b.last_patch()
1221
if len(revision) != 1:
1222
raise BzrError('bzr export --revision takes exactly 1 argument')
1223
revno, rev_id = b.get_revision_info(revision[0])
1224
t = b.revision_tree(rev_id)
1225
root, ext = os.path.splitext(dest)
1227
if ext in (".tar",):
1229
elif ext in (".gz", ".tgz"):
1231
elif ext in (".bz2", ".tbz2"):
1235
t.export(dest, format, root)
1238
class cmd_cat(Command):
1239
"""Write a file's text from a previous revision."""
1241
takes_options = ['revision']
1242
takes_args = ['filename']
1244
def run(self, filename, revision=None):
1245
if revision == None:
1246
raise BzrCommandError("bzr cat requires a revision number")
1247
elif len(revision) != 1:
1248
raise BzrCommandError("bzr cat --revision takes exactly one number")
1249
b = find_branch('.')
1250
b.print_file(b.relpath(filename), revision[0])
1253
class cmd_local_time_offset(Command):
1254
"""Show the offset in seconds from GMT to local time."""
1257
print bzrlib.osutils.local_time_offset()
1261
class cmd_commit(Command):
1262
"""Commit changes into a new revision.
1264
If no arguments are given, the entire tree is committed.
1266
If selected files are specified, only changes to those files are
1267
committed. If a directory is specified then the directory and everything
1268
within it is committed.
1270
A selected-file commit may fail in some cases where the committed
1271
tree would be invalid, such as trying to commit a file in a
1272
newly-added directory that is not itself committed.
1274
TODO: Run hooks on tree to-be-committed, and after commit.
1276
TODO: Strict commit that fails if there are unknown or deleted files.
1278
takes_args = ['selected*']
1279
takes_options = ['message', 'file', 'verbose', 'unchanged']
1280
aliases = ['ci', 'checkin']
1282
# TODO: Give better message for -s, --summary, used by tla people
1284
def run(self, message=None, file=None, verbose=True, selected_list=None,
1286
from bzrlib.errors import PointlessCommit
1287
from bzrlib.osutils import get_text_message
1289
## Warning: shadows builtin file()
1290
if not message and not file:
1291
# FIXME: Ugly; change status code to send to a provided function?
1295
catcher = cStringIO.StringIO()
1296
sys.stdout = catcher
1297
cmd_status({"file_list":selected_list}, {})
1298
info = catcher.getvalue()
1300
message = get_text_message(info)
1303
raise BzrCommandError("please specify a commit message",
1304
["use either --message or --file"])
1305
elif message and file:
1306
raise BzrCommandError("please specify either --message or --file")
1310
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1312
b = find_branch('.')
1314
selected_list = [b.relpath(s) for s in selected_list]
1317
b.commit(message, verbose=verbose,
1318
specific_files=selected_list,
1319
allow_pointless=unchanged)
1320
except PointlessCommit:
1321
# FIXME: This should really happen before the file is read in;
1322
# perhaps prepare the commit; get the message; then actually commit
1323
raise BzrCommandError("no changes to commit",
1324
["use --unchanged to commit anyhow"])
1327
class cmd_check(Command):
1328
"""Validate consistency of branch history.
1330
This command checks various invariants about the branch storage to
1331
detect data corruption or bzr bugs.
1333
If given the --update flag, it will update some optional fields
1334
to help ensure data consistency.
1336
takes_args = ['dir?']
1338
def run(self, dir='.'):
1339
from bzrlib.check import check
1340
check(find_branch(dir))
1344
class cmd_scan_cache(Command):
1347
from bzrlib.hashcache import HashCache
1354
print '%6d stats' % c.stat_count
1355
print '%6d in hashcache' % len(c._cache)
1356
print '%6d files removed from cache' % c.removed_count
1357
print '%6d hashes updated' % c.update_count
1358
print '%6d files changed too recently to cache' % c.danger_count
1365
class cmd_upgrade(Command):
1366
"""Upgrade branch storage to current format.
1368
This should normally be used only after the check command tells
1371
takes_args = ['dir?']
1373
def run(self, dir='.'):
1374
from bzrlib.upgrade import upgrade
1375
upgrade(find_branch(dir))
1379
class cmd_whoami(Command):
1380
"""Show bzr user id."""
1381
takes_options = ['email']
1383
def run(self, email=False):
1385
print bzrlib.osutils.user_email()
1387
print bzrlib.osutils.username()
1390
class cmd_selftest(Command):
1391
"""Run internal test suite"""
1393
takes_options = ['verbose']
1394
def run(self, verbose=False):
1395
from bzrlib.selftest import selftest
1396
return int(not selftest(verbose=verbose))
1399
class cmd_version(Command):
1400
"""Show version of bzr."""
1405
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1406
# is bzrlib itself in a branch?
1407
bzrrev = bzrlib.get_bzr_revision()
1409
print " (bzr checkout, revision %d {%s})" % bzrrev
1410
print bzrlib.__copyright__
1411
print "http://bazaar-ng.org/"
1413
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1414
print "you may use, modify and redistribute it under the terms of the GNU"
1415
print "General Public License version 2 or later."
1418
class cmd_rocks(Command):
1419
"""Statement of optimism."""
1422
print "it sure does!"
1424
def parse_spec(spec):
1426
>>> parse_spec(None)
1428
>>> parse_spec("./")
1430
>>> parse_spec("../@")
1432
>>> parse_spec("../f/@35")
1434
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1435
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1440
parsed = spec.split('/@')
1441
assert len(parsed) == 2
1446
parsed[1] = int(parsed[1])
1448
pass # We can allow stuff like ./@revid:blahblahblah
1450
assert parsed[1] >=0
1452
parsed = [spec, None]
1457
class cmd_merge(Command):
1458
"""Perform a three-way merge of trees.
1460
The SPEC parameters are working tree or revision specifiers. Working trees
1461
are specified using standard paths or urls. No component of a directory
1462
path may begin with '@'.
1464
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1466
Revisions are specified using a dirname/@revno pair, where dirname is the
1467
branch directory and revno is the revision within that branch. If no revno
1468
is specified, the latest revision is used.
1470
Revision examples: './@127', 'foo/@', '../@1'
1472
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1473
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1476
merge refuses to run if there are any uncommitted changes, unless
1479
takes_args = ['other_spec', 'base_spec?']
1480
takes_options = ['force', 'merge-type']
1482
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1483
from bzrlib.merge import merge
1484
from bzrlib.merge_core import ApplyMerge3
1485
if merge_type is None:
1486
merge_type = ApplyMerge3
1487
merge(parse_spec(other_spec), parse_spec(base_spec),
1488
check_clean=(not force), merge_type=merge_type)
1491
class cmd_revert(Command):
1492
"""Reverse all changes since the last commit.
1494
Only versioned files are affected. Specify filenames to revert only
1495
those files. By default, any files that are changed will be backed up
1496
first. Backup files have a '~' appended to their name.
1498
takes_options = ['revision', 'no-backup']
1499
takes_args = ['file*']
1500
aliases = ['merge-revert']
1502
def run(self, revision=None, no_backup=False, file_list=None):
1503
from bzrlib.merge import merge
1504
if file_list is not None:
1505
if len(file_list) == 0:
1506
raise BzrCommandError("No files specified")
1507
if revision is None:
1509
elif len(revision) != 1:
1510
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1511
merge(('.', revision[0]), parse_spec('.'),
1514
backup_files=not no_backup,
1515
file_list=file_list)
1518
class cmd_assert_fail(Command):
1519
"""Test reporting of assertion failures"""
1522
assert False, "always fails"
1525
class cmd_help(Command):
1526
"""Show help on a command or other topic.
1528
For a list of all available commands, say 'bzr help commands'."""
1529
takes_args = ['topic?']
1532
def run(self, topic=None):
1539
class cmd_missing(Command):
1540
"""What is missing in this branch relative to other branch.
1542
takes_args = ['remote?']
1543
aliases = ['mis', 'miss']
1544
# We don't have to add quiet to the list, because
1545
# unknown options are parsed as booleans
1546
takes_options = ['verbose', 'quiet']
1548
def run(self, remote=None, verbose=False, quiet=False):
1549
from bzrlib.branch import find_branch, DivergedBranches
1550
from bzrlib.errors import BzrCommandError
1551
from bzrlib.missing import get_parent, show_missing
1553
if verbose and quiet:
1554
raise BzrCommandError('Cannot pass both quiet and verbose')
1556
b = find_branch('.')
1557
parent = get_parent(b)
1560
raise BzrCommandError("No missing location known or specified.")
1563
print "Using last location: %s" % parent
1565
elif parent is None:
1566
# We only update x-pull if it did not exist, missing should not change the parent
1567
b.controlfile('x-pull', 'wb').write(remote + '\n')
1568
br_remote = find_branch(remote)
1570
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1573
class cmd_plugins(Command):
1577
import bzrlib.plugin
677
raise NotImplementedError('no implementation of command %r'
681
"""Return help message for this class."""
1578
682
from inspect import getdoc
1579
from pprint import pprint
1580
for plugin in bzrlib.plugin.all_plugins:
1581
print plugin.__path__[0]
1584
print '\t', d.split('\n')[0]
1586
#pprint(bzrlib.plugin.all_plugins)
1590
# list of all available options; the rhs can be either None for an
1591
# option that takes no argument, or a constructor function that checks
1595
'diff-options': str,
1604
'revision': _parse_revision_str,
1616
'merge-type': get_merge_type,
1629
def parse_args(argv):
683
if self.__doc__ is Command.__doc__:
688
return _unsquish_command_name(self.__class__.__name__)
690
def plugin_name(self):
691
"""Get the name of the plugin that provides this command.
693
:return: The name of the plugin or None if the command is builtin.
695
mod_parts = self.__module__.split('.')
696
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
702
class CommandHooks(Hooks):
703
"""Hooks related to Command object creation/enumeration."""
706
"""Create the default hooks.
708
These are all empty initially, because by default nothing should get
712
self.create_hook(HookPoint('extend_command',
713
"Called after creating a command object to allow modifications "
714
"such as adding or removing options, docs etc. Called with the "
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
717
"Called when creating a single command. Called with "
718
"(cmd_or_None, command_name). get_command should either return "
719
"the cmd_or_None parameter, or a replacement Command object that "
720
"should be used for the command. Note that the Command.hooks "
721
"hooks are core infrastructure. Many users will prefer to use "
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
725
"Called when creating a single command if no command could be "
726
"found. Called with (command_name). get_missing_command should "
727
"either return None, or a Command object to be used for the "
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
730
"Called when enumerating commands. Called with a set of "
731
"cmd_name strings for all the commands found so far. This set "
732
" is safe to mutate - e.g. to remove a command. "
733
"list_commands should return the updated set of command names.",
736
Command.hooks = CommandHooks()
739
def parse_args(command, argv, alias_argv=None):
1630
740
"""Parse command line.
1632
742
Arguments and options are parsed at this level before being passed
1633
743
down to specific command handlers. This routine knows, from a
1634
744
lookup table, something about the available options, what optargs
1635
745
they take, and which commands will accept them.
1637
>>> parse_args('--help'.split())
1638
([], {'help': True})
1639
>>> parse_args('--version'.split())
1640
([], {'version': True})
1641
>>> parse_args('status --all'.split())
1642
(['status'], {'all': True})
1643
>>> parse_args('commit --message=biter'.split())
1644
(['commit'], {'message': u'biter'})
1645
>>> parse_args('log -r 500'.split())
1646
(['log'], {'revision': [500]})
1647
>>> parse_args('log -r500..600'.split())
1648
(['log'], {'revision': [500, 600]})
1649
>>> parse_args('log -vr500..600'.split())
1650
(['log'], {'verbose': True, 'revision': [500, 600]})
1651
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1652
(['log'], {'revision': ['v500', 600]})
1657
# TODO: Maybe handle '--' to end options?
1662
# option names must not be unicode
1666
mutter(" got option %r" % a)
1668
optname, optarg = a[2:].split('=', 1)
1671
if optname not in OPTIONS:
1672
raise BzrError('unknown long option %r' % a)
1675
if shortopt in SHORT_OPTIONS:
1676
# Multi-character options must have a space to delimit
1678
optname = SHORT_OPTIONS[shortopt]
1680
# Single character short options, can be chained,
1681
# and have their value appended to their name
1683
if shortopt not in SHORT_OPTIONS:
1684
# We didn't find the multi-character name, and we
1685
# didn't find the single char name
1686
raise BzrError('unknown short option %r' % a)
1687
optname = SHORT_OPTIONS[shortopt]
1690
# There are extra things on this option
1691
# see if it is the value, or if it is another
1693
optargfn = OPTIONS[optname]
1694
if optargfn is None:
1695
# This option does not take an argument, so the
1696
# next entry is another short option, pack it back
1698
argv.insert(0, '-' + a[2:])
1700
# This option takes an argument, so pack it
1705
# XXX: Do we ever want to support this, e.g. for -r?
1706
raise BzrError('repeated option %r' % a)
1708
optargfn = OPTIONS[optname]
1712
raise BzrError('option %r needs an argument' % a)
1714
optarg = argv.pop(0)
1715
opts[optname] = optargfn(optarg)
1718
raise BzrError('option %r takes no argument' % optname)
1719
opts[optname] = True
747
# TODO: make it a method of the Command?
748
parser = option.get_optparser(command.options())
749
if alias_argv is not None:
750
args = alias_argv + argv
754
options, args = parser.parse_args(args)
755
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
756
v is not option.OptionParser.DEFAULT_VALUE])
1723
757
return args, opts
1728
760
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
