55
136
def _unsquish_command_name(cmd):
56
assert cmd.startswith("cmd_")
57
137
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)
145
def _get_cmd_dict(plugins_override=True):
147
for k, v in globals().iteritems():
148
if k.startswith("cmd_"):
149
d[_unsquish_command_name(k)] = v
150
# If we didn't load plugins, the plugin_cmds dict will be empty
140
def _builtin_commands():
141
import bzrlib.builtins
142
return _scan_module_for_commands(bzrlib.builtins)
145
def _scan_module_for_commands(module):
147
for name, obj in module.__dict__.iteritems():
148
if name.startswith("cmd_"):
149
real_name = _unsquish_command_name(name)
154
def _list_bzr_commands(names):
155
"""Find commands from bzr's core and plugins."""
156
# to eliminate duplicates
157
names.update(builtin_command_names())
158
names.update(plugin_command_names())
162
def all_command_names():
163
"""Return a set of all command names."""
165
for hook in Command.hooks['list_commands']:
168
raise AssertionError(
169
'hook %s returned None' % Command.hooks.get_hook_name(hook))
173
def builtin_command_names():
174
"""Return list of builtin command names.
176
Use of all_command_names() is encouraged rather than builtin_command_names
177
and/or plugin_command_names.
179
return _builtin_commands().keys()
182
def plugin_command_names():
183
"""Returns command names from commands registered by plugins."""
184
return plugin_cmds.keys()
187
@deprecated_function(deprecated_in((1, 17, 0)))
188
def get_all_cmds(plugins_override=False):
189
"""Return canonical name and class for most commands.
191
NB: This does not return all commands since the introduction of
192
command hooks, and returning the class is not sufficient to
193
get correctly setup commands, which is why it is deprecated.
195
Use 'all_command_names' + 'get_cmd_object' instead.
197
d = _builtin_commands()
151
198
if plugins_override:
152
d.update(plugin_cmds)
154
d2 = plugin_cmds.copy()
160
def get_all_cmds(plugins_override=True):
161
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
199
d.update(plugin_cmds.iteritems())
200
for k, v in d.iteritems():
166
def get_cmd_class(cmd, plugins_override=True):
167
"""Return the canonical name and command class for a command.
169
cmd = str(cmd) # not unicode
171
# first look up this command under the specified name
172
cmds = _get_cmd_dict(plugins_override=plugins_override)
174
return cmd, cmds[cmd]
204
def get_cmd_object(cmd_name, plugins_override=True):
205
"""Return the command object for a command.
208
If true, plugin commands can override builtins.
211
return _get_cmd_object(cmd_name, plugins_override)
213
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
216
def _get_cmd_object(cmd_name, plugins_override=True):
217
"""Get a command object.
219
:param cmd_name: The name of the command.
220
:param plugins_override: Allow plugins to override builtins.
221
:return: A Command object instance
222
:raises KeyError: If no command is found.
224
# We want only 'ascii' command names, but the user may have typed
225
# in a Unicode name. In that case, they should just get a
226
# 'command not found' error later.
227
# In the future, we may actually support Unicode command names.
230
for hook in Command.hooks['get_command']:
231
cmd = hook(cmd, cmd_name)
232
if cmd is not None and not plugins_override and not cmd.plugin_name():
233
# We've found a non-plugin command, don't permit it to be
237
for hook in Command.hooks['get_missing_command']:
244
# Allow plugins to extend commands
245
for hook in Command.hooks['extend_command']:
250
def _try_plugin_provider(cmd_name):
251
"""Probe for a plugin provider having cmd_name."""
253
plugin_metadata, provider = probe_for_provider(cmd_name)
254
raise errors.CommandAvailableInPlugin(cmd_name,
255
plugin_metadata, provider)
256
except errors.NoPluginAvailable:
260
def probe_for_provider(cmd_name):
261
"""Look for a provider for cmd_name.
263
:param cmd_name: The command name.
264
:return: plugin_metadata, provider for getting cmd_name.
265
:raises NoPluginAvailable: When no provider can supply the plugin.
267
# look for providers that provide this command but aren't installed
268
for provider in command_providers_registry:
270
return provider.plugin_for_command(cmd_name), provider
271
except errors.NoPluginAvailable:
273
raise errors.NoPluginAvailable(cmd_name)
276
def _get_bzr_command(cmd_or_None, cmd_name):
277
"""Get a command from bzr's core."""
278
cmds = _builtin_commands()
280
return cmds[cmd_name]()
178
283
# look for any command which claims this as an alias
179
for cmdname, cmdclass in cmds.iteritems():
180
if cmd in cmdclass.aliases:
181
return cmdname, cmdclass
183
cmdclass = ExternalCommand.find_command(cmd)
187
raise BzrCommandError("unknown command %r" % cmd)
284
for real_cmd_name, cmd_class in cmds.iteritems():
285
if cmd_name in cmd_class.aliases:
290
def _get_external_command(cmd_or_None, cmd_name):
291
"""Lookup a command that is a shell script."""
292
# Only do external command lookups when no command is found so far.
293
if cmd_or_None is not None:
295
from bzrlib.externalcommand import ExternalCommand
296
cmd_obj = ExternalCommand.find_command(cmd_name)
301
def _get_plugin_command(cmd_or_None, cmd_name):
302
"""Get a command from bzr's plugins."""
304
return plugin_cmds.get(cmd_name)()
307
for key in plugin_cmds.keys():
308
info = plugin_cmds.get_info(key)
309
if cmd_name in info.aliases:
310
return plugin_cmds.get(key)()
190
314
class Command(object):
191
315
"""Base class for commands.
317
Commands are the heart of the command-line bzr interface.
319
The command object mostly handles the mapping of command-line
320
parameters into one or more bzrlib operations, and of the results
323
Commands normally don't have any state. All their arguments are
324
passed in to the run method. (Subclasses may take a different
325
policy if the behaviour of the instance needs to depend on e.g. a
326
shell plugin and not just its Python class.)
193
328
The docstring for an actual command should give a single-line
194
329
summary, then a complete description of the command. A grammar
195
330
description will be inserted.
333
Other accepted names for this command.
198
336
List of argument forms, marked with whether they are optional,
341
['to_location', 'from_branch?', 'file*']
343
'to_location' is required
344
'from_branch' is optional
345
'file' can be specified 0 or more times
202
List of options that may be given for this command.
348
List of options that may be given for this command. These can
349
be either strings, referring to globally-defined options,
350
or option objects. Retrieve through options().
205
If true, this command isn't advertised.
353
If true, this command isn't advertised. This is typically
354
for commands intended for expert users.
357
Command objects will get a 'outf' attribute, which has been
358
setup to properly handle encoding of unicode strings.
359
encoding_type determines what will happen when characters cannot
361
strict - abort if we cannot decode
362
replace - put in a bogus character (typically '?')
363
exact - do not encode sys.stdout
365
NOTE: by default on Windows, sys.stdout is opened as a text
366
stream, therefore LF line-endings are converted to CRLF.
367
When a command uses encoding_type = 'exact', then
368
sys.stdout is forced to be a binary stream, and line-endings
371
:cvar hooks: An instance of CommandHooks.
210
375
takes_options = []
376
encoding_type = 'strict'
214
def __init__(self, options, arguments):
215
"""Construct and run the command.
217
Sets self.status to the return value of run()."""
218
assert isinstance(options, dict)
219
assert isinstance(arguments, dict)
220
cmdargs = options.copy()
221
cmdargs.update(arguments)
381
"""Construct an instance of this command."""
222
382
if self.__doc__ == Command.__doc__:
223
from warnings import warn
224
383
warn("No help message set for %r" % self)
225
self.status = self.run(**cmdargs)
226
if self.status is None:
384
# List of standard options directly supported
385
self.supported_std_options = []
387
@deprecated_method(deprecated_in((2, 1, 0)))
388
def _maybe_expand_globs(self, file_list):
389
"""Glob expand file_list if the platform does not do that itself.
391
Not used anymore, now that the bzr command-line parser globs on
394
:return: A possibly empty list of unicode paths.
396
Introduced in bzrlib 0.18.
401
"""Return single-line grammar for this command.
403
Only describes arguments, not options.
405
s = 'bzr ' + self.name() + ' '
406
for aname in self.takes_args:
407
aname = aname.upper()
408
if aname[-1] in ['$', '+']:
409
aname = aname[:-1] + '...'
410
elif aname[-1] == '?':
411
aname = '[' + aname[:-1] + ']'
412
elif aname[-1] == '*':
413
aname = '[' + aname[:-1] + '...]'
415
s = s[:-1] # remove last space
418
def get_help_text(self, additional_see_also=None, plain=True,
419
see_also_as_links=False, verbose=True):
420
"""Return a text string with help for this command.
422
:param additional_see_also: Additional help topics to be
424
:param plain: if False, raw help (reStructuredText) is
425
returned instead of plain text.
426
:param see_also_as_links: if True, convert items in 'See also'
427
list to internal links (used by bzr_man rstx generator)
428
:param verbose: if True, display the full help, otherwise
429
leave out the descriptive sections and just display
430
usage help (e.g. Purpose, Usage, Options) with a
431
message explaining how to obtain full help.
435
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
437
# Extract the summary (purpose) and sections out from the text
438
purpose,sections,order = self._get_help_parts(doc)
440
# If a custom usage section was provided, use it
441
if sections.has_key('Usage'):
442
usage = sections.pop('Usage')
444
usage = self._usage()
446
# The header is the purpose and usage
448
result += ':Purpose: %s\n' % purpose
449
if usage.find('\n') >= 0:
450
result += ':Usage:\n%s\n' % usage
452
result += ':Usage: %s\n' % usage
457
# XXX: optparse implicitly rewraps the help, and not always perfectly,
458
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
460
options = option.get_optparser(self.options()).format_option_help()
461
# XXX: According to the spec, ReST option lists actually don't support
462
# options like --1.9 so that causes syntax errors (in Sphinx at least).
463
# As that pattern always appears in the commands that break, we trap
464
# on that and then format that block of 'format' options as a literal
466
if not plain and options.find(' --1.9 ') != -1:
467
options = options.replace(' format:\n', ' format::\n\n', 1)
468
if options.startswith('Options:'):
469
result += ':' + options
470
elif options.startswith('options:'):
471
# Python 2.4 version of optparse
472
result += ':Options:' + options[len('options:'):]
478
# Add the description, indenting it 2 spaces
479
# to match the indentation of the options
480
if sections.has_key(None):
481
text = sections.pop(None)
482
text = '\n '.join(text.splitlines())
483
result += ':%s:\n %s\n\n' % ('Description',text)
485
# Add the custom sections (e.g. Examples). Note that there's no need
486
# to indent these as they must be indented already in the source.
489
if sections.has_key(label):
490
result += ':%s:\n%s\n' % (label,sections[label])
493
result += ("See bzr help %s for more details and examples.\n\n"
496
# Add the aliases, source (plug-in) and see also links, if any
498
result += ':Aliases: '
499
result += ', '.join(self.aliases) + '\n'
500
plugin_name = self.plugin_name()
501
if plugin_name is not None:
502
result += ':From: plugin "%s"\n' % plugin_name
503
see_also = self.get_see_also(additional_see_also)
505
if not plain and see_also_as_links:
507
for item in see_also:
509
# topics doesn't have an independent section
510
# so don't create a real link
511
see_also_links.append(item)
513
# Use a reST link for this entry
514
see_also_links.append("`%s`_" % (item,))
515
see_also = see_also_links
516
result += ':See also: '
517
result += ', '.join(see_also) + '\n'
519
# If this will be rendered as plain text, convert it
521
import bzrlib.help_topics
522
result = bzrlib.help_topics.help_as_plain_text(result)
526
def _get_help_parts(text):
527
"""Split help text into a summary and named sections.
529
:return: (summary,sections,order) where summary is the top line and
530
sections is a dictionary of the rest indexed by section name.
531
order is the order the section appear in the text.
532
A section starts with a heading line of the form ":xxx:".
533
Indented text on following lines is the section value.
534
All text found outside a named section is assigned to the
535
default section which is given the key of None.
537
def save_section(sections, order, label, section):
539
if sections.has_key(label):
540
sections[label] += '\n' + section
543
sections[label] = section
545
lines = text.rstrip().splitlines()
546
summary = lines.pop(0)
549
label,section = None,''
551
if line.startswith(':') and line.endswith(':') and len(line) > 2:
552
save_section(sections, order, label, section)
553
label,section = line[1:-1],''
554
elif (label is not None) and len(line) > 1 and not line[0].isspace():
555
save_section(sections, order, label, section)
556
label,section = None,line
559
section += '\n' + line
562
save_section(sections, order, label, section)
563
return summary, sections, order
565
def get_help_topic(self):
566
"""Return the commands help topic - its name."""
569
def get_see_also(self, additional_terms=None):
570
"""Return a list of help topics that are related to this command.
572
The list is derived from the content of the _see_also attribute. Any
573
duplicates are removed and the result is in lexical order.
574
:param additional_terms: Additional help topics to cross-reference.
575
:return: A list of help topics.
577
see_also = set(getattr(self, '_see_also', []))
579
see_also.update(additional_terms)
580
return sorted(see_also)
583
"""Return dict of valid options for this command.
585
Maps from long option name to option object."""
586
r = Option.STD_OPTIONS.copy()
588
for o in self.takes_options:
589
if isinstance(o, basestring):
590
o = option.Option.OPTIONS[o]
592
if o.name in std_names:
593
self.supported_std_options.append(o.name)
596
def _setup_outf(self):
597
"""Return a file linked to stdout, which has proper encoding."""
598
# Originally I was using self.stdout, but that looks
599
# *way* too much like sys.stdout
600
if self.encoding_type == 'exact':
601
# force sys.stdout to be binary stream on win32
602
if sys.platform == 'win32':
603
fileno = getattr(sys.stdout, 'fileno', None)
606
msvcrt.setmode(fileno(), os.O_BINARY)
607
self.outf = sys.stdout
610
output_encoding = osutils.get_terminal_encoding()
612
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
613
errors=self.encoding_type)
614
# For whatever reason codecs.getwriter() does not advertise its encoding
615
# it just returns the encoding of the wrapped file, which is completely
616
# bogus. So set the attribute, so we can find the correct encoding later.
617
self.outf.encoding = output_encoding
619
def run_argv_aliases(self, argv, alias_argv=None):
620
"""Parse the command line and run with extra aliases in alias_argv."""
622
warn("Passing None for [] is deprecated from bzrlib 0.10",
623
DeprecationWarning, stacklevel=2)
625
args, opts = parse_args(self, argv, alias_argv)
627
# Process the standard options
628
if 'help' in opts: # e.g. bzr add --help
629
sys.stdout.write(self.get_help_text())
631
if 'usage' in opts: # e.g. bzr add --usage
632
sys.stdout.write(self.get_help_text(verbose=False))
634
trace.set_verbosity_level(option._verbosity_level)
635
if 'verbose' in self.supported_std_options:
636
opts['verbose'] = trace.is_verbose()
637
elif opts.has_key('verbose'):
639
if 'quiet' in self.supported_std_options:
640
opts['quiet'] = trace.is_quiet()
641
elif opts.has_key('quiet'):
644
# mix arguments and options into one dictionary
645
cmdargs = _match_argform(self.name(), self.takes_args, args)
647
for k, v in opts.items():
648
cmdopts[k.replace('-', '_')] = v
650
all_cmd_args = cmdargs.copy()
651
all_cmd_args.update(cmdopts)
655
return self.run(**all_cmd_args)
231
"""Override this in sub-classes.
658
"""Actually run the command.
233
660
This is invoked with the options and arguments bound to
234
661
keyword parameters.
236
Return 0 or None if the command was successful, or a shell
663
Return 0 or None if the command was successful, or a non-zero
664
shell error code if not. It's OK for this method to allow
665
an exception to raise up.
242
class ExternalCommand(Command):
243
"""Class to wrap external commands.
245
We cheat a little here, when get_cmd_class() calls us we actually
246
give it back an object we construct that has the appropriate path,
247
help, options etc for the specified command.
249
When run_bzr() tries to instantiate that 'class' it gets caught by
250
the __call__ method, which we override to call the Command.__init__
251
method. That then calls our run method which is pretty straight
254
The only wrinkle is that we have to map bzr's dictionary of options
255
and arguments back into command line options and arguments for the
259
def find_command(cls, cmd):
261
bzrpath = os.environ.get('BZRPATH', '')
263
for dir in bzrpath.split(os.pathsep):
264
path = os.path.join(dir, cmd)
265
if os.path.isfile(path):
266
return ExternalCommand(path)
270
find_command = classmethod(find_command)
272
def __init__(self, path):
275
pipe = os.popen('%s --bzr-usage' % path, 'r')
276
self.takes_options = pipe.readline().split()
278
for opt in self.takes_options:
279
if not opt in OPTIONS:
280
raise BzrError("Unknown option '%s' returned by external command %s"
283
# TODO: Is there any way to check takes_args is valid here?
284
self.takes_args = pipe.readline().split()
286
if pipe.close() is not None:
287
raise BzrError("Failed funning '%s --bzr-usage'" % path)
289
pipe = os.popen('%s --bzr-help' % path, 'r')
290
self.__doc__ = pipe.read()
291
if pipe.close() is not None:
292
raise BzrError("Failed funning '%s --bzr-help'" % path)
294
def __call__(self, options, arguments):
295
Command.__init__(self, options, arguments)
298
def run(self, **kargs):
305
optname = name.replace('_','-')
307
if OPTIONS.has_key(optname):
309
opts.append('--%s' % optname)
310
if value is not None and value is not True:
311
opts.append(str(value))
313
# it's an arg, or arg list
314
if type(value) is not list:
320
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
324
class cmd_status(Command):
325
"""Display status summary.
327
This reports on versioned and unknown files, reporting them
328
grouped by state. Possible states are:
331
Versioned in the working copy but not in the previous revision.
334
Versioned in the previous revision but removed or deleted
338
Path of this file changed from the previous revision;
339
the text may also have changed. This includes files whose
340
parent directory was renamed.
343
Text has changed since the previous revision.
346
Nothing about this file has changed since the previous revision.
347
Only shown with --all.
350
Not versioned and not matching an ignore pattern.
352
To see ignored files use 'bzr ignored'. For details in the
353
changes to file texts, use 'bzr diff'.
355
If no arguments are specified, the status of the entire working
356
directory is shown. Otherwise, only the status of the specified
357
files or directories is reported. If a directory is given, status
358
is reported for everything inside that directory.
360
If a revision is specified, the changes since that revision are shown.
362
takes_args = ['file*']
363
takes_options = ['all', 'show-ids', 'revision']
364
aliases = ['st', 'stat']
366
def run(self, all=False, show_ids=False, file_list=None):
368
b = find_branch(file_list[0])
369
file_list = [b.relpath(x) for x in file_list]
370
# special case: only one path was given and it's the root
372
if file_list == ['']:
377
from bzrlib.status import show_status
378
show_status(b, show_unchanged=all, show_ids=show_ids,
379
specific_files=file_list)
382
class cmd_cat_revision(Command):
383
"""Write out metadata for a revision."""
386
takes_args = ['revision_id']
388
def run(self, revision_id):
389
from bzrlib.xml import pack_xml
390
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
393
class cmd_revno(Command):
394
"""Show current revision number.
396
This is equal to the number of revisions on this branch."""
398
print find_branch('.').revno()
400
class cmd_revision_info(Command):
401
"""Show revision number and revision id for a given revision identifier.
404
takes_args = ['revision_info*']
405
takes_options = ['revision']
406
def run(self, revision=None, revision_info_list=None):
407
from bzrlib.branch import find_branch
410
if revision is not None:
411
revs.extend(revision)
412
if revision_info_list is not None:
413
revs.extend(revision_info_list)
415
raise BzrCommandError('You must supply a revision identifier')
420
print '%4d %s' % b.get_revision_info(rev)
423
class cmd_add(Command):
424
"""Add specified files or directories.
426
In non-recursive mode, all the named items are added, regardless
427
of whether they were previously ignored. A warning is given if
428
any of the named files are already versioned.
430
In recursive mode (the default), files are treated the same way
431
but the behaviour for directories is different. Directories that
432
are already versioned do not give a warning. All directories,
433
whether already versioned or not, are searched for files or
434
subdirectories that are neither versioned or ignored, and these
435
are added. This search proceeds recursively into versioned
436
directories. If no names are given '.' is assumed.
438
Therefore simply saying 'bzr add' will version all files that
439
are currently unknown.
441
TODO: Perhaps adding a file whose directly is not versioned should
442
recursively add that parent, rather than giving an error?
444
takes_args = ['file*']
445
takes_options = ['verbose', 'no-recurse']
447
def run(self, file_list, verbose=False, no_recurse=False):
448
from bzrlib.add import smart_add
449
smart_add(file_list, verbose, not no_recurse)
453
class cmd_mkdir(Command):
454
"""Create a new versioned directory.
456
This is equivalent to creating the directory and then adding it.
458
takes_args = ['dir+']
460
def run(self, dir_list):
467
b.add([d], verbose=True)
470
class cmd_relpath(Command):
471
"""Show path of a file relative to root"""
472
takes_args = ['filename']
475
def run(self, filename):
476
print find_branch(filename).relpath(filename)
480
class cmd_inventory(Command):
481
"""Show inventory of the current working copy or a revision."""
482
takes_options = ['revision', 'show-ids']
484
def run(self, revision=None, show_ids=False):
487
inv = b.read_working_inventory()
489
if len(revision) > 1:
490
raise BzrCommandError('bzr inventory --revision takes'
491
' exactly one revision identifier')
492
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
494
for path, entry in inv.entries():
496
print '%-50s %s' % (path, entry.file_id)
501
class cmd_move(Command):
502
"""Move files to a different directory.
507
The destination must be a versioned directory in the same branch.
509
takes_args = ['source$', 'dest']
510
def run(self, source_list, dest):
513
# TODO: glob expansion on windows?
514
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
517
class cmd_rename(Command):
518
"""Change the name of an entry.
521
bzr rename frob.c frobber.c
522
bzr rename src/frob.c lib/frob.c
524
It is an error if the destination name exists.
526
See also the 'move' command, which moves files into a different
527
directory without changing their name.
529
TODO: Some way to rename multiple files without invoking bzr for each
531
takes_args = ['from_name', 'to_name']
533
def run(self, from_name, to_name):
535
b.rename_one(b.relpath(from_name), b.relpath(to_name))
539
class cmd_mv(Command):
540
"""Move or rename a file.
543
bzr mv OLDNAME NEWNAME
544
bzr mv SOURCE... DESTINATION
546
If the last argument is a versioned directory, all the other names
547
are moved into it. Otherwise, there must be exactly two arguments
548
and the file is changed to a new name, which must not already exist.
550
Files cannot be moved between branches.
552
takes_args = ['names*']
553
def run(self, names_list):
554
if len(names_list) < 2:
555
raise BzrCommandError("missing file argument")
556
b = find_branch(names_list[0])
558
rel_names = [b.relpath(x) for x in names_list]
560
if os.path.isdir(names_list[-1]):
561
# move into existing directory
562
b.move(rel_names[:-1], rel_names[-1])
564
if len(names_list) != 2:
565
raise BzrCommandError('to mv multiple files the destination '
566
'must be a versioned directory')
567
b.move(rel_names[0], rel_names[1])
572
class cmd_pull(Command):
573
"""Pull any changes from another branch into the current one.
575
If the location is omitted, the last-used location will be used.
576
Both the revision history and the working directory will be
579
This command only works on branches that have not diverged. Branches are
580
considered diverged if both branches have had commits without first
581
pulling from the other.
583
If branches have diverged, you can use 'bzr merge' to pull the text changes
584
from one into the other.
586
takes_args = ['location?']
588
def run(self, location=None):
589
from bzrlib.merge import merge
591
from shutil import rmtree
594
br_to = find_branch('.')
597
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
599
if e.errno != errno.ENOENT:
602
if stored_loc is None:
603
raise BzrCommandError("No pull location known or specified.")
605
print "Using last location: %s" % stored_loc
606
location = stored_loc
607
cache_root = tempfile.mkdtemp()
608
from bzrlib.branch import DivergedBranches
609
br_from = find_branch(location)
610
location = pull_loc(br_from)
611
old_revno = br_to.revno()
613
from branch import find_cached_branch, DivergedBranches
614
br_from = find_cached_branch(location, cache_root)
615
location = pull_loc(br_from)
616
old_revno = br_to.revno()
618
br_to.update_revisions(br_from)
619
except DivergedBranches:
620
raise BzrCommandError("These branches have diverged."
623
merge(('.', -1), ('.', old_revno), check_clean=False)
624
if location != stored_loc:
625
br_to.controlfile("x-pull", "wb").write(location + "\n")
631
class cmd_branch(Command):
632
"""Create a new copy of a branch.
634
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
635
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
637
To retrieve the branch as of a particular revision, supply the --revision
638
parameter, as in "branch foo/bar -r 5".
640
takes_args = ['from_location', 'to_location?']
641
takes_options = ['revision']
642
aliases = ['get', 'clone']
644
def run(self, from_location, to_location=None, revision=None):
646
from bzrlib.merge import merge
647
from bzrlib.branch import DivergedBranches, \
648
find_cached_branch, Branch
649
from shutil import rmtree
650
from meta_store import CachedStore
652
cache_root = tempfile.mkdtemp()
656
elif len(revision) > 1:
657
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
661
br_from = find_cached_branch(from_location, cache_root)
663
if e.errno == errno.ENOENT:
664
raise BzrCommandError('Source location "%s" does not'
665
' exist.' % to_location)
669
if to_location is None:
670
to_location = os.path.basename(from_location.rstrip("/\\"))
673
os.mkdir(to_location)
675
if e.errno == errno.EEXIST:
676
raise BzrCommandError('Target directory "%s" already'
677
' exists.' % to_location)
678
if e.errno == errno.ENOENT:
679
raise BzrCommandError('Parent of "%s" does not exist.' %
683
br_to = Branch(to_location, init=True)
685
br_to.set_root_id(br_from.get_root_id())
688
if revision[0] is None:
689
revno = br_from.revno()
691
revno, rev_id = br_from.get_revision_info(revision[0])
693
br_to.update_revisions(br_from, stop_revision=revno)
694
except bzrlib.errors.NoSuchRevision:
696
msg = "The branch %s has no revision %d." % (from_location,
698
raise BzrCommandError(msg)
700
merge((to_location, -1), (to_location, 0), this_dir=to_location,
701
check_clean=False, ignore_zero=True)
702
from_location = pull_loc(br_from)
703
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
708
def pull_loc(branch):
709
# TODO: Should perhaps just make attribute be 'base' in
710
# RemoteBranch and Branch?
711
if hasattr(branch, "baseurl"):
712
return branch.baseurl
718
class cmd_renames(Command):
719
"""Show list of renamed files.
721
TODO: Option to show renames between two historical versions.
723
TODO: Only show renames under dir, rather than in the whole branch.
725
takes_args = ['dir?']
727
def run(self, dir='.'):
729
old_inv = b.basis_tree().inventory
730
new_inv = b.read_working_inventory()
732
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
734
for old_name, new_name in renames:
735
print "%s => %s" % (old_name, new_name)
738
class cmd_info(Command):
739
"""Show statistical information about a branch."""
740
takes_args = ['branch?']
742
def run(self, branch=None):
745
b = find_branch(branch)
749
class cmd_remove(Command):
750
"""Make a file unversioned.
752
This makes bzr stop tracking changes to a versioned file. It does
753
not delete the working copy.
755
takes_args = ['file+']
756
takes_options = ['verbose']
758
def run(self, file_list, verbose=False):
759
b = find_branch(file_list[0])
760
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
763
class cmd_file_id(Command):
764
"""Print file_id of a particular file or directory.
766
The file_id is assigned when the file is first added and remains the
767
same through all revisions where the file exists, even when it is
771
takes_args = ['filename']
772
def run(self, filename):
773
b = find_branch(filename)
774
i = b.inventory.path2id(b.relpath(filename))
776
raise BzrError("%r is not a versioned file" % filename)
781
class cmd_file_path(Command):
782
"""Print path of file_ids to a file or directory.
784
This prints one line for each directory down to the target,
785
starting at the branch root."""
787
takes_args = ['filename']
788
def run(self, filename):
789
b = find_branch(filename)
791
fid = inv.path2id(b.relpath(filename))
793
raise BzrError("%r is not a versioned file" % filename)
794
for fip in inv.get_idpath(fid):
798
class cmd_revision_history(Command):
799
"""Display list of revision ids on this branch."""
802
for patchid in find_branch('.').revision_history():
806
class cmd_directories(Command):
807
"""Display list of versioned directories in this branch."""
809
for name, ie in find_branch('.').read_working_inventory().directories():
816
class cmd_init(Command):
817
"""Make a directory into a versioned branch.
819
Use this to create an empty branch, or before importing an
822
Recipe for importing a tree of files:
827
bzr commit -m 'imported project'
830
from bzrlib.branch import Branch
831
Branch('.', init=True)
834
class cmd_diff(Command):
835
"""Show differences in working tree.
837
If files are listed, only the changes in those files are listed.
838
Otherwise, all changes for the tree are listed.
840
TODO: Given two revision arguments, show the difference between them.
842
TODO: Allow diff across branches.
844
TODO: Option to use external diff command; could be GNU diff, wdiff,
847
TODO: Python difflib is not exactly the same as unidiff; should
848
either fix it up or prefer to use an external diff.
850
TODO: If a directory is given, diff everything under that.
852
TODO: Selected-file diff is inefficient and doesn't show you
855
TODO: This probably handles non-Unix newlines poorly.
858
takes_args = ['file*']
859
takes_options = ['revision', 'diff-options']
860
aliases = ['di', 'dif']
862
def run(self, revision=None, file_list=None, diff_options=None):
863
from bzrlib.diff import show_diff
866
b = find_branch(file_list[0])
867
file_list = [b.relpath(f) for f in file_list]
868
if file_list == ['']:
869
# just pointing to top-of-tree
874
# TODO: Make show_diff support taking 2 arguments
876
if revision is not None:
877
if len(revision) != 1:
878
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
879
base_rev = revision[0]
881
show_diff(b, base_rev, specific_files=file_list,
882
external_diff_options=diff_options)
888
class cmd_deleted(Command):
889
"""List files deleted in the working tree.
891
TODO: Show files deleted since a previous revision, or between two revisions.
893
def run(self, show_ids=False):
896
new = b.working_tree()
898
## TODO: Much more efficient way to do this: read in new
899
## directories with readdir, rather than stating each one. Same
900
## level of effort but possibly much less IO. (Or possibly not,
901
## if the directories are very large...)
903
for path, ie in old.inventory.iter_entries():
904
if not new.has_id(ie.file_id):
906
print '%-50s %s' % (path, ie.file_id)
911
class cmd_modified(Command):
912
"""List files modified in working tree."""
915
from bzrlib.delta import compare_trees
918
td = compare_trees(b.basis_tree(), b.working_tree())
920
for path, id, kind in td.modified:
925
class cmd_added(Command):
926
"""List files added in working tree."""
930
wt = b.working_tree()
931
basis_inv = b.basis_tree().inventory
934
if file_id in basis_inv:
936
path = inv.id2path(file_id)
937
if not os.access(b.abspath(path), os.F_OK):
943
class cmd_root(Command):
944
"""Show the tree root directory.
946
The root is the nearest enclosing directory with a .bzr control
948
takes_args = ['filename?']
949
def run(self, filename=None):
950
"""Print the branch root."""
951
b = find_branch(filename)
952
print getattr(b, 'base', None) or getattr(b, 'baseurl')
955
class cmd_log(Command):
956
"""Show log of this branch.
958
To request a range of logs, you can use the command -r begin:end
959
-r revision requests a specific revision, -r :end or -r begin: are
962
--message allows you to give a regular expression, which will be evaluated
963
so that only matching entries will be displayed.
965
TODO: Make --revision support uuid: and hash: [future tag:] notation.
969
takes_args = ['filename?']
970
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
972
def run(self, filename=None, timezone='original',
979
from bzrlib.branch import find_branch
980
from bzrlib.log import log_formatter, show_log
983
direction = (forward and 'forward') or 'reverse'
986
b = find_branch(filename)
987
fp = b.relpath(filename)
989
file_id = b.read_working_inventory().path2id(fp)
991
file_id = None # points to branch root
999
elif len(revision) == 1:
1000
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1001
elif len(revision) == 2:
1002
rev1 = b.get_revision_info(revision[0])[0]
1003
rev2 = b.get_revision_info(revision[1])[0]
1005
raise BzrCommandError('bzr log --revision takes one or two values.')
1012
mutter('encoding log as %r' % bzrlib.user_encoding)
1014
# use 'replace' so that we don't abort if trying to write out
1015
# in e.g. the default C locale.
1016
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1021
log_format = 'short'
1022
lf = log_formatter(log_format,
1025
show_timezone=timezone)
1031
direction=direction,
1032
start_revision=rev1,
1038
class cmd_touching_revisions(Command):
1039
"""Return revision-ids which affected a particular file.
1041
A more user-friendly interface is "bzr log FILE"."""
1043
takes_args = ["filename"]
1044
def run(self, filename):
1045
b = find_branch(filename)
1046
inv = b.read_working_inventory()
1047
file_id = inv.path2id(b.relpath(filename))
1048
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1049
print "%6d %s" % (revno, what)
1052
class cmd_ls(Command):
1053
"""List files in a tree.
1055
TODO: Take a revision or remote path and list that tree instead.
1058
def run(self, revision=None, verbose=False):
1059
b = find_branch('.')
1060
if revision == None:
1061
tree = b.working_tree()
1063
tree = b.revision_tree(b.lookup_revision(revision))
1065
for fp, fc, kind, fid in tree.list_files():
1067
if kind == 'directory':
1069
elif kind == 'file':
1074
print '%-8s %s%s' % (fc, fp, kindch)
1080
class cmd_unknowns(Command):
1081
"""List unknown files."""
1083
from bzrlib.osutils import quotefn
1084
for f in find_branch('.').unknowns():
1089
class cmd_ignore(Command):
1090
"""Ignore a command or pattern.
1092
To remove patterns from the ignore list, edit the .bzrignore file.
1094
If the pattern contains a slash, it is compared to the whole path
1095
from the branch root. Otherwise, it is comapred to only the last
1096
component of the path.
1098
Ignore patterns are case-insensitive on case-insensitive systems.
1100
Note: wildcards must be quoted from the shell on Unix.
1103
bzr ignore ./Makefile
1104
bzr ignore '*.class'
1106
takes_args = ['name_pattern']
1108
def run(self, name_pattern):
1109
from bzrlib.atomicfile import AtomicFile
1112
b = find_branch('.')
1113
ifn = b.abspath('.bzrignore')
1115
if os.path.exists(ifn):
1118
igns = f.read().decode('utf-8')
1124
# TODO: If the file already uses crlf-style termination, maybe
1125
# we should use that for the newly added lines?
1127
if igns and igns[-1] != '\n':
1129
igns += name_pattern + '\n'
1132
f = AtomicFile(ifn, 'wt')
1133
f.write(igns.encode('utf-8'))
1138
inv = b.working_tree().inventory
1139
if inv.path2id('.bzrignore'):
1140
mutter('.bzrignore is already versioned')
1142
mutter('need to make new .bzrignore file versioned')
1143
b.add(['.bzrignore'])
1147
class cmd_ignored(Command):
1148
"""List ignored files and the patterns that matched them.
1150
See also: bzr ignore"""
1152
tree = find_branch('.').working_tree()
1153
for path, file_class, kind, file_id in tree.list_files():
1154
if file_class != 'I':
1156
## XXX: Slightly inefficient since this was already calculated
1157
pat = tree.is_ignored(path)
1158
print '%-50s %s' % (path, pat)
1161
class cmd_lookup_revision(Command):
1162
"""Lookup the revision-id from a revision-number
1165
bzr lookup-revision 33
1168
takes_args = ['revno']
1170
def run(self, revno):
1174
raise BzrCommandError("not a valid revision-number: %r" % revno)
1176
print find_branch('.').lookup_revision(revno)
1179
class cmd_export(Command):
1180
"""Export past revision to destination directory.
1182
If no revision is specified this exports the last committed revision.
1184
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1185
given, try to find the format with the extension. If no extension
1186
is found exports to a directory (equivalent to --format=dir).
1188
Root may be the top directory for tar, tgz and tbz2 formats. If none
1189
is given, the top directory will be the root name of the file."""
1190
# TODO: list known exporters
1191
takes_args = ['dest']
1192
takes_options = ['revision', 'format', 'root']
1193
def run(self, dest, revision=None, format=None, root=None):
1195
b = find_branch('.')
1196
if revision is None:
1197
rev_id = b.last_patch()
1199
if len(revision) != 1:
1200
raise BzrError('bzr export --revision takes exactly 1 argument')
1201
revno, rev_id = b.get_revision_info(revision[0])
1202
t = b.revision_tree(rev_id)
1203
root, ext = os.path.splitext(dest)
1205
if ext in (".tar",):
1207
elif ext in (".gz", ".tgz"):
1209
elif ext in (".bz2", ".tbz2"):
1213
t.export(dest, format, root)
1216
class cmd_cat(Command):
1217
"""Write a file's text from a previous revision."""
1219
takes_options = ['revision']
1220
takes_args = ['filename']
1222
def run(self, filename, revision=None):
1223
if revision == None:
1224
raise BzrCommandError("bzr cat requires a revision number")
1225
elif len(revision) != 1:
1226
raise BzrCommandError("bzr cat --revision takes exactly one number")
1227
b = find_branch('.')
1228
b.print_file(b.relpath(filename), revision[0])
1231
class cmd_local_time_offset(Command):
1232
"""Show the offset in seconds from GMT to local time."""
1235
print bzrlib.osutils.local_time_offset()
1239
class cmd_commit(Command):
1240
"""Commit changes into a new revision.
1242
If no arguments are given, the entire tree is committed.
1244
If selected files are specified, only changes to those files are
1245
committed. If a directory is specified then the directory and everything
1246
within it is committed.
1248
A selected-file commit may fail in some cases where the committed
1249
tree would be invalid, such as trying to commit a file in a
1250
newly-added directory that is not itself committed.
1252
TODO: Run hooks on tree to-be-committed, and after commit.
1254
TODO: Strict commit that fails if there are unknown or deleted files.
1256
takes_args = ['selected*']
1257
takes_options = ['message', 'file', 'verbose', 'unchanged']
1258
aliases = ['ci', 'checkin']
1260
# TODO: Give better message for -s, --summary, used by tla people
1262
def run(self, message=None, file=None, verbose=True, selected_list=None,
1264
from bzrlib.errors import PointlessCommit
1265
from bzrlib.osutils import get_text_message
1267
## Warning: shadows builtin file()
1268
if not message and not file:
1269
# FIXME: Ugly; change status code to send to a provided function?
1273
catcher = cStringIO.StringIO()
1274
sys.stdout = catcher
1275
cmd_status({"file_list":selected_list}, {})
1276
info = catcher.getvalue()
1278
message = get_text_message(info)
1281
raise BzrCommandError("please specify a commit message",
1282
["use either --message or --file"])
1283
elif message and file:
1284
raise BzrCommandError("please specify either --message or --file")
1288
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1290
b = find_branch('.')
1292
selected_list = [b.relpath(s) for s in selected_list]
1295
b.commit(message, verbose=verbose,
1296
specific_files=selected_list,
1297
allow_pointless=unchanged)
1298
except PointlessCommit:
1299
# FIXME: This should really happen before the file is read in;
1300
# perhaps prepare the commit; get the message; then actually commit
1301
raise BzrCommandError("no changes to commit",
1302
["use --unchanged to commit anyhow"])
1305
class cmd_check(Command):
1306
"""Validate consistency of branch history.
1308
This command checks various invariants about the branch storage to
1309
detect data corruption or bzr bugs.
1311
If given the --update flag, it will update some optional fields
1312
to help ensure data consistency.
1314
takes_args = ['dir?']
1316
def run(self, dir='.'):
1317
from bzrlib.check import check
1318
check(find_branch(dir))
1322
class cmd_scan_cache(Command):
1325
from bzrlib.hashcache import HashCache
1332
print '%6d stats' % c.stat_count
1333
print '%6d in hashcache' % len(c._cache)
1334
print '%6d files removed from cache' % c.removed_count
1335
print '%6d hashes updated' % c.update_count
1336
print '%6d files changed too recently to cache' % c.danger_count
1343
class cmd_upgrade(Command):
1344
"""Upgrade branch storage to current format.
1346
This should normally be used only after the check command tells
1349
takes_args = ['dir?']
1351
def run(self, dir='.'):
1352
from bzrlib.upgrade import upgrade
1353
upgrade(find_branch(dir))
1357
class cmd_whoami(Command):
1358
"""Show bzr user id."""
1359
takes_options = ['email']
1361
def run(self, email=False):
1363
print bzrlib.osutils.user_email()
1365
print bzrlib.osutils.username()
1368
class cmd_selftest(Command):
1369
"""Run internal test suite"""
1371
takes_options = ['verbose']
1372
def run(self, verbose=False):
1373
from bzrlib.selftest import selftest
1374
return int(not selftest(verbose=verbose))
1377
class cmd_version(Command):
1378
"""Show version of bzr."""
1383
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1384
# is bzrlib itself in a branch?
1385
bzrrev = bzrlib.get_bzr_revision()
1387
print " (bzr checkout, revision %d {%s})" % bzrrev
1388
print bzrlib.__copyright__
1389
print "http://bazaar-ng.org/"
1391
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1392
print "you may use, modify and redistribute it under the terms of the GNU"
1393
print "General Public License version 2 or later."
1396
class cmd_rocks(Command):
1397
"""Statement of optimism."""
1400
print "it sure does!"
1402
def parse_spec(spec):
1404
>>> parse_spec(None)
1406
>>> parse_spec("./")
1408
>>> parse_spec("../@")
1410
>>> parse_spec("../f/@35")
1412
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1413
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1418
parsed = spec.split('/@')
1419
assert len(parsed) == 2
1424
parsed[1] = int(parsed[1])
1426
pass # We can allow stuff like ./@revid:blahblahblah
1428
assert parsed[1] >=0
1430
parsed = [spec, None]
1435
class cmd_merge(Command):
1436
"""Perform a three-way merge of trees.
1438
The SPEC parameters are working tree or revision specifiers. Working trees
1439
are specified using standard paths or urls. No component of a directory
1440
path may begin with '@'.
1442
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1444
Revisions are specified using a dirname/@revno pair, where dirname is the
1445
branch directory and revno is the revision within that branch. If no revno
1446
is specified, the latest revision is used.
1448
Revision examples: './@127', 'foo/@', '../@1'
1450
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1451
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1454
merge refuses to run if there are any uncommitted changes, unless
1457
takes_args = ['other_spec', 'base_spec?']
1458
takes_options = ['force', 'merge-type']
1460
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1461
from bzrlib.merge import merge
1462
from bzrlib.merge_core import ApplyMerge3
1463
if merge_type is None:
1464
merge_type = ApplyMerge3
1465
merge(parse_spec(other_spec), parse_spec(base_spec),
1466
check_clean=(not force), merge_type=merge_type)
1469
class cmd_revert(Command):
1470
"""Reverse all changes since the last commit.
1472
Only versioned files are affected. Specify filenames to revert only
1473
those files. By default, any files that are changed will be backed up
1474
first. Backup files have a '~' appended to their name.
1476
takes_options = ['revision', 'no-backup']
1477
takes_args = ['file*']
1478
aliases = ['merge-revert']
1480
def run(self, revision=None, no_backup=False, file_list=None):
1481
from bzrlib.merge import merge
1482
if file_list is not None:
1483
if len(file_list) == 0:
1484
raise BzrCommandError("No files specified")
1485
if revision is None:
1487
elif len(revision) != 1:
1488
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1489
merge(('.', revision[0]), parse_spec('.'),
1492
backup_files=not no_backup,
1493
file_list=file_list)
1496
class cmd_assert_fail(Command):
1497
"""Test reporting of assertion failures"""
1500
assert False, "always fails"
1503
class cmd_help(Command):
1504
"""Show help on a command or other topic.
1506
For a list of all available commands, say 'bzr help commands'."""
1507
takes_args = ['topic?']
1510
def run(self, topic=None):
1517
class cmd_plugins(Command):
1521
import bzrlib.plugin
667
raise NotImplementedError('no implementation of command %r'
671
"""Return help message for this class."""
1522
672
from inspect import getdoc
1523
from pprint import pprint
1524
for plugin in bzrlib.plugin.all_plugins:
1525
print plugin.__path__[0]
1528
print '\t', d.split('\n')[0]
1530
#pprint(bzrlib.plugin.all_plugins)
1534
# list of all available options; the rhs can be either None for an
1535
# option that takes no argument, or a constructor function that checks
1539
'diff-options': str,
1548
'revision': _parse_revision_str,
1559
'merge-type': get_merge_type,
1572
def parse_args(argv):
673
if self.__doc__ is Command.__doc__:
678
return _unsquish_command_name(self.__class__.__name__)
680
def plugin_name(self):
681
"""Get the name of the plugin that provides this command.
683
:return: The name of the plugin or None if the command is builtin.
685
mod_parts = self.__module__.split('.')
686
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
692
class CommandHooks(Hooks):
693
"""Hooks related to Command object creation/enumeration."""
696
"""Create the default hooks.
698
These are all empty initially, because by default nothing should get
702
self.create_hook(HookPoint('extend_command',
703
"Called after creating a command object to allow modifications "
704
"such as adding or removing options, docs etc. Called with the "
705
"new bzrlib.commands.Command object.", (1, 13), None))
706
self.create_hook(HookPoint('get_command',
707
"Called when creating a single command. Called with "
708
"(cmd_or_None, command_name). get_command should either return "
709
"the cmd_or_None parameter, or a replacement Command object that "
710
"should be used for the command. Note that the Command.hooks "
711
"hooks are core infrastructure. Many users will prefer to use "
712
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
714
self.create_hook(HookPoint('get_missing_command',
715
"Called when creating a single command if no command could be "
716
"found. Called with (command_name). get_missing_command should "
717
"either return None, or a Command object to be used for the "
718
"command.", (1, 17), None))
719
self.create_hook(HookPoint('list_commands',
720
"Called when enumerating commands. Called with a set of "
721
"cmd_name strings for all the commands found so far. This set "
722
" is safe to mutate - e.g. to remove a command. "
723
"list_commands should return the updated set of command names.",
726
Command.hooks = CommandHooks()
729
def parse_args(command, argv, alias_argv=None):
1573
730
"""Parse command line.
1575
732
Arguments and options are parsed at this level before being passed
1576
733
down to specific command handlers. This routine knows, from a
1577
734
lookup table, something about the available options, what optargs
1578
735
they take, and which commands will accept them.
1580
>>> parse_args('--help'.split())
1581
([], {'help': True})
1582
>>> parse_args('--version'.split())
1583
([], {'version': True})
1584
>>> parse_args('status --all'.split())
1585
(['status'], {'all': True})
1586
>>> parse_args('commit --message=biter'.split())
1587
(['commit'], {'message': u'biter'})
1588
>>> parse_args('log -r 500'.split())
1589
(['log'], {'revision': [500]})
1590
>>> parse_args('log -r500..600'.split())
1591
(['log'], {'revision': [500, 600]})
1592
>>> parse_args('log -vr500..600'.split())
1593
(['log'], {'verbose': True, 'revision': [500, 600]})
1594
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1595
(['log'], {'revision': ['v500', 600]})
1600
# TODO: Maybe handle '--' to end options?
1605
# option names must not be unicode
1609
mutter(" got option %r" % a)
1611
optname, optarg = a[2:].split('=', 1)
1614
if optname not in OPTIONS:
1615
raise BzrError('unknown long option %r' % a)
1618
if shortopt in SHORT_OPTIONS:
1619
# Multi-character options must have a space to delimit
1621
optname = SHORT_OPTIONS[shortopt]
1623
# Single character short options, can be chained,
1624
# and have their value appended to their name
1626
if shortopt not in SHORT_OPTIONS:
1627
# We didn't find the multi-character name, and we
1628
# didn't find the single char name
1629
raise BzrError('unknown short option %r' % a)
1630
optname = SHORT_OPTIONS[shortopt]
1633
# There are extra things on this option
1634
# see if it is the value, or if it is another
1636
optargfn = OPTIONS[optname]
1637
if optargfn is None:
1638
# This option does not take an argument, so the
1639
# next entry is another short option, pack it back
1641
argv.insert(0, '-' + a[2:])
1643
# This option takes an argument, so pack it
1648
# XXX: Do we ever want to support this, e.g. for -r?
1649
raise BzrError('repeated option %r' % a)
1651
optargfn = OPTIONS[optname]
1655
raise BzrError('option %r needs an argument' % a)
1657
optarg = argv.pop(0)
1658
opts[optname] = optargfn(optarg)
1661
raise BzrError('option %r takes no argument' % optname)
1662
opts[optname] = True
737
# TODO: make it a method of the Command?
738
parser = option.get_optparser(command.options())
739
if alias_argv is not None:
740
args = alias_argv + argv
744
options, args = parser.parse_args(args)
745
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
746
v is not option.OptionParser.DEFAULT_VALUE])
1666
747
return args, opts
1671
750
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
