124
def get_cmd_object(cmd_name, plugins_override=True):
147
def get_cmd_class(cmd, plugins_override=True):
125
148
"""Return the canonical name and command class for a command.
128
If true, plugin commands can override builtins.
130
from bzrlib.externalcommand import ExternalCommand
132
cmd_name = str(cmd_name) # not unicode
150
cmd = str(cmd) # not unicode
134
152
# first look up this command under the specified name
135
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
137
return cmds[cmd_name]()
155
return cmd, cmds[cmd]
141
159
# look for any command which claims this as an alias
142
for real_cmd_name, cmd_class in cmds.iteritems():
143
if cmd_name in cmd_class.aliases:
146
cmd_obj = ExternalCommand.find_command(cmd_name)
150
raise BzrCommandError('unknown command "%s"' % cmd_name)
160
for cmdname, cmdclass in cmds.iteritems():
161
if cmd in cmdclass.aliases:
162
return cmdname, cmdclass
164
cmdclass = ExternalCommand.find_command(cmd)
168
raise BzrCommandError("unknown command %r" % cmd)
153
171
class Command(object):
154
172
"""Base class for commands.
156
Commands are the heart of the command-line bzr interface.
158
The command object mostly handles the mapping of command-line
159
parameters into one or more bzrlib operations, and of the results
162
Commands normally don't have any state. All their arguments are
163
passed in to the run method. (Subclasses may take a different
164
policy if the behaviour of the instance needs to depend on e.g. a
165
shell plugin and not just its Python class.)
167
174
The docstring for an actual command should give a single-line
168
175
summary, then a complete description of the command. A grammar
169
176
description will be inserted.
172
Other accepted names for this command.
175
179
List of argument forms, marked with whether they are optional,
180
['to_location', 'from_branch?', 'file*']
182
'to_location' is required
183
'from_branch' is optional
184
'file' can be specified 0 or more times
187
List of options that may be given for this command. These can
188
be either strings, referring to globally-defined options,
189
or option objects. Retrieve through options().
183
List of options that may be given for this command.
192
If true, this command isn't advertised. This is typically
193
for commands intended for expert users.
196
Command objects will get a 'outf' attribute, which has been
197
setup to properly handle encoding of unicode strings.
198
encoding_type determines what will happen when characters cannot
200
strict - abort if we cannot decode
201
replace - put in a bogus character (typically '?')
202
exact - do not encode sys.stdout
186
If true, this command isn't advertised.
207
191
takes_options = []
208
encoding_type = 'strict'
213
"""Construct an instance of this command."""
214
if self.__doc__ == Command.__doc__:
215
warn("No help message set for %r" % self)
218
"""Return dict of valid options for this command.
220
Maps from long option name to option object."""
222
r['help'] = Option.OPTIONS['help']
223
for o in self.takes_options:
224
if not isinstance(o, Option):
225
o = Option.OPTIONS[o]
229
def _setup_outf(self):
230
"""Return a file linked to stdout, which has proper encoding."""
231
assert self.encoding_type in ['strict', 'exact', 'replace']
233
# Originally I was using self.stdout, but that looks
234
# *way* too much like sys.stdout
235
if self.encoding_type == 'exact':
236
self.outf = sys.stdout
239
output_encoding = bzrlib.osutils.get_terminal_encoding()
195
def __init__(self, options, arguments):
196
"""Construct and run the command.
198
Sets self.status to the return value of run()."""
199
assert isinstance(options, dict)
200
assert isinstance(arguments, dict)
201
cmdargs = options.copy()
202
cmdargs.update(arguments)
203
assert self.__doc__ != Command.__doc__, \
204
("No help message set for %r" % self)
205
self.status = self.run(**cmdargs)
209
"""Override this in sub-classes.
211
This is invoked with the options and arguments bound to
214
Return 0 or None if the command was successful, or a shell
220
class ExternalCommand(Command):
221
"""Class to wrap external commands.
223
We cheat a little here, when get_cmd_class() calls us we actually give it back
224
an object we construct that has the appropriate path, help, options etc for the
227
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
228
method, which we override to call the Command.__init__ method. That then calls
229
our run method which is pretty straight forward.
231
The only wrinkle is that we have to map bzr's dictionary of options and arguments
232
back into command line options and arguments for the script.
235
def find_command(cls, cmd):
237
bzrpath = os.environ.get('BZRPATH', '')
239
for dir in bzrpath.split(os.pathsep):
240
path = os.path.join(dir, cmd)
241
if os.path.isfile(path):
242
return ExternalCommand(path)
246
find_command = classmethod(find_command)
248
def __init__(self, path):
251
pipe = os.popen('%s --bzr-usage' % path, 'r')
252
self.takes_options = pipe.readline().split()
254
for opt in self.takes_options:
255
if not opt in OPTIONS:
256
raise BzrError("Unknown option '%s' returned by external command %s"
259
# TODO: Is there any way to check takes_args is valid here?
260
self.takes_args = pipe.readline().split()
262
if pipe.close() is not None:
263
raise BzrError("Failed funning '%s --bzr-usage'" % path)
265
pipe = os.popen('%s --bzr-help' % path, 'r')
266
self.__doc__ = pipe.read()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-help'" % path)
270
def __call__(self, options, arguments):
271
Command.__init__(self, options, arguments)
274
def run(self, **kargs):
281
optname = name.replace('_','-')
283
if OPTIONS.has_key(optname):
285
opts.append('--%s' % optname)
286
if value is not None and value is not True:
287
opts.append(str(value))
289
# it's an arg, or arg list
290
if type(value) is not list:
296
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
300
class cmd_status(Command):
301
"""Display status summary.
303
This reports on versioned and unknown files, reporting them
304
grouped by state. Possible states are:
307
Versioned in the working copy but not in the previous revision.
310
Versioned in the previous revision but removed or deleted
314
Path of this file changed from the previous revision;
315
the text may also have changed. This includes files whose
316
parent directory was renamed.
319
Text has changed since the previous revision.
322
Nothing about this file has changed since the previous revision.
323
Only shown with --all.
326
Not versioned and not matching an ignore pattern.
328
To see ignored files use 'bzr ignored'. For details in the
329
changes to file texts, use 'bzr diff'.
331
If no arguments are specified, the status of the entire working
332
directory is shown. Otherwise, only the status of the specified
333
files or directories is reported. If a directory is given, status
334
is reported for everything inside that directory.
336
If a revision is specified, the changes since that revision are shown.
338
takes_args = ['file*']
339
takes_options = ['all', 'show-ids', 'revision']
340
aliases = ['st', 'stat']
342
def run(self, all=False, show_ids=False, file_list=None):
344
b = find_branch(file_list[0])
345
file_list = [b.relpath(x) for x in file_list]
346
# special case: only one path was given and it's the root
348
if file_list == ['']:
353
from bzrlib.status import show_status
354
show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
358
class cmd_cat_revision(Command):
359
"""Write out metadata for a revision."""
362
takes_args = ['revision_id']
364
def run(self, revision_id):
365
from bzrlib.xml import pack_xml
366
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
369
class cmd_revno(Command):
370
"""Show current revision number.
372
This is equal to the number of revisions on this branch."""
374
print find_branch('.').revno()
376
class cmd_revision_info(Command):
377
"""Show revision number and revision id for a given revision identifier.
380
takes_args = ['revision_info*']
381
takes_options = ['revision']
382
def run(self, revision=None, revision_info_list=None):
383
from bzrlib.branch import find_branch
386
if revision is not None:
387
revs.extend(revision)
388
if revision_info_list is not None:
389
revs.extend(revision_info_list)
391
raise BzrCommandError('You must supply a revision identifier')
396
print '%4d %s' % b.get_revision_info(rev)
399
class cmd_add(Command):
400
"""Add specified files or directories.
402
In non-recursive mode, all the named items are added, regardless
403
of whether they were previously ignored. A warning is given if
404
any of the named files are already versioned.
406
In recursive mode (the default), files are treated the same way
407
but the behaviour for directories is different. Directories that
408
are already versioned do not give a warning. All directories,
409
whether already versioned or not, are searched for files or
410
subdirectories that are neither versioned or ignored, and these
411
are added. This search proceeds recursively into versioned
414
Therefore simply saying 'bzr add .' will version all files that
415
are currently unknown.
417
TODO: Perhaps adding a file whose directly is not versioned should
418
recursively add that parent, rather than giving an error?
420
takes_args = ['file+']
421
takes_options = ['verbose', 'no-recurse']
423
def run(self, file_list, verbose=False, no_recurse=False):
424
from bzrlib.add import smart_add
425
smart_add(file_list, verbose, not no_recurse)
429
class cmd_mkdir(Command):
430
"""Create a new versioned directory.
432
This is equivalent to creating the directory and then adding it.
434
takes_args = ['dir+']
436
def run(self, dir_list):
443
b.add([d], verbose=True)
446
class cmd_relpath(Command):
447
"""Show path of a file relative to root"""
448
takes_args = ['filename']
451
def run(self, filename):
452
print find_branch(filename).relpath(filename)
456
class cmd_inventory(Command):
457
"""Show inventory of the current working copy or a revision."""
458
takes_options = ['revision', 'show-ids']
460
def run(self, revision=None, show_ids=False):
463
inv = b.read_working_inventory()
465
if len(revision) > 1:
466
raise BzrCommandError('bzr inventory --revision takes'
467
' exactly one revision identifier')
468
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
470
for path, entry in inv.entries():
472
print '%-50s %s' % (path, entry.file_id)
477
class cmd_move(Command):
478
"""Move files to a different directory.
483
The destination must be a versioned directory in the same branch.
485
takes_args = ['source$', 'dest']
486
def run(self, source_list, dest):
489
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
492
class cmd_rename(Command):
493
"""Change the name of an entry.
496
bzr rename frob.c frobber.c
497
bzr rename src/frob.c lib/frob.c
499
It is an error if the destination name exists.
501
See also the 'move' command, which moves files into a different
502
directory without changing their name.
504
TODO: Some way to rename multiple files without invoking bzr for each
506
takes_args = ['from_name', 'to_name']
508
def run(self, from_name, to_name):
510
b.rename_one(b.relpath(from_name), b.relpath(to_name))
516
class cmd_pull(Command):
517
"""Pull any changes from another branch into the current one.
519
If the location is omitted, the last-used location will be used.
520
Both the revision history and the working directory will be
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if both branches have had commits without first
525
pulling from the other.
527
If branches have diverged, you can use 'bzr merge' to pull the text changes
528
from one into the other.
530
takes_args = ['location?']
532
def run(self, location=None):
533
from bzrlib.merge import merge
535
from shutil import rmtree
538
br_to = find_branch('.')
541
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
543
if e.errno != errno.ENOENT:
546
if stored_loc is None:
547
raise BzrCommandError("No pull location known or specified.")
549
print "Using last location: %s" % stored_loc
550
location = stored_loc
551
cache_root = tempfile.mkdtemp()
552
from bzrlib.branch import DivergedBranches
553
br_from = find_branch(location)
554
location = pull_loc(br_from)
555
old_revno = br_to.revno()
557
from branch import find_cached_branch, DivergedBranches
558
br_from = find_cached_branch(location, cache_root)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
562
br_to.update_revisions(br_from)
563
except DivergedBranches:
564
raise BzrCommandError("These branches have diverged."
567
merge(('.', -1), ('.', old_revno), check_clean=False)
568
if location != stored_loc:
569
br_to.controlfile("x-pull", "wb").write(location + "\n")
575
class cmd_branch(Command):
576
"""Create a new copy of a branch.
578
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
579
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
581
To retrieve the branch as of a particular revision, supply the --revision
582
parameter, as in "branch foo/bar -r 5".
584
takes_args = ['from_location', 'to_location?']
585
takes_options = ['revision']
587
def run(self, from_location, to_location=None, revision=None):
589
from bzrlib.merge import merge
590
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
591
find_cached_branch, Branch
592
from shutil import rmtree
593
from meta_store import CachedStore
595
cache_root = tempfile.mkdtemp()
599
elif len(revision) > 1:
600
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
604
br_from = find_cached_branch(from_location, cache_root)
606
if e.errno == errno.ENOENT:
607
raise BzrCommandError('Source location "%s" does not'
608
' exist.' % to_location)
612
if to_location is None:
613
to_location = os.path.basename(from_location.rstrip("/\\"))
616
os.mkdir(to_location)
618
if e.errno == errno.EEXIST:
619
raise BzrCommandError('Target directory "%s" already'
620
' exists.' % to_location)
621
if e.errno == errno.ENOENT:
622
raise BzrCommandError('Parent of "%s" does not exist.' %
626
br_to = Branch(to_location, init=True)
628
br_to.set_root_id(br_from.get_root_id())
631
if revision[0] is None:
632
revno = br_from.revno()
634
revno, rev_id = br_from.get_revision_info(revision[0])
636
br_to.update_revisions(br_from, stop_revision=revno)
637
except NoSuchRevision:
639
msg = "The branch %s has no revision %d." % (from_location,
641
raise BzrCommandError(msg)
643
merge((to_location, -1), (to_location, 0), this_dir=to_location,
644
check_clean=False, ignore_zero=True)
645
from_location = pull_loc(br_from)
646
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
651
def pull_loc(branch):
652
# TODO: Should perhaps just make attribute be 'base' in
653
# RemoteBranch and Branch?
654
if hasattr(branch, "baseurl"):
655
return branch.baseurl
661
class cmd_renames(Command):
662
"""Show list of renamed files.
664
TODO: Option to show renames between two historical versions.
666
TODO: Only show renames under dir, rather than in the whole branch.
668
takes_args = ['dir?']
670
def run(self, dir='.'):
672
old_inv = b.basis_tree().inventory
673
new_inv = b.read_working_inventory()
675
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
677
for old_name, new_name in renames:
678
print "%s => %s" % (old_name, new_name)
681
class cmd_info(Command):
682
"""Show statistical information about a branch."""
683
takes_args = ['branch?']
685
def run(self, branch=None):
688
b = find_branch(branch)
692
class cmd_remove(Command):
693
"""Make a file unversioned.
695
This makes bzr stop tracking changes to a versioned file. It does
696
not delete the working copy.
698
takes_args = ['file+']
699
takes_options = ['verbose']
701
def run(self, file_list, verbose=False):
702
b = find_branch(file_list[0])
703
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
706
class cmd_file_id(Command):
707
"""Print file_id of a particular file or directory.
709
The file_id is assigned when the file is first added and remains the
710
same through all revisions where the file exists, even when it is
714
takes_args = ['filename']
715
def run(self, filename):
716
b = find_branch(filename)
717
i = b.inventory.path2id(b.relpath(filename))
719
raise BzrError("%r is not a versioned file" % filename)
724
class cmd_file_path(Command):
725
"""Print path of file_ids to a file or directory.
727
This prints one line for each directory down to the target,
728
starting at the branch root."""
730
takes_args = ['filename']
731
def run(self, filename):
732
b = find_branch(filename)
734
fid = inv.path2id(b.relpath(filename))
736
raise BzrError("%r is not a versioned file" % filename)
737
for fip in inv.get_idpath(fid):
741
class cmd_revision_history(Command):
742
"""Display list of revision ids on this branch."""
745
for patchid in find_branch('.').revision_history():
749
class cmd_directories(Command):
750
"""Display list of versioned directories in this branch."""
752
for name, ie in find_branch('.').read_working_inventory().directories():
759
class cmd_init(Command):
760
"""Make a directory into a versioned branch.
762
Use this to create an empty branch, or before importing an
765
Recipe for importing a tree of files:
770
bzr commit -m 'imported project'
773
from bzrlib.branch import Branch
774
Branch('.', init=True)
777
class cmd_diff(Command):
778
"""Show differences in working tree.
780
If files are listed, only the changes in those files are listed.
781
Otherwise, all changes for the tree are listed.
783
TODO: Given two revision arguments, show the difference between them.
785
TODO: Allow diff across branches.
787
TODO: Option to use external diff command; could be GNU diff, wdiff,
790
TODO: Python difflib is not exactly the same as unidiff; should
791
either fix it up or prefer to use an external diff.
793
TODO: If a directory is given, diff everything under that.
795
TODO: Selected-file diff is inefficient and doesn't show you
798
TODO: This probably handles non-Unix newlines poorly.
801
takes_args = ['file*']
802
takes_options = ['revision', 'diff-options']
803
aliases = ['di', 'dif']
805
def run(self, revision=None, file_list=None, diff_options=None):
806
from bzrlib.diff import show_diff
809
b = find_branch(file_list[0])
810
file_list = [b.relpath(f) for f in file_list]
811
if file_list == ['']:
812
# just pointing to top-of-tree
817
# TODO: Make show_diff support taking 2 arguments
819
if revision is not None:
820
if len(revision) != 1:
821
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
822
base_rev = revision[0]
824
show_diff(b, base_rev, specific_files=file_list,
825
external_diff_options=diff_options)
831
class cmd_deleted(Command):
832
"""List files deleted in the working tree.
834
TODO: Show files deleted since a previous revision, or between two revisions.
836
def run(self, show_ids=False):
839
new = b.working_tree()
841
## TODO: Much more efficient way to do this: read in new
842
## directories with readdir, rather than stating each one. Same
843
## level of effort but possibly much less IO. (Or possibly not,
844
## if the directories are very large...)
846
for path, ie in old.inventory.iter_entries():
847
if not new.has_id(ie.file_id):
849
print '%-50s %s' % (path, ie.file_id)
854
class cmd_modified(Command):
855
"""List files modified in working tree."""
858
from bzrlib.diff import compare_trees
861
td = compare_trees(b.basis_tree(), b.working_tree())
863
for path, id, kind in td.modified:
868
class cmd_added(Command):
869
"""List files added in working tree."""
873
wt = b.working_tree()
874
basis_inv = b.basis_tree().inventory
877
if file_id in basis_inv:
879
path = inv.id2path(file_id)
880
if not os.access(b.abspath(path), os.F_OK):
886
class cmd_root(Command):
887
"""Show the tree root directory.
889
The root is the nearest enclosing directory with a .bzr control
891
takes_args = ['filename?']
892
def run(self, filename=None):
893
"""Print the branch root."""
894
b = find_branch(filename)
895
print getattr(b, 'base', None) or getattr(b, 'baseurl')
898
class cmd_log(Command):
899
"""Show log of this branch.
901
To request a range of logs, you can use the command -r begin:end
902
-r revision requests a specific revision, -r :end or -r begin: are
905
--message allows you to give a regular expression, which will be evaluated
906
so that only matching entries will be displayed.
908
TODO: Make --revision support uuid: and hash: [future tag:] notation.
912
takes_args = ['filename?']
913
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
915
def run(self, filename=None, timezone='original',
922
from bzrlib.branch import find_branch
923
from bzrlib.log import log_formatter, show_log
926
direction = (forward and 'forward') or 'reverse'
929
b = find_branch(filename)
930
fp = b.relpath(filename)
932
file_id = b.read_working_inventory().path2id(fp)
934
file_id = None # points to branch root
942
elif len(revision) == 1:
943
rev1 = rev2 = b.get_revision_info(revision[0])[0]
944
elif len(revision) == 2:
945
rev1 = b.get_revision_info(revision[0])[0]
946
rev2 = b.get_revision_info(revision[1])[0]
948
raise BzrCommandError('bzr log --revision takes one or two values.')
955
mutter('encoding log as %r' % bzrlib.user_encoding)
241
957
# use 'replace' so that we don't abort if trying to write out
242
958
# in e.g. the default C locale.
243
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
244
# For whatever reason codecs.getwriter() does not advertise its encoding
245
# it just returns the encoding of the wrapped file, which is completely
246
# bogus. So set the attribute, so we can find the correct encoding later.
247
self.outf.encoding = output_encoding
249
@deprecated_method(zero_eight)
250
def run_argv(self, argv):
251
"""Parse command line and run.
959
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
965
lf = log_formatter(log_format,
968
show_timezone=timezone)
981
class cmd_touching_revisions(Command):
982
"""Return revision-ids which affected a particular file.
984
A more user-friendly interface is "bzr log FILE"."""
986
takes_args = ["filename"]
987
def run(self, filename):
988
b = find_branch(filename)
989
inv = b.read_working_inventory()
990
file_id = inv.path2id(b.relpath(filename))
991
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
992
print "%6d %s" % (revno, what)
995
class cmd_ls(Command):
996
"""List files in a tree.
998
TODO: Take a revision or remote path and list that tree instead.
1001
def run(self, revision=None, verbose=False):
1002
b = find_branch('.')
1003
if revision == None:
1004
tree = b.working_tree()
1006
tree = b.revision_tree(b.lookup_revision(revision))
1008
for fp, fc, kind, fid in tree.list_files():
1010
if kind == 'directory':
1012
elif kind == 'file':
1017
print '%-8s %s%s' % (fc, fp, kindch)
1023
class cmd_unknowns(Command):
1024
"""List unknown files."""
1026
from bzrlib.osutils import quotefn
1027
for f in find_branch('.').unknowns():
1032
class cmd_ignore(Command):
1033
"""Ignore a command or pattern.
1035
To remove patterns from the ignore list, edit the .bzrignore file.
1037
If the pattern contains a slash, it is compared to the whole path
1038
from the branch root. Otherwise, it is comapred to only the last
1039
component of the path.
1041
Ignore patterns are case-insensitive on case-insensitive systems.
1043
Note: wildcards must be quoted from the shell on Unix.
1046
bzr ignore ./Makefile
1047
bzr ignore '*.class'
1049
takes_args = ['name_pattern']
1051
def run(self, name_pattern):
1052
from bzrlib.atomicfile import AtomicFile
1055
b = find_branch('.')
1056
ifn = b.abspath('.bzrignore')
1058
if os.path.exists(ifn):
1061
igns = f.read().decode('utf-8')
1067
# TODO: If the file already uses crlf-style termination, maybe
1068
# we should use that for the newly added lines?
1070
if igns and igns[-1] != '\n':
1072
igns += name_pattern + '\n'
1075
f = AtomicFile(ifn, 'wt')
1076
f.write(igns.encode('utf-8'))
1081
inv = b.working_tree().inventory
1082
if inv.path2id('.bzrignore'):
1083
mutter('.bzrignore is already versioned')
1085
mutter('need to make new .bzrignore file versioned')
1086
b.add(['.bzrignore'])
1090
class cmd_ignored(Command):
1091
"""List ignored files and the patterns that matched them.
1093
See also: bzr ignore"""
1095
tree = find_branch('.').working_tree()
1096
for path, file_class, kind, file_id in tree.list_files():
1097
if file_class != 'I':
1099
## XXX: Slightly inefficient since this was already calculated
1100
pat = tree.is_ignored(path)
1101
print '%-50s %s' % (path, pat)
1104
class cmd_lookup_revision(Command):
1105
"""Lookup the revision-id from a revision-number
1108
bzr lookup-revision 33
1111
takes_args = ['revno']
1113
def run(self, revno):
1117
raise BzrCommandError("not a valid revision-number: %r" % revno)
1119
print find_branch('.').lookup_revision(revno)
1122
class cmd_export(Command):
1123
"""Export past revision to destination directory.
1125
If no revision is specified this exports the last committed revision.
1127
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1128
given, try to find the format with the extension. If no extension
1129
is found exports to a directory (equivalent to --format=dir).
1131
Root may be the top directory for tar, tgz and tbz2 formats. If none
1132
is given, the top directory will be the root name of the file."""
1133
# TODO: list known exporters
1134
takes_args = ['dest']
1135
takes_options = ['revision', 'format', 'root']
1136
def run(self, dest, revision=None, format=None, root=None):
1138
b = find_branch('.')
1139
if revision is None:
1140
rev_id = b.last_patch()
1142
if len(revision) != 1:
1143
raise BzrError('bzr export --revision takes exactly 1 argument')
1144
revno, rev_id = b.get_revision_info(revision[0])
1145
t = b.revision_tree(rev_id)
1146
root, ext = os.path.splitext(dest)
1148
if ext in (".tar",):
1150
elif ext in (".gz", ".tgz"):
1152
elif ext in (".bz2", ".tbz2"):
1156
t.export(dest, format, root)
1159
class cmd_cat(Command):
1160
"""Write a file's text from a previous revision."""
1162
takes_options = ['revision']
1163
takes_args = ['filename']
1165
def run(self, filename, revision=None):
1166
if revision == None:
1167
raise BzrCommandError("bzr cat requires a revision number")
1168
elif len(revision) != 1:
1169
raise BzrCommandError("bzr cat --revision takes exactly one number")
1170
b = find_branch('.')
1171
b.print_file(b.relpath(filename), revision[0])
1174
class cmd_local_time_offset(Command):
1175
"""Show the offset in seconds from GMT to local time."""
1178
print bzrlib.osutils.local_time_offset()
1182
class cmd_commit(Command):
1183
"""Commit changes into a new revision.
1185
If selected files are specified, only changes to those files are
1186
committed. If a directory is specified then its contents are also
1189
A selected-file commit may fail in some cases where the committed
1190
tree would be invalid, such as trying to commit a file in a
1191
newly-added directory that is not itself committed.
1193
TODO: Run hooks on tree to-be-committed, and after commit.
1195
TODO: Strict commit that fails if there are unknown or deleted files.
1197
takes_args = ['selected*']
1198
takes_options = ['message', 'file', 'verbose', 'unchanged']
1199
aliases = ['ci', 'checkin']
1201
def run(self, message=None, file=None, verbose=True, selected_list=None,
1203
from bzrlib.errors import PointlessCommit
1204
from bzrlib.osutils import get_text_message
1206
## Warning: shadows builtin file()
1207
if not message and not file:
1210
catcher = cStringIO.StringIO()
1211
sys.stdout = catcher
1212
cmd_status({"file_list":selected_list}, {})
1213
info = catcher.getvalue()
1215
message = get_text_message(info)
1218
raise BzrCommandError("please specify a commit message",
1219
["use either --message or --file"])
1220
elif message and file:
1221
raise BzrCommandError("please specify either --message or --file")
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
257
def run_argv_aliases(self, argv, alias_argv=None):
258
"""Parse the command line and run with extra aliases in alias_argv."""
259
args, opts = parse_args(self, argv, alias_argv)
260
if 'help' in opts: # e.g. bzr add --help
261
from bzrlib.help import help_on_command
262
help_on_command(self.name())
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
267
if oname not in allowed_names:
268
raise BzrOptionError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
270
# mix arguments and options into one dictionary
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
273
for k, v in opts.items():
274
cmdopts[k.replace('-', '_')] = v
276
all_cmd_args = cmdargs.copy()
277
all_cmd_args.update(cmdopts)
281
return self.run(**all_cmd_args)
1225
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1227
b = find_branch('.')
1230
b.commit(message, verbose=verbose,
1231
specific_files=selected_list,
1232
allow_pointless=unchanged)
1233
except PointlessCommit:
1234
# FIXME: This should really happen before the file is read in;
1235
# perhaps prepare the commit; get the message; then actually commit
1236
raise BzrCommandError("no changes to commit",
1237
["use --unchanged to commit anyhow"])
1240
class cmd_check(Command):
1241
"""Validate consistency of branch history.
1243
This command checks various invariants about the branch storage to
1244
detect data corruption or bzr bugs.
1246
If given the --update flag, it will update some optional fields
1247
to help ensure data consistency.
1249
takes_args = ['dir?']
1251
def run(self, dir='.'):
1252
from bzrlib.check import check
1253
check(find_branch(dir))
1257
class cmd_scan_cache(Command):
1260
from bzrlib.hashcache import HashCache
1267
print '%6d stats' % c.stat_count
1268
print '%6d in hashcache' % len(c._cache)
1269
print '%6d files removed from cache' % c.removed_count
1270
print '%6d hashes updated' % c.update_count
1271
print '%6d files changed too recently to cache' % c.danger_count
1278
class cmd_upgrade(Command):
1279
"""Upgrade branch storage to current format.
1281
This should normally be used only after the check command tells
1284
takes_args = ['dir?']
1286
def run(self, dir='.'):
1287
from bzrlib.upgrade import upgrade
1288
upgrade(find_branch(dir))
1292
class cmd_whoami(Command):
1293
"""Show bzr user id."""
1294
takes_options = ['email']
284
"""Actually run the command.
286
This is invoked with the options and arguments bound to
289
Return 0 or None if the command was successful, or a non-zero
290
shell error code if not. It's OK for this method to allow
291
an exception to raise up.
293
raise NotImplementedError('no implementation of command %r'
297
"""Return help message for this class."""
298
from inspect import getdoc
299
if self.__doc__ is Command.__doc__:
304
return _unsquish_command_name(self.__class__.__name__)
306
def plugin_name(self):
307
"""Get the name of the plugin that provides this command.
309
:return: The name of the plugin or None if the command is builtin.
311
mod_parts = self.__module__.split('.')
312
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
1296
def run(self, email=False):
1298
print bzrlib.osutils.user_email()
1300
print bzrlib.osutils.username()
1303
class cmd_selftest(Command):
1304
"""Run internal test suite"""
1307
from bzrlib.selftest import selftest
1308
return int(not selftest())
1311
class cmd_version(Command):
1312
"""Show version of bzr."""
1317
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1318
# is bzrlib itself in a branch?
1319
bzrrev = bzrlib.get_bzr_revision()
1321
print " (bzr checkout, revision %d {%s})" % bzrrev
1322
print bzrlib.__copyright__
1323
print "http://bazaar-ng.org/"
1325
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1326
print "you may use, modify and redistribute it under the terms of the GNU"
1327
print "General Public License version 2 or later."
1330
class cmd_rocks(Command):
1331
"""Statement of optimism."""
1334
print "it sure does!"
318
1336
def parse_spec(spec):
346
1364
parsed = [spec, None]
349
def parse_args(command, argv, alias_argv=None):
1369
class cmd_merge(Command):
1370
"""Perform a three-way merge of trees.
1372
The SPEC parameters are working tree or revision specifiers. Working trees
1373
are specified using standard paths or urls. No component of a directory
1374
path may begin with '@'.
1376
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1378
Revisions are specified using a dirname/@revno pair, where dirname is the
1379
branch directory and revno is the revision within that branch. If no revno
1380
is specified, the latest revision is used.
1382
Revision examples: './@127', 'foo/@', '../@1'
1384
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1385
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1388
merge refuses to run if there are any uncommitted changes, unless
1391
takes_args = ['other_spec', 'base_spec?']
1392
takes_options = ['force']
1394
def run(self, other_spec, base_spec=None, force=False):
1395
from bzrlib.merge import merge
1396
merge(parse_spec(other_spec), parse_spec(base_spec),
1397
check_clean=(not force))
1401
class cmd_revert(Command):
1402
"""Restore selected files from a previous revision.
1404
takes_args = ['file+']
1405
def run(self, file_list):
1406
from bzrlib.branch import find_branch
1411
b = find_branch(file_list[0])
1413
b.revert([b.relpath(f) for f in file_list])
1416
class cmd_merge_revert(Command):
1417
"""Reverse all changes since the last commit.
1419
Only versioned files are affected.
1421
TODO: Store backups of any files that will be reverted, so
1422
that the revert can be undone.
1424
takes_options = ['revision']
1426
def run(self, revision=None):
1427
from bzrlib.merge import merge
1428
if revision is None:
1430
elif len(revision) != 1:
1431
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1432
merge(('.', revision[0]), parse_spec('.'),
1437
class cmd_assert_fail(Command):
1438
"""Test reporting of assertion failures"""
1441
assert False, "always fails"
1444
class cmd_help(Command):
1445
"""Show help on a command or other topic.
1447
For a list of all available commands, say 'bzr help commands'."""
1448
takes_args = ['topic?']
1451
def run(self, topic=None):
1458
class cmd_plugins(Command):
1462
import bzrlib.plugin
1463
from inspect import getdoc
1464
from pprint import pprint
1465
for plugin in bzrlib.plugin.all_plugins:
1466
print plugin.__path__[0]
1469
print '\t', d.split('\n')[0]
1471
#pprint(bzrlib.plugin.all_plugins)
1475
# list of all available options; the rhs can be either None for an
1476
# option that takes no argument, or a constructor function that checks
1480
'diff-options': str,
1489
'revision': _parse_revision_str,
1511
def parse_args(argv):
350
1512
"""Parse command line.
352
1514
Arguments and options are parsed at this level before being passed
353
1515
down to specific command handlers. This routine knows, from a
354
1516
lookup table, something about the available options, what optargs
355
1517
they take, and which commands will accept them.
1519
>>> parse_args('--help'.split())
1520
([], {'help': True})
1521
>>> parse_args('--version'.split())
1522
([], {'version': True})
1523
>>> parse_args('status --all'.split())
1524
(['status'], {'all': True})
1525
>>> parse_args('commit --message=biter'.split())
1526
(['commit'], {'message': u'biter'})
1527
>>> parse_args('log -r 500'.split())
1528
(['log'], {'revision': [500]})
1529
>>> parse_args('log -r500..600'.split())
1530
(['log'], {'revision': [500, 600]})
1531
>>> parse_args('log -vr500..600'.split())
1532
(['log'], {'verbose': True, 'revision': [500, 600]})
1533
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1534
(['log'], {'revision': ['v500', 600]})
357
# TODO: chop up this beast; make it a method of the Command
362
cmd_options = command.options()
364
proc_aliasarg = True # Are we processing alias_argv now?
365
for proc_argv in alias_argv, argv:
375
# We've received a standalone -- No more flags
379
# option names must not be unicode
383
mutter(" got option %r", a)
385
optname, optarg = a[2:].split('=', 1)
388
if optname not in cmd_options:
389
raise BzrCommandError('unknown option "%s"' % a)
392
if shortopt in Option.SHORT_OPTIONS:
393
# Multi-character options must have a space to delimit
395
# ^^^ what does this mean? mbp 20051014
396
optname = Option.SHORT_OPTIONS[shortopt].name
398
# Single character short options, can be chained,
399
# and have their value appended to their name
401
if shortopt not in Option.SHORT_OPTIONS:
402
# We didn't find the multi-character name, and we
403
# didn't find the single char name
404
raise BzrCommandError('unknown option "%s"' % a)
405
optname = Option.SHORT_OPTIONS[shortopt].name
408
# There are extra things on this option
409
# see if it is the value, or if it is another
411
optargfn = Option.OPTIONS[optname].type
413
# This option does not take an argument, so the
414
# next entry is another short option, pack it
416
proc_argv.insert(0, '-' + a[2:])
418
# This option takes an argument, so pack it
421
if optname not in cmd_options:
422
raise BzrCommandError('unknown option "%s"' % shortopt)
424
# XXX: Do we ever want to support this, e.g. for -r?
426
raise BzrCommandError('repeated option %r' % a)
427
elif optname in alias_opts:
428
# Replace what's in the alias with what's in the real
430
del alias_opts[optname]
432
proc_argv.insert(0, a)
435
raise BzrCommandError('repeated option %r' % a)
437
option_obj = cmd_options[optname]
438
optargfn = option_obj.type
442
raise BzrCommandError('option %r needs an argument' % a)
1539
# TODO: Maybe handle '--' to end options?
1544
# option names must not be unicode
1548
mutter(" got option %r" % a)
1550
optname, optarg = a[2:].split('=', 1)
1553
if optname not in OPTIONS:
1554
raise BzrError('unknown long option %r' % a)
1557
if shortopt in SHORT_OPTIONS:
1558
# Multi-character options must have a space to delimit
1560
optname = SHORT_OPTIONS[shortopt]
1562
# Single character short options, can be chained,
1563
# and have their value appended to their name
1565
if shortopt not in SHORT_OPTIONS:
1566
# We didn't find the multi-character name, and we
1567
# didn't find the single char name
1568
raise BzrError('unknown short option %r' % a)
1569
optname = SHORT_OPTIONS[shortopt]
1572
# There are extra things on this option
1573
# see if it is the value, or if it is another
1575
optargfn = OPTIONS[optname]
1576
if optargfn is None:
1577
# This option does not take an argument, so the
1578
# next entry is another short option, pack it back
1580
argv.insert(0, '-' + a[2:])
444
optarg = proc_argv.pop(0)
445
opts[optname] = optargfn(optarg)
447
alias_opts[optname] = optargfn(optarg)
450
raise BzrCommandError('option %r takes no argument' % optname)
453
alias_opts[optname] = True
1582
# This option takes an argument, so pack it
1587
# XXX: Do we ever want to support this, e.g. for -r?
1588
raise BzrError('repeated option %r' % a)
1590
optargfn = OPTIONS[optname]
1594
raise BzrError('option %r needs an argument' % a)
1596
optarg = argv.pop(0)
1597
opts[optname] = optargfn(optarg)
456
proc_aliasarg = False # Done with alias argv
1600
raise BzrError('option %r takes no argument' % optname)
1601
opts[optname] = True
457
1605
return args, opts
460
1610
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
