117
def get_cmd_object(cmd_name, plugins_override=True):
111
def get_cmd_class(cmd, plugins_override=True):
118
112
"""Return the canonical name and command class for a command.
121
If true, plugin commands can override builtins.
123
from bzrlib.externalcommand import ExternalCommand
125
cmd_name = str(cmd_name) # not unicode
114
cmd = str(cmd) # not unicode
127
116
# first look up this command under the specified name
128
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
130
return cmds[cmd_name]()
119
return cmd, cmds[cmd]
134
123
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
139
cmd_obj = ExternalCommand.find_command(cmd_name)
143
raise BzrCommandError("unknown command %r" % cmd_name)
124
for cmdname, cmdclass in cmds.iteritems():
125
if cmd in cmdclass.aliases:
126
return cmdname, cmdclass
128
cmdclass = ExternalCommand.find_command(cmd)
132
raise BzrCommandError("unknown command %r" % cmd)
146
135
class Command(object):
147
136
"""Base class for commands.
149
Commands are the heart of the command-line bzr interface.
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
160
138
The docstring for an actual command should give a single-line
161
139
summary, then a complete description of the command. A grammar
162
140
description will be inserted.
165
Other accepted names for this command.
168
143
List of argument forms, marked with whether they are optional,
173
['to_location', 'from_branch?', 'file*']
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
147
List of options that may be given for this command.
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
150
If true, this command isn't advertised.
190
155
takes_options = []
195
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
200
"""Return dict of valid options for this command.
202
Maps from long option name to option object."""
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
233
return self.run(**all_cmd_args)
159
def __init__(self, options, arguments):
160
"""Construct and run the command.
162
Sets self.status to the return value of run()."""
163
assert isinstance(options, dict)
164
assert isinstance(arguments, dict)
165
cmdargs = options.copy()
166
cmdargs.update(arguments)
167
assert self.__doc__ != Command.__doc__, \
168
("No help message set for %r" % self)
169
self.status = self.run(**cmdargs)
236
"""Actually run the command.
173
"""Override this in sub-classes.
238
175
This is invoked with the options and arguments bound to
239
176
keyword parameters.
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
178
Return 0 or None if the command was successful, or a shell
245
raise NotImplementedError()
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
255
return _unsquish_command_name(self.__class__.__name__)
184
class ExternalCommand(Command):
185
"""Class to wrap external commands.
187
We cheat a little here, when get_cmd_class() calls us we actually give it back
188
an object we construct that has the appropriate path, help, options etc for the
191
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
192
method, which we override to call the Command.__init__ method. That then calls
193
our run method which is pretty straight forward.
195
The only wrinkle is that we have to map bzr's dictionary of options and arguments
196
back into command line options and arguments for the script.
199
def find_command(cls, cmd):
201
bzrpath = os.environ.get('BZRPATH', '')
203
for dir in bzrpath.split(os.pathsep):
204
path = os.path.join(dir, cmd)
205
if os.path.isfile(path):
206
return ExternalCommand(path)
210
find_command = classmethod(find_command)
212
def __init__(self, path):
215
pipe = os.popen('%s --bzr-usage' % path, 'r')
216
self.takes_options = pipe.readline().split()
218
for opt in self.takes_options:
219
if not opt in OPTIONS:
220
raise BzrError("Unknown option '%s' returned by external command %s"
223
# TODO: Is there any way to check takes_args is valid here?
224
self.takes_args = pipe.readline().split()
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
229
pipe = os.popen('%s --bzr-help' % path, 'r')
230
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
234
def __call__(self, options, arguments):
235
Command.__init__(self, options, arguments)
238
def run(self, **kargs):
245
optname = name.replace('_','-')
247
if OPTIONS.has_key(optname):
249
opts.append('--%s' % optname)
250
if value is not None and value is not True:
251
opts.append(str(value))
253
# it's an arg, or arg list
254
if type(value) is not list:
260
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
264
class cmd_status(Command):
265
"""Display status summary.
267
This reports on versioned and unknown files, reporting them
268
grouped by state. Possible states are:
271
Versioned in the working copy but not in the previous revision.
274
Versioned in the previous revision but removed or deleted
278
Path of this file changed from the previous revision;
279
the text may also have changed. This includes files whose
280
parent directory was renamed.
283
Text has changed since the previous revision.
286
Nothing about this file has changed since the previous revision.
287
Only shown with --all.
290
Not versioned and not matching an ignore pattern.
292
To see ignored files use 'bzr ignored'. For details in the
293
changes to file texts, use 'bzr diff'.
295
If no arguments are specified, the status of the entire working
296
directory is shown. Otherwise, only the status of the specified
297
files or directories is reported. If a directory is given, status
298
is reported for everything inside that directory.
300
takes_args = ['file*']
301
takes_options = ['all', 'show-ids']
302
aliases = ['st', 'stat']
304
def run(self, all=False, show_ids=False, file_list=None):
306
b = find_branch(file_list[0])
307
file_list = [b.relpath(x) for x in file_list]
308
# special case: only one path was given and it's the root
310
if file_list == ['']:
315
status.show_status(b, show_unchanged=all, show_ids=show_ids,
316
specific_files=file_list)
319
class cmd_cat_revision(Command):
320
"""Write out metadata for a revision."""
323
takes_args = ['revision_id']
325
def run(self, revision_id):
326
from bzrlib.xml import pack_xml
327
pack_xml(find_branch('.').get_revision(revision_id), 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 find_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
from bzrlib.add import smart_add
364
smart_add(file_list, verbose, not no_recurse)
368
class cmd_mkdir(Command):
369
"""Create a new versioned directory.
371
This is equivalent to creating the directory and then adding it.
373
takes_args = ['dir+']
375
def run(self, dir_list):
382
b.add([d], verbose=True)
385
class cmd_relpath(Command):
386
"""Show path of a file relative to root"""
387
takes_args = ['filename']
390
def run(self, filename):
391
print find_branch(filename).relpath(filename)
395
class cmd_inventory(Command):
396
"""Show inventory of the current working copy or a revision."""
397
takes_options = ['revision', 'show-ids']
399
def run(self, revision=None, show_ids=False):
402
inv = b.read_working_inventory()
404
inv = b.get_revision_inventory(b.lookup_revision(revision))
406
for path, entry in inv.entries():
408
print '%-50s %s' % (path, entry.file_id)
413
class cmd_move(Command):
414
"""Move files to a different directory.
419
The destination must be a versioned directory in the same branch.
421
takes_args = ['source$', 'dest']
422
def run(self, source_list, dest):
425
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
428
class cmd_rename(Command):
429
"""Change the name of an entry.
432
bzr rename frob.c frobber.c
433
bzr rename src/frob.c lib/frob.c
435
It is an error if the destination name exists.
437
See also the 'move' command, which moves files into a different
438
directory without changing their name.
440
TODO: Some way to rename multiple files without invoking bzr for each
442
takes_args = ['from_name', 'to_name']
444
def run(self, from_name, to_name):
446
b.rename_one(b.relpath(from_name), b.relpath(to_name))
452
class cmd_pull(Command):
453
"""Pull any changes from another branch into the current one.
455
If the location is omitted, the last-used location will be used.
456
Both the revision history and the working directory will be
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if both branches have had commits without first
461
pulling from the other.
463
If branches have diverged, you can use 'bzr merge' to pull the text changes
464
from one into the other.
466
takes_args = ['location?']
468
def run(self, location=None):
469
from bzrlib.merge import merge
471
from shutil import rmtree
474
br_to = find_branch('.')
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
479
if e.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
cache_root = tempfile.mkdtemp()
488
from bzrlib.branch import DivergedBranches
489
br_from = find_branch(location)
490
location = pull_loc(br_from)
491
old_revno = br_to.revno()
493
from branch import find_cached_branch, DivergedBranches
494
br_from = find_cached_branch(location, cache_root)
495
location = pull_loc(br_from)
496
old_revno = br_to.revno()
498
br_to.update_revisions(br_from)
499
except DivergedBranches:
500
raise BzrCommandError("These branches have diverged."
503
merge(('.', -1), ('.', old_revno), check_clean=False)
504
if location != stored_loc:
505
br_to.controlfile("x-pull", "wb").write(location + "\n")
511
class cmd_branch(Command):
512
"""Create a new copy of a branch.
514
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
515
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
517
To retrieve the branch as of a particular revision, supply the --revision
518
parameter, as in "branch foo/bar -r 5".
520
takes_args = ['from_location', 'to_location?']
521
takes_options = ['revision']
523
def run(self, from_location, to_location=None, revision=None):
525
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
527
find_cached_branch, Branch
528
from shutil import rmtree
529
from meta_store import CachedStore
531
cache_root = tempfile.mkdtemp()
534
br_from = find_cached_branch(from_location, cache_root)
536
if e.errno == errno.ENOENT:
537
raise BzrCommandError('Source location "%s" does not'
538
' exist.' % to_location)
542
if to_location is None:
543
to_location = os.path.basename(from_location.rstrip("/\\"))
546
os.mkdir(to_location)
548
if e.errno == errno.EEXIST:
549
raise BzrCommandError('Target directory "%s" already'
550
' exists.' % to_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Parent of "%s" does not exist.' %
556
br_to = Branch(to_location, init=True)
559
br_to.update_revisions(br_from, stop_revision=revision)
560
except NoSuchRevision:
562
msg = "The branch %s has no revision %d." % (from_location,
564
raise BzrCommandError(msg)
565
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
check_clean=False, ignore_zero=True)
567
from_location = pull_loc(br_from)
568
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
573
def pull_loc(branch):
574
# TODO: Should perhaps just make attribute be 'base' in
575
# RemoteBranch and Branch?
576
if hasattr(branch, "baseurl"):
577
return branch.baseurl
583
class cmd_renames(Command):
584
"""Show list of renamed files.
586
TODO: Option to show renames between two historical versions.
588
TODO: Only show renames under dir, rather than in the whole branch.
590
takes_args = ['dir?']
592
def run(self, dir='.'):
594
old_inv = b.basis_tree().inventory
595
new_inv = b.read_working_inventory()
597
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
599
for old_name, new_name in renames:
600
print "%s => %s" % (old_name, new_name)
603
class cmd_info(Command):
604
"""Show statistical information about a branch."""
605
takes_args = ['branch?']
607
def run(self, branch=None):
610
b = find_branch(branch)
614
class cmd_remove(Command):
615
"""Make a file unversioned.
617
This makes bzr stop tracking changes to a versioned file. It does
618
not delete the working copy.
620
takes_args = ['file+']
621
takes_options = ['verbose']
623
def run(self, file_list, verbose=False):
624
b = find_branch(file_list[0])
625
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
628
class cmd_file_id(Command):
629
"""Print file_id of a particular file or directory.
631
The file_id is assigned when the file is first added and remains the
632
same through all revisions where the file exists, even when it is
636
takes_args = ['filename']
637
def run(self, filename):
638
b = find_branch(filename)
639
i = b.inventory.path2id(b.relpath(filename))
641
raise BzrError("%r is not a versioned file" % filename)
646
class cmd_file_path(Command):
647
"""Print path of file_ids to a file or directory.
649
This prints one line for each directory down to the target,
650
starting at the branch root."""
652
takes_args = ['filename']
653
def run(self, filename):
654
b = find_branch(filename)
656
fid = inv.path2id(b.relpath(filename))
658
raise BzrError("%r is not a versioned file" % filename)
659
for fip in inv.get_idpath(fid):
663
class cmd_revision_history(Command):
664
"""Display list of revision ids on this branch."""
667
for patchid in find_branch('.').revision_history():
671
class cmd_directories(Command):
672
"""Display list of versioned directories in this branch."""
674
for name, ie in find_branch('.').read_working_inventory().directories():
681
class cmd_init(Command):
682
"""Make a directory into a versioned branch.
684
Use this to create an empty branch, or before importing an
687
Recipe for importing a tree of files:
692
bzr commit -m 'imported project'
695
from bzrlib.branch import Branch
696
Branch('.', init=True)
699
class cmd_diff(Command):
700
"""Show differences in working tree.
702
If files are listed, only the changes in those files are listed.
703
Otherwise, all changes for the tree are listed.
705
TODO: Given two revision arguments, show the difference between them.
707
TODO: Allow diff across branches.
709
TODO: Option to use external diff command; could be GNU diff, wdiff,
712
TODO: Python difflib is not exactly the same as unidiff; should
713
either fix it up or prefer to use an external diff.
715
TODO: If a directory is given, diff everything under that.
717
TODO: Selected-file diff is inefficient and doesn't show you
720
TODO: This probably handles non-Unix newlines poorly.
723
takes_args = ['file*']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
727
def run(self, revision=None, file_list=None, diff_options=None):
728
from bzrlib.diff import show_diff
731
b = find_branch(file_list[0])
732
file_list = [b.relpath(f) for f in file_list]
733
if file_list == ['']:
734
# just pointing to top-of-tree
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
746
class cmd_deleted(Command):
747
"""List files deleted in the working tree.
749
TODO: Show files deleted since a previous revision, or between two revisions.
751
def run(self, show_ids=False):
754
new = b.working_tree()
756
## TODO: Much more efficient way to do this: read in new
757
## directories with readdir, rather than stating each one. Same
758
## level of effort but possibly much less IO. (Or possibly not,
759
## if the directories are very large...)
761
for path, ie in old.inventory.iter_entries():
762
if not new.has_id(ie.file_id):
764
print '%-50s %s' % (path, ie.file_id)
769
class cmd_modified(Command):
770
"""List files modified in working tree."""
773
from bzrlib.statcache import update_cache, SC_SHA1
775
inv = b.read_working_inventory()
776
sc = update_cache(b, inv)
777
basis = b.basis_tree()
778
basis_inv = basis.inventory
780
# We used to do this through iter_entries(), but that's slow
781
# when most of the files are unmodified, as is usually the
782
# case. So instead we iterate by inventory entry, and only
783
# calculate paths as necessary.
785
for file_id in basis_inv:
786
cacheentry = sc.get(file_id)
787
if not cacheentry: # deleted
789
ie = basis_inv[file_id]
790
if cacheentry[SC_SHA1] != ie.text_sha1:
791
path = inv.id2path(file_id)
796
class cmd_added(Command):
797
"""List files added in working tree."""
801
wt = b.working_tree()
802
basis_inv = b.basis_tree().inventory
805
if file_id in basis_inv:
807
path = inv.id2path(file_id)
808
if not os.access(b.abspath(path), os.F_OK):
814
class cmd_root(Command):
815
"""Show the tree root directory.
817
The root is the nearest enclosing directory with a .bzr control
819
takes_args = ['filename?']
820
def run(self, filename=None):
821
"""Print the branch root."""
822
b = find_branch(filename)
823
print getattr(b, 'base', None) or getattr(b, 'baseurl')
826
class cmd_log(Command):
827
"""Show log of this branch.
829
To request a range of logs, you can use the command -r begin:end
830
-r revision requests a specific revision, -r :end or -r begin: are
833
TODO: Make --revision support uuid: and hash: [future tag:] notation.
837
takes_args = ['filename?']
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
840
def run(self, filename=None, timezone='original',
846
from bzrlib.branch import find_branch
847
from bzrlib.log import log_formatter, show_log
850
direction = (forward and 'forward') or 'reverse'
853
b = find_branch(filename)
854
fp = b.relpath(filename)
856
file_id = b.read_working_inventory().path2id(fp)
858
file_id = None # points to branch root
864
revision = [None, None]
865
elif isinstance(revision, int):
866
revision = [revision, revision]
871
assert len(revision) == 2
873
mutter('encoding log as %r' % bzrlib.user_encoding)
875
# use 'replace' so that we don't abort if trying to write out
876
# in e.g. the default C locale.
877
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
883
lf = log_formatter(log_format,
886
show_timezone=timezone)
893
start_revision=revision[0],
894
end_revision=revision[1])
898
class cmd_touching_revisions(Command):
899
"""Return revision-ids which affected a particular file.
901
A more user-friendly interface is "bzr log FILE"."""
903
takes_args = ["filename"]
904
def run(self, filename):
905
b = find_branch(filename)
906
inv = b.read_working_inventory()
907
file_id = inv.path2id(b.relpath(filename))
908
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
909
print "%6d %s" % (revno, what)
912
class cmd_ls(Command):
913
"""List files in a tree.
915
TODO: Take a revision or remote path and list that tree instead.
918
def run(self, revision=None, verbose=False):
921
tree = b.working_tree()
923
tree = b.revision_tree(b.lookup_revision(revision))
925
for fp, fc, kind, fid in tree.list_files():
927
if kind == 'directory':
934
print '%-8s %s%s' % (fc, fp, kindch)
940
class cmd_unknowns(Command):
941
"""List unknown files."""
943
from bzrlib.osutils import quotefn
944
for f in find_branch('.').unknowns():
949
class cmd_ignore(Command):
950
"""Ignore a command or pattern.
952
To remove patterns from the ignore list, edit the .bzrignore file.
954
If the pattern contains a slash, it is compared to the whole path
955
from the branch root. Otherwise, it is comapred to only the last
956
component of the path.
958
Ignore patterns are case-insensitive on case-insensitive systems.
960
Note: wildcards must be quoted from the shell on Unix.
963
bzr ignore ./Makefile
966
takes_args = ['name_pattern']
968
def run(self, name_pattern):
969
from bzrlib.atomicfile import AtomicFile
973
ifn = b.abspath('.bzrignore')
975
if os.path.exists(ifn):
978
igns = f.read().decode('utf-8')
984
# TODO: If the file already uses crlf-style termination, maybe
985
# we should use that for the newly added lines?
987
if igns and igns[-1] != '\n':
989
igns += name_pattern + '\n'
992
f = AtomicFile(ifn, 'wt')
993
f.write(igns.encode('utf-8'))
998
inv = b.working_tree().inventory
999
if inv.path2id('.bzrignore'):
1000
mutter('.bzrignore is already versioned')
1002
mutter('need to make new .bzrignore file versioned')
1003
b.add(['.bzrignore'])
1007
class cmd_ignored(Command):
1008
"""List ignored files and the patterns that matched them.
1010
See also: bzr ignore"""
1012
tree = find_branch('.').working_tree()
1013
for path, file_class, kind, file_id in tree.list_files():
1014
if file_class != 'I':
1016
## XXX: Slightly inefficient since this was already calculated
1017
pat = tree.is_ignored(path)
1018
print '%-50s %s' % (path, pat)
1021
class cmd_lookup_revision(Command):
1022
"""Lookup the revision-id from a revision-number
1025
bzr lookup-revision 33
1028
takes_args = ['revno']
1030
def run(self, revno):
1034
raise BzrCommandError("not a valid revision-number: %r" % revno)
1036
print find_branch('.').lookup_revision(revno)
1039
class cmd_export(Command):
1040
"""Export past revision to destination directory.
1042
If no revision is specified this exports the last committed revision.
1044
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1045
given, try to find the format with the extension. If no extension
1046
is found exports to a directory (equivalent to --format=dir).
1048
Root may be the top directory for tar, tgz and tbz2 formats. If none
1049
is given, the top directory will be the root name of the file."""
1050
# TODO: list known exporters
1051
takes_args = ['dest']
1052
takes_options = ['revision', 'format', 'root']
1053
def run(self, dest, revision=None, format=None, root=None):
1055
b = find_branch('.')
1056
if revision == None:
1057
rh = b.revision_history()[-1]
1059
rh = b.lookup_revision(int(revision))
1060
t = b.revision_tree(rh)
1061
root, ext = os.path.splitext(dest)
1063
if ext in (".tar",):
1065
elif ext in (".gz", ".tgz"):
1067
elif ext in (".bz2", ".tbz2"):
1071
t.export(dest, format, root)
1074
class cmd_cat(Command):
1075
"""Write a file's text from a previous revision."""
1077
takes_options = ['revision']
1078
takes_args = ['filename']
1080
def run(self, filename, revision=None):
1081
if revision == None:
1082
raise BzrCommandError("bzr cat requires a revision number")
1083
b = find_branch('.')
1084
b.print_file(b.relpath(filename), int(revision))
1087
class cmd_local_time_offset(Command):
1088
"""Show the offset in seconds from GMT to local time."""
1091
print bzrlib.osutils.local_time_offset()
1095
class cmd_commit(Command):
1096
"""Commit changes into a new revision.
1098
If selected files are specified, only changes to those files are
1099
committed. If a directory is specified then its contents are also
1102
A selected-file commit may fail in some cases where the committed
1103
tree would be invalid, such as trying to commit a file in a
1104
newly-added directory that is not itself committed.
1106
TODO: Run hooks on tree to-be-committed, and after commit.
1108
TODO: Strict commit that fails if there are unknown or deleted files.
1110
takes_args = ['selected*']
1111
takes_options = ['message', 'file', 'verbose']
1112
aliases = ['ci', 'checkin']
1114
def run(self, message=None, file=None, verbose=True, selected_list=None):
1115
from bzrlib.commit import commit
1116
from bzrlib.osutils import get_text_message
1118
## Warning: shadows builtin file()
1119
if not message and not file:
1122
catcher = cStringIO.StringIO()
1123
sys.stdout = catcher
1124
cmd_status({"file_list":selected_list}, {})
1125
info = catcher.getvalue()
1127
message = get_text_message(info)
1130
raise BzrCommandError("please specify a commit message",
1131
["use either --message or --file"])
1132
elif message and file:
1133
raise BzrCommandError("please specify either --message or --file")
1137
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1139
b = find_branch('.')
1140
commit(b, message, verbose=verbose, specific_files=selected_list)
1143
class cmd_check(Command):
1144
"""Validate consistency of branch history.
1146
This command checks various invariants about the branch storage to
1147
detect data corruption or bzr bugs.
1149
If given the --update flag, it will update some optional fields
1150
to help ensure data consistency.
1152
takes_args = ['dir?']
1154
def run(self, dir='.'):
1155
from bzrlib.check import check
1156
check(find_branch(dir))
1160
class cmd_upgrade(Command):
1161
"""Upgrade branch storage to current format.
1163
This should normally be used only after the check command tells
1166
takes_args = ['dir?']
1168
def run(self, dir='.'):
1169
from bzrlib.upgrade import upgrade
1170
upgrade(find_branch(dir))
1174
class cmd_whoami(Command):
1175
"""Show bzr user id."""
1176
takes_options = ['email']
1178
def run(self, email=False):
1180
print bzrlib.osutils.user_email()
1182
print bzrlib.osutils.username()
1185
class cmd_selftest(Command):
1186
"""Run internal test suite"""
1189
from bzrlib.selftest import selftest
1190
return int(not selftest())
1193
class cmd_version(Command):
1194
"""Show version of bzr."""
1199
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1200
# is bzrlib itself in a branch?
1201
bzrrev = bzrlib.get_bzr_revision()
1203
print " (bzr checkout, revision %d {%s})" % bzrrev
1204
print bzrlib.__copyright__
1205
print "http://bazaar-ng.org/"
1207
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1208
print "you may use, modify and redistribute it under the terms of the GNU"
1209
print "General Public License version 2 or later."
1212
class cmd_rocks(Command):
1213
"""Statement of optimism."""
1216
print "it sure does!"
258
1218
def parse_spec(spec):
276
1234
if parsed[1] == "":
280
parsed[1] = int(parsed[1])
282
pass # We can allow stuff like ./@revid:blahblahblah
1237
parsed[1] = int(parsed[1])
1238
assert parsed[1] >=0
286
1240
parsed = [spec, None]
289
def parse_args(command, argv):
1245
class cmd_merge(Command):
1246
"""Perform a three-way merge of trees.
1248
The SPEC parameters are working tree or revision specifiers. Working trees
1249
are specified using standard paths or urls. No component of a directory
1250
path may begin with '@'.
1252
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1254
Revisions are specified using a dirname/@revno pair, where dirname is the
1255
branch directory and revno is the revision within that branch. If no revno
1256
is specified, the latest revision is used.
1258
Revision examples: './@127', 'foo/@', '../@1'
1260
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1261
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1264
merge refuses to run if there are any uncommitted changes, unless
1267
takes_args = ['other_spec', 'base_spec?']
1268
takes_options = ['force']
1270
def run(self, other_spec, base_spec=None, force=False):
1271
from bzrlib.merge import merge
1272
merge(parse_spec(other_spec), parse_spec(base_spec),
1273
check_clean=(not force))
1277
class cmd_revert(Command):
1278
"""Restore selected files from a previous revision.
1280
takes_args = ['file+']
1281
def run(self, file_list):
1282
from bzrlib.branch import find_branch
1287
b = find_branch(file_list[0])
1289
b.revert([b.relpath(f) for f in file_list])
1292
class cmd_merge_revert(Command):
1293
"""Reverse all changes since the last commit.
1295
Only versioned files are affected.
1297
TODO: Store backups of any files that will be reverted, so
1298
that the revert can be undone.
1300
takes_options = ['revision']
1302
def run(self, revision=-1):
1303
from bzrlib.merge import merge
1304
merge(('.', revision), parse_spec('.'),
1309
class cmd_assert_fail(Command):
1310
"""Test reporting of assertion failures"""
1313
assert False, "always fails"
1316
class cmd_help(Command):
1317
"""Show help on a command or other topic.
1319
For a list of all available commands, say 'bzr help commands'."""
1320
takes_args = ['topic?']
1323
def run(self, topic=None):
1328
class cmd_update_stat_cache(Command):
1329
"""Update stat-cache mapping inodes to SHA-1 hashes.
1331
For testing only."""
1334
from bzrlib.statcache import update_cache
1335
b = find_branch('.')
1336
update_cache(b.base, b.read_working_inventory())
1340
class cmd_plugins(Command):
1344
import bzrlib.plugin
1345
from pprint import pprint
1346
pprint(bzrlib.plugin.all_plugins)
1350
# list of all available options; the rhs can be either None for an
1351
# option that takes no argument, or a constructor function that checks
1355
'diff-options': str,
1364
'revision': _parse_revision_str,
1385
def parse_args(argv):
290
1386
"""Parse command line.
292
1388
Arguments and options are parsed at this level before being passed
293
1389
down to specific command handlers. This routine knows, from a
294
1390
lookup table, something about the available options, what optargs
295
1391
they take, and which commands will accept them.
1393
>>> parse_args('--help'.split())
1394
([], {'help': True})
1395
>>> parse_args('--version'.split())
1396
([], {'version': True})
1397
>>> parse_args('status --all'.split())
1398
(['status'], {'all': True})
1399
>>> parse_args('commit --message=biter'.split())
1400
(['commit'], {'message': u'biter'})
1401
>>> parse_args('log -r 500'.split())
1402
(['log'], {'revision': 500})
1403
>>> parse_args('log -r500:600'.split())
1404
(['log'], {'revision': [500, 600]})
1405
>>> parse_args('log -vr500:600'.split())
1406
(['log'], {'verbose': True, 'revision': [500, 600]})
1407
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1408
Traceback (most recent call last):
1410
ValueError: invalid literal for int(): v500
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
1415
# TODO: Maybe handle '--' to end options?
309
# We've received a standalone -- No more flags
313
1420
# option names must not be unicode
317
mutter(" got option %r", a)
1424
mutter(" got option %r" % a)
319
1426
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
1429
if optname not in OPTIONS:
1430
raise BzrError('unknown long option %r' % a)
326
1432
shortopt = a[1:]
327
if shortopt in Option.SHORT_OPTIONS:
1433
if shortopt in SHORT_OPTIONS:
328
1434
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
1436
optname = SHORT_OPTIONS[shortopt]
333
1438
# Single character short options, can be chained,
334
1439
# and have their value appended to their name
335
1440
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
1441
if shortopt not in SHORT_OPTIONS:
337
1442
# We didn't find the multi-character name, and we
338
1443
# didn't find the single char name
339
1444
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
1445
optname = SHORT_OPTIONS[shortopt]
343
1448
# There are extra things on this option
344
1449
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
1451
optargfn = OPTIONS[optname]
347
1452
if optargfn is None:
348
1453
# This option does not take an argument, so the
349
1454
# next entry is another short option, pack it back
427
def apply_profiled(the_callable, *args, **kwargs):
431
pffileno, pfname = tempfile.mkstemp()
433
prof = hotshot.Profile(pfname)
435
ret = prof.runcall(the_callable, *args, **kwargs) or 0
438
stats = hotshot.stats.load(pfname)
440
stats.sort_stats('cum') # 'time'
441
## XXX: Might like to write to stderr or the trace file instead but
442
## print_stats seems hardcoded to stdout
443
stats.print_stats(20)
450
def apply_lsprofiled(the_callable, *args, **kwargs):
451
from bzrlib.lsprof import profile
452
ret,stats = profile(the_callable,*args,**kwargs)
1530
def _parse_master_args(argv):
1531
"""Parse the arguments that always go with the original command.
1532
These are things like bzr --no-plugins, etc.
1534
There are now 2 types of option flags. Ones that come *before* the command,
1535
and ones that come *after* the command.
1536
Ones coming *before* the command are applied against all possible commands.
1537
And are generally applied before plugins are loaded.
1539
The current list are:
1540
--builtin Allow plugins to load, but don't let them override builtin commands,
1541
they will still be allowed if they do not override a builtin.
1542
--no-plugins Don't load any plugins. This lets you get back to official source
1544
--profile Enable the hotspot profile before running the command.
1545
For backwards compatibility, this is also a non-master option.
1546
--version Spit out the version of bzr that is running and exit.
1547
This is also a non-master option.
1548
--help Run help and exit, also a non-master option (I think that should stay, though)
1550
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1551
Traceback (most recent call last):
1553
BzrCommandError: Invalid master option: 'test'
1554
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1557
>>> print opts['version']
1559
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1561
['command', '--more-options']
1562
>>> print opts['profile']
1564
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1567
>>> print opts['no-plugins']
1569
>>> print opts['profile']
1571
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1573
['command', '--profile']
1574
>>> print opts['profile']
1577
master_opts = {'builtin':False,
1584
# This is the point where we could hook into argv[0] to determine
1585
# what front-end is supposed to be run
1586
# For now, we are just ignoring it.
1587
cmd_name = argv.pop(0)
1589
if arg[:2] != '--': # at the first non-option, we return the rest
1591
arg = arg[2:] # Remove '--'
1592
if arg not in master_opts:
1593
# We could say that this is not an error, that we should
1594
# just let it be handled by the main section instead
1595
raise BzrCommandError('Invalid master option: %r' % arg)
1596
argv.pop(0) # We are consuming this entry
1597
master_opts[arg] = True
1598
return argv, master_opts
457
1602
def run_bzr(argv):
458
1603
"""Execute a command.
460
1605
This is similar to main(), but without all the trappings for
461
1606
logging and error handling.
464
The command-line arguments, without the program name from argv[0]
466
Returns a command status or raises an exception.
468
Special master options: these must come before the command because
469
they control how the command is interpreted.
472
Do not load plugin modules at all
475
Only use builtin commands. (Plugins are still allowed to change
479
Run under the Python hotshot profiler.
482
Run under the Python lsprof profiler.
484
1608
argv = [a.decode(bzrlib.user_encoding) for a in argv]
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
488
# --no-plugins is handled specially at a very early stage. We need
489
# to load plugins before doing other command parsing so that they
490
# can override commands, but this needs to happen first.
495
elif a == '--lsprof':
497
elif a == '--no-plugins':
498
opt_no_plugins = True
499
elif a == '--builtin':
501
elif a in ('--quiet', '-q'):
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
515
if argv[0] == '--version':
516
from bzrlib.builtins import show_version
520
if not opt_no_plugins:
521
from bzrlib.plugin import load_plugins
524
cmd = str(argv.pop(0))
526
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
532
ret = apply_profiled(cmd_obj.run_argv, argv)
534
ret = cmd_obj.run_argv(argv)
537
# reset, in case we may do other commands later within the same process
540
def display_command(func):
541
"""Decorator that suppresses pipe/interrupt errors."""
542
def ignore_pipe(*args, **kwargs):
1611
# some options like --builtin and --no-plugins have special effects
1612
argv, master_opts = _parse_master_args(argv)
1613
if not master_opts['no-plugins']:
1614
from bzrlib.plugin import load_plugins
1617
args, opts = parse_args(argv)
1619
if master_opts['help']:
1620
from bzrlib.help import help
1628
from bzrlib.help import help
1634
elif 'version' in opts:
1637
elif args and args[0] == 'builtin':
1638
include_plugins=False
1640
cmd = str(args.pop(0))
1647
plugins_override = not (master_opts['builtin'])
1648
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1650
profile = master_opts['profile']
1651
# For backwards compatibility, I would rather stick with --profile being a
1652
# master/global option
1653
if 'profile' in opts:
1657
# check options are reasonable
1658
allowed = cmd_class.takes_options
1660
if oname not in allowed:
1661
raise BzrCommandError("option '--%s' is not allowed for command %r"
1664
# mix arguments and options into one dictionary
1665
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1667
for k, v in opts.items():
1668
cmdopts[k.replace('-', '_')] = v
1671
import hotshot, tempfile
1672
pffileno, pfname = tempfile.mkstemp()
544
result = func(*args, **kwargs)
548
if not hasattr(e, 'errno'):
550
if e.errno != errno.EPIPE:
553
except KeyboardInterrupt:
1674
prof = hotshot.Profile(pfname)
1675
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1678
import hotshot.stats
1679
stats = hotshot.stats.load(pfname)
1681
stats.sort_stats('time')
1682
## XXX: Might like to write to stderr or the trace file instead but
1683
## print_stats seems hardcoded to stdout
1684
stats.print_stats(20)
1692
return cmd_class(cmdopts, cmdargs).status
1695
def _report_exception(summary, quiet=False):
1697
log_error('bzr: ' + summary)
1698
bzrlib.trace.log_exception()
1701
tb = sys.exc_info()[2]
1702
exinfo = traceback.extract_tb(tb)
1704
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1705
sys.stderr.write(' see ~/.bzr.log for debug information\n')
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
563
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
569
def run_bzr_catch_errors(argv):
1711
bzrlib.trace.open_tracefile(argv)
574
# do this here inside the exception wrappers to catch EPIPE
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
590
pdb.post_mortem(sys.exc_traceback)
1716
return run_bzr(argv)
1718
# do this here inside the exception wrappers to catch EPIPE
1721
quiet = isinstance(e, (BzrCommandError))
1722
_report_exception('error: ' + e.args[0], quiet=quiet)
1725
# some explanation or hints
1728
except AssertionError, e:
1729
msg = 'assertion failed'
1731
msg += ': ' + str(e)
1732
_report_exception(msg)
1734
except KeyboardInterrupt, e:
1735
_report_exception('interrupted', quiet=True)
1737
except Exception, e:
1740
if (isinstance(e, IOError)
1741
and hasattr(e, 'errno')
1742
and e.errno == errno.EPIPE):
1746
msg = str(e).rstrip('\n')
1747
_report_exception(msg, quiet)
1750
bzrlib.trace.close_trace()
593
1753
if __name__ == '__main__':
594
1754
sys.exit(main(sys.argv))