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, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
69
from pprint import pprint
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
113
## TODO: move command; check destination is a directory and will not
116
## TODO: command to show renames, one per line, as to->from
121
def cmd_status(all=False):
122
"""Display status summary.
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
128
:todo: Don't show unchanged files unless ``--all`` is given?
130
Branch('.').show_status(show_all=all)
134
######################################################################
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
147
######################################################################
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
175
bzrlib.add.smart_add(file_list, verbose)
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
184
def cmd_inventory(revision=None):
185
"""Show inventory of the current working copy."""
186
## TODO: Also optionally show a previous inventory
187
## TODO: Format options
190
inv = b.read_working_inventory()
192
inv = b.get_revision_inventory(b.lookup_revision(revision))
194
for path, entry in inv.iter_entries():
195
print '%-50s %s' % (entry.file_id, path)
199
# TODO: Maybe a 'mv' command that has the combined move/rename
200
# special behaviour of Unix?
202
def cmd_move(source_list, dest):
205
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
209
def cmd_rename(from_name, to_name):
210
"""Change the name of an entry.
212
usage: bzr rename FROM_NAME TO_NAME
215
bzr rename frob.c frobber.c
216
bzr rename src/frob.c lib/frob.c
218
It is an error if the destination name exists.
220
See also the 'move' command, which moves files into a different
221
directory without changing their name.
223
TODO: Some way to rename multiple files without invoking bzr for each
226
b.rename_one(b.relpath(from_name), b.relpath(to_name))
231
def cmd_renames(dir='.'):
232
"""Show list of renamed files.
234
usage: bzr renames [BRANCH]
236
TODO: Option to show renames between two historical versions.
238
TODO: Only show renames under dir, rather than in the whole branch.
241
old_inv = b.basis_tree().inventory
242
new_inv = b.read_working_inventory()
244
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
246
for old_name, new_name in renames:
247
print "%s => %s" % (old_name, new_name)
252
"""info: Show statistical information for this branch
256
info.show_info(Branch('.'))
260
def cmd_remove(file_list, verbose=False):
261
b = Branch(file_list[0])
262
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
266
def cmd_file_id(filename):
267
"""Print file_id of a particular file or directory.
269
usage: bzr file-id FILE
271
The file_id is assigned when the file is first added and remains the
272
same through all revisions where the file exists, even when it is
276
i = b.inventory.path2id(b.relpath(filename))
278
bailout("%r is not a versioned file" % filename)
283
def cmd_file_id_path(filename):
284
"""Print path of file_ids to a file or directory.
286
usage: bzr file-id-path FILE
288
This prints one line for each directory down to the target,
289
starting at the branch root."""
292
fid = inv.path2id(b.relpath(filename))
294
bailout("%r is not a versioned file" % filename)
295
for fip in inv.get_idpath(fid):
299
def cmd_find_filename(fileid):
300
n = find_filename(fileid)
302
bailout("%s is not a live file id" % fileid)
307
def cmd_revision_history():
308
for patchid in Branch('.').revision_history():
312
def cmd_directories():
313
for name, ie in Branch('.').read_working_inventory().directories():
321
for name, ie in Branch('.').working_tree().missing():
326
# TODO: Check we're not already in a working directory? At the
327
# moment you'll get an ugly error.
329
# TODO: What if we're in a subdirectory of a branch? Would like
330
# to allow that, but then the parent may need to understand that
331
# the children have disappeared, or should they be versioned in
334
# TODO: Take an argument/option for branch name.
335
Branch('.', init=True)
338
def cmd_diff(revision=None):
339
"""bzr diff: Show differences in working tree.
341
usage: bzr diff [-r REV]
344
Show changes since REV, rather than predecessor.
346
TODO: Given two revision arguments, show the difference between them.
348
TODO: Allow diff across branches.
350
TODO: Option to use external diff command; could be GNU diff, wdiff,
353
TODO: Diff selected files.
356
## TODO: Shouldn't be in the cmd function.
361
old_tree = b.basis_tree()
363
old_tree = b.revision_tree(b.lookup_revision(revision))
365
new_tree = b.working_tree()
366
old_inv = old_tree.inventory
367
new_inv = new_tree.inventory
369
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
373
DEVNULL = '/dev/null'
374
# Windows users, don't panic about this filename -- it is a
375
# special signal to GNU patch that the file should be created or
376
# deleted respectively.
378
# TODO: Generation of pseudo-diffs for added/deleted files could
379
# be usefully made into a much faster special case.
381
# TODO: Better to return them in sorted order I think.
383
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
386
# Don't show this by default; maybe do it if an option is passed
387
# idlabel = ' {%s}' % fid
390
# FIXME: Something about the diff format makes patch unhappy
391
# with newly-added files.
393
def diffit(oldlines, newlines, **kw):
394
# FIXME: difflib is wrong if there is no trailing newline.
396
# Special workaround for Python2.3, where difflib fails if
397
# both sequences are empty.
398
if oldlines or newlines:
399
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
402
if file_state in ['.', '?', 'I']:
404
elif file_state == 'A':
405
print '*** added %s %r' % (kind, new_name)
408
new_tree.get_file(fid).readlines(),
410
tofile=new_label + new_name + idlabel)
411
elif file_state == 'D':
412
assert isinstance(old_name, types.StringTypes)
413
print '*** deleted %s %r' % (kind, old_name)
415
diffit(old_tree.get_file(fid).readlines(), [],
416
fromfile=old_label + old_name + idlabel,
418
elif file_state in ['M', 'R']:
419
if file_state == 'M':
420
assert kind == 'file'
421
assert old_name == new_name
422
print '*** modified %s %r' % (kind, new_name)
423
elif file_state == 'R':
424
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
427
diffit(old_tree.get_file(fid).readlines(),
428
new_tree.get_file(fid).readlines(),
429
fromfile=old_label + old_name + idlabel,
430
tofile=new_label + new_name)
432
bailout("can't represent state %s {%s}" % (file_state, fid))
436
def cmd_deleted(show_ids=False):
437
"""List files deleted in the working tree.
439
TODO: Show files deleted since a previous revision, or between two revisions.
443
new = b.working_tree()
445
## TODO: Much more efficient way to do this: read in new
446
## directories with readdir, rather than stating each one. Same
447
## level of effort but possibly much less IO. (Or possibly not,
448
## if the directories are very large...)
450
for path, ie in old.inventory.iter_entries():
451
if not new.has_id(ie.file_id):
453
print '%-50s %s' % (path, ie.file_id)
459
def cmd_parse_inventory():
462
cElementTree.ElementTree().parse(file('.bzr/inventory'))
466
def cmd_load_inventory():
467
inv = Branch('.').basis_tree().inventory
471
def cmd_dump_new_inventory():
472
import bzrlib.newinventory
473
inv = Branch('.').basis_tree().inventory
474
bzrlib.newinventory.write_inventory(inv, sys.stdout)
477
def cmd_load_new_inventory():
478
import bzrlib.newinventory
479
bzrlib.newinventory.read_new_inventory(sys.stdin)
482
def cmd_dump_slacker_inventory():
483
import bzrlib.newinventory
484
inv = Branch('.').basis_tree().inventory
485
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
489
def cmd_root(filename=None):
490
"""Print the branch root."""
491
print bzrlib.branch.find_branch_root(filename)
494
def cmd_log(timezone='original'):
495
"""Show log of this branch.
497
:todo: Options for utc; to show ids; to limit range; etc.
499
Branch('.').write_log(show_timezone=timezone)
502
def cmd_ls(revision=None, verbose=False):
503
"""List files in a tree.
505
:todo: Take a revision or remote path and list that tree instead.
509
tree = b.working_tree()
511
tree = b.revision_tree(b.lookup_revision(revision))
513
for fp, fc, kind, fid in tree.list_files():
515
if kind == 'directory':
522
print '%-8s %s%s' % (fc, fp, kindch)
529
"""List unknown files"""
530
for f in Branch('.').unknowns():
535
def cmd_ignored(verbose=True):
536
"""List ignored files and the patterns that matched them.
538
tree = Branch('.').working_tree()
539
for path, file_class, kind, id in tree.list_files():
540
if file_class != 'I':
542
## XXX: Slightly inefficient since this was already calculated
543
pat = tree.is_ignored(path)
544
print '%-50s %s' % (path, pat)
547
def cmd_lookup_revision(revno):
551
bailout("usage: lookup-revision REVNO",
552
["REVNO is a non-negative revision number for this branch"])
554
print Branch('.').lookup_revision(revno) or NONE_STRING
558
def cmd_export(revno, dest):
559
"""Export past revision to destination directory."""
561
rh = b.lookup_revision(int(revno))
562
t = b.revision_tree(rh)
565
def cmd_cat(revision, filename):
566
"""Print file to stdout."""
568
b.print_file(b.relpath(filename), int(revision))
571
######################################################################
572
# internal/test commands
576
"""Print a newly-generated UUID."""
577
print bzrlib.osutils.uuid()
581
def cmd_local_time_offset():
582
print bzrlib.osutils.local_time_offset()
586
def cmd_commit(message=None, verbose=False):
587
"""Commit changes to a new revision.
590
Description of changes in this revision; free form text.
591
It is recommended that the first line be a single-sentence
594
Show status of changed files,
596
TODO: Commit only selected files.
598
TODO: Run hooks on tree to-be-committed, and after commit.
600
TODO: Strict commit that fails if there are unknown or deleted files.
604
bailout("please specify a commit message")
605
Branch('.').commit(message, verbose=verbose)
608
def cmd_check(dir='.'):
609
"""check: Consistency check of branch history.
611
usage: bzr check [-v] [BRANCH]
614
--verbose, -v Show progress of checking.
616
This command checks various invariants about the branch storage to
617
detect data corruption or bzr bugs.
620
bzrlib.check.check(Branch(dir, find_root=False))
623
def cmd_is(pred, *rest):
624
"""Test whether PREDICATE is true."""
626
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
628
bailout("unknown predicate: %s" % quotefn(pred))
632
except BzrCheckError:
633
# by default we don't print the message so that this can
634
# be used from shell scripts without producing noise
639
print bzrlib.osutils.username()
642
def cmd_user_email():
643
print bzrlib.osutils.user_email()
646
def cmd_gen_revision_id():
648
print bzrlib.branch._gen_revision_id(time.time())
651
def cmd_selftest(verbose=False):
652
"""Run internal test suite"""
653
## -v, if present, is seen by doctest; the argument is just here
654
## so our parser doesn't complain
656
## TODO: --verbose option
658
failures, tests = 0, 0
660
import doctest, bzrlib.store, bzrlib.tests
661
bzrlib.trace.verbose = False
663
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
664
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
665
mf, mt = doctest.testmod(m)
668
print '%-40s %3d tests' % (m.__name__, mt),
670
print '%3d FAILED!' % mf
674
print '%-40s %3d tests' % ('total', tests),
676
print '%3d FAILED!' % failures
683
cmd_doctest = cmd_selftest
686
######################################################################
690
def cmd_help(topic=None):
695
# otherwise, maybe the name of a command?
697
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
699
bailout("no help for %r" % topic)
703
bailout("sorry, no detailed help yet for %r" % topic)
711
print "bzr (bazaar-ng) %s" % bzrlib.__version__
712
print bzrlib.__copyright__
713
print "http://bazaar-ng.org/"
716
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
717
you may use, modify and redistribute it under the terms of the GNU
718
General Public License version 2 or later."""
722
"""Statement of optimism."""
723
print "it sure does!"
727
######################################################################
731
# list of all available options; the rhs can be either None for an
732
# option that takes no argument, or a constructor function that checks
752
# List of options that apply to particular commands; commands not
757
'commit': ['message', 'verbose'],
758
'deleted': ['show-ids'],
759
'diff': ['revision'],
760
'inventory': ['revision'],
762
'ls': ['revision', 'verbose'],
763
'remove': ['verbose'],
773
'export': ['revno', 'dest'],
774
'file-id': ['filename'],
775
'file-id-path': ['filename'],
776
'get-file-text': ['text_id'],
777
'get-inventory': ['inventory_id'],
778
'get-revision': ['revision_id'],
779
'get-revision-inventory': ['revision_id'],
783
'lookup-revision': ['revno'],
784
'move': ['source$', 'dest'],
785
'relpath': ['filename'],
787
'rename': ['from_name', 'to_name'],
789
'root': ['filename?'],
794
def parse_args(argv):
795
"""Parse command line.
797
Arguments and options are parsed at this level before being passed
798
down to specific command handlers. This routine knows, from a
799
lookup table, something about the available options, what optargs
800
they take, and which commands will accept them.
802
>>> parse_args('--help'.split())
804
>>> parse_args('--version'.split())
805
([], {'version': True})
806
>>> parse_args('status --all'.split())
807
(['status'], {'all': True})
808
>>> parse_args('commit --message=biter'.split())
809
(['commit'], {'message': u'biter'})
814
# TODO: Maybe handle '--' to end options?
821
mutter(" got option %r" % a)
823
optname, optarg = a[2:].split('=', 1)
826
if optname not in OPTIONS:
827
bailout('unknown long option %r' % a)
830
if shortopt not in SHORT_OPTIONS:
831
bailout('unknown short option %r' % a)
832
optname = SHORT_OPTIONS[shortopt]
835
# XXX: Do we ever want to support this, e.g. for -r?
836
bailout('repeated option %r' % a)
838
optargfn = OPTIONS[optname]
842
bailout('option %r needs an argument' % a)
845
opts[optname] = optargfn(optarg)
848
bailout('option %r takes no argument' % optname)
857
def _match_args(cmd, args):
858
"""Check non-option arguments match required pattern.
860
>>> _match_args('status', ['asdasdsadasd'])
861
Traceback (most recent call last):
863
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
864
>>> _match_args('add', ['asdasdsadasd'])
865
{'file_list': ['asdasdsadasd']}
866
>>> _match_args('add', 'abc def gj'.split())
867
{'file_list': ['abc', 'def', 'gj']}
869
# match argument pattern
870
argform = cmd_args.get(cmd, [])
872
# TODO: Need a way to express 'cp SRC... DEST', where it matches
875
# step through args and argform, allowing appropriate 0-many matches
880
argdict[argname] = args.pop(0)
885
bailout("command %r needs one or more %s"
886
% (cmd, argname.upper()))
888
argdict[argname + '_list'] = args[:]
890
elif ap[-1] == '$': # all but one
892
bailout("command %r needs one or more %s"
893
% (cmd, argname.upper()))
894
argdict[argname + '_list'] = args[:-1]
900
bailout("command %r requires argument %s"
901
% (cmd, argname.upper()))
903
argdict[argname] = args.pop(0)
906
bailout("extra arguments to command %s: %r"
914
"""Execute a command.
916
This is similar to main(), but without all the trappings for
917
logging and error handling.
920
args, opts = parse_args(argv[1:])
922
# TODO: pass down other arguments in case they asked for
923
# help on a command name?
929
elif 'version' in opts:
934
log_error('usage: bzr COMMAND\n')
935
log_error(' try "bzr help"\n')
939
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
941
bailout("unknown command " + `cmd`)
944
if 'profile' in opts:
950
# check options are reasonable
951
allowed = cmd_options.get(cmd, [])
953
if oname not in allowed:
954
bailout("option %r is not allowed for command %r"
957
# TODO: give an error if there are any mandatory options which are
958
# not specified? Or maybe there shouldn't be any "mandatory
959
# options" (it is an oxymoron)
961
# mix arguments and options into one dictionary
962
cmdargs = _match_args(cmd, args)
963
for k, v in opts.items():
964
cmdargs[k.replace('-', '_')] = v
968
prof = hotshot.Profile('.bzr.profile')
969
ret = prof.runcall(cmd_handler, **cmdargs) or 0
973
stats = hotshot.stats.load('.bzr.profile')
975
stats.sort_stats('time')
976
stats.print_stats(20)
978
return cmd_handler(**cmdargs) or 0
983
## TODO: Handle command-line options; probably know what options are valid for
986
## TODO: If the arguments are wrong, give a usage message rather
987
## than just a backtrace.
989
bzrlib.trace.create_tracefile(argv)
995
log_error('bzr: error: ' + e.args[0] + '\n')
998
log_error(' ' + h + '\n')
999
traceback.print_exc(None, bzrlib.trace._tracefile)
1000
log_error('see ~/.bzr.log for more information\n')
1002
except Exception, e:
1003
log_error('bzr: exception: %s\n' % e)
1004
log_error(' see .bzr.log for details\n')
1005
traceback.print_exc(None, bzrlib.trace._tracefile)
1006
traceback.print_exc(None, sys.stderr)
1009
# TODO: Maybe nicer handling of IOError?
1013
if __name__ == '__main__':
1014
sys.exit(main(sys.argv))
1016
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
