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):
268
i = b.inventory.path2id(b.relpath(filename))
270
bailout("%s is not a versioned file" % filename)
275
def cmd_find_filename(fileid):
276
n = find_filename(fileid)
278
bailout("%s is not a live file id" % fileid)
283
def cmd_revision_history():
284
for patchid in Branch('.').revision_history():
288
def cmd_directories():
289
for name, ie in Branch('.').read_working_inventory().directories():
297
for name, ie in Branch('.').working_tree().missing():
302
# TODO: Check we're not already in a working directory? At the
303
# moment you'll get an ugly error.
305
# TODO: What if we're in a subdirectory of a branch? Would like
306
# to allow that, but then the parent may need to understand that
307
# the children have disappeared, or should they be versioned in
310
# TODO: Take an argument/option for branch name.
311
Branch('.', init=True)
314
def cmd_diff(revision=None):
315
"""bzr diff: Show differences in working tree.
317
usage: bzr diff [-r REV]
320
Show changes since REV, rather than predecessor.
322
TODO: Given two revision arguments, show the difference between them.
324
TODO: Allow diff across branches.
326
TODO: Option to use external diff command; could be GNU diff, wdiff,
329
TODO: Diff selected files.
332
## TODO: Shouldn't be in the cmd function.
337
old_tree = b.basis_tree()
339
old_tree = b.revision_tree(b.lookup_revision(revision))
341
new_tree = b.working_tree()
342
old_inv = old_tree.inventory
343
new_inv = new_tree.inventory
345
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
349
DEVNULL = '/dev/null'
350
# Windows users, don't panic about this filename -- it is a
351
# special signal to GNU patch that the file should be created or
352
# deleted respectively.
354
# TODO: Generation of pseudo-diffs for added/deleted files could
355
# be usefully made into a much faster special case.
357
# TODO: Better to return them in sorted order I think.
359
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
362
# Don't show this by default; maybe do it if an option is passed
363
# idlabel = ' {%s}' % fid
366
# FIXME: Something about the diff format makes patch unhappy
367
# with newly-added files.
369
def diffit(oldlines, newlines, **kw):
370
# FIXME: difflib is wrong if there is no trailing newline.
372
# Special workaround for Python2.3, where difflib fails if
373
# both sequences are empty.
374
if oldlines or newlines:
375
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
378
if file_state in ['.', '?', 'I']:
380
elif file_state == 'A':
381
print '*** added %s %r' % (kind, new_name)
384
new_tree.get_file(fid).readlines(),
386
tofile=new_label + new_name + idlabel)
387
elif file_state == 'D':
388
assert isinstance(old_name, types.StringTypes)
389
print '*** deleted %s %r' % (kind, old_name)
391
diffit(old_tree.get_file(fid).readlines(), [],
392
fromfile=old_label + old_name + idlabel,
394
elif file_state in ['M', 'R']:
395
if file_state == 'M':
396
assert kind == 'file'
397
assert old_name == new_name
398
print '*** modified %s %r' % (kind, new_name)
399
elif file_state == 'R':
400
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
403
diffit(old_tree.get_file(fid).readlines(),
404
new_tree.get_file(fid).readlines(),
405
fromfile=old_label + old_name + idlabel,
406
tofile=new_label + new_name)
408
bailout("can't represent state %s {%s}" % (file_state, fid))
412
def cmd_deleted(show_ids=False):
413
"""List files deleted in the working tree.
415
TODO: Show files deleted since a previous revision, or between two revisions.
419
new = b.working_tree()
421
## TODO: Much more efficient way to do this: read in new
422
## directories with readdir, rather than stating each one. Same
423
## level of effort but possibly much less IO. (Or possibly not,
424
## if the directories are very large...)
426
for path, ie in old.inventory.iter_entries():
427
if not new.has_id(ie.file_id):
429
print '%-50s %s' % (path, ie.file_id)
435
def cmd_parse_inventory():
438
cElementTree.ElementTree().parse(file('.bzr/inventory'))
442
def cmd_load_inventory():
443
inv = Branch('.').basis_tree().inventory
447
def cmd_dump_new_inventory():
448
import bzrlib.newinventory
449
inv = Branch('.').basis_tree().inventory
450
bzrlib.newinventory.write_inventory(inv, sys.stdout)
453
def cmd_load_new_inventory():
454
import bzrlib.newinventory
455
bzrlib.newinventory.read_new_inventory(sys.stdin)
458
def cmd_dump_slacker_inventory():
459
import bzrlib.newinventory
460
inv = Branch('.').basis_tree().inventory
461
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
465
def cmd_root(filename=None):
466
"""Print the branch root."""
467
print bzrlib.branch.find_branch_root(filename)
470
def cmd_log(timezone='original'):
471
"""Show log of this branch.
473
:todo: Options for utc; to show ids; to limit range; etc.
475
Branch('.').write_log(show_timezone=timezone)
478
def cmd_ls(revision=None, verbose=False):
479
"""List files in a tree.
481
:todo: Take a revision or remote path and list that tree instead.
485
tree = b.working_tree()
487
tree = b.revision_tree(b.lookup_revision(revision))
489
for fp, fc, kind, fid in tree.list_files():
491
if kind == 'directory':
498
print '%-8s %s%s' % (fc, fp, kindch)
505
"""List unknown files"""
506
for f in Branch('.').unknowns():
511
def cmd_ignored(verbose=True):
512
"""List ignored files and the patterns that matched them.
514
tree = Branch('.').working_tree()
515
for path, file_class, kind, id in tree.list_files():
516
if file_class != 'I':
518
## XXX: Slightly inefficient since this was already calculated
519
pat = tree.is_ignored(path)
520
print '%-50s %s' % (path, pat)
523
def cmd_lookup_revision(revno):
527
bailout("usage: lookup-revision REVNO",
528
["REVNO is a non-negative revision number for this branch"])
530
print Branch('.').lookup_revision(revno) or NONE_STRING
534
def cmd_export(revno, dest):
535
"""Export past revision to destination directory."""
537
rh = b.lookup_revision(int(revno))
538
t = b.revision_tree(rh)
541
def cmd_cat(revision, filename):
542
"""Print file to stdout."""
544
b.print_file(b.relpath(filename), int(revision))
547
######################################################################
548
# internal/test commands
552
"""Print a newly-generated UUID."""
553
print bzrlib.osutils.uuid()
557
def cmd_local_time_offset():
558
print bzrlib.osutils.local_time_offset()
562
def cmd_commit(message=None, verbose=False):
563
"""Commit changes to a new revision.
566
Description of changes in this revision; free form text.
567
It is recommended that the first line be a single-sentence
570
Show status of changed files,
572
TODO: Commit only selected files.
574
TODO: Run hooks on tree to-be-committed, and after commit.
576
TODO: Strict commit that fails if there are unknown or deleted files.
580
bailout("please specify a commit message")
581
Branch('.').commit(message, verbose=verbose)
584
def cmd_check(dir='.'):
585
"""check: Consistency check of branch history.
587
usage: bzr check [-v] [BRANCH]
590
--verbose, -v Show progress of checking.
592
This command checks various invariants about the branch storage to
593
detect data corruption or bzr bugs.
596
bzrlib.check.check(Branch(dir, find_root=False))
599
def cmd_is(pred, *rest):
600
"""Test whether PREDICATE is true."""
602
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
604
bailout("unknown predicate: %s" % quotefn(pred))
608
except BzrCheckError:
609
# by default we don't print the message so that this can
610
# be used from shell scripts without producing noise
615
print bzrlib.osutils.username()
618
def cmd_user_email():
619
print bzrlib.osutils.user_email()
622
def cmd_gen_revision_id():
624
print bzrlib.branch._gen_revision_id(time.time())
627
def cmd_selftest(verbose=False):
628
"""Run internal test suite"""
629
## -v, if present, is seen by doctest; the argument is just here
630
## so our parser doesn't complain
632
## TODO: --verbose option
634
failures, tests = 0, 0
636
import doctest, bzrlib.store, bzrlib.tests
637
bzrlib.trace.verbose = False
639
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
640
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
641
mf, mt = doctest.testmod(m)
644
print '%-40s %3d tests' % (m.__name__, mt),
646
print '%3d FAILED!' % mf
650
print '%-40s %3d tests' % ('total', tests),
652
print '%3d FAILED!' % failures
659
cmd_doctest = cmd_selftest
662
######################################################################
666
def cmd_help(topic=None):
671
# otherwise, maybe the name of a command?
673
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
675
bailout("no help for %r" % topic)
679
bailout("sorry, no detailed help yet for %r" % topic)
687
print "bzr (bazaar-ng) %s" % bzrlib.__version__
688
print bzrlib.__copyright__
689
print "http://bazaar-ng.org/"
692
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
693
you may use, modify and redistribute it under the terms of the GNU
694
General Public License version 2 or later."""
698
"""Statement of optimism."""
699
print "it sure does!"
703
######################################################################
707
# list of all available options; the rhs can be either None for an
708
# option that takes no argument, or a constructor function that checks
728
# List of options that apply to particular commands; commands not
733
'commit': ['message', 'verbose'],
734
'deleted': ['show-ids'],
735
'diff': ['revision'],
736
'inventory': ['revision'],
738
'ls': ['revision', 'verbose'],
739
'remove': ['verbose'],
749
'export': ['revno', 'dest'],
750
'file-id': ['filename'],
751
'get-file-text': ['text_id'],
752
'get-inventory': ['inventory_id'],
753
'get-revision': ['revision_id'],
754
'get-revision-inventory': ['revision_id'],
758
'lookup-revision': ['revno'],
759
'move': ['source$', 'dest'],
760
'relpath': ['filename'],
762
'rename': ['from_name', 'to_name'],
764
'root': ['filename?'],
769
def parse_args(argv):
770
"""Parse command line.
772
Arguments and options are parsed at this level before being passed
773
down to specific command handlers. This routine knows, from a
774
lookup table, something about the available options, what optargs
775
they take, and which commands will accept them.
777
>>> parse_args('--help'.split())
779
>>> parse_args('--version'.split())
780
([], {'version': True})
781
>>> parse_args('status --all'.split())
782
(['status'], {'all': True})
783
>>> parse_args('commit --message=biter'.split())
784
(['commit'], {'message': u'biter'})
789
# TODO: Maybe handle '--' to end options?
796
mutter(" got option %r" % a)
798
optname, optarg = a[2:].split('=', 1)
801
if optname not in OPTIONS:
802
bailout('unknown long option %r' % a)
805
if shortopt not in SHORT_OPTIONS:
806
bailout('unknown short option %r' % a)
807
optname = SHORT_OPTIONS[shortopt]
810
# XXX: Do we ever want to support this, e.g. for -r?
811
bailout('repeated option %r' % a)
813
optargfn = OPTIONS[optname]
817
bailout('option %r needs an argument' % a)
820
opts[optname] = optargfn(optarg)
823
bailout('option %r takes no argument' % optname)
832
def _match_args(cmd, args):
833
"""Check non-option arguments match required pattern.
835
>>> _match_args('status', ['asdasdsadasd'])
836
Traceback (most recent call last):
838
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
839
>>> _match_args('add', ['asdasdsadasd'])
840
{'file_list': ['asdasdsadasd']}
841
>>> _match_args('add', 'abc def gj'.split())
842
{'file_list': ['abc', 'def', 'gj']}
844
# match argument pattern
845
argform = cmd_args.get(cmd, [])
847
# TODO: Need a way to express 'cp SRC... DEST', where it matches
850
# step through args and argform, allowing appropriate 0-many matches
855
argdict[argname] = args.pop(0)
860
bailout("command %r needs one or more %s"
861
% (cmd, argname.upper()))
863
argdict[argname + '_list'] = args[:]
865
elif ap[-1] == '$': # all but one
867
bailout("command %r needs one or more %s"
868
% (cmd, argname.upper()))
869
argdict[argname + '_list'] = args[:-1]
875
bailout("command %r requires argument %s"
876
% (cmd, argname.upper()))
878
argdict[argname] = args.pop(0)
881
bailout("extra arguments to command %s: %r"
889
"""Execute a command.
891
This is similar to main(), but without all the trappings for
892
logging and error handling.
895
args, opts = parse_args(argv[1:])
897
# TODO: pass down other arguments in case they asked for
898
# help on a command name?
904
elif 'version' in opts:
909
log_error('usage: bzr COMMAND\n')
910
log_error(' try "bzr help"\n')
914
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
916
bailout("unknown command " + `cmd`)
919
if 'profile' in opts:
925
# check options are reasonable
926
allowed = cmd_options.get(cmd, [])
928
if oname not in allowed:
929
bailout("option %r is not allowed for command %r"
932
# TODO: give an error if there are any mandatory options which are
933
# not specified? Or maybe there shouldn't be any "mandatory
934
# options" (it is an oxymoron)
936
# mix arguments and options into one dictionary
937
cmdargs = _match_args(cmd, args)
938
for k, v in opts.items():
939
cmdargs[k.replace('-', '_')] = v
943
prof = hotshot.Profile('.bzr.profile')
944
ret = prof.runcall(cmd_handler, **cmdargs) or 0
948
stats = hotshot.stats.load('.bzr.profile')
950
stats.sort_stats('time')
951
stats.print_stats(20)
953
return cmd_handler(**cmdargs) or 0
958
## TODO: Handle command-line options; probably know what options are valid for
961
## TODO: If the arguments are wrong, give a usage message rather
962
## than just a backtrace.
964
bzrlib.trace.create_tracefile(argv)
970
log_error('bzr: error: ' + e.args[0] + '\n')
973
log_error(' ' + h + '\n')
976
log_error('bzr: exception: %s\n' % e)
977
log_error(' see .bzr.log for details\n')
978
traceback.print_exc(None, bzrlib.trace._tracefile)
979
traceback.print_exc(None, sys.stderr)
982
# TODO: Maybe nicer handling of IOError?
986
if __name__ == '__main__':
987
sys.exit(main(sys.argv))
989
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
