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):
130
assert isinstance(cmd, str)
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: If a directory is given, diff everything under that.
372
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
375
## TODO: Shouldn't be in the cmd function.
380
old_tree = b.basis_tree()
382
old_tree = b.revision_tree(b.lookup_revision(revision))
384
new_tree = b.working_tree()
386
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
390
DEVNULL = '/dev/null'
391
# Windows users, don't panic about this filename -- it is a
392
# special signal to GNU patch that the file should be created or
393
# deleted respectively.
395
# TODO: Generation of pseudo-diffs for added/deleted files could
396
# be usefully made into a much faster special case.
398
# TODO: Better to return them in sorted order I think.
401
file_list = [b.relpath(f) for f in file_list]
403
# FIXME: If given a file list, compare only those files rather
404
# than comparing everything and then throwing stuff away.
406
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
408
if file_list and (new_name not in file_list):
411
# Don't show this by default; maybe do it if an option is passed
412
# idlabel = ' {%s}' % fid
415
# FIXME: Something about the diff format makes patch unhappy
416
# with newly-added files.
418
def diffit(oldlines, newlines, **kw):
419
# FIXME: difflib is wrong if there is no trailing newline.
421
# Special workaround for Python2.3, where difflib fails if
422
# both sequences are empty.
423
if oldlines or newlines:
424
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
427
if file_state in ['.', '?', 'I']:
429
elif file_state == 'A':
430
print '*** added %s %r' % (kind, new_name)
433
new_tree.get_file(fid).readlines(),
435
tofile=new_label + new_name + idlabel)
436
elif file_state == 'D':
437
assert isinstance(old_name, types.StringTypes)
438
print '*** deleted %s %r' % (kind, old_name)
440
diffit(old_tree.get_file(fid).readlines(), [],
441
fromfile=old_label + old_name + idlabel,
443
elif file_state in ['M', 'R']:
444
if file_state == 'M':
445
assert kind == 'file'
446
assert old_name == new_name
447
print '*** modified %s %r' % (kind, new_name)
448
elif file_state == 'R':
449
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
452
diffit(old_tree.get_file(fid).readlines(),
453
new_tree.get_file(fid).readlines(),
454
fromfile=old_label + old_name + idlabel,
455
tofile=new_label + new_name)
457
bailout("can't represent state %s {%s}" % (file_state, fid))
461
def cmd_deleted(show_ids=False):
462
"""List files deleted in the working tree.
464
TODO: Show files deleted since a previous revision, or between two revisions.
468
new = b.working_tree()
470
## TODO: Much more efficient way to do this: read in new
471
## directories with readdir, rather than stating each one. Same
472
## level of effort but possibly much less IO. (Or possibly not,
473
## if the directories are very large...)
475
for path, ie in old.inventory.iter_entries():
476
if not new.has_id(ie.file_id):
478
print '%-50s %s' % (path, ie.file_id)
484
def cmd_parse_inventory():
487
cElementTree.ElementTree().parse(file('.bzr/inventory'))
491
def cmd_load_inventory():
492
"""Load inventory for timing purposes"""
493
Branch('.').basis_tree().inventory
496
def cmd_dump_inventory():
497
Branch('.').read_working_inventory().write_xml(sys.stdout)
500
def cmd_dump_new_inventory():
501
import bzrlib.newinventory
502
inv = Branch('.').basis_tree().inventory
503
bzrlib.newinventory.write_inventory(inv, sys.stdout)
506
def cmd_load_new_inventory():
507
import bzrlib.newinventory
508
bzrlib.newinventory.read_new_inventory(sys.stdin)
511
def cmd_dump_slacker_inventory():
512
import bzrlib.newinventory
513
inv = Branch('.').basis_tree().inventory
514
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
518
def cmd_dump_text_inventory():
519
import bzrlib.textinv
520
inv = Branch('.').basis_tree().inventory
521
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
524
def cmd_load_text_inventory():
525
import bzrlib.textinv
526
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
527
print 'loaded %d entries' % len(inv)
531
def cmd_root(filename=None):
532
"""Print the branch root."""
533
print bzrlib.branch.find_branch_root(filename)
536
def cmd_log(timezone='original', verbose=False):
537
"""Show log of this branch.
539
TODO: Options for utc; to show ids; to limit range; etc.
541
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
544
def cmd_ls(revision=None, verbose=False):
545
"""List files in a tree.
547
TODO: Take a revision or remote path and list that tree instead.
551
tree = b.working_tree()
553
tree = b.revision_tree(b.lookup_revision(revision))
555
for fp, fc, kind, fid in tree.list_files():
557
if kind == 'directory':
564
print '%-8s %s%s' % (fc, fp, kindch)
571
"""List unknown files"""
572
for f in Branch('.').unknowns():
578
"""List ignored files and the patterns that matched them.
580
tree = Branch('.').working_tree()
581
for path, file_class, kind, file_id in tree.list_files():
582
if file_class != 'I':
584
## XXX: Slightly inefficient since this was already calculated
585
pat = tree.is_ignored(path)
586
print '%-50s %s' % (path, pat)
589
def cmd_lookup_revision(revno):
593
bailout("usage: lookup-revision REVNO",
594
["REVNO is a non-negative revision number for this branch"])
596
print Branch('.').lookup_revision(revno) or NONE_STRING
600
def cmd_export(revno, dest):
601
"""Export past revision to destination directory."""
603
rh = b.lookup_revision(int(revno))
604
t = b.revision_tree(rh)
607
def cmd_cat(revision, filename):
608
"""Print file to stdout."""
610
b.print_file(b.relpath(filename), int(revision))
613
######################################################################
614
# internal/test commands
618
"""Print a newly-generated UUID."""
619
print bzrlib.osutils.uuid()
623
def cmd_local_time_offset():
624
print bzrlib.osutils.local_time_offset()
628
def cmd_commit(message=None, verbose=False):
629
"""Commit changes to a new revision.
632
Description of changes in this revision; free form text.
633
It is recommended that the first line be a single-sentence
636
Show status of changed files,
638
TODO: Commit only selected files.
640
TODO: Run hooks on tree to-be-committed, and after commit.
642
TODO: Strict commit that fails if there are unknown or deleted files.
646
bailout("please specify a commit message")
647
Branch('.').commit(message, verbose=verbose)
650
def cmd_check(dir='.'):
651
"""check: Consistency check of branch history.
653
usage: bzr check [-v] [BRANCH]
656
--verbose, -v Show progress of checking.
658
This command checks various invariants about the branch storage to
659
detect data corruption or bzr bugs.
662
bzrlib.check.check(Branch(dir, find_root=False))
665
def cmd_is(pred, *rest):
666
"""Test whether PREDICATE is true."""
668
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
670
bailout("unknown predicate: %s" % quotefn(pred))
674
except BzrCheckError:
675
# by default we don't print the message so that this can
676
# be used from shell scripts without producing noise
685
TODO: Command to show only the email-address part as parsed out.
687
print bzrlib.osutils.username()
690
def cmd_gen_revision_id():
691
print bzrlib.branch._gen_revision_id(time.time())
695
"""Run internal test suite"""
696
## -v, if present, is seen by doctest; the argument is just here
697
## so our parser doesn't complain
699
## TODO: --verbose option
701
failures, tests = 0, 0
703
import doctest, bzrlib.store, bzrlib.tests
704
bzrlib.trace.verbose = False
706
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
707
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
708
mf, mt = doctest.testmod(m)
711
print '%-40s %3d tests' % (m.__name__, mt),
713
print '%3d FAILED!' % mf
717
print '%-40s %3d tests' % ('total', tests),
719
print '%3d FAILED!' % failures
726
cmd_doctest = cmd_selftest
729
######################################################################
733
def cmd_help(topic=None):
736
elif topic == 'commands':
739
# otherwise, maybe the name of a command?
740
topic, cmdfn = get_cmd_handler(topic)
744
bailout("sorry, no detailed help yet for %r" % topic)
750
"""List all commands"""
752
for k in globals().keys():
753
if k.startswith('cmd_'):
754
accu.append(k[4:].replace('_','-'))
756
print "bzr commands: "
759
print "note: some of these commands are internal-use or obsolete"
760
# TODO: Some kind of marker for internal-use commands?
761
# TODO: Show aliases?
767
print "bzr (bazaar-ng) %s" % bzrlib.__version__
768
print bzrlib.__copyright__
769
print "http://bazaar-ng.org/"
772
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
773
you may use, modify and redistribute it under the terms of the GNU
774
General Public License version 2 or later."""
778
"""Statement of optimism."""
779
print "it sure does!"
783
######################################################################
787
# list of all available options; the rhs can be either None for an
788
# option that takes no argument, or a constructor function that checks
808
# List of options that apply to particular commands; commands not
813
'commit': ['message', 'verbose'],
814
'deleted': ['show-ids'],
815
'diff': ['revision'],
816
'inventory': ['revision'],
817
'log': ['timezone', 'verbose'],
818
'ls': ['revision', 'verbose'],
819
'remove': ['verbose'],
829
'export': ['revno', 'dest'],
830
'file-id': ['filename'],
831
'file-id-path': ['filename'],
832
'get-file-text': ['text_id'],
833
'get-inventory': ['inventory_id'],
834
'get-revision': ['revision_id'],
835
'get-revision-inventory': ['revision_id'],
839
'lookup-revision': ['revno'],
840
'move': ['source$', 'dest'],
841
'relpath': ['filename'],
843
'rename': ['from_name', 'to_name'],
845
'root': ['filename?'],
850
def parse_args(argv):
851
"""Parse command line.
853
Arguments and options are parsed at this level before being passed
854
down to specific command handlers. This routine knows, from a
855
lookup table, something about the available options, what optargs
856
they take, and which commands will accept them.
858
>>> parse_args('--help'.split())
860
>>> parse_args('--version'.split())
861
([], {'version': True})
862
>>> parse_args('status --all'.split())
863
(['status'], {'all': True})
864
>>> parse_args('commit --message=biter'.split())
865
(['commit'], {'message': u'biter'})
870
# TODO: Maybe handle '--' to end options?
875
# option names must not be unicode
879
mutter(" got option %r" % a)
881
optname, optarg = a[2:].split('=', 1)
884
if optname not in OPTIONS:
885
bailout('unknown long option %r' % a)
888
if shortopt not in SHORT_OPTIONS:
889
bailout('unknown short option %r' % a)
890
optname = SHORT_OPTIONS[shortopt]
893
# XXX: Do we ever want to support this, e.g. for -r?
894
bailout('repeated option %r' % a)
896
optargfn = OPTIONS[optname]
900
bailout('option %r needs an argument' % a)
903
opts[optname] = optargfn(optarg)
906
bailout('option %r takes no argument' % optname)
915
def _match_args(cmd, args):
916
"""Check non-option arguments match required pattern.
918
>>> _match_args('status', ['asdasdsadasd'])
919
Traceback (most recent call last):
921
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
922
>>> _match_args('add', ['asdasdsadasd'])
923
{'file_list': ['asdasdsadasd']}
924
>>> _match_args('add', 'abc def gj'.split())
925
{'file_list': ['abc', 'def', 'gj']}
927
# match argument pattern
928
argform = cmd_args.get(cmd, [])
930
# TODO: Need a way to express 'cp SRC... DEST', where it matches
933
# step through args and argform, allowing appropriate 0-many matches
938
argdict[argname] = args.pop(0)
939
elif ap[-1] == '*': # all remaining arguments
941
argdict[argname + '_list'] = args[:]
944
argdict[argname + '_list'] = None
947
bailout("command %r needs one or more %s"
948
% (cmd, argname.upper()))
950
argdict[argname + '_list'] = args[:]
952
elif ap[-1] == '$': # all but one
954
bailout("command %r needs one or more %s"
955
% (cmd, argname.upper()))
956
argdict[argname + '_list'] = args[:-1]
962
bailout("command %r requires argument %s"
963
% (cmd, argname.upper()))
965
argdict[argname] = args.pop(0)
968
bailout("extra arguments to command %s: %r"
976
"""Execute a command.
978
This is similar to main(), but without all the trappings for
979
logging and error handling.
982
argv = [a.decode(bzrlib.user_encoding) for a in argv]
985
args, opts = parse_args(argv[1:])
987
# TODO: pass down other arguments in case they asked for
988
# help on a command name?
994
elif 'version' in opts:
997
cmd = str(args.pop(0))
999
log_error('usage: bzr COMMAND')
1000
log_error(' try "bzr help"')
1003
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1006
if 'profile' in opts:
1012
# check options are reasonable
1013
allowed = cmd_options.get(canonical_cmd, [])
1015
if oname not in allowed:
1016
bailout("option %r is not allowed for command %r"
1019
# TODO: give an error if there are any mandatory options which are
1020
# not specified? Or maybe there shouldn't be any "mandatory
1021
# options" (it is an oxymoron)
1023
# mix arguments and options into one dictionary
1024
cmdargs = _match_args(canonical_cmd, args)
1025
for k, v in opts.items():
1026
cmdargs[k.replace('-', '_')] = v
1030
pffileno, pfname = tempfile.mkstemp()
1032
prof = hotshot.Profile(pfname)
1033
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1036
import hotshot.stats
1037
stats = hotshot.stats.load(pfname)
1039
stats.sort_stats('time')
1040
## XXX: Might like to write to stderr or the trace file instead but
1041
## print_stats seems hardcoded to stdout
1042
stats.print_stats(20)
1050
return cmd_handler(**cmdargs) or 0
1054
def _report_exception(e, summary):
1056
log_error('bzr: ' + summary)
1057
bzrlib.trace.log_exception(e)
1058
tb = sys.exc_info()[2]
1059
exinfo = traceback.extract_tb(tb, 1)
1061
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[0][:3])
1062
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1065
def cmd_assert_fail():
1066
assert False, "always fails"
1070
bzrlib.trace.create_tracefile(argv)
1077
_report_exception(e, 'error: ' + e.args[0])
1080
# some explanation or hints
1083
except AssertionError, e:
1084
msg = 'assertion failed'
1086
msg += ': ' + str(e)
1087
_report_exception(e, msg)
1088
except Exception, e:
1089
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1092
bzrlib.trace.close_trace()
1094
## TODO: Trap AssertionError
1096
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1100
if __name__ == '__main__':
1101
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
