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
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, time, types, shutil, tempfile, traceback, 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
120
def cmd_status(all=False):
121
"""Display status summary.
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
127
:todo: Don't show unchanged files unless ``--all`` is given?
129
#import bzrlib.status
130
#bzrlib.status.tree_status(Branch('.'))
131
Branch('.').show_status(show_all=all)
135
######################################################################
137
def cmd_get_revision(revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
141
def cmd_get_file_text(text_id):
142
"""Get contents of a file by hash."""
143
sf = Branch('.').text_store[text_id]
144
pumpfile(sf, sys.stdout)
148
######################################################################
153
"""Show number of revisions on this branch"""
154
print Branch('.').revno()
158
def cmd_add(file_list, verbose=False):
159
"""Add specified files or directories.
161
In non-recursive mode, all the named items are added, regardless
162
of whether they were previously ignored. A warning is given if
163
any of the named files are already versioned.
165
In recursive mode (the default), files are treated the same way
166
but the behaviour for directories is different. Directories that
167
are already versioned do not give a warning. All directories,
168
whether already versioned or not, are searched for files or
169
subdirectories that are neither versioned or ignored, and these
170
are added. This search proceeds recursively into versioned
173
Therefore simply saying 'bzr add .' will version all files that
174
are currently unknown.
176
bzrlib.add.smart_add(file_list, verbose)
179
def cmd_relpath(filename):
180
"""Show path of file relative to root"""
181
print Branch(filename).relpath(filename)
185
def cmd_inventory(revision=None):
186
"""Show inventory of the current working copy."""
187
## TODO: Also optionally show a previous inventory
188
## TODO: Format options
191
inv = b.read_working_inventory()
193
inv = b.get_revision_inventory(b.lookup_revision(revision))
195
for path, entry in inv.iter_entries():
196
print '%-50s %s' % (entry.file_id, path)
200
# TODO: Maybe a 'mv' command that has the combined move/rename
201
# special behaviour of Unix?
203
def cmd_move(source_list, dest):
206
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
210
def cmd_rename(from_name, to_name):
211
"""Change the name of an entry.
213
usage: bzr rename FROM_NAME TO_NAME
216
bzr rename frob.c frobber.c
217
bzr rename src/frob.c lib/frob.c
219
It is an error if the destination name exists.
221
See also the 'move' command, which moves files into a different
222
directory without changing their name.
224
TODO: Some way to rename multiple files without invoking bzr for each
227
b.rename_one(b.relpath(from_name), b.relpath(to_name))
232
def cmd_renames(dir='.'):
233
"""Show list of renamed files.
235
usage: bzr renames [BRANCH]
237
TODO: Option to show renames between two historical versions.
239
TODO: Only show renames under dir, rather than in the whole branch.
242
old_inv = b.basis_tree().inventory
243
new_inv = b.read_working_inventory()
245
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
247
for old_name, new_name in renames:
248
print "%s => %s" % (old_name, new_name)
253
"""info: Show statistical information for this branch
257
info.show_info(Branch('.'))
261
def cmd_remove(file_list, verbose=False):
262
b = Branch(file_list[0])
263
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
267
def cmd_file_id(filename):
268
"""Print file_id of a particular file or directory.
270
usage: bzr file-id FILE
272
The file_id is assigned when the file is first added and remains the
273
same through all revisions where the file exists, even when it is
277
i = b.inventory.path2id(b.relpath(filename))
279
bailout("%r is not a versioned file" % filename)
284
def cmd_file_id_path(filename):
285
"""Print path of file_ids to a file or directory.
287
usage: bzr file-id-path FILE
289
This prints one line for each directory down to the target,
290
starting at the branch root."""
293
fid = inv.path2id(b.relpath(filename))
295
bailout("%r is not a versioned file" % filename)
296
for fip in inv.get_idpath(fid):
300
def cmd_revision_history():
301
for patchid in Branch('.').revision_history():
305
def cmd_directories():
306
for name, ie in Branch('.').read_working_inventory().directories():
314
for name, ie in Branch('.').working_tree().missing():
319
# TODO: Check we're not already in a working directory? At the
320
# moment you'll get an ugly error.
322
# TODO: What if we're in a subdirectory of a branch? Would like
323
# to allow that, but then the parent may need to understand that
324
# the children have disappeared, or should they be versioned in
327
# TODO: Take an argument/option for branch name.
328
Branch('.', init=True)
331
def cmd_diff(revision=None, file_list=None):
332
"""bzr diff: Show differences in working tree.
334
usage: bzr diff [-r REV] [FILE...]
337
Show changes since REV, rather than predecessor.
339
If files are listed, only the changes in those files are listed.
340
Otherwise, all changes for the tree are listed.
342
TODO: Given two revision arguments, show the difference between them.
344
TODO: Allow diff across branches.
346
TODO: Option to use external diff command; could be GNU diff, wdiff,
349
TODO: If a directory is given, diff everything under that.
351
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
354
## TODO: Shouldn't be in the cmd function.
359
old_tree = b.basis_tree()
361
old_tree = b.revision_tree(b.lookup_revision(revision))
363
new_tree = b.working_tree()
365
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
369
DEVNULL = '/dev/null'
370
# Windows users, don't panic about this filename -- it is a
371
# special signal to GNU patch that the file should be created or
372
# deleted respectively.
374
# TODO: Generation of pseudo-diffs for added/deleted files could
375
# be usefully made into a much faster special case.
377
# TODO: Better to return them in sorted order I think.
379
# FIXME: If given a file list, compare only those files rather
380
# than comparing everything and then throwing stuff away.
382
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
384
if file_list and new_name not in file_list:
387
# Don't show this by default; maybe do it if an option is passed
388
# idlabel = ' {%s}' % fid
391
# FIXME: Something about the diff format makes patch unhappy
392
# with newly-added files.
394
def diffit(oldlines, newlines, **kw):
395
# FIXME: difflib is wrong if there is no trailing newline.
397
# Special workaround for Python2.3, where difflib fails if
398
# both sequences are empty.
399
if oldlines or newlines:
400
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
403
if file_state in ['.', '?', 'I']:
405
elif file_state == 'A':
406
print '*** added %s %r' % (kind, new_name)
409
new_tree.get_file(fid).readlines(),
411
tofile=new_label + new_name + idlabel)
412
elif file_state == 'D':
413
assert isinstance(old_name, types.StringTypes)
414
print '*** deleted %s %r' % (kind, old_name)
416
diffit(old_tree.get_file(fid).readlines(), [],
417
fromfile=old_label + old_name + idlabel,
419
elif file_state in ['M', 'R']:
420
if file_state == 'M':
421
assert kind == 'file'
422
assert old_name == new_name
423
print '*** modified %s %r' % (kind, new_name)
424
elif file_state == 'R':
425
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
428
diffit(old_tree.get_file(fid).readlines(),
429
new_tree.get_file(fid).readlines(),
430
fromfile=old_label + old_name + idlabel,
431
tofile=new_label + new_name)
433
bailout("can't represent state %s {%s}" % (file_state, fid))
437
def cmd_deleted(show_ids=False):
438
"""List files deleted in the working tree.
440
TODO: Show files deleted since a previous revision, or between two revisions.
444
new = b.working_tree()
446
## TODO: Much more efficient way to do this: read in new
447
## directories with readdir, rather than stating each one. Same
448
## level of effort but possibly much less IO. (Or possibly not,
449
## if the directories are very large...)
451
for path, ie in old.inventory.iter_entries():
452
if not new.has_id(ie.file_id):
454
print '%-50s %s' % (path, ie.file_id)
460
def cmd_parse_inventory():
463
cElementTree.ElementTree().parse(file('.bzr/inventory'))
467
def cmd_load_inventory():
468
"""Load inventory for timing purposes"""
469
Branch('.').basis_tree().inventory
472
def cmd_dump_inventory():
473
Branch('.').read_working_inventory().write_xml(sys.stdout)
476
def cmd_dump_new_inventory():
477
import bzrlib.newinventory
478
inv = Branch('.').basis_tree().inventory
479
bzrlib.newinventory.write_inventory(inv, sys.stdout)
482
def cmd_load_new_inventory():
483
import bzrlib.newinventory
484
bzrlib.newinventory.read_new_inventory(sys.stdin)
487
def cmd_dump_slacker_inventory():
488
import bzrlib.newinventory
489
inv = Branch('.').basis_tree().inventory
490
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
494
def cmd_dump_text_inventory():
495
import bzrlib.textinv
496
inv = Branch('.').basis_tree().inventory
497
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
500
def cmd_load_text_inventory():
501
import bzrlib.textinv
502
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
503
print 'loaded %d entries' % len(inv)
507
def cmd_root(filename=None):
508
"""Print the branch root."""
509
print bzrlib.branch.find_branch_root(filename)
512
def cmd_log(timezone='original'):
513
"""Show log of this branch.
515
:todo: Options for utc; to show ids; to limit range; etc.
517
Branch('.').write_log(show_timezone=timezone)
520
def cmd_ls(revision=None, verbose=False):
521
"""List files in a tree.
523
:todo: Take a revision or remote path and list that tree instead.
527
tree = b.working_tree()
529
tree = b.revision_tree(b.lookup_revision(revision))
531
for fp, fc, kind, fid in tree.list_files():
533
if kind == 'directory':
540
print '%-8s %s%s' % (fc, fp, kindch)
547
"""List unknown files"""
548
for f in Branch('.').unknowns():
554
"""List ignored files and the patterns that matched them.
556
tree = Branch('.').working_tree()
557
for path, file_class, kind, file_id in tree.list_files():
558
if file_class != 'I':
560
## XXX: Slightly inefficient since this was already calculated
561
pat = tree.is_ignored(path)
562
print '%-50s %s' % (path, pat)
565
def cmd_lookup_revision(revno):
569
bailout("usage: lookup-revision REVNO",
570
["REVNO is a non-negative revision number for this branch"])
572
print Branch('.').lookup_revision(revno) or NONE_STRING
576
def cmd_export(revno, dest):
577
"""Export past revision to destination directory."""
579
rh = b.lookup_revision(int(revno))
580
t = b.revision_tree(rh)
583
def cmd_cat(revision, filename):
584
"""Print file to stdout."""
586
b.print_file(b.relpath(filename), int(revision))
589
######################################################################
590
# internal/test commands
594
"""Print a newly-generated UUID."""
595
print bzrlib.osutils.uuid()
599
def cmd_local_time_offset():
600
print bzrlib.osutils.local_time_offset()
604
def cmd_commit(message=None, verbose=False):
605
"""Commit changes to a new revision.
608
Description of changes in this revision; free form text.
609
It is recommended that the first line be a single-sentence
612
Show status of changed files,
614
TODO: Commit only selected files.
616
TODO: Run hooks on tree to-be-committed, and after commit.
618
TODO: Strict commit that fails if there are unknown or deleted files.
622
bailout("please specify a commit message")
623
Branch('.').commit(message, verbose=verbose)
626
def cmd_check(dir='.'):
627
"""check: Consistency check of branch history.
629
usage: bzr check [-v] [BRANCH]
632
--verbose, -v Show progress of checking.
634
This command checks various invariants about the branch storage to
635
detect data corruption or bzr bugs.
638
bzrlib.check.check(Branch(dir, find_root=False))
641
def cmd_is(pred, *rest):
642
"""Test whether PREDICATE is true."""
644
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
646
bailout("unknown predicate: %s" % quotefn(pred))
650
except BzrCheckError:
651
# by default we don't print the message so that this can
652
# be used from shell scripts without producing noise
657
print bzrlib.osutils.username()
660
def cmd_user_email():
661
print bzrlib.osutils.user_email()
664
def cmd_gen_revision_id():
665
print bzrlib.branch._gen_revision_id(time.time())
669
"""Run internal test suite"""
670
## -v, if present, is seen by doctest; the argument is just here
671
## so our parser doesn't complain
673
## TODO: --verbose option
675
failures, tests = 0, 0
677
import doctest, bzrlib.store, bzrlib.tests
678
bzrlib.trace.verbose = False
680
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
681
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
682
mf, mt = doctest.testmod(m)
685
print '%-40s %3d tests' % (m.__name__, mt),
687
print '%3d FAILED!' % mf
691
print '%-40s %3d tests' % ('total', tests),
693
print '%3d FAILED!' % failures
700
cmd_doctest = cmd_selftest
703
######################################################################
707
def cmd_help(topic=None):
712
# otherwise, maybe the name of a command?
714
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
716
bailout("no help for %r" % topic)
720
bailout("sorry, no detailed help yet for %r" % topic)
728
print "bzr (bazaar-ng) %s" % bzrlib.__version__
729
print bzrlib.__copyright__
730
print "http://bazaar-ng.org/"
733
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
734
you may use, modify and redistribute it under the terms of the GNU
735
General Public License version 2 or later."""
739
"""Statement of optimism."""
740
print "it sure does!"
744
######################################################################
748
# list of all available options; the rhs can be either None for an
749
# option that takes no argument, or a constructor function that checks
769
# List of options that apply to particular commands; commands not
774
'commit': ['message', 'verbose'],
775
'deleted': ['show-ids'],
776
'diff': ['revision'],
777
'inventory': ['revision'],
779
'ls': ['revision', 'verbose'],
780
'remove': ['verbose'],
790
'export': ['revno', 'dest'],
791
'file-id': ['filename'],
792
'file-id-path': ['filename'],
793
'get-file-text': ['text_id'],
794
'get-inventory': ['inventory_id'],
795
'get-revision': ['revision_id'],
796
'get-revision-inventory': ['revision_id'],
800
'lookup-revision': ['revno'],
801
'move': ['source$', 'dest'],
802
'relpath': ['filename'],
804
'rename': ['from_name', 'to_name'],
806
'root': ['filename?'],
811
def parse_args(argv):
812
"""Parse command line.
814
Arguments and options are parsed at this level before being passed
815
down to specific command handlers. This routine knows, from a
816
lookup table, something about the available options, what optargs
817
they take, and which commands will accept them.
819
>>> parse_args('--help'.split())
821
>>> parse_args('--version'.split())
822
([], {'version': True})
823
>>> parse_args('status --all'.split())
824
(['status'], {'all': True})
825
>>> parse_args('commit --message=biter'.split())
826
(['commit'], {'message': u'biter'})
831
# TODO: Maybe handle '--' to end options?
838
mutter(" got option %r" % a)
840
optname, optarg = a[2:].split('=', 1)
843
if optname not in OPTIONS:
844
bailout('unknown long option %r' % a)
847
if shortopt not in SHORT_OPTIONS:
848
bailout('unknown short option %r' % a)
849
optname = SHORT_OPTIONS[shortopt]
852
# XXX: Do we ever want to support this, e.g. for -r?
853
bailout('repeated option %r' % a)
855
optargfn = OPTIONS[optname]
859
bailout('option %r needs an argument' % a)
862
opts[optname] = optargfn(optarg)
865
bailout('option %r takes no argument' % optname)
874
def _match_args(cmd, args):
875
"""Check non-option arguments match required pattern.
877
>>> _match_args('status', ['asdasdsadasd'])
878
Traceback (most recent call last):
880
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
881
>>> _match_args('add', ['asdasdsadasd'])
882
{'file_list': ['asdasdsadasd']}
883
>>> _match_args('add', 'abc def gj'.split())
884
{'file_list': ['abc', 'def', 'gj']}
886
# match argument pattern
887
argform = cmd_args.get(cmd, [])
889
# TODO: Need a way to express 'cp SRC... DEST', where it matches
892
# step through args and argform, allowing appropriate 0-many matches
897
argdict[argname] = args.pop(0)
898
elif ap[-1] == '*': # all remaining arguments
900
argdict[argname + '_list'] = args[:]
903
argdict[argname + '_list'] = None
906
bailout("command %r needs one or more %s"
907
% (cmd, argname.upper()))
909
argdict[argname + '_list'] = args[:]
911
elif ap[-1] == '$': # all but one
913
bailout("command %r needs one or more %s"
914
% (cmd, argname.upper()))
915
argdict[argname + '_list'] = args[:-1]
921
bailout("command %r requires argument %s"
922
% (cmd, argname.upper()))
924
argdict[argname] = args.pop(0)
927
bailout("extra arguments to command %s: %r"
935
"""Execute a command.
937
This is similar to main(), but without all the trappings for
938
logging and error handling.
941
args, opts = parse_args(argv[1:])
943
# TODO: pass down other arguments in case they asked for
944
# help on a command name?
950
elif 'version' in opts:
955
log_error('usage: bzr COMMAND\n')
956
log_error(' try "bzr help"\n')
960
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
962
bailout("unknown command " + `cmd`)
965
if 'profile' in opts:
971
# check options are reasonable
972
allowed = cmd_options.get(cmd, [])
974
if oname not in allowed:
975
bailout("option %r is not allowed for command %r"
978
# TODO: give an error if there are any mandatory options which are
979
# not specified? Or maybe there shouldn't be any "mandatory
980
# options" (it is an oxymoron)
982
# mix arguments and options into one dictionary
983
cmdargs = _match_args(cmd, args)
984
for k, v in opts.items():
985
cmdargs[k.replace('-', '_')] = v
989
pffileno, pfname = tempfile.mkstemp()
991
prof = hotshot.Profile(pfname)
992
ret = prof.runcall(cmd_handler, **cmdargs) or 0
996
stats = hotshot.stats.load(pfname)
998
stats.sort_stats('time')
999
## XXX: Might like to write to stderr or the trace file instead but
1000
## print_stats seems hardcoded to stdout
1001
stats.print_stats(20)
1009
return cmd_handler(**cmdargs) or 0
1014
## TODO: Handle command-line options; probably know what options are valid for
1017
## TODO: If the arguments are wrong, give a usage message rather
1018
## than just a backtrace.
1020
bzrlib.trace.create_tracefile(argv)
1026
log_error('bzr: error: ' + e.args[0] + '\n')
1029
log_error(' ' + h + '\n')
1030
traceback.print_exc(None, bzrlib.trace._tracefile)
1031
log_error('(see $HOME/.bzr.log for debug information)\n')
1033
except Exception, e:
1034
log_error('bzr: exception: %s\n' % e)
1035
log_error('(see $HOME/.bzr.log for debug information)\n')
1036
traceback.print_exc(None, bzrlib.trace._tracefile)
1037
## traceback.print_exc(None, sys.stderr)
1040
## TODO: Trap AssertionError
1042
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1046
if __name__ == '__main__':
1047
sys.exit(main(sys.argv))
1049
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
