97
38
assert cmd.startswith("cmd_")
98
39
return cmd[4:].replace('_','-')
101
def _builtin_commands():
102
import bzrlib.builtins
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
106
if name.startswith("cmd_"):
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
112
def builtin_command_names():
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
117
def plugin_command_names():
118
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
42
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
135
def get_cmd_object(cmd_name, plugins_override=True):
43
for k, v in globals().iteritems():
44
if k.startswith("cmd_"):
45
yield _unsquish_command_name(k), v
47
def get_cmd_class(cmd):
136
48
"""Return the canonical name and command class for a command.
139
If true, plugin commands can override builtins.
142
return _get_cmd_object(cmd_name, plugins_override)
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
151
# We want only 'ascii' command names, but the user may have typed
152
# in a Unicode name. In that case, they should just get a
153
# 'command not found' error later.
154
# In the future, we may actually support Unicode command names.
50
cmd = str(cmd) # not unicode
156
52
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
54
return cmd, globals()[_squish_command_name(cmd)]
163
58
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
168
cmd_obj = ExternalCommand.find_command(cmd_name)
174
class Command(object):
59
for cmdname, cmdclass in get_all_cmds():
60
if cmd in cmdclass.aliases:
61
return cmdname, cmdclass
63
cmdclass = ExternalCommand.find_command(cmd)
67
raise BzrCommandError("unknown command %r" % cmd)
175
71
"""Base class for commands.
177
Commands are the heart of the command-line bzr interface.
179
The command object mostly handles the mapping of command-line
180
parameters into one or more bzrlib operations, and of the results
183
Commands normally don't have any state. All their arguments are
184
passed in to the run method. (Subclasses may take a different
185
policy if the behaviour of the instance needs to depend on e.g. a
186
shell plugin and not just its Python class.)
188
73
The docstring for an actual command should give a single-line
189
74
summary, then a complete description of the command. A grammar
190
75
description will be inserted.
193
Other accepted names for this command.
196
78
List of argument forms, marked with whether they are optional,
201
['to_location', 'from_branch?', 'file*']
203
'to_location' is required
204
'from_branch' is optional
205
'file' can be specified 0 or more times
208
List of options that may be given for this command. These can
209
be either strings, referring to globally-defined options,
210
or option objects. Retrieve through options().
82
List of options that may be given for this command.
213
If true, this command isn't advertised. This is typically
214
for commands intended for expert users.
217
Command objects will get a 'outf' attribute, which has been
218
setup to properly handle encoding of unicode strings.
219
encoding_type determines what will happen when characters cannot
221
strict - abort if we cannot decode
222
replace - put in a bogus character (typically '?')
223
exact - do not encode sys.stdout
225
NOTE: by default on Windows, sys.stdout is opened as a text
226
stream, therefore LF line-endings are converted to CRLF.
227
When a command uses encoding_type = 'exact', then
228
sys.stdout is forced to be a binary stream, and line-endings
85
If true, this command isn't advertised.
234
90
takes_options = []
235
encoding_type = 'strict'
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
243
# List of standard options directly supported
244
self.supported_std_options = []
246
def _maybe_expand_globs(self, file_list):
247
"""Glob expand file_list if the platform does not do that itself.
249
:return: A possibly empty list of unicode paths.
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
260
"""Return single-line grammar for this command.
262
Only describes arguments, not options.
264
s = 'bzr ' + self.name() + ' '
265
for aname in self.takes_args:
266
aname = aname.upper()
267
if aname[-1] in ['$', '+']:
268
aname = aname[:-1] + '...'
269
elif aname[-1] == '?':
270
aname = '[' + aname[:-1] + ']'
271
elif aname[-1] == '*':
272
aname = '[' + aname[:-1] + '...]'
279
def get_help_text(self, additional_see_also=None, plain=True,
280
see_also_as_links=False):
281
"""Return a text string with help for this command.
283
:param additional_see_also: Additional help topics to be
285
:param plain: if False, raw help (reStructuredText) is
286
returned instead of plain text.
287
:param see_also_as_links: if True, convert items in 'See also'
288
list to internal links (used by bzr_man rstx generator)
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
294
# Extract the summary (purpose) and sections out from the text
295
purpose,sections = self._get_help_parts(doc)
297
# If a custom usage section was provided, use it
298
if sections.has_key('Usage'):
299
usage = sections.pop('Usage')
301
usage = self._usage()
303
# The header is the purpose and usage
305
result += ':Purpose: %s\n' % purpose
306
if usage.find('\n') >= 0:
307
result += ':Usage:\n%s\n' % usage
309
result += ':Usage: %s\n' % usage
313
options = option.get_optparser(self.options()).format_option_help()
314
if options.startswith('Options:'):
315
result += ':' + options
316
elif options.startswith('options:'):
317
# Python 2.4 version of optparse
318
result += ':Options:' + options[len('options:'):]
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
337
# Add the aliases, source (plug-in) and see also links, if any
339
result += ':Aliases: '
340
result += ', '.join(self.aliases) + '\n'
341
plugin_name = self.plugin_name()
342
if plugin_name is not None:
343
result += ':From: plugin "%s"\n' % plugin_name
344
see_also = self.get_see_also(additional_see_also)
346
if not plain and see_also_as_links:
348
for item in see_also:
350
# topics doesn't have an independent section
351
# so don't create a real link
352
see_also_links.append(item)
354
# Use a reST link for this entry
355
see_also_links.append("`%s`_" % (item,))
356
see_also = see_also_links
357
result += ':See also: '
358
result += ', '.join(see_also) + '\n'
360
# If this will be rendered as plan text, convert it
362
import bzrlib.help_topics
363
result = bzrlib.help_topics.help_as_plain_text(result)
367
def _get_help_parts(text):
368
"""Split help text into a summary and named sections.
370
:return: (summary,sections) where summary is the top line and
371
sections is a dictionary of the rest indexed by section name.
372
A section starts with a heading line of the form ":xxx:".
373
Indented text on following lines is the section value.
374
All text found outside a named section is assigned to the
375
default section which is given the key of None.
377
def save_section(sections, label, section):
379
if sections.has_key(label):
380
sections[label] += '\n' + section
382
sections[label] = section
384
lines = text.rstrip().splitlines()
385
summary = lines.pop(0)
387
label,section = None,''
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
390
save_section(sections, label, section)
391
label,section = line[1:-1],''
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
394
label,section = None,line
397
section += '\n' + line
400
save_section(sections, label, section)
401
return summary, sections
403
def get_help_topic(self):
404
"""Return the commands help topic - its name."""
407
def get_see_also(self, additional_terms=None):
408
"""Return a list of help topics that are related to this command.
410
The list is derived from the content of the _see_also attribute. Any
411
duplicates are removed and the result is in lexical order.
412
:param additional_terms: Additional help topics to cross-reference.
413
:return: A list of help topics.
415
see_also = set(getattr(self, '_see_also', []))
417
see_also.update(additional_terms)
418
return sorted(see_also)
421
"""Return dict of valid options for this command.
423
Maps from long option name to option object."""
424
r = Option.STD_OPTIONS.copy()
426
for o in self.takes_options:
427
if isinstance(o, basestring):
428
o = option.Option.OPTIONS[o]
430
if o.name in std_names:
431
self.supported_std_options.append(o.name)
434
def _setup_outf(self):
435
"""Return a file linked to stdout, which has proper encoding."""
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
459
def run_argv_aliases(self, argv, alias_argv=None):
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
465
args, opts = parse_args(self, argv, alias_argv)
467
# Process the standard options
468
if 'help' in opts: # e.g. bzr add --help
469
sys.stdout.write(self.get_help_text())
471
trace.set_verbosity_level(option._verbosity_level)
472
if 'verbose' in self.supported_std_options:
473
opts['verbose'] = trace.is_verbose()
474
elif opts.has_key('verbose'):
476
if 'quiet' in self.supported_std_options:
477
opts['quiet'] = trace.is_quiet()
478
elif opts.has_key('quiet'):
481
# mix arguments and options into one dictionary
482
cmdargs = _match_argform(self.name(), self.takes_args, args)
484
for k, v in opts.items():
485
cmdopts[k.replace('-', '_')] = v
487
all_cmd_args = cmdargs.copy()
488
all_cmd_args.update(cmdopts)
492
return self.run(**all_cmd_args)
94
def __init__(self, options, arguments):
95
"""Construct and run the command.
97
Sets self.status to the return value of run()."""
98
assert isinstance(options, dict)
99
assert isinstance(arguments, dict)
100
cmdargs = options.copy()
101
cmdargs.update(arguments)
102
assert self.__doc__ != Command.__doc__, \
103
("No help message set for %r" % self)
104
self.status = self.run(**cmdargs)
495
"""Actually run the command.
108
"""Override this in sub-classes.
497
110
This is invoked with the options and arguments bound to
498
111
keyword parameters.
500
Return 0 or None if the command was successful, or a non-zero
501
shell error code if not. It's OK for this method to allow
502
an exception to raise up.
504
raise NotImplementedError('no implementation of command %r'
508
"""Return help message for this class."""
509
from inspect import getdoc
510
if self.__doc__ is Command.__doc__:
515
return _unsquish_command_name(self.__class__.__name__)
517
def plugin_name(self):
518
"""Get the name of the plugin that provides this command.
520
:return: The name of the plugin or None if the command is builtin.
522
mod_parts = self.__module__.split('.')
523
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
529
def parse_args(command, argv, alias_argv=None):
113
Return 0 or None if the command was successful, or a shell
119
class ExternalCommand(Command):
120
"""Class to wrap external commands.
122
We cheat a little here, when get_cmd_class() calls us we actually give it back
123
an object we construct that has the appropriate path, help, options etc for the
126
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
127
method, which we override to call the Command.__init__ method. That then calls
128
our run method which is pretty straight forward.
130
The only wrinkle is that we have to map bzr's dictionary of options and arguments
131
back into command line options and arguments for the script.
134
def find_command(cls, cmd):
135
bzrpath = os.environ.get('BZRPATH', '')
137
for dir in bzrpath.split(':'):
138
path = os.path.join(dir, cmd)
139
if os.path.isfile(path):
140
return ExternalCommand(path)
144
find_command = classmethod(find_command)
146
def __init__(self, path):
149
# TODO: If either of these fail, we should detect that and
150
# assume that path is not really a bzr plugin after all.
152
pipe = os.popen('%s --bzr-usage' % path, 'r')
153
self.takes_options = pipe.readline().split()
154
self.takes_args = pipe.readline().split()
157
pipe = os.popen('%s --bzr-help' % path, 'r')
158
self.__doc__ = pipe.read()
161
def __call__(self, options, arguments):
162
Command.__init__(self, options, arguments)
165
def run(self, **kargs):
173
if OPTIONS.has_key(name):
175
opts.append('--%s' % name)
176
if value is not None and value is not True:
177
opts.append(str(value))
179
# it's an arg, or arg list
180
if type(value) is not list:
186
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
190
class cmd_status(Command):
191
"""Display status summary.
193
This reports on versioned and unknown files, reporting them
194
grouped by state. Possible states are:
197
Versioned in the working copy but not in the previous revision.
200
Versioned in the previous revision but removed or deleted
204
Path of this file changed from the previous revision;
205
the text may also have changed. This includes files whose
206
parent directory was renamed.
209
Text has changed since the previous revision.
212
Nothing about this file has changed since the previous revision.
213
Only shown with --all.
216
Not versioned and not matching an ignore pattern.
218
To see ignored files use 'bzr ignored'. For details in the
219
changes to file texts, use 'bzr diff'.
221
If no arguments are specified, the status of the entire working
222
directory is shown. Otherwise, only the status of the specified
223
files or directories is reported. If a directory is given, status
224
is reported for everything inside that directory.
226
takes_args = ['file*']
227
takes_options = ['all', 'show-ids']
228
aliases = ['st', 'stat']
230
def run(self, all=False, show_ids=False, file_list=None):
232
b = Branch(file_list[0], lock_mode='r')
233
file_list = [b.relpath(x) for x in file_list]
234
# special case: only one path was given and it's the root
236
if file_list == ['']:
239
b = Branch('.', lock_mode='r')
241
status.show_status(b, show_unchanged=all, show_ids=show_ids,
242
specific_files=file_list)
245
class cmd_cat_revision(Command):
246
"""Write out metadata for a revision."""
249
takes_args = ['revision_id']
251
def run(self, revision_id):
252
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
255
class cmd_revno(Command):
256
"""Show current revision number.
258
This is equal to the number of revisions on this branch."""
260
print Branch('.').revno()
263
class cmd_add(Command):
264
"""Add specified files or directories.
266
In non-recursive mode, all the named items are added, regardless
267
of whether they were previously ignored. A warning is given if
268
any of the named files are already versioned.
270
In recursive mode (the default), files are treated the same way
271
but the behaviour for directories is different. Directories that
272
are already versioned do not give a warning. All directories,
273
whether already versioned or not, are searched for files or
274
subdirectories that are neither versioned or ignored, and these
275
are added. This search proceeds recursively into versioned
278
Therefore simply saying 'bzr add .' will version all files that
279
are currently unknown.
281
TODO: Perhaps adding a file whose directly is not versioned should
282
recursively add that parent, rather than giving an error?
284
takes_args = ['file+']
285
takes_options = ['verbose']
287
def run(self, file_list, verbose=False):
288
bzrlib.add.smart_add(file_list, verbose)
291
class cmd_relpath(Command):
292
"""Show path of a file relative to root"""
293
takes_args = ['filename']
295
def run(self, filename):
296
print Branch(filename).relpath(filename)
300
class cmd_inventory(Command):
301
"""Show inventory of the current working copy or a revision."""
302
takes_options = ['revision']
304
def run(self, revision=None):
307
inv = b.read_working_inventory()
309
inv = b.get_revision_inventory(b.lookup_revision(revision))
311
for path, entry in inv.iter_entries():
312
print '%-50s %s' % (entry.file_id, path)
315
class cmd_move(Command):
316
"""Move files to a different directory.
321
The destination must be a versioned directory in the same branch.
323
takes_args = ['source$', 'dest']
324
def run(self, source_list, dest):
327
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
330
class cmd_rename(Command):
331
"""Change the name of an entry.
334
bzr rename frob.c frobber.c
335
bzr rename src/frob.c lib/frob.c
337
It is an error if the destination name exists.
339
See also the 'move' command, which moves files into a different
340
directory without changing their name.
342
TODO: Some way to rename multiple files without invoking bzr for each
344
takes_args = ['from_name', 'to_name']
346
def run(self, from_name, to_name):
348
b.rename_one(b.relpath(from_name), b.relpath(to_name))
352
class cmd_renames(Command):
353
"""Show list of renamed files.
355
TODO: Option to show renames between two historical versions.
357
TODO: Only show renames under dir, rather than in the whole branch.
359
takes_args = ['dir?']
361
def run(self, dir='.'):
363
old_inv = b.basis_tree().inventory
364
new_inv = b.read_working_inventory()
366
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
368
for old_name, new_name in renames:
369
print "%s => %s" % (old_name, new_name)
372
class cmd_info(Command):
373
"""Show statistical information about a branch."""
374
takes_args = ['branch?']
376
def run(self, branch=None):
379
from branch import find_branch
380
b = find_branch(branch)
384
class cmd_remove(Command):
385
"""Make a file unversioned.
387
This makes bzr stop tracking changes to a versioned file. It does
388
not delete the working copy.
390
takes_args = ['file+']
391
takes_options = ['verbose']
393
def run(self, file_list, verbose=False):
394
b = Branch(file_list[0])
395
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
398
class cmd_file_id(Command):
399
"""Print file_id of a particular file or directory.
401
The file_id is assigned when the file is first added and remains the
402
same through all revisions where the file exists, even when it is
406
takes_args = ['filename']
407
def run(self, filename):
409
i = b.inventory.path2id(b.relpath(filename))
411
bailout("%r is not a versioned file" % filename)
416
class cmd_file_path(Command):
417
"""Print path of file_ids to a file or directory.
419
This prints one line for each directory down to the target,
420
starting at the branch root."""
422
takes_args = ['filename']
423
def run(self, filename):
426
fid = inv.path2id(b.relpath(filename))
428
bailout("%r is not a versioned file" % filename)
429
for fip in inv.get_idpath(fid):
433
class cmd_revision_history(Command):
434
"""Display list of revision ids on this branch."""
436
for patchid in Branch('.').revision_history():
440
class cmd_directories(Command):
441
"""Display list of versioned directories in this branch."""
443
for name, ie in Branch('.').read_working_inventory().directories():
450
class cmd_init(Command):
451
"""Make a directory into a versioned branch.
453
Use this to create an empty branch, or before importing an
456
Recipe for importing a tree of files:
461
bzr commit -m 'imported project'
464
Branch('.', init=True)
467
class cmd_diff(Command):
468
"""Show differences in working tree.
470
If files are listed, only the changes in those files are listed.
471
Otherwise, all changes for the tree are listed.
473
TODO: Given two revision arguments, show the difference between them.
475
TODO: Allow diff across branches.
477
TODO: Option to use external diff command; could be GNU diff, wdiff,
480
TODO: Python difflib is not exactly the same as unidiff; should
481
either fix it up or prefer to use an external diff.
483
TODO: If a directory is given, diff everything under that.
485
TODO: Selected-file diff is inefficient and doesn't show you
488
TODO: This probably handles non-Unix newlines poorly.
491
takes_args = ['file*']
492
takes_options = ['revision']
495
def run(self, revision=None, file_list=None):
496
from bzrlib.diff import show_diff
498
show_diff(Branch('.'), revision, specific_files=file_list)
504
class cmd_deleted(Command):
505
"""List files deleted in the working tree.
507
TODO: Show files deleted since a previous revision, or between two revisions.
509
def run(self, show_ids=False):
512
new = b.working_tree()
514
## TODO: Much more efficient way to do this: read in new
515
## directories with readdir, rather than stating each one. Same
516
## level of effort but possibly much less IO. (Or possibly not,
517
## if the directories are very large...)
519
for path, ie in old.inventory.iter_entries():
520
if not new.has_id(ie.file_id):
522
print '%-50s %s' % (path, ie.file_id)
527
class cmd_modified(Command):
528
"""List files modified in working tree."""
533
inv = b.read_working_inventory()
534
sc = statcache.update_cache(b, inv)
535
basis = b.basis_tree()
536
basis_inv = basis.inventory
538
# We used to do this through iter_entries(), but that's slow
539
# when most of the files are unmodified, as is usually the
540
# case. So instead we iterate by inventory entry, and only
541
# calculate paths as necessary.
543
for file_id in basis_inv:
544
cacheentry = sc.get(file_id)
545
if not cacheentry: # deleted
547
ie = basis_inv[file_id]
548
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
549
path = inv.id2path(file_id)
554
class cmd_added(Command):
555
"""List files added in working tree."""
559
wt = b.working_tree()
560
basis_inv = b.basis_tree().inventory
563
if file_id in basis_inv:
565
path = inv.id2path(file_id)
566
if not os.access(b.abspath(path), os.F_OK):
572
class cmd_root(Command):
573
"""Show the tree root directory.
575
The root is the nearest enclosing directory with a .bzr control
577
takes_args = ['filename?']
578
def run(self, filename=None):
579
"""Print the branch root."""
580
from branch import find_branch
581
b = find_branch(filename)
582
print getattr(b, 'base', None) or getattr(b, 'baseurl')
585
class cmd_log(Command):
586
"""Show log of this branch.
588
TODO: Option to limit range.
590
TODO: Perhaps show most-recent first with an option for last.
592
takes_args = ['filename?']
593
takes_options = ['timezone', 'verbose', 'show-ids']
594
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
595
from branch import find_branch
596
b = find_branch((filename or '.'), lock_mode='r')
598
filename = b.relpath(filename)
599
bzrlib.show_log(b, filename,
600
show_timezone=timezone,
606
class cmd_touching_revisions(Command):
607
"""Return revision-ids which affected a particular file."""
609
takes_args = ["filename"]
610
def run(self, filename):
611
b = Branch(filename, lock_mode='r')
612
inv = b.read_working_inventory()
613
file_id = inv.path2id(b.relpath(filename))
614
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
615
print "%6d %s" % (revno, what)
618
class cmd_ls(Command):
619
"""List files in a tree.
621
TODO: Take a revision or remote path and list that tree instead.
624
def run(self, revision=None, verbose=False):
627
tree = b.working_tree()
629
tree = b.revision_tree(b.lookup_revision(revision))
631
for fp, fc, kind, fid in tree.list_files():
633
if kind == 'directory':
640
print '%-8s %s%s' % (fc, fp, kindch)
646
class cmd_unknowns(Command):
647
"""List unknown files"""
649
for f in Branch('.').unknowns():
654
class cmd_ignore(Command):
655
"""Ignore a command or pattern
657
To remove patterns from the ignore list, edit the .bzrignore file.
659
If the pattern contains a slash, it is compared to the whole path
660
from the branch root. Otherwise, it is comapred to only the last
661
component of the path.
663
Ignore patterns are case-insensitive on case-insensitive systems.
665
Note: wildcards must be quoted from the shell on Unix.
668
bzr ignore ./Makefile
671
takes_args = ['name_pattern']
673
def run(self, name_pattern):
674
from bzrlib.atomicfile import AtomicFile
678
ifn = b.abspath('.bzrignore')
680
# FIXME: probably doesn't handle non-ascii patterns
682
if os.path.exists(ifn):
683
f = b.controlfile(ifn, 'rt')
689
if igns and igns[-1] != '\n':
691
igns += name_pattern + '\n'
693
f = AtomicFile(ifn, 'wt')
697
inv = b.working_tree().inventory
698
if inv.path2id('.bzrignore'):
699
mutter('.bzrignore is already versioned')
701
mutter('need to make new .bzrignore file versioned')
702
b.add(['.bzrignore'])
706
class cmd_ignored(Command):
707
"""List ignored files and the patterns that matched them.
709
See also: bzr ignore"""
711
tree = Branch('.').working_tree()
712
for path, file_class, kind, file_id in tree.list_files():
713
if file_class != 'I':
715
## XXX: Slightly inefficient since this was already calculated
716
pat = tree.is_ignored(path)
717
print '%-50s %s' % (path, pat)
720
class cmd_lookup_revision(Command):
721
"""Lookup the revision-id from a revision-number
724
bzr lookup-revision 33
727
takes_args = ['revno']
729
def run(self, revno):
733
raise BzrCommandError("not a valid revision-number: %r" % revno)
735
print Branch('.').lookup_revision(revno)
738
class cmd_export(Command):
739
"""Export past revision to destination directory.
741
If no revision is specified this exports the last committed revision."""
742
takes_args = ['dest']
743
takes_options = ['revision']
744
def run(self, dest, revision=None):
747
rh = b.revision_history()[-1]
749
rh = b.lookup_revision(int(revision))
750
t = b.revision_tree(rh)
754
class cmd_cat(Command):
755
"""Write a file's text from a previous revision."""
757
takes_options = ['revision']
758
takes_args = ['filename']
760
def run(self, filename, revision=None):
762
raise BzrCommandError("bzr cat requires a revision number")
764
b.print_file(b.relpath(filename), int(revision))
767
class cmd_local_time_offset(Command):
768
"""Show the offset in seconds from GMT to local time."""
771
print bzrlib.osutils.local_time_offset()
775
class cmd_commit(Command):
776
"""Commit changes into a new revision.
778
If selected files are specified, only changes to those files are
779
committed. If a directory is specified then its contents are also
782
A selected-file commit may fail in some cases where the committed
783
tree would be invalid, such as trying to commit a file in a
784
newly-added directory that is not itself committed.
786
TODO: Run hooks on tree to-be-committed, and after commit.
788
TODO: Strict commit that fails if there are unknown or deleted files.
790
takes_args = ['selected*']
791
takes_options = ['message', 'file', 'verbose']
792
aliases = ['ci', 'checkin']
794
def run(self, message=None, file=None, verbose=False, selected_list=None):
795
from bzrlib.commit import commit
797
## Warning: shadows builtin file()
798
if not message and not file:
799
raise BzrCommandError("please specify a commit message",
800
["use either --message or --file"])
801
elif message and file:
802
raise BzrCommandError("please specify either --message or --file")
806
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
809
commit(b, message, verbose=verbose, specific_files=selected_list)
812
class cmd_check(Command):
813
"""Validate consistency of branch history.
815
This command checks various invariants about the branch storage to
816
detect data corruption or bzr bugs.
818
takes_args = ['dir?']
819
def run(self, dir='.'):
821
bzrlib.check.check(Branch(dir, find_root=False))
825
class cmd_whoami(Command):
826
"""Show bzr user id."""
827
takes_options = ['email']
829
def run(self, email=False):
831
print bzrlib.osutils.user_email()
833
print bzrlib.osutils.username()
836
class cmd_selftest(Command):
837
"""Run internal test suite"""
840
failures, tests = 0, 0
842
import doctest, bzrlib.store, bzrlib.tests
843
bzrlib.trace.verbose = False
845
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
846
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
847
mf, mt = doctest.testmod(m)
850
print '%-40s %3d tests' % (m.__name__, mt),
852
print '%3d FAILED!' % mf
856
print '%-40s %3d tests' % ('total', tests),
858
print '%3d FAILED!' % failures
864
class cmd_version(Command):
865
"""Show version of bzr"""
870
print "bzr (bazaar-ng) %s" % bzrlib.__version__
871
print bzrlib.__copyright__
872
print "http://bazaar-ng.org/"
874
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
875
print "you may use, modify and redistribute it under the terms of the GNU"
876
print "General Public License version 2 or later."
879
class cmd_rocks(Command):
880
"""Statement of optimism."""
883
print "it sure does!"
885
def parse_spec(spec):
887
parsed = spec.split('/@')
888
assert len(parsed) == 2
892
parsed[1] = int(parsed[1])
895
parsed = [spec, None]
898
class cmd_merge(Command):
899
"""Perform a three-way merge of trees."""
900
takes_args = ['other_spec', 'base_spec']
902
def run(self, other_spec, base_spec):
903
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
905
class cmd_assert_fail(Command):
906
"""Test reporting of assertion failures"""
909
assert False, "always fails"
912
class cmd_help(Command):
913
"""Show help on a command or other topic.
915
For a list of all available commands, say 'bzr help commands'."""
916
takes_args = ['topic?']
919
def run(self, topic=None):
924
class cmd_update_stat_cache(Command):
925
"""Update stat-cache mapping inodes to SHA-1 hashes.
932
statcache.update_cache(b.base, b.read_working_inventory())
935
######################################################################
939
# list of all available options; the rhs can be either None for an
940
# option that takes no argument, or a constructor function that checks
964
def parse_args(argv):
530
965
"""Parse command line.
532
967
Arguments and options are parsed at this level before being passed
533
968
down to specific command handlers. This routine knows, from a
534
969
lookup table, something about the available options, what optargs
535
970
they take, and which commands will accept them.
972
>>> parse_args('--help'.split())
974
>>> parse_args('--version'.split())
975
([], {'version': True})
976
>>> parse_args('status --all'.split())
977
(['status'], {'all': True})
978
>>> parse_args('commit --message=biter'.split())
979
(['commit'], {'message': u'biter'})
537
# TODO: make it a method of the Command?
538
parser = option.get_optparser(command.options())
539
if alias_argv is not None:
540
args = alias_argv + argv
544
options, args = parser.parse_args(args)
545
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
546
v is not option.OptionParser.DEFAULT_VALUE])
984
# TODO: Maybe handle '--' to end options?
989
# option names must not be unicode
993
mutter(" got option %r" % a)
995
optname, optarg = a[2:].split('=', 1)
998
if optname not in OPTIONS:
999
bailout('unknown long option %r' % a)
1002
if shortopt not in SHORT_OPTIONS:
1003
bailout('unknown short option %r' % a)
1004
optname = SHORT_OPTIONS[shortopt]
1007
# XXX: Do we ever want to support this, e.g. for -r?
1008
bailout('repeated option %r' % a)
1010
optargfn = OPTIONS[optname]
1014
bailout('option %r needs an argument' % a)
1016
optarg = argv.pop(0)
1017
opts[optname] = optargfn(optarg)
1020
bailout('option %r takes no argument' % optname)
1021
opts[optname] = True
547
1025
return args, opts
550
1030
def _match_argform(cmd, takes_args, args):
564
1044
argdict[argname + '_list'] = None
565
1045
elif ap[-1] == '+':
567
raise errors.BzrCommandError("command %r needs one or more %s"
568
% (cmd, argname.upper()))
1047
raise BzrCommandError("command %r needs one or more %s"
1048
% (cmd, argname.upper()))
570
1050
argdict[argname + '_list'] = args[:]
572
1052
elif ap[-1] == '$': # all but one
573
1053
if len(args) < 2:
574
raise errors.BzrCommandError("command %r needs one or more %s"
575
% (cmd, argname.upper()))
1054
raise BzrCommandError("command %r needs one or more %s"
1055
% (cmd, argname.upper()))
576
1056
argdict[argname + '_list'] = args[:-1]
579
1059
# just a plain arg
582
raise errors.BzrCommandError("command %r requires argument %s"
583
% (cmd, argname.upper()))
1062
raise BzrCommandError("command %r requires argument %s"
1063
% (cmd, argname.upper()))
585
1065
argdict[argname] = args.pop(0)
588
raise errors.BzrCommandError("extra argument to command %s: %s"
1068
raise BzrCommandError("extra argument to command %s: %s"
595
def apply_profiled(the_callable, *args, **kwargs):
599
pffileno, pfname = tempfile.mkstemp()
601
prof = hotshot.Profile(pfname)
603
ret = prof.runcall(the_callable, *args, **kwargs) or 0
606
stats = hotshot.stats.load(pfname)
608
stats.sort_stats('cum') # 'time'
609
## XXX: Might like to write to stderr or the trace file instead but
610
## print_stats seems hardcoded to stdout
611
stats.print_stats(20)
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
619
from bzrlib.lsprof import profile
620
ret, stats = profile(the_callable, *args, **kwargs)
626
trace.note('Profile data written to "%s".', filename)
630
def get_alias(cmd, config=None):
631
"""Return an expanded alias, or None if no alias exists.
634
Command to be checked for an alias.
636
Used to specify an alternative config to use,
637
which is especially useful for testing.
638
If it is unspecified, the global config will be used.
642
config = bzrlib.config.GlobalConfig()
643
alias = config.get_alias(cmd)
646
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
650
1075
def run_bzr(argv):
651
1076
"""Execute a command.
653
1078
This is similar to main(), but without all the trappings for
654
1079
logging and error handling.
657
The command-line arguments, without the program name from argv[0]
658
These should already be decoded. All library/test code calling
659
run_bzr should be passing valid strings (don't need decoding).
661
Returns a command status or raises an exception.
663
Special master options: these must come before the command because
664
they control how the command is interpreted.
667
Do not load plugin modules at all
673
Only use builtin commands. (Plugins are still allowed to change
677
Run under the Python hotshot profiler.
680
Run under the Python lsprof profiler.
683
trace.mutter("bzr arguments: %r", argv)
685
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
686
opt_no_aliases = False
687
opt_lsprof_file = None
689
# --no-plugins is handled specially at a very early stage. We need
690
# to load plugins before doing other command parsing so that they
691
# can override commands, but this needs to happen first.
699
elif a == '--lsprof':
701
elif a == '--lsprof-file':
703
opt_lsprof_file = argv[i + 1]
705
elif a == '--no-plugins':
706
opt_no_plugins = True
707
elif a == '--no-aliases':
708
opt_no_aliases = True
709
elif a == '--builtin':
711
elif a.startswith('-D'):
712
debug.debug_flags.add(a[2:])
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
723
if argv[0] == '--version':
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
728
if not opt_no_plugins:
729
from bzrlib.plugin import load_plugins
732
from bzrlib.plugin import disable_plugins
737
if not opt_no_aliases:
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
741
argv[0] = alias_argv.pop(0)
744
# We want only 'ascii' command names, but the user may have typed
745
# in a Unicode name. In that case, they should just get a
746
# 'command not found' error later.
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
749
run = cmd_obj.run_argv_aliases
750
run_argv = [argv, alias_argv]
1081
argv = [a.decode(bzrlib.user_encoding) for a in argv]
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
756
ret = apply_profiled(run, *run_argv)
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
764
def display_command(func):
765
"""Decorator that suppresses pipe/interrupt errors."""
766
def ignore_pipe(*args, **kwargs):
1084
args, opts = parse_args(argv[1:])
1092
elif 'version' in opts:
1095
cmd = str(args.pop(0))
1102
canonical_cmd, cmd_class = get_cmd_class(cmd)
1105
if 'profile' in opts:
1111
# check options are reasonable
1112
allowed = cmd_class.takes_options
1114
if oname not in allowed:
1115
raise BzrCommandError("option '--%s' is not allowed for command %r"
1118
# mix arguments and options into one dictionary
1119
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1121
for k, v in opts.items():
1122
cmdopts[k.replace('-', '_')] = v
1125
import hotshot, tempfile
1126
pffileno, pfname = tempfile.mkstemp()
768
result = func(*args, **kwargs)
772
if getattr(e, 'errno', None) is None:
774
if e.errno != errno.EPIPE:
775
# Win32 raises IOError with errno=0 on a broken pipe
776
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
779
except KeyboardInterrupt:
1128
prof = hotshot.Profile(pfname)
1129
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1132
import hotshot.stats
1133
stats = hotshot.stats.load(pfname)
1135
stats.sort_stats('time')
1136
## XXX: Might like to write to stderr or the trace file instead but
1137
## print_stats seems hardcoded to stdout
1138
stats.print_stats(20)
1146
cmdobj = cmd_class(cmdopts, cmdargs).status
1149
def _report_exception(summary, quiet=False):
1151
log_error('bzr: ' + summary)
1152
bzrlib.trace.log_exception()
1155
tb = sys.exc_info()[2]
1156
exinfo = traceback.extract_tb(tb)
1158
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1159
sys.stderr.write(' see ~/.bzr.log for debug information\n')
786
from bzrlib.ui.text import TextUIFactory
787
bzrlib.ui.ui_factory = TextUIFactory()
789
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
790
except UnicodeDecodeError:
791
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
793
ret = run_bzr_catch_errors(argv)
794
trace.mutter("return code %d", ret)
798
def run_bzr_catch_errors(argv):
799
# Note: The except clause logic below should be kept in sync with the
800
# profile() routine in lsprof.py.
803
except (KeyboardInterrupt, Exception), e:
804
# used to handle AssertionError and KeyboardInterrupt
805
# specially here, but hopefully they're handled ok by the logger now
806
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
807
if os.environ.get('BZR_PDB'):
808
print '**** entering debugger'
810
pdb.post_mortem(sys.exc_traceback)
814
def run_bzr_catch_user_errors(argv):
815
"""Run bzr and report user errors, but let internal errors propagate.
817
This is used for the test suite, and might be useful for other programs
818
that want to wrap the commandline interface.
823
if (isinstance(e, (OSError, IOError))
824
or not getattr(e, 'internal_error', True)):
825
trace.report_exception(sys.exc_info(), sys.stderr)
831
class HelpCommandIndex(object):
832
"""A index for bzr help that returns commands."""
835
self.prefix = 'commands/'
837
def get_topics(self, topic):
838
"""Search for topic amongst commands.
840
:param topic: A topic to search for.
841
:return: A list which is either empty or contains a single
844
if topic and topic.startswith(self.prefix):
845
topic = topic[len(self.prefix):]
1166
bzrlib.open_tracefile(argv)
847
cmd = _get_cmd_object(topic)
1171
return run_bzr(argv)
1173
# do this here inside the exception wrappers to catch EPIPE
1176
quiet = isinstance(e, (BzrCommandError))
1177
_report_exception('error: ' + e.args[0], quiet=quiet)
1180
# some explanation or hints
1183
except AssertionError, e:
1184
msg = 'assertion failed'
1186
msg += ': ' + str(e)
1187
_report_exception(msg)
1189
except KeyboardInterrupt, e:
1190
_report_exception('interrupted', quiet=True)
1192
except Exception, e:
1194
if (isinstance(e, IOError)
1195
and hasattr(e, 'errno')
1196
and e.errno == errno.EPIPE):
1200
msg = str(e).rstrip('\n')
1201
_report_exception(msg, quiet)
1204
bzrlib.trace.close_trace()
854
1207
if __name__ == '__main__':
added
removed
bzrlib/commands.py
