124
def get_cmd_object(cmd_name, plugins_override=True):
112
def get_cmd_class(cmd, plugins_override=True):
125
113
"""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
115
cmd = str(cmd) # not unicode
134
117
# first look up this command under the specified name
135
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
137
return cmds[cmd_name]()
120
return cmd, cmds[cmd]
141
124
# 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)
125
for cmdname, cmdclass in cmds.iteritems():
126
if cmd in cmdclass.aliases:
127
return cmdname, cmdclass
129
cmdclass = ExternalCommand.find_command(cmd)
133
raise BzrCommandError("unknown command %r" % cmd)
153
136
class Command(object):
154
137
"""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
139
The docstring for an actual command should give a single-line
168
140
summary, then a complete description of the command. A grammar
169
141
description will be inserted.
172
Other accepted names for this command.
175
144
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().
148
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
151
If true, this command isn't advertised.
207
156
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()
160
def __init__(self, options, arguments):
161
"""Construct and run the command.
163
Sets self.status to the return value of run()."""
164
assert isinstance(options, dict)
165
assert isinstance(arguments, dict)
166
cmdargs = options.copy()
167
cmdargs.update(arguments)
168
assert self.__doc__ != Command.__doc__, \
169
("No help message set for %r" % self)
170
self.status = self.run(**cmdargs)
174
"""Override this in sub-classes.
176
This is invoked with the options and arguments bound to
179
Return 0 or None if the command was successful, or a shell
185
class ExternalCommand(Command):
186
"""Class to wrap external commands.
188
We cheat a little here, when get_cmd_class() calls us we actually give it back
189
an object we construct that has the appropriate path, help, options etc for the
192
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
193
method, which we override to call the Command.__init__ method. That then calls
194
our run method which is pretty straight forward.
196
The only wrinkle is that we have to map bzr's dictionary of options and arguments
197
back into command line options and arguments for the script.
200
def find_command(cls, cmd):
202
bzrpath = os.environ.get('BZRPATH', '')
204
for dir in bzrpath.split(os.pathsep):
205
path = os.path.join(dir, cmd)
206
if os.path.isfile(path):
207
return ExternalCommand(path)
211
find_command = classmethod(find_command)
213
def __init__(self, path):
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
217
self.takes_options = pipe.readline().split()
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
224
# TODO: Is there any way to check takes_args is valid here?
225
self.takes_args = pipe.readline().split()
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
230
pipe = os.popen('%s --bzr-help' % path, 'r')
231
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
235
def __call__(self, options, arguments):
236
Command.__init__(self, options, arguments)
239
def run(self, **kargs):
246
optname = name.replace('_','-')
248
if OPTIONS.has_key(optname):
250
opts.append('--%s' % optname)
251
if value is not None and value is not True:
252
opts.append(str(value))
254
# it's an arg, or arg list
255
if type(value) is not list:
261
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
265
class cmd_status(Command):
266
"""Display status summary.
268
This reports on versioned and unknown files, reporting them
269
grouped by state. Possible states are:
272
Versioned in the working copy but not in the previous revision.
275
Versioned in the previous revision but removed or deleted
279
Path of this file changed from the previous revision;
280
the text may also have changed. This includes files whose
281
parent directory was renamed.
284
Text has changed since the previous revision.
287
Nothing about this file has changed since the previous revision.
288
Only shown with --all.
291
Not versioned and not matching an ignore pattern.
293
To see ignored files use 'bzr ignored'. For details in the
294
changes to file texts, use 'bzr diff'.
296
If no arguments are specified, the status of the entire working
297
directory is shown. Otherwise, only the status of the specified
298
files or directories is reported. If a directory is given, status
299
is reported for everything inside that directory.
301
takes_args = ['file*']
302
takes_options = ['all', 'show-ids']
303
aliases = ['st', 'stat']
305
def run(self, all=False, show_ids=False, file_list=None):
307
b = Branch(file_list[0])
308
file_list = [b.relpath(x) for x in file_list]
309
# special case: only one path was given and it's the root
311
if file_list == ['']:
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
320
class cmd_cat_revision(Command):
321
"""Write out metadata for a revision."""
324
takes_args = ['revision_id']
326
def run(self, revision_id):
327
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
330
class cmd_revno(Command):
331
"""Show current revision number.
333
This is equal to the number of revisions on this branch."""
335
print Branch('.').revno()
338
class cmd_add(Command):
339
"""Add specified files or directories.
341
In non-recursive mode, all the named items are added, regardless
342
of whether they were previously ignored. A warning is given if
343
any of the named files are already versioned.
345
In recursive mode (the default), files are treated the same way
346
but the behaviour for directories is different. Directories that
347
are already versioned do not give a warning. All directories,
348
whether already versioned or not, are searched for files or
349
subdirectories that are neither versioned or ignored, and these
350
are added. This search proceeds recursively into versioned
353
Therefore simply saying 'bzr add .' will version all files that
354
are currently unknown.
356
TODO: Perhaps adding a file whose directly is not versioned should
357
recursively add that parent, rather than giving an error?
359
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
362
def run(self, file_list, verbose=False, no_recurse=False):
363
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
367
class cmd_mkdir(Command):
368
"""Create a new versioned directory.
370
This is equivalent to creating the directory and then adding it.
372
takes_args = ['dir+']
374
def run(self, dir_list):
383
b = bzrlib.branch.Branch(d)
384
b.add([d], verbose=True)
387
class cmd_relpath(Command):
388
"""Show path of a file relative to root"""
389
takes_args = ['filename']
392
def run(self, filename):
393
print Branch(filename).relpath(filename)
397
class cmd_inventory(Command):
398
"""Show inventory of the current working copy or a revision."""
399
takes_options = ['revision', 'show-ids']
401
def run(self, revision=None, show_ids=False):
404
inv = b.read_working_inventory()
406
inv = b.get_revision_inventory(b.lookup_revision(revision))
408
for path, entry in inv.entries():
410
print '%-50s %s' % (path, entry.file_id)
415
class cmd_move(Command):
416
"""Move files to a different directory.
421
The destination must be a versioned directory in the same branch.
423
takes_args = ['source$', 'dest']
424
def run(self, source_list, dest):
427
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
430
class cmd_rename(Command):
431
"""Change the name of an entry.
434
bzr rename frob.c frobber.c
435
bzr rename src/frob.c lib/frob.c
437
It is an error if the destination name exists.
439
See also the 'move' command, which moves files into a different
440
directory without changing their name.
442
TODO: Some way to rename multiple files without invoking bzr for each
444
takes_args = ['from_name', 'to_name']
446
def run(self, from_name, to_name):
448
b.rename_one(b.relpath(from_name), b.relpath(to_name))
454
class cmd_pull(Command):
455
"""Pull any changes from another branch into the current one.
457
If the location is omitted, the last-used location will be used.
458
Both the revision history and the working directory will be
461
This command only works on branches that have not diverged. Branches are
462
considered diverged if both branches have had commits without first
463
pulling from the other.
465
If branches have diverged, you can use 'bzr merge' to pull the text changes
466
from one into the other.
468
takes_args = ['location?']
470
def run(self, location=None):
471
from bzrlib.merge import merge
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
479
if errno == errno.ENOENT:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
from branch import find_branch, DivergedBranches
488
br_from = find_branch(location)
489
location = pull_loc(br_from)
490
old_revno = br_to.revno()
492
br_to.update_revisions(br_from)
493
except DivergedBranches:
494
raise BzrCommandError("These branches have diverged. Try merge.")
496
merge(('.', -1), ('.', old_revno), check_clean=False)
497
if location != stored_loc:
498
br_to.controlfile("x-pull", "wb").write(location + "\n")
502
class cmd_branch(Command):
503
"""Create a new copy of a branch.
505
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
506
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
508
To retrieve the branch as of a particular revision, supply the --revision
509
parameter, as in "branch foo/bar -r 5".
511
takes_args = ['from_location', 'to_location?']
512
takes_options = ['revision']
514
def run(self, from_location, to_location=None, revision=None):
516
from bzrlib.merge import merge
517
from branch import find_branch, DivergedBranches, NoSuchRevision
518
from shutil import rmtree
520
br_from = find_branch(from_location)
522
if e.errno == errno.ENOENT:
523
raise BzrCommandError('Source location "%s" does not exist.' %
528
if to_location is None:
529
to_location = os.path.basename(from_location.rstrip("/\\"))
532
os.mkdir(to_location)
534
if e.errno == errno.EEXIST:
535
raise BzrCommandError('Target directory "%s" already exists.' %
537
if e.errno == errno.ENOENT:
538
raise BzrCommandError('Parent of "%s" does not exist.' %
542
br_to = Branch(to_location, init=True)
545
br_to.update_revisions(br_from, stop_revision=revision)
546
except NoSuchRevision:
548
msg = "The branch %s has no revision %d." % (from_location,
550
raise BzrCommandError(msg)
551
merge((to_location, -1), (to_location, 0), this_dir=to_location,
552
check_clean=False, ignore_zero=True)
553
from_location = pull_loc(br_from)
554
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
557
def pull_loc(branch):
558
# TODO: Should perhaps just make attribute be 'base' in
559
# RemoteBranch and Branch?
560
if hasattr(branch, "baseurl"):
561
return branch.baseurl
567
class cmd_renames(Command):
568
"""Show list of renamed files.
570
TODO: Option to show renames between two historical versions.
572
TODO: Only show renames under dir, rather than in the whole branch.
574
takes_args = ['dir?']
576
def run(self, dir='.'):
578
old_inv = b.basis_tree().inventory
579
new_inv = b.read_working_inventory()
581
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
583
for old_name, new_name in renames:
584
print "%s => %s" % (old_name, new_name)
587
class cmd_info(Command):
588
"""Show statistical information about a branch."""
589
takes_args = ['branch?']
591
def run(self, branch=None):
594
from branch import find_branch
595
b = find_branch(branch)
599
class cmd_remove(Command):
600
"""Make a file unversioned.
602
This makes bzr stop tracking changes to a versioned file. It does
603
not delete the working copy.
605
takes_args = ['file+']
606
takes_options = ['verbose']
608
def run(self, file_list, verbose=False):
609
b = Branch(file_list[0])
610
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
613
class cmd_file_id(Command):
614
"""Print file_id of a particular file or directory.
616
The file_id is assigned when the file is first added and remains the
617
same through all revisions where the file exists, even when it is
621
takes_args = ['filename']
622
def run(self, filename):
624
i = b.inventory.path2id(b.relpath(filename))
626
raise BzrError("%r is not a versioned file" % filename)
631
class cmd_file_path(Command):
632
"""Print path of file_ids to a file or directory.
634
This prints one line for each directory down to the target,
635
starting at the branch root."""
637
takes_args = ['filename']
638
def run(self, filename):
641
fid = inv.path2id(b.relpath(filename))
643
raise BzrError("%r is not a versioned file" % filename)
644
for fip in inv.get_idpath(fid):
648
class cmd_revision_history(Command):
649
"""Display list of revision ids on this branch."""
652
for patchid in Branch('.').revision_history():
656
class cmd_directories(Command):
657
"""Display list of versioned directories in this branch."""
659
for name, ie in Branch('.').read_working_inventory().directories():
666
class cmd_init(Command):
667
"""Make a directory into a versioned branch.
669
Use this to create an empty branch, or before importing an
672
Recipe for importing a tree of files:
677
bzr commit -m 'imported project'
680
Branch('.', init=True)
683
class cmd_diff(Command):
684
"""Show differences in working tree.
686
If files are listed, only the changes in those files are listed.
687
Otherwise, all changes for the tree are listed.
689
TODO: Given two revision arguments, show the difference between them.
691
TODO: Allow diff across branches.
693
TODO: Option to use external diff command; could be GNU diff, wdiff,
696
TODO: Python difflib is not exactly the same as unidiff; should
697
either fix it up or prefer to use an external diff.
699
TODO: If a directory is given, diff everything under that.
701
TODO: Selected-file diff is inefficient and doesn't show you
704
TODO: This probably handles non-Unix newlines poorly.
707
takes_args = ['file*']
708
takes_options = ['revision', 'diff-options']
709
aliases = ['di', 'dif']
711
def run(self, revision=None, file_list=None, diff_options=None):
712
from bzrlib.diff import show_diff
713
from bzrlib import find_branch
716
b = find_branch(file_list[0])
717
file_list = [b.relpath(f) for f in file_list]
718
if file_list == ['']:
719
# just pointing to top-of-tree
724
show_diff(b, revision, specific_files=file_list,
725
external_diff_options=diff_options)
731
class cmd_deleted(Command):
732
"""List files deleted in the working tree.
734
TODO: Show files deleted since a previous revision, or between two revisions.
736
def run(self, show_ids=False):
739
new = b.working_tree()
741
## TODO: Much more efficient way to do this: read in new
742
## directories with readdir, rather than stating each one. Same
743
## level of effort but possibly much less IO. (Or possibly not,
744
## if the directories are very large...)
746
for path, ie in old.inventory.iter_entries():
747
if not new.has_id(ie.file_id):
749
print '%-50s %s' % (path, ie.file_id)
754
class cmd_modified(Command):
755
"""List files modified in working tree."""
760
inv = b.read_working_inventory()
761
sc = statcache.update_cache(b, inv)
762
basis = b.basis_tree()
763
basis_inv = basis.inventory
765
# We used to do this through iter_entries(), but that's slow
766
# when most of the files are unmodified, as is usually the
767
# case. So instead we iterate by inventory entry, and only
768
# calculate paths as necessary.
770
for file_id in basis_inv:
771
cacheentry = sc.get(file_id)
772
if not cacheentry: # deleted
774
ie = basis_inv[file_id]
775
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
776
path = inv.id2path(file_id)
781
class cmd_added(Command):
782
"""List files added in working tree."""
786
wt = b.working_tree()
787
basis_inv = b.basis_tree().inventory
790
if file_id in basis_inv:
792
path = inv.id2path(file_id)
793
if not os.access(b.abspath(path), os.F_OK):
799
class cmd_root(Command):
800
"""Show the tree root directory.
802
The root is the nearest enclosing directory with a .bzr control
804
takes_args = ['filename?']
805
def run(self, filename=None):
806
"""Print the branch root."""
807
from branch import find_branch
808
b = find_branch(filename)
809
print getattr(b, 'base', None) or getattr(b, 'baseurl')
812
class cmd_log(Command):
813
"""Show log of this branch.
815
To request a range of logs, you can use the command -r begin:end
816
-r revision requests a specific revision, -r :end or -r begin: are
819
TODO: Make --revision support uuid: and hash: [future tag:] notation.
823
takes_args = ['filename?']
824
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
826
def run(self, filename=None, timezone='original',
831
from bzrlib import show_log, find_branch
834
direction = (forward and 'forward') or 'reverse'
837
b = find_branch(filename)
838
fp = b.relpath(filename)
840
file_id = b.read_working_inventory().path2id(fp)
842
file_id = None # points to branch root
848
revision = [None, None]
849
elif isinstance(revision, int):
850
revision = [revision, revision]
855
assert len(revision) == 2
857
mutter('encoding log as %r' % bzrlib.user_encoding)
241
859
# use 'replace' so that we don't abort if trying to write out
242
860
# 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.
861
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
864
show_timezone=timezone,
869
start_revision=revision[0],
870
end_revision=revision[1])
874
class cmd_touching_revisions(Command):
875
"""Return revision-ids which affected a particular file.
877
A more user-friendly interface is "bzr log FILE"."""
879
takes_args = ["filename"]
880
def run(self, filename):
882
inv = b.read_working_inventory()
883
file_id = inv.path2id(b.relpath(filename))
884
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
885
print "%6d %s" % (revno, what)
888
class cmd_ls(Command):
889
"""List files in a tree.
891
TODO: Take a revision or remote path and list that tree instead.
894
def run(self, revision=None, verbose=False):
897
tree = b.working_tree()
899
tree = b.revision_tree(b.lookup_revision(revision))
901
for fp, fc, kind, fid in tree.list_files():
903
if kind == 'directory':
910
print '%-8s %s%s' % (fc, fp, kindch)
916
class cmd_unknowns(Command):
917
"""List unknown files."""
919
for f in Branch('.').unknowns():
924
class cmd_ignore(Command):
925
"""Ignore a command or pattern.
927
To remove patterns from the ignore list, edit the .bzrignore file.
929
If the pattern contains a slash, it is compared to the whole path
930
from the branch root. Otherwise, it is comapred to only the last
931
component of the path.
933
Ignore patterns are case-insensitive on case-insensitive systems.
935
Note: wildcards must be quoted from the shell on Unix.
938
bzr ignore ./Makefile
941
takes_args = ['name_pattern']
943
def run(self, name_pattern):
944
from bzrlib.atomicfile import AtomicFile
948
ifn = b.abspath('.bzrignore')
950
if os.path.exists(ifn):
953
igns = f.read().decode('utf-8')
959
# TODO: If the file already uses crlf-style termination, maybe
960
# we should use that for the newly added lines?
962
if igns and igns[-1] != '\n':
964
igns += name_pattern + '\n'
967
f = AtomicFile(ifn, 'wt')
968
f.write(igns.encode('utf-8'))
973
inv = b.working_tree().inventory
974
if inv.path2id('.bzrignore'):
975
mutter('.bzrignore is already versioned')
977
mutter('need to make new .bzrignore file versioned')
978
b.add(['.bzrignore'])
982
class cmd_ignored(Command):
983
"""List ignored files and the patterns that matched them.
985
See also: bzr ignore"""
987
tree = Branch('.').working_tree()
988
for path, file_class, kind, file_id in tree.list_files():
989
if file_class != 'I':
991
## XXX: Slightly inefficient since this was already calculated
992
pat = tree.is_ignored(path)
993
print '%-50s %s' % (path, pat)
996
class cmd_lookup_revision(Command):
997
"""Lookup the revision-id from a revision-number
1000
bzr lookup-revision 33
1003
takes_args = ['revno']
1005
def run(self, revno):
1009
raise BzrCommandError("not a valid revision-number: %r" % revno)
1011
print Branch('.').lookup_revision(revno)
1014
class cmd_export(Command):
1015
"""Export past revision to destination directory.
1017
If no revision is specified this exports the last committed revision.
1019
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1020
given, exports to a directory (equivalent to --format=dir)."""
1021
# TODO: list known exporters
1022
takes_args = ['dest']
1023
takes_options = ['revision', 'format']
1024
def run(self, dest, revision=None, format='dir'):
1026
if revision == None:
1027
rh = b.revision_history()[-1]
1029
rh = b.lookup_revision(int(revision))
1030
t = b.revision_tree(rh)
1031
t.export(dest, format)
1034
class cmd_cat(Command):
1035
"""Write a file's text from a previous revision."""
1037
takes_options = ['revision']
1038
takes_args = ['filename']
1040
def run(self, filename, revision=None):
1041
if revision == None:
1042
raise BzrCommandError("bzr cat requires a revision number")
1044
b.print_file(b.relpath(filename), int(revision))
1047
class cmd_local_time_offset(Command):
1048
"""Show the offset in seconds from GMT to local time."""
1051
print bzrlib.osutils.local_time_offset()
1055
class cmd_commit(Command):
1056
"""Commit changes into a new revision.
1058
If selected files are specified, only changes to those files are
1059
committed. If a directory is specified then its contents are also
1062
A selected-file commit may fail in some cases where the committed
1063
tree would be invalid, such as trying to commit a file in a
1064
newly-added directory that is not itself committed.
1066
TODO: Run hooks on tree to-be-committed, and after commit.
1068
TODO: Strict commit that fails if there are unknown or deleted files.
1070
takes_args = ['selected*']
1071
takes_options = ['message', 'file', 'verbose']
1072
aliases = ['ci', 'checkin']
1074
def run(self, message=None, file=None, verbose=True, selected_list=None):
1075
from bzrlib.commit import commit
1077
## Warning: shadows builtin file()
1078
if not message and not file:
1079
raise BzrCommandError("please specify a commit message",
1080
["use either --message or --file"])
1081
elif message and file:
1082
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)
1086
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1089
commit(b, message, verbose=verbose, specific_files=selected_list)
1092
class cmd_check(Command):
1093
"""Validate consistency of branch history.
1095
This command checks various invariants about the branch storage to
1096
detect data corruption or bzr bugs.
1098
If given the --update flag, it will update some optional fields
1099
to help ensure data consistency.
1101
takes_args = ['dir?']
1103
def run(self, dir='.'):
1105
bzrlib.check.check(Branch(dir))
1109
class cmd_upgrade(Command):
1110
"""Upgrade branch storage to current format.
1112
This should normally be used only after the check command tells
1115
takes_args = ['dir?']
1117
def run(self, dir='.'):
1118
from bzrlib.upgrade import upgrade
1119
upgrade(Branch(dir))
1123
class cmd_whoami(Command):
1124
"""Show bzr user id."""
1125
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':
1127
def run(self, email=False):
1129
print bzrlib.osutils.user_email()
1131
print bzrlib.osutils.username()
1134
class cmd_selftest(Command):
1135
"""Run internal test suite"""
1138
from bzrlib.selftest import selftest
1139
return int(not selftest())
1142
class cmd_version(Command):
1143
"""Show version of bzr."""
1148
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1149
# is bzrlib itself in a branch?
1150
bzrrev = bzrlib.get_bzr_revision()
1152
print " (bzr checkout, revision %d {%s})" % bzrrev
1153
print bzrlib.__copyright__
1154
print "http://bazaar-ng.org/"
1156
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1157
print "you may use, modify and redistribute it under the terms of the GNU"
1158
print "General Public License version 2 or later."
1161
class cmd_rocks(Command):
1162
"""Statement of optimism."""
1165
print "it sure does!"
318
1167
def parse_spec(spec):
336
1183
if parsed[1] == "":
340
parsed[1] = int(parsed[1])
342
pass # We can allow stuff like ./@revid:blahblahblah
1186
parsed[1] = int(parsed[1])
1187
assert parsed[1] >=0
346
1189
parsed = [spec, None]
349
def parse_args(command, argv, alias_argv=None):
1194
class cmd_merge(Command):
1195
"""Perform a three-way merge of trees.
1197
The SPEC parameters are working tree or revision specifiers. Working trees
1198
are specified using standard paths or urls. No component of a directory
1199
path may begin with '@'.
1201
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1203
Revisions are specified using a dirname/@revno pair, where dirname is the
1204
branch directory and revno is the revision within that branch. If no revno
1205
is specified, the latest revision is used.
1207
Revision examples: './@127', 'foo/@', '../@1'
1209
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1210
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1213
merge refuses to run if there are any uncommitted changes, unless
1216
takes_args = ['other_spec', 'base_spec?']
1217
takes_options = ['force']
1219
def run(self, other_spec, base_spec=None, force=False):
1220
from bzrlib.merge import merge
1221
merge(parse_spec(other_spec), parse_spec(base_spec),
1222
check_clean=(not force))
1225
class cmd_revert(Command):
1226
"""Reverse all changes since the last commit.
1228
Only versioned files are affected.
1230
TODO: Store backups of any files that will be reverted, so
1231
that the revert can be undone.
1233
takes_options = ['revision']
1235
def run(self, revision=-1):
1236
from bzrlib.merge import merge
1237
merge(('.', revision), parse_spec('.'),
1242
class cmd_assert_fail(Command):
1243
"""Test reporting of assertion failures"""
1246
assert False, "always fails"
1249
class cmd_help(Command):
1250
"""Show help on a command or other topic.
1252
For a list of all available commands, say 'bzr help commands'."""
1253
takes_args = ['topic?']
1256
def run(self, topic=None):
1261
class cmd_update_stat_cache(Command):
1262
"""Update stat-cache mapping inodes to SHA-1 hashes.
1264
For testing only."""
1269
statcache.update_cache(b.base, b.read_working_inventory())
1273
class cmd_plugins(Command):
1277
import bzrlib.plugin
1278
from pprint import pprint
1279
pprint(bzrlib.plugin.all_plugins)
1283
# list of all available options; the rhs can be either None for an
1284
# option that takes no argument, or a constructor function that checks
1288
'diff-options': str,
1297
'revision': _parse_revision_str,
1315
def parse_args(argv):
350
1316
"""Parse command line.
352
1318
Arguments and options are parsed at this level before being passed
353
1319
down to specific command handlers. This routine knows, from a
354
1320
lookup table, something about the available options, what optargs
355
1321
they take, and which commands will accept them.
1323
>>> parse_args('--help'.split())
1324
([], {'help': True})
1325
>>> parse_args('--version'.split())
1326
([], {'version': True})
1327
>>> parse_args('status --all'.split())
1328
(['status'], {'all': True})
1329
>>> parse_args('commit --message=biter'.split())
1330
(['commit'], {'message': u'biter'})
1331
>>> parse_args('log -r 500'.split())
1332
(['log'], {'revision': 500})
1333
>>> parse_args('log -r500:600'.split())
1334
(['log'], {'revision': [500, 600]})
1335
>>> parse_args('log -vr500:600'.split())
1336
(['log'], {'verbose': True, 'revision': [500, 600]})
1337
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1338
Traceback (most recent call last):
1340
ValueError: invalid literal for int(): v500
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:
372
# We've received a standalone -- No more flags
376
# option names must not be unicode
380
mutter(" got option %r", a)
382
optname, optarg = a[2:].split('=', 1)
385
if optname not in cmd_options:
386
raise BzrCommandError('unknown option "%s"' % a)
389
if shortopt in Option.SHORT_OPTIONS:
390
# Multi-character options must have a space to delimit
392
# ^^^ what does this mean? mbp 20051014
393
optname = Option.SHORT_OPTIONS[shortopt].name
395
# Single character short options, can be chained,
396
# and have their value appended to their name
398
if shortopt not in Option.SHORT_OPTIONS:
399
# We didn't find the multi-character name, and we
400
# didn't find the single char name
401
raise BzrCommandError('unknown option "%s"' % a)
402
optname = Option.SHORT_OPTIONS[shortopt].name
405
# There are extra things on this option
406
# see if it is the value, or if it is another
408
optargfn = Option.OPTIONS[optname].type
410
# This option does not take an argument, so the
411
# next entry is another short option, pack it
413
proc_argv.insert(0, '-' + a[2:])
415
# This option takes an argument, so pack it
418
if optname not in cmd_options:
419
raise BzrCommandError('unknown option "%s"' % shortopt)
421
# XXX: Do we ever want to support this, e.g. for -r?
423
raise BzrCommandError('repeated option %r' % a)
424
elif optname in alias_opts:
425
# Replace what's in the alias with what's in the real
427
del alias_opts[optname]
429
proc_argv.insert(0, a)
432
raise BzrCommandError('repeated option %r' % a)
434
option_obj = cmd_options[optname]
435
optargfn = option_obj.type
439
raise BzrCommandError('option %r needs an argument' % a)
1345
# TODO: Maybe handle '--' to end options?
1350
# option names must not be unicode
1354
mutter(" got option %r" % a)
1356
optname, optarg = a[2:].split('=', 1)
1359
if optname not in OPTIONS:
1360
raise BzrError('unknown long option %r' % a)
1363
if shortopt in SHORT_OPTIONS:
1364
# Multi-character options must have a space to delimit
1366
optname = SHORT_OPTIONS[shortopt]
1368
# Single character short options, can be chained,
1369
# and have their value appended to their name
1371
if shortopt not in SHORT_OPTIONS:
1372
# We didn't find the multi-character name, and we
1373
# didn't find the single char name
1374
raise BzrError('unknown short option %r' % a)
1375
optname = SHORT_OPTIONS[shortopt]
1378
# There are extra things on this option
1379
# see if it is the value, or if it is another
1381
optargfn = OPTIONS[optname]
1382
if optargfn is None:
1383
# This option does not take an argument, so the
1384
# next entry is another short option, pack it back
1386
argv.insert(0, '-' + a[2:])
441
optarg = proc_argv.pop(0)
442
opts[optname] = optargfn(optarg)
444
alias_opts[optname] = optargfn(optarg)
447
raise BzrCommandError('option %r takes no argument' % optname)
450
alias_opts[optname] = True
1388
# This option takes an argument, so pack it
1393
# XXX: Do we ever want to support this, e.g. for -r?
1394
raise BzrError('repeated option %r' % a)
1396
optargfn = OPTIONS[optname]
1400
raise BzrError('option %r needs an argument' % a)
1402
optarg = argv.pop(0)
1403
opts[optname] = optargfn(optarg)
453
proc_aliasarg = False # Done with alias argv
1406
raise BzrError('option %r takes no argument' % optname)
1407
opts[optname] = True
454
1411
return args, opts
457
1416
def _match_argform(cmd, takes_args, args):
added
removed
bzrlib/commands.py
