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
def cmd_mv(source_list, dest):
202
b.rename([b.relpath(s) for s in source_list], b.relpath(dest))
207
"""info: Show statistical information for this branch
211
info.show_info(Branch('.'))
215
def cmd_remove(file_list, verbose=False):
216
b = Branch(file_list[0])
217
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
221
def cmd_file_id(filename):
223
i = b.inventory.path2id(b.relpath(filename))
225
bailout("%s is not a versioned file" % filename)
230
def cmd_find_filename(fileid):
231
n = find_filename(fileid)
233
bailout("%s is not a live file id" % fileid)
238
def cmd_revision_history():
239
for patchid in Branch('.').revision_history():
243
def cmd_directories():
244
for name, ie in Branch('.').read_working_inventory().directories():
252
for name, ie in Branch('.').working_tree().missing():
257
# TODO: Check we're not already in a working directory? At the
258
# moment you'll get an ugly error.
260
# TODO: What if we're in a subdirectory of a branch? Would like
261
# to allow that, but then the parent may need to understand that
262
# the children have disappeared, or should they be versioned in
265
# TODO: Take an argument/option for branch name.
266
Branch('.', init=True)
269
def cmd_diff(revision=None):
270
"""bzr diff: Show differences in working tree.
272
usage: bzr diff [-r REV]
275
Show changes since REV, rather than predecessor.
277
TODO: Given two revision arguments, show the difference between them.
279
TODO: Allow diff across branches.
281
TODO: Option to use external diff command; could be GNU diff, wdiff,
284
TODO: Diff selected files.
287
## TODO: Shouldn't be in the cmd function.
292
old_tree = b.basis_tree()
294
old_tree = b.revision_tree(b.lookup_revision(revision))
296
new_tree = b.working_tree()
297
old_inv = old_tree.inventory
298
new_inv = new_tree.inventory
300
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
304
DEVNULL = '/dev/null'
305
# Windows users, don't panic about this filename -- it is a
306
# special signal to GNU patch that the file should be created or
307
# deleted respectively.
309
# TODO: Generation of pseudo-diffs for added/deleted files could
310
# be usefully made into a much faster special case.
312
# TODO: Better to return them in sorted order I think.
314
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
317
# Don't show this by default; maybe do it if an option is passed
318
# idlabel = ' {%s}' % fid
321
# FIXME: Something about the diff format makes patch unhappy
322
# with newly-added files.
324
def diffit(oldlines, newlines, **kw):
325
# FIXME: difflib is wrong if there is no trailing newline.
327
# Special workaround for Python2.3, where difflib fails if
328
# both sequences are empty.
329
if oldlines or newlines:
330
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
333
if file_state in ['.', '?', 'I']:
335
elif file_state == 'A':
336
print '*** added %s %r' % (kind, new_name)
339
new_tree.get_file(fid).readlines(),
341
tofile=new_label + new_name + idlabel)
342
elif file_state == 'D':
343
assert isinstance(old_name, types.StringTypes)
344
print '*** deleted %s %r' % (kind, old_name)
346
diffit(old_tree.get_file(fid).readlines(), [],
347
fromfile=old_label + old_name + idlabel,
349
elif file_state in ['M', 'R']:
350
if file_state == 'M':
351
assert kind == 'file'
352
assert old_name == new_name
353
print '*** modified %s %r' % (kind, new_name)
354
elif file_state == 'R':
355
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
358
diffit(old_tree.get_file(fid).readlines(),
359
new_tree.get_file(fid).readlines(),
360
fromfile=old_label + old_name + idlabel,
361
tofile=new_label + new_name)
363
bailout("can't represent state %s {%s}" % (file_state, fid))
367
def cmd_deleted(show_ids=False):
368
"""List files deleted in the working tree.
370
TODO: Show files deleted since a previous revision, or between two revisions.
374
new = b.working_tree()
376
## TODO: Much more efficient way to do this: read in new
377
## directories with readdir, rather than stating each one. Same
378
## level of effort but possibly much less IO. (Or possibly not,
379
## if the directories are very large...)
381
for path, ie in old.inventory.iter_entries():
382
if not new.has_id(ie.file_id):
384
print '%-50s %s' % (path, ie.file_id)
390
def cmd_parse_inventory():
393
cElementTree.ElementTree().parse(file('.bzr/inventory'))
397
def cmd_load_inventory():
398
inv = Branch('.').basis_tree().inventory
402
def cmd_dump_new_inventory():
403
import bzrlib.newinventory
404
inv = Branch('.').basis_tree().inventory
405
bzrlib.newinventory.write_inventory(inv, sys.stdout)
408
def cmd_load_new_inventory():
409
import bzrlib.newinventory
410
bzrlib.newinventory.read_new_inventory(sys.stdin)
413
def cmd_dump_slacker_inventory():
414
import bzrlib.newinventory
415
inv = Branch('.').basis_tree().inventory
416
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
420
def cmd_root(filename=None):
421
"""Print the branch root."""
422
print bzrlib.branch.find_branch_root(filename)
425
def cmd_log(timezone='original'):
426
"""Show log of this branch.
428
:todo: Options for utc; to show ids; to limit range; etc.
430
Branch('.').write_log(show_timezone=timezone)
433
def cmd_ls(revision=None, verbose=False):
434
"""List files in a tree.
436
:todo: Take a revision or remote path and list that tree instead.
440
tree = b.working_tree()
442
tree = b.revision_tree(b.lookup_revision(revision))
444
for fp, fc, kind, fid in tree.list_files():
446
if kind == 'directory':
453
print '%-8s %s%s' % (fc, fp, kindch)
460
"""List unknown files"""
461
for f in Branch('.').unknowns():
466
def cmd_ignored(verbose=True):
467
"""List ignored files and the patterns that matched them.
469
tree = Branch('.').working_tree()
470
for path, file_class, kind, id in tree.list_files():
471
if file_class != 'I':
473
## XXX: Slightly inefficient since this was already calculated
474
pat = tree.is_ignored(path)
475
print '%-50s %s' % (path, pat)
478
def cmd_lookup_revision(revno):
482
bailout("usage: lookup-revision REVNO",
483
["REVNO is a non-negative revision number for this branch"])
485
print Branch('.').lookup_revision(revno) or NONE_STRING
489
def cmd_export(revno, dest):
490
"""Export past revision to destination directory."""
492
rh = b.lookup_revision(int(revno))
493
t = b.revision_tree(rh)
498
######################################################################
499
# internal/test commands
503
"""Print a newly-generated UUID."""
504
print bzrlib.osutils.uuid()
508
def cmd_local_time_offset():
509
print bzrlib.osutils.local_time_offset()
513
def cmd_commit(message=None, verbose=False):
514
"""Commit changes to a new revision.
517
Description of changes in this revision; free form text.
518
It is recommended that the first line be a single-sentence
521
Show status of changed files,
523
TODO: Commit only selected files.
525
TODO: Run hooks on tree to-be-committed, and after commit.
527
TODO: Strict commit that fails if there are unknown or deleted files.
531
bailout("please specify a commit message")
532
Branch('.').commit(message, verbose=verbose)
535
def cmd_check(dir='.'):
536
"""check: Consistency check of branch history.
538
usage: bzr check [-v] [BRANCH]
541
--verbose, -v Show progress of checking.
543
This command checks various invariants about the branch storage to
544
detect data corruption or bzr bugs.
547
bzrlib.check.check(Branch(dir, find_root=False))
550
def cmd_is(pred, *rest):
551
"""Test whether PREDICATE is true."""
553
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
555
bailout("unknown predicate: %s" % quotefn(pred))
559
except BzrCheckError:
560
# by default we don't print the message so that this can
561
# be used from shell scripts without producing noise
566
print bzrlib.osutils.username()
569
def cmd_user_email():
570
print bzrlib.osutils.user_email()
573
def cmd_gen_revision_id():
575
print bzrlib.branch._gen_revision_id(time.time())
578
def cmd_selftest(verbose=False):
579
"""Run internal test suite"""
580
## -v, if present, is seen by doctest; the argument is just here
581
## so our parser doesn't complain
583
## TODO: --verbose option
585
failures, tests = 0, 0
587
import doctest, bzrlib.store, bzrlib.tests
588
bzrlib.trace.verbose = False
590
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
591
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
592
mf, mt = doctest.testmod(m)
595
print '%-40s %3d tests' % (m.__name__, mt),
597
print '%3d FAILED!' % mf
601
print '%-40s %3d tests' % ('total', tests),
603
print '%3d FAILED!' % failures
610
cmd_doctest = cmd_selftest
613
######################################################################
617
def cmd_help(topic=None):
622
# otherwise, maybe the name of a command?
624
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
626
bailout("no help for %r" % topic)
630
bailout("sorry, no detailed help yet for %r" % topic)
638
print "bzr (bazaar-ng) %s" % bzrlib.__version__
639
print bzrlib.__copyright__
640
print "http://bazaar-ng.org/"
643
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
644
you may use, modify and redistribute it under the terms of the GNU
645
General Public License version 2 or later."""
649
"""Statement of optimism."""
650
print "it sure does!"
654
######################################################################
658
# list of all available options; the rhs can be either None for an
659
# option that takes no argument, or a constructor function that checks
679
# List of options that apply to particular commands; commands not
683
'commit': ['message', 'verbose'],
684
'deleted': ['show-ids'],
685
'diff': ['revision'],
686
'inventory': ['revision'],
688
'ls': ['revision', 'verbose'],
689
'remove': ['verbose'],
698
'export': ['revno', 'dest'],
699
'file-id': ['filename'],
700
'get-file-text': ['text_id'],
701
'get-inventory': ['inventory_id'],
702
'get-revision': ['revision_id'],
703
'get-revision-inventory': ['revision_id'],
707
'lookup-revision': ['revno'],
708
'mv': ['source$', 'dest'],
709
'relpath': ['filename'],
711
'root': ['filename?'],
716
def parse_args(argv):
717
"""Parse command line.
719
Arguments and options are parsed at this level before being passed
720
down to specific command handlers. This routine knows, from a
721
lookup table, something about the available options, what optargs
722
they take, and which commands will accept them.
724
>>> parse_args('--help'.split())
726
>>> parse_args('--version'.split())
727
([], {'version': True})
728
>>> parse_args('status --all'.split())
729
(['status'], {'all': True})
730
>>> parse_args('commit --message=biter'.split())
731
(['commit'], {'message': u'biter'})
736
# TODO: Maybe handle '--' to end options?
743
mutter(" got option %r" % a)
745
optname, optarg = a[2:].split('=', 1)
748
if optname not in OPTIONS:
749
bailout('unknown long option %r' % a)
752
if shortopt not in SHORT_OPTIONS:
753
bailout('unknown short option %r' % a)
754
optname = SHORT_OPTIONS[shortopt]
757
# XXX: Do we ever want to support this, e.g. for -r?
758
bailout('repeated option %r' % a)
760
optargfn = OPTIONS[optname]
764
bailout('option %r needs an argument' % a)
767
opts[optname] = optargfn(optarg)
770
bailout('option %r takes no argument' % optname)
779
def _match_args(cmd, args):
780
"""Check non-option arguments match required pattern.
782
>>> _match_args('status', ['asdasdsadasd'])
783
Traceback (most recent call last):
785
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
786
>>> _match_args('add', ['asdasdsadasd'])
787
{'file_list': ['asdasdsadasd']}
788
>>> _match_args('add', 'abc def gj'.split())
789
{'file_list': ['abc', 'def', 'gj']}
791
# match argument pattern
792
argform = cmd_args.get(cmd, [])
794
# TODO: Need a way to express 'cp SRC... DEST', where it matches
797
# step through args and argform, allowing appropriate 0-many matches
802
argdict[argname] = args.pop(0)
807
bailout("command %r needs one or more %s"
808
% (cmd, argname.upper()))
810
argdict[argname + '_list'] = args[:]
812
elif ap[-1] == '$': # all but one
814
bailout("command %r needs one or more %s"
815
% (cmd, argname.upper()))
816
argdict[argname + '_list'] = args[:-1]
822
bailout("command %r requires argument %s"
823
% (cmd, argname.upper()))
825
argdict[argname] = args.pop(0)
828
bailout("extra arguments to command %s: %r"
836
"""Execute a command.
838
This is similar to main(), but without all the trappings for
839
logging and error handling.
842
args, opts = parse_args(argv[1:])
844
# TODO: pass down other arguments in case they asked for
845
# help on a command name?
851
elif 'version' in opts:
856
log_error('usage: bzr COMMAND\n')
857
log_error(' try "bzr help"\n')
861
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
863
bailout("unknown command " + `cmd`)
866
if 'profile' in opts:
872
# check options are reasonable
873
allowed = cmd_options.get(cmd, [])
875
if oname not in allowed:
876
bailout("option %r is not allowed for command %r"
879
# mix arguments and options into one dictionary
880
cmdargs = _match_args(cmd, args)
881
for k, v in opts.items():
882
cmdargs[k.replace('-', '_')] = v
886
prof = hotshot.Profile('.bzr.profile')
887
ret = prof.runcall(cmd_handler, **cmdargs) or 0
891
stats = hotshot.stats.load('.bzr.profile')
893
stats.sort_stats('time')
894
stats.print_stats(20)
896
return cmd_handler(**cmdargs) or 0
901
## TODO: Handle command-line options; probably know what options are valid for
904
## TODO: If the arguments are wrong, give a usage message rather
905
## than just a backtrace.
907
bzrlib.trace.create_tracefile(argv)
913
log_error('bzr: error: ' + e.args[0] + '\n')
916
log_error(' ' + h + '\n')
919
log_error('bzr: exception: %s\n' % e)
920
log_error(' see .bzr.log for details\n')
921
traceback.print_exc(None, bzrlib.trace._tracefile)
922
traceback.print_exc(None, sys.stderr)
925
# TODO: Maybe nicer handling of IOError?
929
if __name__ == '__main__':
930
sys.exit(main(sys.argv))
932
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
