135
def get_cmd_object(cmd_name, plugins_override=True):
187
def get_cmd_class(cmd, plugins_override=True):
136
188
"""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.
190
cmd = str(cmd) # not unicode
156
192
# first look up this command under the specified name
157
193
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
195
return cmd, cmds[cmd]
163
199
# 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)
200
for cmdname, cmdclass in cmds.iteritems():
201
if cmd in cmdclass.aliases:
202
return cmdname, cmdclass
204
cmdclass = ExternalCommand.find_command(cmd)
208
raise BzrCommandError("unknown command %r" % cmd)
174
211
class Command(object):
175
212
"""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
214
The docstring for an actual command should give a single-line
189
215
summary, then a complete description of the command. A grammar
190
216
description will be inserted.
193
Other accepted names for this command.
196
219
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().
223
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
226
If true, this command isn't advertised.
234
231
takes_options = []
235
encoding_type = 'strict'
240
"""Construct an instance of this command."""
235
def __init__(self, options, arguments):
236
"""Construct and run the command.
238
Sets self.status to the return value of run()."""
239
assert isinstance(options, dict)
240
assert isinstance(arguments, dict)
241
cmdargs = options.copy()
242
cmdargs.update(arguments)
241
243
if self.__doc__ == Command.__doc__:
244
from warnings import warn
242
245
warn("No help message set for %r" % self)
244
def _maybe_expand_globs(self, file_list):
245
"""Glob expand file_list if the platform does not do that itself.
247
:return: A possibly empty list of unicode paths.
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
258
"""Return single-line grammar for this command.
260
Only describes arguments, not options.
262
s = 'bzr ' + self.name() + ' '
263
for aname in self.takes_args:
264
aname = aname.upper()
265
if aname[-1] in ['$', '+']:
266
aname = aname[:-1] + '...'
267
elif aname[-1] == '?':
268
aname = '[' + aname[:-1] + ']'
269
elif aname[-1] == '*':
270
aname = '[' + aname[:-1] + '...]'
277
def get_help_text(self, additional_see_also=None, plain=True,
278
see_also_as_links=False):
279
"""Return a text string with help for this command.
281
:param additional_see_also: Additional help topics to be
283
:param plain: if False, raw help (reStructuredText) is
284
returned instead of plain text.
285
:param see_also_as_links: if True, convert items in 'See also'
286
list to internal links (used by bzr_man rstx generator)
290
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
292
# Extract the summary (purpose) and sections out from the text
293
purpose,sections = self._get_help_parts(doc)
295
# If a custom usage section was provided, use it
296
if sections.has_key('Usage'):
297
usage = sections.pop('Usage')
299
usage = self._usage()
301
# The header is the purpose and usage
303
result += ':Purpose: %s\n' % purpose
304
if usage.find('\n') >= 0:
305
result += ':Usage:\n%s\n' % usage
307
result += ':Usage: %s\n' % usage
311
options = option.get_optparser(self.options()).format_option_help()
312
if options.startswith('Options:'):
313
result += ':' + options
314
elif options.startswith('options:'):
315
# Python 2.4 version of optparse
316
result += ':Options:' + options[len('options:'):]
321
# Add the description, indenting it 2 spaces
322
# to match the indentation of the options
323
if sections.has_key(None):
324
text = sections.pop(None)
325
text = '\n '.join(text.splitlines())
326
result += ':%s:\n %s\n\n' % ('Description',text)
328
# Add the custom sections (e.g. Examples). Note that there's no need
329
# to indent these as they must be indented already in the source.
331
labels = sorted(sections.keys())
333
result += ':%s:\n%s\n\n' % (label,sections[label])
335
# Add the aliases, source (plug-in) and see also links, if any
337
result += ':Aliases: '
338
result += ', '.join(self.aliases) + '\n'
339
plugin_name = self.plugin_name()
340
if plugin_name is not None:
341
result += ':From: plugin "%s"\n' % plugin_name
342
see_also = self.get_see_also(additional_see_also)
344
if not plain and see_also_as_links:
346
for item in see_also:
348
# topics doesn't have an independent section
349
# so don't create a real link
350
see_also_links.append(item)
352
# Use a reST link for this entry
353
see_also_links.append("`%s`_" % (item,))
354
see_also = see_also_links
355
result += ':See also: '
356
result += ', '.join(see_also) + '\n'
358
# If this will be rendered as plan text, convert it
360
import bzrlib.help_topics
361
result = bzrlib.help_topics.help_as_plain_text(result)
365
def _get_help_parts(text):
366
"""Split help text into a summary and named sections.
368
:return: (summary,sections) where summary is the top line and
369
sections is a dictionary of the rest indexed by section name.
370
A section starts with a heading line of the form ":xxx:".
371
Indented text on following lines is the section value.
372
All text found outside a named section is assigned to the
373
default section which is given the key of None.
375
def save_section(sections, label, section):
377
if sections.has_key(label):
378
sections[label] += '\n' + section
380
sections[label] = section
382
lines = text.rstrip().splitlines()
383
summary = lines.pop(0)
385
label,section = None,''
387
if line.startswith(':') and line.endswith(':') and len(line) > 2:
388
save_section(sections, label, section)
389
label,section = line[1:-1],''
390
elif label != None and len(line) > 1 and not line[0].isspace():
391
save_section(sections, label, section)
392
label,section = None,line
395
section += '\n' + line
398
save_section(sections, label, section)
399
return summary, sections
401
def get_help_topic(self):
402
"""Return the commands help topic - its name."""
405
def get_see_also(self, additional_terms=None):
406
"""Return a list of help topics that are related to this command.
408
The list is derived from the content of the _see_also attribute. Any
409
duplicates are removed and the result is in lexical order.
410
:param additional_terms: Additional help topics to cross-reference.
411
:return: A list of help topics.
413
see_also = set(getattr(self, '_see_also', []))
415
see_also.update(additional_terms)
416
return sorted(see_also)
419
"""Return dict of valid options for this command.
421
Maps from long option name to option object."""
423
r['help'] = option._help_option
424
for o in self.takes_options:
425
if isinstance(o, basestring):
426
o = option.Option.OPTIONS[o]
430
def _setup_outf(self):
431
"""Return a file linked to stdout, which has proper encoding."""
432
assert self.encoding_type in ['strict', 'exact', 'replace']
434
# Originally I was using self.stdout, but that looks
435
# *way* too much like sys.stdout
436
if self.encoding_type == 'exact':
437
# force sys.stdout to be binary stream on win32
438
if sys.platform == 'win32':
439
fileno = getattr(sys.stdout, 'fileno', None)
442
msvcrt.setmode(fileno(), os.O_BINARY)
443
self.outf = sys.stdout
446
output_encoding = osutils.get_terminal_encoding()
246
self.status = self.run(**cmdargs)
247
if self.status is None:
252
"""Override this in sub-classes.
254
This is invoked with the options and arguments bound to
257
Return 0 or None if the command was successful, or a shell
263
class ExternalCommand(Command):
264
"""Class to wrap external commands.
266
We cheat a little here, when get_cmd_class() calls us we actually
267
give it back an object we construct that has the appropriate path,
268
help, options etc for the specified command.
270
When run_bzr() tries to instantiate that 'class' it gets caught by
271
the __call__ method, which we override to call the Command.__init__
272
method. That then calls our run method which is pretty straight
275
The only wrinkle is that we have to map bzr's dictionary of options
276
and arguments back into command line options and arguments for the
280
def find_command(cls, cmd):
282
bzrpath = os.environ.get('BZRPATH', '')
284
for dir in bzrpath.split(os.pathsep):
285
path = os.path.join(dir, cmd)
286
if os.path.isfile(path):
287
return ExternalCommand(path)
291
find_command = classmethod(find_command)
293
def __init__(self, path):
296
pipe = os.popen('%s --bzr-usage' % path, 'r')
297
self.takes_options = pipe.readline().split()
299
for opt in self.takes_options:
300
if not opt in OPTIONS:
301
raise BzrError("Unknown option '%s' returned by external command %s"
304
# TODO: Is there any way to check takes_args is valid here?
305
self.takes_args = pipe.readline().split()
307
if pipe.close() is not None:
308
raise BzrError("Failed funning '%s --bzr-usage'" % path)
310
pipe = os.popen('%s --bzr-help' % path, 'r')
311
self.__doc__ = pipe.read()
312
if pipe.close() is not None:
313
raise BzrError("Failed funning '%s --bzr-help'" % path)
315
def __call__(self, options, arguments):
316
Command.__init__(self, options, arguments)
319
def run(self, **kargs):
326
optname = name.replace('_','-')
328
if OPTIONS.has_key(optname):
330
opts.append('--%s' % optname)
331
if value is not None and value is not True:
332
opts.append(str(value))
334
# it's an arg, or arg list
335
if type(value) is not list:
341
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
345
class cmd_status(Command):
346
"""Display status summary.
348
This reports on versioned and unknown files, reporting them
349
grouped by state. Possible states are:
352
Versioned in the working copy but not in the previous revision.
355
Versioned in the previous revision but removed or deleted
359
Path of this file changed from the previous revision;
360
the text may also have changed. This includes files whose
361
parent directory was renamed.
364
Text has changed since the previous revision.
367
Nothing about this file has changed since the previous revision.
368
Only shown with --all.
371
Not versioned and not matching an ignore pattern.
373
To see ignored files use 'bzr ignored'. For details in the
374
changes to file texts, use 'bzr diff'.
376
If no arguments are specified, the status of the entire working
377
directory is shown. Otherwise, only the status of the specified
378
files or directories is reported. If a directory is given, status
379
is reported for everything inside that directory.
381
If a revision is specified, the changes since that revision are shown.
383
takes_args = ['file*']
384
takes_options = ['all', 'show-ids', 'revision']
385
aliases = ['st', 'stat']
387
def run(self, all=False, show_ids=False, file_list=None):
389
b = find_branch(file_list[0])
390
file_list = [b.relpath(x) for x in file_list]
391
# special case: only one path was given and it's the root
393
if file_list == ['']:
398
from bzrlib.status import show_status
399
show_status(b, show_unchanged=all, show_ids=show_ids,
400
specific_files=file_list)
403
class cmd_cat_revision(Command):
404
"""Write out metadata for a revision."""
407
takes_args = ['revision_id']
409
def run(self, revision_id):
410
from bzrlib.xml import pack_xml
411
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
414
class cmd_revno(Command):
415
"""Show current revision number.
417
This is equal to the number of revisions on this branch."""
419
print find_branch('.').revno()
421
class cmd_revision_info(Command):
422
"""Show revision number and revision id for a given revision identifier.
425
takes_args = ['revision_info*']
426
takes_options = ['revision']
427
def run(self, revision=None, revision_info_list=None):
428
from bzrlib.branch import find_branch
431
if revision is not None:
432
revs.extend(revision)
433
if revision_info_list is not None:
434
revs.extend(revision_info_list)
436
raise BzrCommandError('You must supply a revision identifier')
441
print '%4d %s' % b.get_revision_info(rev)
444
class cmd_add(Command):
445
"""Add specified files or directories.
447
In non-recursive mode, all the named items are added, regardless
448
of whether they were previously ignored. A warning is given if
449
any of the named files are already versioned.
451
In recursive mode (the default), files are treated the same way
452
but the behaviour for directories is different. Directories that
453
are already versioned do not give a warning. All directories,
454
whether already versioned or not, are searched for files or
455
subdirectories that are neither versioned or ignored, and these
456
are added. This search proceeds recursively into versioned
457
directories. If no names are given '.' is assumed.
459
Therefore simply saying 'bzr add' will version all files that
460
are currently unknown.
462
TODO: Perhaps adding a file whose directly is not versioned should
463
recursively add that parent, rather than giving an error?
465
takes_args = ['file*']
466
takes_options = ['verbose', 'no-recurse']
468
def run(self, file_list, verbose=False, no_recurse=False):
469
from bzrlib.add import smart_add
470
smart_add(file_list, verbose, not no_recurse)
474
class cmd_mkdir(Command):
475
"""Create a new versioned directory.
477
This is equivalent to creating the directory and then adding it.
479
takes_args = ['dir+']
481
def run(self, dir_list):
488
b.add([d], verbose=True)
491
class cmd_relpath(Command):
492
"""Show path of a file relative to root"""
493
takes_args = ['filename']
496
def run(self, filename):
497
print find_branch(filename).relpath(filename)
501
class cmd_inventory(Command):
502
"""Show inventory of the current working copy or a revision."""
503
takes_options = ['revision', 'show-ids']
505
def run(self, revision=None, show_ids=False):
508
inv = b.read_working_inventory()
510
if len(revision) > 1:
511
raise BzrCommandError('bzr inventory --revision takes'
512
' exactly one revision identifier')
513
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
515
for path, entry in inv.entries():
517
print '%-50s %s' % (path, entry.file_id)
522
class cmd_move(Command):
523
"""Move files to a different directory.
528
The destination must be a versioned directory in the same branch.
530
takes_args = ['source$', 'dest']
531
def run(self, source_list, dest):
534
# TODO: glob expansion on windows?
535
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
538
class cmd_rename(Command):
539
"""Change the name of an entry.
542
bzr rename frob.c frobber.c
543
bzr rename src/frob.c lib/frob.c
545
It is an error if the destination name exists.
547
See also the 'move' command, which moves files into a different
548
directory without changing their name.
550
TODO: Some way to rename multiple files without invoking bzr for each
552
takes_args = ['from_name', 'to_name']
554
def run(self, from_name, to_name):
556
b.rename_one(b.relpath(from_name), b.relpath(to_name))
560
class cmd_mv(Command):
561
"""Move or rename a file.
564
bzr mv OLDNAME NEWNAME
565
bzr mv SOURCE... DESTINATION
567
If the last argument is a versioned directory, all the other names
568
are moved into it. Otherwise, there must be exactly two arguments
569
and the file is changed to a new name, which must not already exist.
571
Files cannot be moved between branches.
573
takes_args = ['names*']
574
def run(self, names_list):
575
if len(names_list) < 2:
576
raise BzrCommandError("missing file argument")
577
b = find_branch(names_list[0])
579
rel_names = [b.relpath(x) for x in names_list]
581
if os.path.isdir(names_list[-1]):
582
# move into existing directory
583
b.move(rel_names[:-1], rel_names[-1])
585
if len(names_list) != 2:
586
raise BzrCommandError('to mv multiple files the destination '
587
'must be a versioned directory')
588
b.move(rel_names[0], rel_names[1])
593
class cmd_pull(Command):
594
"""Pull any changes from another branch into the current one.
596
If the location is omitted, the last-used location will be used.
597
Both the revision history and the working directory will be
600
This command only works on branches that have not diverged. Branches are
601
considered diverged if both branches have had commits without first
602
pulling from the other.
604
If branches have diverged, you can use 'bzr merge' to pull the text changes
605
from one into the other.
607
takes_args = ['location?']
609
def run(self, location=None):
610
from bzrlib.merge import merge
612
from shutil import rmtree
615
br_to = find_branch('.')
618
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
620
if e.errno != errno.ENOENT:
623
if stored_loc is None:
624
raise BzrCommandError("No pull location known or specified.")
626
print "Using last location: %s" % stored_loc
627
location = stored_loc
628
cache_root = tempfile.mkdtemp()
629
from bzrlib.branch import DivergedBranches
630
br_from = find_branch(location)
631
location = pull_loc(br_from)
632
old_revno = br_to.revno()
634
from branch import find_cached_branch, DivergedBranches
635
br_from = find_cached_branch(location, cache_root)
636
location = pull_loc(br_from)
637
old_revno = br_to.revno()
639
br_to.update_revisions(br_from)
640
except DivergedBranches:
641
raise BzrCommandError("These branches have diverged."
644
merge(('.', -1), ('.', old_revno), check_clean=False)
645
if location != stored_loc:
646
br_to.controlfile("x-pull", "wb").write(location + "\n")
652
class cmd_branch(Command):
653
"""Create a new copy of a branch.
655
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
656
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
658
To retrieve the branch as of a particular revision, supply the --revision
659
parameter, as in "branch foo/bar -r 5".
661
takes_args = ['from_location', 'to_location?']
662
takes_options = ['revision']
663
aliases = ['get', 'clone']
665
def run(self, from_location, to_location=None, revision=None):
667
from bzrlib.merge import merge
668
from bzrlib.branch import DivergedBranches, \
669
find_cached_branch, Branch
670
from shutil import rmtree
671
from meta_store import CachedStore
673
cache_root = tempfile.mkdtemp()
677
elif len(revision) > 1:
678
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
682
br_from = find_cached_branch(from_location, cache_root)
684
if e.errno == errno.ENOENT:
685
raise BzrCommandError('Source location "%s" does not'
686
' exist.' % to_location)
690
if to_location is None:
691
to_location = os.path.basename(from_location.rstrip("/\\"))
694
os.mkdir(to_location)
696
if e.errno == errno.EEXIST:
697
raise BzrCommandError('Target directory "%s" already'
698
' exists.' % to_location)
699
if e.errno == errno.ENOENT:
700
raise BzrCommandError('Parent of "%s" does not exist.' %
704
br_to = Branch(to_location, init=True)
706
br_to.set_root_id(br_from.get_root_id())
709
if revision[0] is None:
710
revno = br_from.revno()
712
revno, rev_id = br_from.get_revision_info(revision[0])
714
br_to.update_revisions(br_from, stop_revision=revno)
715
except bzrlib.errors.NoSuchRevision:
717
msg = "The branch %s has no revision %d." % (from_location,
719
raise BzrCommandError(msg)
721
merge((to_location, -1), (to_location, 0), this_dir=to_location,
722
check_clean=False, ignore_zero=True)
723
from_location = pull_loc(br_from)
724
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
729
def pull_loc(branch):
730
# TODO: Should perhaps just make attribute be 'base' in
731
# RemoteBranch and Branch?
732
if hasattr(branch, "baseurl"):
733
return branch.baseurl
739
class cmd_renames(Command):
740
"""Show list of renamed files.
742
TODO: Option to show renames between two historical versions.
744
TODO: Only show renames under dir, rather than in the whole branch.
746
takes_args = ['dir?']
748
def run(self, dir='.'):
750
old_inv = b.basis_tree().inventory
751
new_inv = b.read_working_inventory()
753
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
755
for old_name, new_name in renames:
756
print "%s => %s" % (old_name, new_name)
759
class cmd_info(Command):
760
"""Show statistical information about a branch."""
761
takes_args = ['branch?']
763
def run(self, branch=None):
766
b = find_branch(branch)
770
class cmd_remove(Command):
771
"""Make a file unversioned.
773
This makes bzr stop tracking changes to a versioned file. It does
774
not delete the working copy.
776
takes_args = ['file+']
777
takes_options = ['verbose']
779
def run(self, file_list, verbose=False):
780
b = find_branch(file_list[0])
781
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
784
class cmd_file_id(Command):
785
"""Print file_id of a particular file or directory.
787
The file_id is assigned when the file is first added and remains the
788
same through all revisions where the file exists, even when it is
792
takes_args = ['filename']
793
def run(self, filename):
794
b = find_branch(filename)
795
i = b.inventory.path2id(b.relpath(filename))
797
raise BzrError("%r is not a versioned file" % filename)
802
class cmd_file_path(Command):
803
"""Print path of file_ids to a file or directory.
805
This prints one line for each directory down to the target,
806
starting at the branch root."""
808
takes_args = ['filename']
809
def run(self, filename):
810
b = find_branch(filename)
812
fid = inv.path2id(b.relpath(filename))
814
raise BzrError("%r is not a versioned file" % filename)
815
for fip in inv.get_idpath(fid):
819
class cmd_revision_history(Command):
820
"""Display list of revision ids on this branch."""
823
for patchid in find_branch('.').revision_history():
827
class cmd_directories(Command):
828
"""Display list of versioned directories in this branch."""
830
for name, ie in find_branch('.').read_working_inventory().directories():
837
class cmd_init(Command):
838
"""Make a directory into a versioned branch.
840
Use this to create an empty branch, or before importing an
843
Recipe for importing a tree of files:
848
bzr commit -m 'imported project'
851
from bzrlib.branch import Branch
852
Branch('.', init=True)
855
class cmd_diff(Command):
856
"""Show differences in working tree.
858
If files are listed, only the changes in those files are listed.
859
Otherwise, all changes for the tree are listed.
861
TODO: Allow diff across branches.
863
TODO: Option to use external diff command; could be GNU diff, wdiff,
866
TODO: Python difflib is not exactly the same as unidiff; should
867
either fix it up or prefer to use an external diff.
869
TODO: If a directory is given, diff everything under that.
871
TODO: Selected-file diff is inefficient and doesn't show you
874
TODO: This probably handles non-Unix newlines poorly.
882
takes_args = ['file*']
883
takes_options = ['revision', 'diff-options']
884
aliases = ['di', 'dif']
886
def run(self, revision=None, file_list=None, diff_options=None):
887
from bzrlib.diff import show_diff
890
b = find_branch(file_list[0])
891
file_list = [b.relpath(f) for f in file_list]
892
if file_list == ['']:
893
# just pointing to top-of-tree
898
if revision is not None:
899
if len(revision) == 1:
900
show_diff(b, revision[0], specific_files=file_list,
901
external_diff_options=diff_options)
902
elif len(revision) == 2:
903
show_diff(b, revision[0], specific_files=file_list,
904
external_diff_options=diff_options,
905
revision2=revision[1])
907
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
909
show_diff(b, None, specific_files=file_list,
910
external_diff_options=diff_options)
915
class cmd_deleted(Command):
916
"""List files deleted in the working tree.
918
TODO: Show files deleted since a previous revision, or between two revisions.
920
def run(self, show_ids=False):
923
new = b.working_tree()
925
## TODO: Much more efficient way to do this: read in new
926
## directories with readdir, rather than stating each one. Same
927
## level of effort but possibly much less IO. (Or possibly not,
928
## if the directories are very large...)
930
for path, ie in old.inventory.iter_entries():
931
if not new.has_id(ie.file_id):
933
print '%-50s %s' % (path, ie.file_id)
938
class cmd_modified(Command):
939
"""List files modified in working tree."""
942
from bzrlib.delta import compare_trees
945
td = compare_trees(b.basis_tree(), b.working_tree())
947
for path, id, kind in td.modified:
952
class cmd_added(Command):
953
"""List files added in working tree."""
957
wt = b.working_tree()
958
basis_inv = b.basis_tree().inventory
961
if file_id in basis_inv:
963
path = inv.id2path(file_id)
964
if not os.access(b.abspath(path), os.F_OK):
970
class cmd_root(Command):
971
"""Show the tree root directory.
973
The root is the nearest enclosing directory with a .bzr control
975
takes_args = ['filename?']
976
def run(self, filename=None):
977
"""Print the branch root."""
978
b = find_branch(filename)
979
print getattr(b, 'base', None) or getattr(b, 'baseurl')
982
class cmd_log(Command):
983
"""Show log of this branch.
985
To request a range of logs, you can use the command -r begin:end
986
-r revision requests a specific revision, -r :end or -r begin: are
989
--message allows you to give a regular expression, which will be evaluated
990
so that only matching entries will be displayed.
992
TODO: Make --revision support uuid: and hash: [future tag:] notation.
996
takes_args = ['filename?']
997
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
998
'long', 'message', 'short',]
1000
def run(self, filename=None, timezone='original',
1008
from bzrlib.branch import find_branch
1009
from bzrlib.log import log_formatter, show_log
1012
direction = (forward and 'forward') or 'reverse'
1015
b = find_branch(filename)
1016
fp = b.relpath(filename)
1018
file_id = b.read_working_inventory().path2id(fp)
1020
file_id = None # points to branch root
1022
b = find_branch('.')
1025
if revision is None:
1028
elif len(revision) == 1:
1029
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1030
elif len(revision) == 2:
1031
rev1 = b.get_revision_info(revision[0])[0]
1032
rev2 = b.get_revision_info(revision[1])[0]
1034
raise BzrCommandError('bzr log --revision takes one or two values.')
1041
mutter('encoding log as %r' % bzrlib.user_encoding)
448
1043
# use 'replace' so that we don't abort if trying to write out
449
1044
# in e.g. the default C locale.
450
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
451
# For whatever reason codecs.getwriter() does not advertise its encoding
452
# it just returns the encoding of the wrapped file, which is completely
453
# bogus. So set the attribute, so we can find the correct encoding later.
454
self.outf.encoding = output_encoding
456
def run_argv_aliases(self, argv, alias_argv=None):
457
"""Parse the command line and run with extra aliases in alias_argv."""
459
warn("Passing None for [] is deprecated from bzrlib 0.10",
460
DeprecationWarning, stacklevel=2)
462
args, opts = parse_args(self, argv, alias_argv)
463
if 'help' in opts: # e.g. bzr add --help
464
sys.stdout.write(self.get_help_text())
466
# mix arguments and options into one dictionary
467
cmdargs = _match_argform(self.name(), self.takes_args, args)
469
for k, v in opts.items():
470
cmdopts[k.replace('-', '_')] = v
472
all_cmd_args = cmdargs.copy()
473
all_cmd_args.update(cmdopts)
477
return self.run(**all_cmd_args)
480
"""Actually run the command.
482
This is invoked with the options and arguments bound to
485
Return 0 or None if the command was successful, or a non-zero
486
shell error code if not. It's OK for this method to allow
487
an exception to raise up.
489
raise NotImplementedError('no implementation of command %r'
493
"""Return help message for this class."""
494
from inspect import getdoc
495
if self.__doc__ is Command.__doc__:
500
return _unsquish_command_name(self.__class__.__name__)
502
def plugin_name(self):
503
"""Get the name of the plugin that provides this command.
505
:return: The name of the plugin or None if the command is builtin.
507
mod_parts = self.__module__.split('.')
508
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
514
# Technically, this function hasn't been use in a *really* long time
515
# but we are only deprecating it now.
516
@deprecated_function(zero_eleven)
1045
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1050
log_format = 'short'
1051
lf = log_formatter(log_format,
1054
show_timezone=timezone)
1060
direction=direction,
1061
start_revision=rev1,
1067
class cmd_touching_revisions(Command):
1068
"""Return revision-ids which affected a particular file.
1070
A more user-friendly interface is "bzr log FILE"."""
1072
takes_args = ["filename"]
1073
def run(self, filename):
1074
b = find_branch(filename)
1075
inv = b.read_working_inventory()
1076
file_id = inv.path2id(b.relpath(filename))
1077
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1078
print "%6d %s" % (revno, what)
1081
class cmd_ls(Command):
1082
"""List files in a tree.
1084
TODO: Take a revision or remote path and list that tree instead.
1087
def run(self, revision=None, verbose=False):
1088
b = find_branch('.')
1089
if revision == None:
1090
tree = b.working_tree()
1092
tree = b.revision_tree(b.lookup_revision(revision))
1094
for fp, fc, kind, fid in tree.list_files():
1096
if kind == 'directory':
1098
elif kind == 'file':
1103
print '%-8s %s%s' % (fc, fp, kindch)
1109
class cmd_unknowns(Command):
1110
"""List unknown files."""
1112
from bzrlib.osutils import quotefn
1113
for f in find_branch('.').unknowns():
1118
class cmd_ignore(Command):
1119
"""Ignore a command or pattern.
1121
To remove patterns from the ignore list, edit the .bzrignore file.
1123
If the pattern contains a slash, it is compared to the whole path
1124
from the branch root. Otherwise, it is comapred to only the last
1125
component of the path.
1127
Ignore patterns are case-insensitive on case-insensitive systems.
1129
Note: wildcards must be quoted from the shell on Unix.
1132
bzr ignore ./Makefile
1133
bzr ignore '*.class'
1135
takes_args = ['name_pattern']
1137
def run(self, name_pattern):
1138
from bzrlib.atomicfile import AtomicFile
1141
b = find_branch('.')
1142
ifn = b.abspath('.bzrignore')
1144
if os.path.exists(ifn):
1147
igns = f.read().decode('utf-8')
1153
# TODO: If the file already uses crlf-style termination, maybe
1154
# we should use that for the newly added lines?
1156
if igns and igns[-1] != '\n':
1158
igns += name_pattern + '\n'
1161
f = AtomicFile(ifn, 'wt')
1162
f.write(igns.encode('utf-8'))
1167
inv = b.working_tree().inventory
1168
if inv.path2id('.bzrignore'):
1169
mutter('.bzrignore is already versioned')
1171
mutter('need to make new .bzrignore file versioned')
1172
b.add(['.bzrignore'])
1176
class cmd_ignored(Command):
1177
"""List ignored files and the patterns that matched them.
1179
See also: bzr ignore"""
1181
tree = find_branch('.').working_tree()
1182
for path, file_class, kind, file_id in tree.list_files():
1183
if file_class != 'I':
1185
## XXX: Slightly inefficient since this was already calculated
1186
pat = tree.is_ignored(path)
1187
print '%-50s %s' % (path, pat)
1190
class cmd_lookup_revision(Command):
1191
"""Lookup the revision-id from a revision-number
1194
bzr lookup-revision 33
1197
takes_args = ['revno']
1199
def run(self, revno):
1203
raise BzrCommandError("not a valid revision-number: %r" % revno)
1205
print find_branch('.').lookup_revision(revno)
1208
class cmd_export(Command):
1209
"""Export past revision to destination directory.
1211
If no revision is specified this exports the last committed revision.
1213
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1214
given, try to find the format with the extension. If no extension
1215
is found exports to a directory (equivalent to --format=dir).
1217
Root may be the top directory for tar, tgz and tbz2 formats. If none
1218
is given, the top directory will be the root name of the file."""
1219
# TODO: list known exporters
1220
takes_args = ['dest']
1221
takes_options = ['revision', 'format', 'root']
1222
def run(self, dest, revision=None, format=None, root=None):
1224
b = find_branch('.')
1225
if revision is None:
1226
rev_id = b.last_patch()
1228
if len(revision) != 1:
1229
raise BzrError('bzr export --revision takes exactly 1 argument')
1230
revno, rev_id = b.get_revision_info(revision[0])
1231
t = b.revision_tree(rev_id)
1232
root, ext = os.path.splitext(dest)
1234
if ext in (".tar",):
1236
elif ext in (".gz", ".tgz"):
1238
elif ext in (".bz2", ".tbz2"):
1242
t.export(dest, format, root)
1245
class cmd_cat(Command):
1246
"""Write a file's text from a previous revision."""
1248
takes_options = ['revision']
1249
takes_args = ['filename']
1251
def run(self, filename, revision=None):
1252
if revision == None:
1253
raise BzrCommandError("bzr cat requires a revision number")
1254
elif len(revision) != 1:
1255
raise BzrCommandError("bzr cat --revision takes exactly one number")
1256
b = find_branch('.')
1257
b.print_file(b.relpath(filename), revision[0])
1260
class cmd_local_time_offset(Command):
1261
"""Show the offset in seconds from GMT to local time."""
1264
print bzrlib.osutils.local_time_offset()
1268
class cmd_commit(Command):
1269
"""Commit changes into a new revision.
1271
If no arguments are given, the entire tree is committed.
1273
If selected files are specified, only changes to those files are
1274
committed. If a directory is specified then the directory and everything
1275
within it is committed.
1277
A selected-file commit may fail in some cases where the committed
1278
tree would be invalid, such as trying to commit a file in a
1279
newly-added directory that is not itself committed.
1281
TODO: Run hooks on tree to-be-committed, and after commit.
1283
TODO: Strict commit that fails if there are unknown or deleted files.
1285
takes_args = ['selected*']
1286
takes_options = ['message', 'file', 'verbose', 'unchanged']
1287
aliases = ['ci', 'checkin']
1289
# TODO: Give better message for -s, --summary, used by tla people
1291
def run(self, message=None, file=None, verbose=True, selected_list=None,
1293
from bzrlib.errors import PointlessCommit
1294
from bzrlib.osutils import get_text_message
1296
## Warning: shadows builtin file()
1297
if not message and not file:
1298
# FIXME: Ugly; change status code to send to a provided function?
1302
catcher = cStringIO.StringIO()
1303
sys.stdout = catcher
1304
cmd_status({"file_list":selected_list}, {})
1305
info = catcher.getvalue()
1307
message = get_text_message(info)
1310
raise BzrCommandError("please specify a commit message",
1311
["use either --message or --file"])
1312
elif message and file:
1313
raise BzrCommandError("please specify either --message or --file")
1317
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1319
b = find_branch('.')
1321
selected_list = [b.relpath(s) for s in selected_list]
1324
b.commit(message, verbose=verbose,
1325
specific_files=selected_list,
1326
allow_pointless=unchanged)
1327
except PointlessCommit:
1328
# FIXME: This should really happen before the file is read in;
1329
# perhaps prepare the commit; get the message; then actually commit
1330
raise BzrCommandError("no changes to commit",
1331
["use --unchanged to commit anyhow"])
1334
class cmd_check(Command):
1335
"""Validate consistency of branch history.
1337
This command checks various invariants about the branch storage to
1338
detect data corruption or bzr bugs.
1340
If given the --update flag, it will update some optional fields
1341
to help ensure data consistency.
1343
takes_args = ['dir?']
1345
def run(self, dir='.'):
1346
from bzrlib.check import check
1347
check(find_branch(dir))
1351
class cmd_scan_cache(Command):
1354
from bzrlib.hashcache import HashCache
1361
print '%6d stats' % c.stat_count
1362
print '%6d in hashcache' % len(c._cache)
1363
print '%6d files removed from cache' % c.removed_count
1364
print '%6d hashes updated' % c.update_count
1365
print '%6d files changed too recently to cache' % c.danger_count
1372
class cmd_upgrade(Command):
1373
"""Upgrade branch storage to current format.
1375
This should normally be used only after the check command tells
1378
takes_args = ['dir?']
1380
def run(self, dir='.'):
1381
from bzrlib.upgrade import upgrade
1382
upgrade(find_branch(dir))
1386
class cmd_whoami(Command):
1387
"""Show bzr user id."""
1388
takes_options = ['email']
1390
def run(self, email=False):
1392
b = bzrlib.branch.find_branch('.')
1397
print bzrlib.osutils.user_email(b)
1399
print bzrlib.osutils.username(b)
1402
class cmd_selftest(Command):
1403
"""Run internal test suite"""
1405
takes_options = ['verbose']
1406
def run(self, verbose=False):
1407
from bzrlib.selftest import selftest
1408
return int(not selftest(verbose=verbose))
1411
class cmd_version(Command):
1412
"""Show version of bzr."""
1417
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1418
# is bzrlib itself in a branch?
1419
bzrrev = bzrlib.get_bzr_revision()
1421
print " (bzr checkout, revision %d {%s})" % bzrrev
1422
print bzrlib.__copyright__
1423
print "http://bazaar-ng.org/"
1425
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1426
print "you may use, modify and redistribute it under the terms of the GNU"
1427
print "General Public License version 2 or later."
1430
class cmd_rocks(Command):
1431
"""Statement of optimism."""
1434
print "it sure does!"
517
1436
def parse_spec(spec):
519
1438
>>> parse_spec(None)
added
removed
bzrlib/commands.py
