1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Bazaar-NG -- a free distributed version-control tool
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
24
* Metadata format is not stable yet -- you may need to
25
discard history in the future.
27
* Many commands unimplemented or partially implemented.
29
* Space-inefficient storage.
31
* No merge operators yet.
38
Show software version/licence/non-warranty.
40
Start versioning the current directory
44
Show revision history.
46
Show changes from last revision to working copy.
47
bzr commit -m 'MESSAGE'
48
Store current state as new revision.
49
bzr export REVNO DESTINATION
50
Export the branch state at a previous version.
52
Show summary of pending changes.
54
Make a file not versioned.
56
Show statistics about this branch.
58
Verify history is stored safely.
59
(for more type 'bzr help commands')
65
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
67
from pprint import pprint
70
from inspect import getdoc
73
from bzrlib.store import ImmutableStore
74
from bzrlib.trace import mutter, note, log_error
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
## standard representation
86
NONE_STRING = '(none)'
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
112
## TODO: move command; check destination is a directory and will not
115
## TODO: command to show renames, one per line, as to->from
129
def get_cmd_handler(cmd):
132
cmd = cmd_aliases.get(cmd, cmd)
135
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
137
raise BzrError("unknown command %r" % cmd)
139
return cmd, cmd_handler
143
def cmd_status(all=False):
144
"""Display status summary.
146
For each file there is a single line giving its file state and name.
147
The name is that in the current revision unless it is deleted or
148
missing, in which case the old name is shown.
150
#import bzrlib.status
151
#bzrlib.status.tree_status(Branch('.'))
152
Branch('.').show_status(show_all=all)
156
######################################################################
158
def cmd_get_revision(revision_id):
159
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
162
def cmd_get_file_text(text_id):
163
"""Get contents of a file by hash."""
164
sf = Branch('.').text_store[text_id]
165
pumpfile(sf, sys.stdout)
169
######################################################################
174
"""Show number of revisions on this branch"""
175
print Branch('.').revno()
179
def cmd_add(file_list, verbose=False):
180
"""Add specified files or directories.
182
In non-recursive mode, all the named items are added, regardless
183
of whether they were previously ignored. A warning is given if
184
any of the named files are already versioned.
186
In recursive mode (the default), files are treated the same way
187
but the behaviour for directories is different. Directories that
188
are already versioned do not give a warning. All directories,
189
whether already versioned or not, are searched for files or
190
subdirectories that are neither versioned or ignored, and these
191
are added. This search proceeds recursively into versioned
194
Therefore simply saying 'bzr add .' will version all files that
195
are currently unknown.
197
bzrlib.add.smart_add(file_list, verbose)
200
def cmd_relpath(filename):
201
"""Show path of file relative to root"""
202
print Branch(filename).relpath(filename)
206
def cmd_inventory(revision=None):
207
"""Show inventory of the current working copy."""
208
## TODO: Also optionally show a previous inventory
209
## TODO: Format options
212
inv = b.read_working_inventory()
214
inv = b.get_revision_inventory(b.lookup_revision(revision))
216
for path, entry in inv.iter_entries():
217
print '%-50s %s' % (entry.file_id, path)
221
# TODO: Maybe a 'mv' command that has the combined move/rename
222
# special behaviour of Unix?
224
def cmd_move(source_list, dest):
227
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
231
def cmd_rename(from_name, to_name):
232
"""Change the name of an entry.
234
usage: bzr rename FROM_NAME TO_NAME
237
bzr rename frob.c frobber.c
238
bzr rename src/frob.c lib/frob.c
240
It is an error if the destination name exists.
242
See also the 'move' command, which moves files into a different
243
directory without changing their name.
245
TODO: Some way to rename multiple files without invoking bzr for each
248
b.rename_one(b.relpath(from_name), b.relpath(to_name))
253
def cmd_renames(dir='.'):
254
"""Show list of renamed files.
256
usage: bzr renames [BRANCH]
258
TODO: Option to show renames between two historical versions.
260
TODO: Only show renames under dir, rather than in the whole branch.
263
old_inv = b.basis_tree().inventory
264
new_inv = b.read_working_inventory()
266
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
268
for old_name, new_name in renames:
269
print "%s => %s" % (old_name, new_name)
274
"""info: Show statistical information for this branch
278
info.show_info(Branch('.'))
282
def cmd_remove(file_list, verbose=False):
283
b = Branch(file_list[0])
284
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
288
def cmd_file_id(filename):
289
"""Print file_id of a particular file or directory.
291
usage: bzr file-id FILE
293
The file_id is assigned when the file is first added and remains the
294
same through all revisions where the file exists, even when it is
298
i = b.inventory.path2id(b.relpath(filename))
300
bailout("%r is not a versioned file" % filename)
305
def cmd_file_id_path(filename):
306
"""Print path of file_ids to a file or directory.
308
usage: bzr file-id-path FILE
310
This prints one line for each directory down to the target,
311
starting at the branch root."""
314
fid = inv.path2id(b.relpath(filename))
316
bailout("%r is not a versioned file" % filename)
317
for fip in inv.get_idpath(fid):
321
def cmd_revision_history():
322
for patchid in Branch('.').revision_history():
326
def cmd_directories():
327
for name, ie in Branch('.').read_working_inventory().directories():
335
for name, ie in Branch('.').working_tree().missing():
340
# TODO: Check we're not already in a working directory? At the
341
# moment you'll get an ugly error.
343
# TODO: What if we're in a subdirectory of a branch? Would like
344
# to allow that, but then the parent may need to understand that
345
# the children have disappeared, or should they be versioned in
348
# TODO: Take an argument/option for branch name.
349
Branch('.', init=True)
352
def cmd_diff(revision=None, file_list=None):
353
"""bzr diff: Show differences in working tree.
355
usage: bzr diff [-r REV] [FILE...]
358
Show changes since REV, rather than predecessor.
360
If files are listed, only the changes in those files are listed.
361
Otherwise, all changes for the tree are listed.
363
TODO: Given two revision arguments, show the difference between them.
365
TODO: Allow diff across branches.
367
TODO: Option to use external diff command; could be GNU diff, wdiff,
370
TODO: Python difflib is not exactly the same as unidiff; should
371
either fix it up or prefer to use an external diff.
373
TODO: If a directory is given, diff everything under that.
375
TODO: Selected-file diff is inefficient and doesn't show you
378
TODO: This probably handles non-Unix newlines poorly.
381
## TODO: Shouldn't be in the cmd function.
386
old_tree = b.basis_tree()
388
old_tree = b.revision_tree(b.lookup_revision(revision))
390
new_tree = b.working_tree()
392
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
396
DEVNULL = '/dev/null'
397
# Windows users, don't panic about this filename -- it is a
398
# special signal to GNU patch that the file should be created or
399
# deleted respectively.
401
# TODO: Generation of pseudo-diffs for added/deleted files could
402
# be usefully made into a much faster special case.
404
# TODO: Better to return them in sorted order I think.
407
file_list = [b.relpath(f) for f in file_list]
409
# FIXME: If given a file list, compare only those files rather
410
# than comparing everything and then throwing stuff away.
412
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
414
if file_list and (new_name not in file_list):
417
# Don't show this by default; maybe do it if an option is passed
418
# idlabel = ' {%s}' % fid
421
# FIXME: Something about the diff format makes patch unhappy
422
# with newly-added files.
424
def diffit(oldlines, newlines, **kw):
426
# FIXME: difflib is wrong if there is no trailing newline.
427
# The syntax used by patch seems to be "\ No newline at
428
# end of file" following the last diff line from that
429
# file. This is not trivial to insert into the
430
# unified_diff output and it might be better to just fix
431
# or replace that function.
433
# In the meantime we at least make sure the patch isn't
437
# Special workaround for Python2.3, where difflib fails if
438
# both sequences are empty.
439
if not oldlines and not newlines:
444
if oldlines and (oldlines[-1][-1] != '\n'):
447
if newlines and (newlines[-1][-1] != '\n'):
451
ud = difflib.unified_diff(oldlines, newlines, **kw)
452
sys.stdout.writelines(ud)
454
print "\\ No newline at end of file"
455
sys.stdout.write('\n')
457
if file_state in ['.', '?', 'I']:
459
elif file_state == 'A':
460
print '*** added %s %r' % (kind, new_name)
463
new_tree.get_file(fid).readlines(),
465
tofile=new_label + new_name + idlabel)
466
elif file_state == 'D':
467
assert isinstance(old_name, types.StringTypes)
468
print '*** deleted %s %r' % (kind, old_name)
470
diffit(old_tree.get_file(fid).readlines(), [],
471
fromfile=old_label + old_name + idlabel,
473
elif file_state in ['M', 'R']:
474
if file_state == 'M':
475
assert kind == 'file'
476
assert old_name == new_name
477
print '*** modified %s %r' % (kind, new_name)
478
elif file_state == 'R':
479
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
482
diffit(old_tree.get_file(fid).readlines(),
483
new_tree.get_file(fid).readlines(),
484
fromfile=old_label + old_name + idlabel,
485
tofile=new_label + new_name)
487
bailout("can't represent state %s {%s}" % (file_state, fid))
491
def cmd_deleted(show_ids=False):
492
"""List files deleted in the working tree.
494
TODO: Show files deleted since a previous revision, or between two revisions.
498
new = b.working_tree()
500
## TODO: Much more efficient way to do this: read in new
501
## directories with readdir, rather than stating each one. Same
502
## level of effort but possibly much less IO. (Or possibly not,
503
## if the directories are very large...)
505
for path, ie in old.inventory.iter_entries():
506
if not new.has_id(ie.file_id):
508
print '%-50s %s' % (path, ie.file_id)
514
def cmd_parse_inventory():
517
cElementTree.ElementTree().parse(file('.bzr/inventory'))
521
def cmd_load_inventory():
522
"""Load inventory for timing purposes"""
523
Branch('.').basis_tree().inventory
526
def cmd_dump_inventory():
527
Branch('.').read_working_inventory().write_xml(sys.stdout)
530
def cmd_dump_new_inventory():
531
import bzrlib.newinventory
532
inv = Branch('.').basis_tree().inventory
533
bzrlib.newinventory.write_inventory(inv, sys.stdout)
536
def cmd_load_new_inventory():
537
import bzrlib.newinventory
538
bzrlib.newinventory.read_new_inventory(sys.stdin)
541
def cmd_dump_slacker_inventory():
542
import bzrlib.newinventory
543
inv = Branch('.').basis_tree().inventory
544
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
548
def cmd_dump_text_inventory():
549
import bzrlib.textinv
550
inv = Branch('.').basis_tree().inventory
551
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
554
def cmd_load_text_inventory():
555
import bzrlib.textinv
556
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
557
print 'loaded %d entries' % len(inv)
561
def cmd_root(filename=None):
562
"""Print the branch root."""
563
print bzrlib.branch.find_branch_root(filename)
566
def cmd_log(timezone='original', verbose=False):
567
"""Show log of this branch.
569
TODO: Options for utc; to show ids; to limit range; etc.
571
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
574
def cmd_ls(revision=None, verbose=False):
575
"""List files in a tree.
577
TODO: Take a revision or remote path and list that tree instead.
581
tree = b.working_tree()
583
tree = b.revision_tree(b.lookup_revision(revision))
585
for fp, fc, kind, fid in tree.list_files():
587
if kind == 'directory':
594
print '%-8s %s%s' % (fc, fp, kindch)
601
"""List unknown files"""
602
for f in Branch('.').unknowns():
608
"""List ignored files and the patterns that matched them.
610
tree = Branch('.').working_tree()
611
for path, file_class, kind, file_id in tree.list_files():
612
if file_class != 'I':
614
## XXX: Slightly inefficient since this was already calculated
615
pat = tree.is_ignored(path)
616
print '%-50s %s' % (path, pat)
619
def cmd_lookup_revision(revno):
623
bailout("usage: lookup-revision REVNO",
624
["REVNO is a non-negative revision number for this branch"])
626
print Branch('.').lookup_revision(revno) or NONE_STRING
630
def cmd_export(revno, dest):
631
"""Export past revision to destination directory."""
633
rh = b.lookup_revision(int(revno))
634
t = b.revision_tree(rh)
637
def cmd_cat(revision, filename):
638
"""Print file to stdout."""
640
b.print_file(b.relpath(filename), int(revision))
643
######################################################################
644
# internal/test commands
648
"""Print a newly-generated UUID."""
649
print bzrlib.osutils.uuid()
653
def cmd_local_time_offset():
654
print bzrlib.osutils.local_time_offset()
658
def cmd_commit(message=None, verbose=False):
659
"""Commit changes to a new revision.
662
Description of changes in this revision; free form text.
663
It is recommended that the first line be a single-sentence
666
Show status of changed files,
668
TODO: Commit only selected files.
670
TODO: Run hooks on tree to-be-committed, and after commit.
672
TODO: Strict commit that fails if there are unknown or deleted files.
676
bailout("please specify a commit message")
677
Branch('.').commit(message, verbose=verbose)
680
def cmd_check(dir='.'):
681
"""check: Consistency check of branch history.
683
usage: bzr check [-v] [BRANCH]
686
--verbose, -v Show progress of checking.
688
This command checks various invariants about the branch storage to
689
detect data corruption or bzr bugs.
692
bzrlib.check.check(Branch(dir, find_root=False))
695
def cmd_is(pred, *rest):
696
"""Test whether PREDICATE is true."""
698
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
700
bailout("unknown predicate: %s" % quotefn(pred))
704
except BzrCheckError:
705
# by default we don't print the message so that this can
706
# be used from shell scripts without producing noise
715
TODO: Command to show only the email-address part as parsed out.
717
print bzrlib.osutils.username()
720
def cmd_gen_revision_id():
721
print bzrlib.branch._gen_revision_id(time.time())
725
"""Run internal test suite"""
726
## -v, if present, is seen by doctest; the argument is just here
727
## so our parser doesn't complain
729
## TODO: --verbose option
731
failures, tests = 0, 0
733
import doctest, bzrlib.store, bzrlib.tests
734
bzrlib.trace.verbose = False
736
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
737
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
738
mf, mt = doctest.testmod(m)
741
print '%-40s %3d tests' % (m.__name__, mt),
743
print '%3d FAILED!' % mf
747
print '%-40s %3d tests' % ('total', tests),
749
print '%3d FAILED!' % failures
756
cmd_doctest = cmd_selftest
759
######################################################################
763
def cmd_help(topic=None):
766
elif topic == 'commands':
769
# otherwise, maybe the name of a command?
770
topic, cmdfn = get_cmd_handler(topic)
774
bailout("sorry, no detailed help yet for %r" % topic)
780
"""List all commands"""
782
for k in globals().keys():
783
if k.startswith('cmd_'):
784
accu.append(k[4:].replace('_','-'))
786
print "bzr commands: "
789
print "note: some of these commands are internal-use or obsolete"
790
# TODO: Some kind of marker for internal-use commands?
791
# TODO: Show aliases?
797
print "bzr (bazaar-ng) %s" % bzrlib.__version__
798
print bzrlib.__copyright__
799
print "http://bazaar-ng.org/"
802
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
803
you may use, modify and redistribute it under the terms of the GNU
804
General Public License version 2 or later."""
808
"""Statement of optimism."""
809
print "it sure does!"
813
######################################################################
817
# list of all available options; the rhs can be either None for an
818
# option that takes no argument, or a constructor function that checks
838
# List of options that apply to particular commands; commands not
843
'commit': ['message', 'verbose'],
844
'deleted': ['show-ids'],
845
'diff': ['revision'],
846
'inventory': ['revision'],
847
'log': ['timezone', 'verbose'],
848
'ls': ['revision', 'verbose'],
849
'remove': ['verbose'],
859
'export': ['revno', 'dest'],
860
'file-id': ['filename'],
861
'file-id-path': ['filename'],
862
'get-file-text': ['text_id'],
863
'get-inventory': ['inventory_id'],
864
'get-revision': ['revision_id'],
865
'get-revision-inventory': ['revision_id'],
869
'lookup-revision': ['revno'],
870
'move': ['source$', 'dest'],
871
'relpath': ['filename'],
873
'rename': ['from_name', 'to_name'],
875
'root': ['filename?'],
880
def parse_args(argv):
881
"""Parse command line.
883
Arguments and options are parsed at this level before being passed
884
down to specific command handlers. This routine knows, from a
885
lookup table, something about the available options, what optargs
886
they take, and which commands will accept them.
888
>>> parse_args('--help'.split())
890
>>> parse_args('--version'.split())
891
([], {'version': True})
892
>>> parse_args('status --all'.split())
893
(['status'], {'all': True})
894
>>> parse_args('commit --message=biter'.split())
895
(['commit'], {'message': u'biter'})
900
# TODO: Maybe handle '--' to end options?
905
# option names must not be unicode
909
mutter(" got option %r" % a)
911
optname, optarg = a[2:].split('=', 1)
914
if optname not in OPTIONS:
915
bailout('unknown long option %r' % a)
918
if shortopt not in SHORT_OPTIONS:
919
bailout('unknown short option %r' % a)
920
optname = SHORT_OPTIONS[shortopt]
923
# XXX: Do we ever want to support this, e.g. for -r?
924
bailout('repeated option %r' % a)
926
optargfn = OPTIONS[optname]
930
bailout('option %r needs an argument' % a)
933
opts[optname] = optargfn(optarg)
936
bailout('option %r takes no argument' % optname)
945
def _match_args(cmd, args):
946
"""Check non-option arguments match required pattern.
948
>>> _match_args('status', ['asdasdsadasd'])
949
Traceback (most recent call last):
951
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
952
>>> _match_args('add', ['asdasdsadasd'])
953
{'file_list': ['asdasdsadasd']}
954
>>> _match_args('add', 'abc def gj'.split())
955
{'file_list': ['abc', 'def', 'gj']}
957
# match argument pattern
958
argform = cmd_args.get(cmd, [])
960
# TODO: Need a way to express 'cp SRC... DEST', where it matches
963
# step through args and argform, allowing appropriate 0-many matches
968
argdict[argname] = args.pop(0)
969
elif ap[-1] == '*': # all remaining arguments
971
argdict[argname + '_list'] = args[:]
974
argdict[argname + '_list'] = None
977
bailout("command %r needs one or more %s"
978
% (cmd, argname.upper()))
980
argdict[argname + '_list'] = args[:]
982
elif ap[-1] == '$': # all but one
984
bailout("command %r needs one or more %s"
985
% (cmd, argname.upper()))
986
argdict[argname + '_list'] = args[:-1]
992
bailout("command %r requires argument %s"
993
% (cmd, argname.upper()))
995
argdict[argname] = args.pop(0)
998
bailout("extra arguments to command %s: %r"
1006
"""Execute a command.
1008
This is similar to main(), but without all the trappings for
1009
logging and error handling.
1012
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1015
args, opts = parse_args(argv[1:])
1017
# TODO: pass down other arguments in case they asked for
1018
# help on a command name?
1024
elif 'version' in opts:
1027
cmd = str(args.pop(0))
1029
log_error('usage: bzr COMMAND')
1030
log_error(' try "bzr help"')
1033
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1036
if 'profile' in opts:
1042
# check options are reasonable
1043
allowed = cmd_options.get(canonical_cmd, [])
1045
if oname not in allowed:
1046
bailout("option %r is not allowed for command %r"
1049
# TODO: give an error if there are any mandatory options which are
1050
# not specified? Or maybe there shouldn't be any "mandatory
1051
# options" (it is an oxymoron)
1053
# mix arguments and options into one dictionary
1054
cmdargs = _match_args(canonical_cmd, args)
1055
for k, v in opts.items():
1056
cmdargs[k.replace('-', '_')] = v
1060
pffileno, pfname = tempfile.mkstemp()
1062
prof = hotshot.Profile(pfname)
1063
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1066
import hotshot.stats
1067
stats = hotshot.stats.load(pfname)
1069
stats.sort_stats('time')
1070
## XXX: Might like to write to stderr or the trace file instead but
1071
## print_stats seems hardcoded to stdout
1072
stats.print_stats(20)
1080
return cmd_handler(**cmdargs) or 0
1084
def _report_exception(e, summary):
1086
log_error('bzr: ' + summary)
1087
bzrlib.trace.log_exception(e)
1088
tb = sys.exc_info()[2]
1089
exinfo = traceback.extract_tb(tb)
1091
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1092
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1095
def cmd_assert_fail():
1096
assert False, "always fails"
1100
bzrlib.trace.create_tracefile(argv)
1107
_report_exception(e, 'error: ' + e.args[0])
1110
# some explanation or hints
1113
except AssertionError, e:
1114
msg = 'assertion failed'
1116
msg += ': ' + str(e)
1117
_report_exception(e, msg)
1118
except Exception, e:
1119
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1122
bzrlib.trace.close_trace()
1124
## TODO: Trap AssertionError
1126
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1130
if __name__ == '__main__':
1131
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
