33
97
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
35
98
return cmd[4:].replace('_','-')
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
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()
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
145
for k, v in globals().iteritems():
146
if k.startswith("cmd_"):
147
d[_unsquish_command_name(k)] = v
149
d.update(_find_plugins())
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)
152
def get_all_cmds(include_plugins=True):
129
def get_all_cmds(plugins_override=True):
153
130
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
158
def get_cmd_class(cmd,include_plugins=True):
135
def get_cmd_object(cmd_name, plugins_override=True):
159
136
"""Return the canonical name and command class for a command.
139
If true, plugin commands can override builtins.
161
cmd = str(cmd) # not unicode
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.
163
156
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
166
return cmd, cmds[cmd]
159
return cmds[cmd_name]()
170
163
# look for any command which claims this as an alias
171
for cmdname, cmdclass in cmds.iteritems():
172
if cmd in cmdclass.aliases:
173
return cmdname, cmdclass
175
cmdclass = ExternalCommand.find_command(cmd)
179
raise BzrCommandError("unknown command %r" % cmd)
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)
172
# look for plugins that provide this command but aren't installed
173
for provider in command_providers_registry:
175
plugin_metadata = provider.plugin_for_command(cmd_name)
176
except errors.NoPluginAvailable:
179
raise errors.CommandAvailableInPlugin(cmd_name,
180
plugin_metadata, provider)
182
185
class Command(object):
183
186
"""Base class for commands.
188
Commands are the heart of the command-line bzr interface.
190
The command object mostly handles the mapping of command-line
191
parameters into one or more bzrlib operations, and of the results
194
Commands normally don't have any state. All their arguments are
195
passed in to the run method. (Subclasses may take a different
196
policy if the behaviour of the instance needs to depend on e.g. a
197
shell plugin and not just its Python class.)
185
199
The docstring for an actual command should give a single-line
186
200
summary, then a complete description of the command. A grammar
187
201
description will be inserted.
204
Other accepted names for this command.
190
207
List of argument forms, marked with whether they are optional,
212
['to_location', 'from_branch?', 'file*']
214
'to_location' is required
215
'from_branch' is optional
216
'file' can be specified 0 or more times
194
List of options that may be given for this command.
219
List of options that may be given for this command. These can
220
be either strings, referring to globally-defined options,
221
or option objects. Retrieve through options().
197
If true, this command isn't advertised.
224
If true, this command isn't advertised. This is typically
225
for commands intended for expert users.
228
Command objects will get a 'outf' attribute, which has been
229
setup to properly handle encoding of unicode strings.
230
encoding_type determines what will happen when characters cannot
232
strict - abort if we cannot decode
233
replace - put in a bogus character (typically '?')
234
exact - do not encode sys.stdout
236
NOTE: by default on Windows, sys.stdout is opened as a text
237
stream, therefore LF line-endings are converted to CRLF.
238
When a command uses encoding_type = 'exact', then
239
sys.stdout is forced to be a binary stream, and line-endings
202
245
takes_options = []
246
encoding_type = 'strict'
206
def __init__(self, options, arguments):
207
"""Construct and run the command.
209
Sets self.status to the return value of run()."""
210
assert isinstance(options, dict)
211
assert isinstance(arguments, dict)
212
cmdargs = options.copy()
213
cmdargs.update(arguments)
214
assert self.__doc__ != Command.__doc__, \
215
("No help message set for %r" % self)
216
self.status = self.run(**cmdargs)
251
"""Construct an instance of this command."""
252
if self.__doc__ == Command.__doc__:
253
warn("No help message set for %r" % self)
254
# List of standard options directly supported
255
self.supported_std_options = []
257
def _maybe_expand_globs(self, file_list):
258
"""Glob expand file_list if the platform does not do that itself.
260
:return: A possibly empty list of unicode paths.
262
Introduced in bzrlib 0.18.
266
if sys.platform == 'win32':
267
file_list = win32utils.glob_expand(file_list)
268
return list(file_list)
271
"""Return single-line grammar for this command.
273
Only describes arguments, not options.
275
s = 'bzr ' + self.name() + ' '
276
for aname in self.takes_args:
277
aname = aname.upper()
278
if aname[-1] in ['$', '+']:
279
aname = aname[:-1] + '...'
280
elif aname[-1] == '?':
281
aname = '[' + aname[:-1] + ']'
282
elif aname[-1] == '*':
283
aname = '[' + aname[:-1] + '...]'
285
s = s[:-1] # remove last space
288
def get_help_text(self, additional_see_also=None, plain=True,
289
see_also_as_links=False):
290
"""Return a text string with help for this command.
292
:param additional_see_also: Additional help topics to be
294
:param plain: if False, raw help (reStructuredText) is
295
returned instead of plain text.
296
:param see_also_as_links: if True, convert items in 'See also'
297
list to internal links (used by bzr_man rstx generator)
301
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
303
# Extract the summary (purpose) and sections out from the text
304
purpose,sections = self._get_help_parts(doc)
306
# If a custom usage section was provided, use it
307
if sections.has_key('Usage'):
308
usage = sections.pop('Usage')
310
usage = self._usage()
312
# The header is the purpose and usage
314
result += ':Purpose: %s\n' % purpose
315
if usage.find('\n') >= 0:
316
result += ':Usage:\n%s\n' % usage
318
result += ':Usage: %s\n' % usage
322
options = option.get_optparser(self.options()).format_option_help()
323
if options.startswith('Options:'):
324
result += ':' + options
325
elif options.startswith('options:'):
326
# Python 2.4 version of optparse
327
result += ':Options:' + options[len('options:'):]
332
# Add the description, indenting it 2 spaces
333
# to match the indentation of the options
334
if sections.has_key(None):
335
text = sections.pop(None)
336
text = '\n '.join(text.splitlines())
337
result += ':%s:\n %s\n\n' % ('Description',text)
339
# Add the custom sections (e.g. Examples). Note that there's no need
340
# to indent these as they must be indented already in the source.
342
labels = sorted(sections.keys())
344
result += ':%s:\n%s\n\n' % (label,sections[label])
346
# Add the aliases, source (plug-in) and see also links, if any
348
result += ':Aliases: '
349
result += ', '.join(self.aliases) + '\n'
350
plugin_name = self.plugin_name()
351
if plugin_name is not None:
352
result += ':From: plugin "%s"\n' % plugin_name
353
see_also = self.get_see_also(additional_see_also)
355
if not plain and see_also_as_links:
357
for item in see_also:
359
# topics doesn't have an independent section
360
# so don't create a real link
361
see_also_links.append(item)
363
# Use a reST link for this entry
364
see_also_links.append("`%s`_" % (item,))
365
see_also = see_also_links
366
result += ':See also: '
367
result += ', '.join(see_also) + '\n'
369
# If this will be rendered as plain text, convert it
371
import bzrlib.help_topics
372
result = bzrlib.help_topics.help_as_plain_text(result)
376
def _get_help_parts(text):
377
"""Split help text into a summary and named sections.
379
:return: (summary,sections) where summary is the top line and
380
sections is a dictionary of the rest indexed by section name.
381
A section starts with a heading line of the form ":xxx:".
382
Indented text on following lines is the section value.
383
All text found outside a named section is assigned to the
384
default section which is given the key of None.
386
def save_section(sections, label, section):
388
if sections.has_key(label):
389
sections[label] += '\n' + section
391
sections[label] = section
393
lines = text.rstrip().splitlines()
394
summary = lines.pop(0)
396
label,section = None,''
398
if line.startswith(':') and line.endswith(':') and len(line) > 2:
399
save_section(sections, label, section)
400
label,section = line[1:-1],''
401
elif (label is not None) and len(line) > 1 and not line[0].isspace():
402
save_section(sections, label, section)
403
label,section = None,line
406
section += '\n' + line
409
save_section(sections, label, section)
410
return summary, sections
412
def get_help_topic(self):
413
"""Return the commands help topic - its name."""
416
def get_see_also(self, additional_terms=None):
417
"""Return a list of help topics that are related to this command.
419
The list is derived from the content of the _see_also attribute. Any
420
duplicates are removed and the result is in lexical order.
421
:param additional_terms: Additional help topics to cross-reference.
422
:return: A list of help topics.
424
see_also = set(getattr(self, '_see_also', []))
426
see_also.update(additional_terms)
427
return sorted(see_also)
430
"""Return dict of valid options for this command.
432
Maps from long option name to option object."""
433
r = Option.STD_OPTIONS.copy()
435
for o in self.takes_options:
436
if isinstance(o, basestring):
437
o = option.Option.OPTIONS[o]
439
if o.name in std_names:
440
self.supported_std_options.append(o.name)
443
def _setup_outf(self):
444
"""Return a file linked to stdout, which has proper encoding."""
445
# Originally I was using self.stdout, but that looks
446
# *way* too much like sys.stdout
447
if self.encoding_type == 'exact':
448
# force sys.stdout to be binary stream on win32
449
if sys.platform == 'win32':
450
fileno = getattr(sys.stdout, 'fileno', None)
453
msvcrt.setmode(fileno(), os.O_BINARY)
454
self.outf = sys.stdout
457
output_encoding = osutils.get_terminal_encoding()
459
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
460
errors=self.encoding_type)
461
# For whatever reason codecs.getwriter() does not advertise its encoding
462
# it just returns the encoding of the wrapped file, which is completely
463
# bogus. So set the attribute, so we can find the correct encoding later.
464
self.outf.encoding = output_encoding
466
def run_argv_aliases(self, argv, alias_argv=None):
467
"""Parse the command line and run with extra aliases in alias_argv."""
469
warn("Passing None for [] is deprecated from bzrlib 0.10",
470
DeprecationWarning, stacklevel=2)
472
args, opts = parse_args(self, argv, alias_argv)
474
# Process the standard options
475
if 'help' in opts: # e.g. bzr add --help
476
sys.stdout.write(self.get_help_text())
478
trace.set_verbosity_level(option._verbosity_level)
479
if 'verbose' in self.supported_std_options:
480
opts['verbose'] = trace.is_verbose()
481
elif opts.has_key('verbose'):
483
if 'quiet' in self.supported_std_options:
484
opts['quiet'] = trace.is_quiet()
485
elif opts.has_key('quiet'):
488
# mix arguments and options into one dictionary
489
cmdargs = _match_argform(self.name(), self.takes_args, args)
491
for k, v in opts.items():
492
cmdopts[k.replace('-', '_')] = v
494
all_cmd_args = cmdargs.copy()
495
all_cmd_args.update(cmdopts)
499
return self.run(**all_cmd_args)
220
"""Override this in sub-classes.
502
"""Actually run the command.
222
504
This is invoked with the options and arguments bound to
223
505
keyword parameters.
225
Return 0 or None if the command was successful, or a shell
231
class ExternalCommand(Command):
232
"""Class to wrap external commands.
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
246
def find_command(cls, cmd):
248
bzrpath = os.environ.get('BZRPATH', '')
250
for dir in bzrpath.split(os.pathsep):
251
path = os.path.join(dir, cmd)
252
if os.path.isfile(path):
253
return ExternalCommand(path)
257
find_command = classmethod(find_command)
259
def __init__(self, path):
262
pipe = os.popen('%s --bzr-usage' % path, 'r')
263
self.takes_options = pipe.readline().split()
265
for opt in self.takes_options:
266
if not opt in OPTIONS:
267
raise BzrError("Unknown option '%s' returned by external command %s"
270
# TODO: Is there any way to check takes_args is valid here?
271
self.takes_args = pipe.readline().split()
273
if pipe.close() is not None:
274
raise BzrError("Failed funning '%s --bzr-usage'" % path)
276
pipe = os.popen('%s --bzr-help' % path, 'r')
277
self.__doc__ = pipe.read()
278
if pipe.close() is not None:
279
raise BzrError("Failed funning '%s --bzr-help'" % path)
281
def __call__(self, options, arguments):
282
Command.__init__(self, options, arguments)
285
def run(self, **kargs):
292
optname = name.replace('_','-')
294
if OPTIONS.has_key(optname):
296
opts.append('--%s' % optname)
297
if value is not None and value is not True:
298
opts.append(str(value))
300
# it's an arg, or arg list
301
if type(value) is not list:
307
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
311
class cmd_status(Command):
312
"""Display status summary.
314
This reports on versioned and unknown files, reporting them
315
grouped by state. Possible states are:
318
Versioned in the working copy but not in the previous revision.
321
Versioned in the previous revision but removed or deleted
325
Path of this file changed from the previous revision;
326
the text may also have changed. This includes files whose
327
parent directory was renamed.
330
Text has changed since the previous revision.
333
Nothing about this file has changed since the previous revision.
334
Only shown with --all.
337
Not versioned and not matching an ignore pattern.
339
To see ignored files use 'bzr ignored'. For details in the
340
changes to file texts, use 'bzr diff'.
342
If no arguments are specified, the status of the entire working
343
directory is shown. Otherwise, only the status of the specified
344
files or directories is reported. If a directory is given, status
345
is reported for everything inside that directory.
347
takes_args = ['file*']
348
takes_options = ['all', 'show-ids']
349
aliases = ['st', 'stat']
351
def run(self, all=False, show_ids=False, file_list=None):
353
b = Branch(file_list[0])
354
file_list = [b.relpath(x) for x in file_list]
355
# special case: only one path was given and it's the root
357
if file_list == ['']:
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
366
class cmd_cat_revision(Command):
367
"""Write out metadata for a revision."""
370
takes_args = ['revision_id']
372
def run(self, revision_id):
373
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
376
class cmd_revno(Command):
377
"""Show current revision number.
379
This is equal to the number of revisions on this branch."""
381
print Branch('.').revno()
384
class cmd_add(Command):
385
"""Add specified files or directories.
387
In non-recursive mode, all the named items are added, regardless
388
of whether they were previously ignored. A warning is given if
389
any of the named files are already versioned.
391
In recursive mode (the default), files are treated the same way
392
but the behaviour for directories is different. Directories that
393
are already versioned do not give a warning. All directories,
394
whether already versioned or not, are searched for files or
395
subdirectories that are neither versioned or ignored, and these
396
are added. This search proceeds recursively into versioned
399
Therefore simply saying 'bzr add .' will version all files that
400
are currently unknown.
402
TODO: Perhaps adding a file whose directly is not versioned should
403
recursively add that parent, rather than giving an error?
405
takes_args = ['file+']
406
takes_options = ['verbose', 'no-recurse']
408
def run(self, file_list, verbose=False, no_recurse=False):
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
412
class cmd_relpath(Command):
413
"""Show path of a file relative to root"""
414
takes_args = ['filename']
417
def run(self, filename):
418
print Branch(filename).relpath(filename)
422
class cmd_inventory(Command):
423
"""Show inventory of the current working copy or a revision."""
424
takes_options = ['revision', 'show-ids']
426
def run(self, revision=None, show_ids=False):
429
inv = b.read_working_inventory()
431
inv = b.get_revision_inventory(b.lookup_revision(revision))
433
for path, entry in inv.entries():
435
print '%-50s %s' % (path, entry.file_id)
440
class cmd_move(Command):
441
"""Move files to a different directory.
446
The destination must be a versioned directory in the same branch.
448
takes_args = ['source$', 'dest']
449
def run(self, source_list, dest):
452
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
455
class cmd_rename(Command):
456
"""Change the name of an entry.
459
bzr rename frob.c frobber.c
460
bzr rename src/frob.c lib/frob.c
462
It is an error if the destination name exists.
464
See also the 'move' command, which moves files into a different
465
directory without changing their name.
467
TODO: Some way to rename multiple files without invoking bzr for each
469
takes_args = ['from_name', 'to_name']
471
def run(self, from_name, to_name):
473
b.rename_one(b.relpath(from_name), b.relpath(to_name))
479
class cmd_pull(Command):
480
"""Pull any changes from another branch into the current one.
482
If the location is omitted, the last-used location will be used.
483
Both the revision history and the working directory will be
486
This command only works on branches that have not diverged. Branches are
487
considered diverged if both branches have had commits without first
488
pulling from the other.
490
If branches have diverged, you can use 'bzr merge' to pull the text changes
491
from one into the other.
493
takes_args = ['location?']
495
def run(self, location=None):
496
from bzrlib.merge import merge
502
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
504
if errno == errno.ENOENT:
507
location = stored_loc
509
raise BzrCommandError("No pull location known or specified.")
510
from branch import find_branch, DivergedBranches
511
br_from = find_branch(location)
512
location = pull_loc(br_from)
513
old_revno = br_to.revno()
515
br_to.update_revisions(br_from)
516
except DivergedBranches:
517
raise BzrCommandError("These branches have diverged. Try merge.")
519
merge(('.', -1), ('.', old_revno), check_clean=False)
520
if location != stored_loc:
521
br_to.controlfile("x-pull", "wb").write(location + "\n")
525
class cmd_branch(Command):
526
"""Create a new copy of a branch.
528
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
529
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
531
To retrieve the branch as of a particular revision, supply the --revision
532
parameter, as in "branch foo/bar -r 5".
534
takes_args = ['from_location', 'to_location?']
535
takes_options = ['revision']
537
def run(self, from_location, to_location=None, revision=None):
539
from bzrlib.merge import merge
540
from branch import find_branch, DivergedBranches, NoSuchRevision
541
from shutil import rmtree
543
br_from = find_branch(from_location)
545
if e.errno == errno.ENOENT:
546
raise BzrCommandError('Source location "%s" does not exist.' %
551
if to_location is None:
552
to_location = os.path.basename(from_location.rstrip("/\\"))
555
os.mkdir(to_location)
557
if e.errno == errno.EEXIST:
558
raise BzrCommandError('Target directory "%s" already exists.' %
560
if e.errno == errno.ENOENT:
561
raise BzrCommandError('Parent of "%s" does not exist.' %
565
br_to = Branch(to_location, init=True)
568
br_to.update_revisions(br_from, stop_revision=revision)
569
except NoSuchRevision:
571
msg = "The branch %s has no revision %d." % (from_location,
573
raise BzrCommandError(msg)
574
merge((to_location, -1), (to_location, 0), this_dir=to_location,
575
check_clean=False, ignore_zero=True)
576
from_location = pull_loc(br_from)
577
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
580
def pull_loc(branch):
581
# TODO: Should perhaps just make attribute be 'base' in
582
# RemoteBranch and Branch?
583
if hasattr(branch, "baseurl"):
584
return branch.baseurl
590
class cmd_renames(Command):
591
"""Show list of renamed files.
593
TODO: Option to show renames between two historical versions.
595
TODO: Only show renames under dir, rather than in the whole branch.
597
takes_args = ['dir?']
599
def run(self, dir='.'):
601
old_inv = b.basis_tree().inventory
602
new_inv = b.read_working_inventory()
604
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
606
for old_name, new_name in renames:
607
print "%s => %s" % (old_name, new_name)
610
class cmd_info(Command):
611
"""Show statistical information about a branch."""
612
takes_args = ['branch?']
614
def run(self, branch=None):
617
from branch import find_branch
618
b = find_branch(branch)
622
class cmd_remove(Command):
623
"""Make a file unversioned.
625
This makes bzr stop tracking changes to a versioned file. It does
626
not delete the working copy.
628
takes_args = ['file+']
629
takes_options = ['verbose']
631
def run(self, file_list, verbose=False):
632
b = Branch(file_list[0])
633
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
636
class cmd_file_id(Command):
637
"""Print file_id of a particular file or directory.
639
The file_id is assigned when the file is first added and remains the
640
same through all revisions where the file exists, even when it is
644
takes_args = ['filename']
645
def run(self, filename):
647
i = b.inventory.path2id(b.relpath(filename))
649
raise BzrError("%r is not a versioned file" % filename)
654
class cmd_file_path(Command):
655
"""Print path of file_ids to a file or directory.
657
This prints one line for each directory down to the target,
658
starting at the branch root."""
660
takes_args = ['filename']
661
def run(self, filename):
664
fid = inv.path2id(b.relpath(filename))
666
raise BzrError("%r is not a versioned file" % filename)
667
for fip in inv.get_idpath(fid):
671
class cmd_revision_history(Command):
672
"""Display list of revision ids on this branch."""
675
for patchid in Branch('.').revision_history():
679
class cmd_directories(Command):
680
"""Display list of versioned directories in this branch."""
682
for name, ie in Branch('.').read_working_inventory().directories():
689
class cmd_init(Command):
690
"""Make a directory into a versioned branch.
692
Use this to create an empty branch, or before importing an
695
Recipe for importing a tree of files:
700
bzr commit -m 'imported project'
703
Branch('.', init=True)
706
class cmd_diff(Command):
707
"""Show differences in working tree.
709
If files are listed, only the changes in those files are listed.
710
Otherwise, all changes for the tree are listed.
712
TODO: Given two revision arguments, show the difference between them.
714
TODO: Allow diff across branches.
716
TODO: Option to use external diff command; could be GNU diff, wdiff,
719
TODO: Python difflib is not exactly the same as unidiff; should
720
either fix it up or prefer to use an external diff.
722
TODO: If a directory is given, diff everything under that.
724
TODO: Selected-file diff is inefficient and doesn't show you
727
TODO: This probably handles non-Unix newlines poorly.
730
takes_args = ['file*']
731
takes_options = ['revision', 'diff-options']
732
aliases = ['di', 'dif']
734
def run(self, revision=None, file_list=None, diff_options=None):
735
from bzrlib.diff import show_diff
736
from bzrlib import find_branch
739
b = find_branch(file_list[0])
740
file_list = [b.relpath(f) for f in file_list]
741
if file_list == ['']:
742
# just pointing to top-of-tree
747
show_diff(b, revision, specific_files=file_list,
748
external_diff_options=diff_options)
754
class cmd_deleted(Command):
755
"""List files deleted in the working tree.
757
TODO: Show files deleted since a previous revision, or between two revisions.
759
def run(self, show_ids=False):
762
new = b.working_tree()
764
## TODO: Much more efficient way to do this: read in new
765
## directories with readdir, rather than stating each one. Same
766
## level of effort but possibly much less IO. (Or possibly not,
767
## if the directories are very large...)
769
for path, ie in old.inventory.iter_entries():
770
if not new.has_id(ie.file_id):
772
print '%-50s %s' % (path, ie.file_id)
777
class cmd_modified(Command):
778
"""List files modified in working tree."""
783
inv = b.read_working_inventory()
784
sc = statcache.update_cache(b, inv)
785
basis = b.basis_tree()
786
basis_inv = basis.inventory
788
# We used to do this through iter_entries(), but that's slow
789
# when most of the files are unmodified, as is usually the
790
# case. So instead we iterate by inventory entry, and only
791
# calculate paths as necessary.
793
for file_id in basis_inv:
794
cacheentry = sc.get(file_id)
795
if not cacheentry: # deleted
797
ie = basis_inv[file_id]
798
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
799
path = inv.id2path(file_id)
804
class cmd_added(Command):
805
"""List files added in working tree."""
809
wt = b.working_tree()
810
basis_inv = b.basis_tree().inventory
813
if file_id in basis_inv:
815
path = inv.id2path(file_id)
816
if not os.access(b.abspath(path), os.F_OK):
822
class cmd_root(Command):
823
"""Show the tree root directory.
825
The root is the nearest enclosing directory with a .bzr control
827
takes_args = ['filename?']
828
def run(self, filename=None):
829
"""Print the branch root."""
830
from branch import find_branch
831
b = find_branch(filename)
832
print getattr(b, 'base', None) or getattr(b, 'baseurl')
835
class cmd_log(Command):
836
"""Show log of this branch.
838
To request a range of logs, you can use the command -r begin:end
839
-r revision requests a specific revision, -r :end or -r begin: are
842
TODO: Make --revision support uuid: and hash: [future tag:] notation.
846
takes_args = ['filename?']
847
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
849
def run(self, filename=None, timezone='original',
854
from bzrlib import show_log, find_branch
857
direction = (forward and 'forward') or 'reverse'
860
b = find_branch(filename)
861
fp = b.relpath(filename)
863
file_id = b.read_working_inventory().path2id(fp)
865
file_id = None # points to branch root
871
revision = [None, None]
872
elif isinstance(revision, int):
873
revision = [revision, revision]
878
assert len(revision) == 2
880
mutter('encoding log as %r' % bzrlib.user_encoding)
882
# use 'replace' so that we don't abort if trying to write out
883
# in e.g. the default C locale.
884
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
887
show_timezone=timezone,
892
start_revision=revision[0],
893
end_revision=revision[1])
897
class cmd_touching_revisions(Command):
898
"""Return revision-ids which affected a particular file.
900
A more user-friendly interface is "bzr log FILE"."""
902
takes_args = ["filename"]
903
def run(self, filename):
905
inv = b.read_working_inventory()
906
file_id = inv.path2id(b.relpath(filename))
907
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
908
print "%6d %s" % (revno, what)
911
class cmd_ls(Command):
912
"""List files in a tree.
914
TODO: Take a revision or remote path and list that tree instead.
917
def run(self, revision=None, verbose=False):
920
tree = b.working_tree()
922
tree = b.revision_tree(b.lookup_revision(revision))
924
for fp, fc, kind, fid in tree.list_files():
926
if kind == 'directory':
933
print '%-8s %s%s' % (fc, fp, kindch)
939
class cmd_unknowns(Command):
940
"""List unknown files."""
942
for f in Branch('.').unknowns():
947
class cmd_ignore(Command):
948
"""Ignore a command or pattern.
950
To remove patterns from the ignore list, edit the .bzrignore file.
952
If the pattern contains a slash, it is compared to the whole path
953
from the branch root. Otherwise, it is comapred to only the last
954
component of the path.
956
Ignore patterns are case-insensitive on case-insensitive systems.
958
Note: wildcards must be quoted from the shell on Unix.
961
bzr ignore ./Makefile
964
takes_args = ['name_pattern']
966
def run(self, name_pattern):
967
from bzrlib.atomicfile import AtomicFile
971
ifn = b.abspath('.bzrignore')
973
if os.path.exists(ifn):
976
igns = f.read().decode('utf-8')
982
# TODO: If the file already uses crlf-style termination, maybe
983
# we should use that for the newly added lines?
985
if igns and igns[-1] != '\n':
987
igns += name_pattern + '\n'
990
f = AtomicFile(ifn, 'wt')
991
f.write(igns.encode('utf-8'))
996
inv = b.working_tree().inventory
997
if inv.path2id('.bzrignore'):
998
mutter('.bzrignore is already versioned')
1000
mutter('need to make new .bzrignore file versioned')
1001
b.add(['.bzrignore'])
1005
class cmd_ignored(Command):
1006
"""List ignored files and the patterns that matched them.
1008
See also: bzr ignore"""
1010
tree = Branch('.').working_tree()
1011
for path, file_class, kind, file_id in tree.list_files():
1012
if file_class != 'I':
1014
## XXX: Slightly inefficient since this was already calculated
1015
pat = tree.is_ignored(path)
1016
print '%-50s %s' % (path, pat)
1019
class cmd_lookup_revision(Command):
1020
"""Lookup the revision-id from a revision-number
1023
bzr lookup-revision 33
1026
takes_args = ['revno']
1028
def run(self, revno):
1032
raise BzrCommandError("not a valid revision-number: %r" % revno)
1034
print Branch('.').lookup_revision(revno)
1037
class cmd_export(Command):
1038
"""Export past revision to destination directory.
1040
If no revision is specified this exports the last committed revision.
1042
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1043
given, exports to a directory (equivalent to --format=dir)."""
1044
# TODO: list known exporters
1045
takes_args = ['dest']
1046
takes_options = ['revision', 'format']
1047
def run(self, dest, revision=None, format='dir'):
1049
if revision == None:
1050
rh = b.revision_history()[-1]
1052
rh = b.lookup_revision(int(revision))
1053
t = b.revision_tree(rh)
1054
t.export(dest, format)
1057
class cmd_cat(Command):
1058
"""Write a file's text from a previous revision."""
1060
takes_options = ['revision']
1061
takes_args = ['filename']
1063
def run(self, filename, revision=None):
1064
if revision == None:
1065
raise BzrCommandError("bzr cat requires a revision number")
1067
b.print_file(b.relpath(filename), int(revision))
1070
class cmd_local_time_offset(Command):
1071
"""Show the offset in seconds from GMT to local time."""
1074
print bzrlib.osutils.local_time_offset()
1078
class cmd_commit(Command):
1079
"""Commit changes into a new revision.
1081
If selected files are specified, only changes to those files are
1082
committed. If a directory is specified then its contents are also
1085
A selected-file commit may fail in some cases where the committed
1086
tree would be invalid, such as trying to commit a file in a
1087
newly-added directory that is not itself committed.
1089
TODO: Run hooks on tree to-be-committed, and after commit.
1091
TODO: Strict commit that fails if there are unknown or deleted files.
1093
takes_args = ['selected*']
1094
takes_options = ['message', 'file', 'verbose']
1095
aliases = ['ci', 'checkin']
1097
def run(self, message=None, file=None, verbose=True, selected_list=None):
1098
from bzrlib.commit import commit
1100
## Warning: shadows builtin file()
1101
if not message and not file:
1102
raise BzrCommandError("please specify a commit message",
1103
["use either --message or --file"])
1104
elif message and file:
1105
raise BzrCommandError("please specify either --message or --file")
1109
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1112
commit(b, message, verbose=verbose, specific_files=selected_list)
1115
class cmd_check(Command):
1116
"""Validate consistency of branch history.
1118
This command checks various invariants about the branch storage to
1119
detect data corruption or bzr bugs.
1121
If given the --update flag, it will update some optional fields
1122
to help ensure data consistency.
1124
takes_args = ['dir?']
1126
def run(self, dir='.'):
1128
bzrlib.check.check(Branch(dir))
1132
class cmd_upgrade(Command):
1133
"""Upgrade branch storage to current format.
1135
This should normally be used only after the check command tells
1138
takes_args = ['dir?']
1140
def run(self, dir='.'):
1141
from bzrlib.upgrade import upgrade
1142
upgrade(Branch(dir))
1146
class cmd_whoami(Command):
1147
"""Show bzr user id."""
1148
takes_options = ['email']
1150
def run(self, email=False):
1152
print bzrlib.osutils.user_email()
1154
print bzrlib.osutils.username()
1157
class cmd_selftest(Command):
1158
"""Run internal test suite"""
1161
from bzrlib.selftest import selftest
1169
class cmd_version(Command):
1170
"""Show version of bzr."""
1175
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1176
# is bzrlib itself in a branch?
1177
bzrrev = bzrlib.get_bzr_revision()
1179
print " (bzr checkout, revision %d {%s})" % bzrrev
1180
print bzrlib.__copyright__
1181
print "http://bazaar-ng.org/"
1183
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1184
print "you may use, modify and redistribute it under the terms of the GNU"
1185
print "General Public License version 2 or later."
1188
class cmd_rocks(Command):
1189
"""Statement of optimism."""
1192
print "it sure does!"
1194
def parse_spec(spec):
1196
>>> parse_spec(None)
1198
>>> parse_spec("./")
1200
>>> parse_spec("../@")
1202
>>> parse_spec("../f/@35")
1208
parsed = spec.split('/@')
1209
assert len(parsed) == 2
1213
parsed[1] = int(parsed[1])
1214
assert parsed[1] >=0
1216
parsed = [spec, None]
1221
class cmd_merge(Command):
1222
"""Perform a three-way merge of trees.
1224
The SPEC parameters are working tree or revision specifiers. Working trees
1225
are specified using standard paths or urls. No component of a directory
1226
path may begin with '@'.
1228
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1230
Revisions are specified using a dirname/@revno pair, where dirname is the
1231
branch directory and revno is the revision within that branch. If no revno
1232
is specified, the latest revision is used.
1234
Revision examples: './@127', 'foo/@', '../@1'
1236
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1237
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1240
merge refuses to run if there are any uncommitted changes, unless
1243
takes_args = ['other_spec', 'base_spec?']
1244
takes_options = ['force']
1246
def run(self, other_spec, base_spec=None, force=False):
1247
from bzrlib.merge import merge
1248
merge(parse_spec(other_spec), parse_spec(base_spec),
1249
check_clean=(not force))
1252
class cmd_revert(Command):
1253
"""Reverse all changes since the last commit.
1255
Only versioned files are affected.
1257
TODO: Store backups of any files that will be reverted, so
1258
that the revert can be undone.
1260
takes_options = ['revision']
1262
def run(self, revision=-1):
1263
from bzrlib.merge import merge
1264
merge(('.', revision), parse_spec('.'),
1269
class cmd_assert_fail(Command):
1270
"""Test reporting of assertion failures"""
1273
assert False, "always fails"
1276
class cmd_help(Command):
1277
"""Show help on a command or other topic.
1279
For a list of all available commands, say 'bzr help commands'."""
1280
takes_args = ['topic?']
1283
def run(self, topic=None):
1288
class cmd_update_stat_cache(Command):
1289
"""Update stat-cache mapping inodes to SHA-1 hashes.
1291
For testing only."""
1296
statcache.update_cache(b.base, b.read_working_inventory())
1300
# list of all available options; the rhs can be either None for an
1301
# option that takes no argument, or a constructor function that checks
1305
'diff-options': str,
1314
'revision': _parse_revision_str,
1332
def parse_args(argv):
507
Return 0 or None if the command was successful, or a non-zero
508
shell error code if not. It's OK for this method to allow
509
an exception to raise up.
511
raise NotImplementedError('no implementation of command %r'
515
"""Return help message for this class."""
516
from inspect import getdoc
517
if self.__doc__ is Command.__doc__:
522
return _unsquish_command_name(self.__class__.__name__)
524
def plugin_name(self):
525
"""Get the name of the plugin that provides this command.
527
:return: The name of the plugin or None if the command is builtin.
529
mod_parts = self.__module__.split('.')
530
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
536
def parse_args(command, argv, alias_argv=None):
1333
537
"""Parse command line.
1335
539
Arguments and options are parsed at this level before being passed
1336
540
down to specific command handlers. This routine knows, from a
1337
541
lookup table, something about the available options, what optargs
1338
542
they take, and which commands will accept them.
1340
>>> parse_args('--help'.split())
1341
([], {'help': True})
1342
>>> parse_args('--version'.split())
1343
([], {'version': True})
1344
>>> parse_args('status --all'.split())
1345
(['status'], {'all': True})
1346
>>> parse_args('commit --message=biter'.split())
1347
(['commit'], {'message': u'biter'})
1348
>>> parse_args('log -r 500'.split())
1349
(['log'], {'revision': 500})
1350
>>> parse_args('log -r500:600'.split())
1351
(['log'], {'revision': [500, 600]})
1352
>>> parse_args('log -vr500:600'.split())
1353
(['log'], {'verbose': True, 'revision': [500, 600]})
1354
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1355
Traceback (most recent call last):
1357
ValueError: invalid literal for int(): v500
1362
# TODO: Maybe handle '--' to end options?
1367
# option names must not be unicode
1371
mutter(" got option %r" % a)
1373
optname, optarg = a[2:].split('=', 1)
1376
if optname not in OPTIONS:
1377
raise BzrError('unknown long option %r' % a)
1380
if shortopt in SHORT_OPTIONS:
1381
# Multi-character options must have a space to delimit
1383
optname = SHORT_OPTIONS[shortopt]
1385
# Single character short options, can be chained,
1386
# and have their value appended to their name
1388
if shortopt not in SHORT_OPTIONS:
1389
# We didn't find the multi-character name, and we
1390
# didn't find the single char name
1391
raise BzrError('unknown short option %r' % a)
1392
optname = SHORT_OPTIONS[shortopt]
1395
# There are extra things on this option
1396
# see if it is the value, or if it is another
1398
optargfn = OPTIONS[optname]
1399
if optargfn is None:
1400
# This option does not take an argument, so the
1401
# next entry is another short option, pack it back
1403
argv.insert(0, '-' + a[2:])
1405
# This option takes an argument, so pack it
1410
# XXX: Do we ever want to support this, e.g. for -r?
1411
raise BzrError('repeated option %r' % a)
1413
optargfn = OPTIONS[optname]
1417
raise BzrError('option %r needs an argument' % a)
1419
optarg = argv.pop(0)
1420
opts[optname] = optargfn(optarg)
1423
raise BzrError('option %r takes no argument' % optname)
1424
opts[optname] = True
544
# TODO: make it a method of the Command?
545
parser = option.get_optparser(command.options())
546
if alias_argv is not None:
547
args = alias_argv + argv
551
options, args = parser.parse_args(args)
552
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
553
v is not option.OptionParser.DEFAULT_VALUE])
1428
554
return args, opts
1433
557
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
