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)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
199
"""info: Show statistical information for this branch
203
info.show_info(Branch('.'))
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
213
def cmd_file_id(filename):
215
i = b.inventory.path2id(b.relpath(filename))
217
bailout("%s is not a versioned file" % filename)
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
225
bailout("%s is not a live file id" % fileid)
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
235
def cmd_directories():
236
for name, ie in Branch('.').read_working_inventory().directories():
244
for name, ie in Branch('.').working_tree().missing():
249
# TODO: Check we're not already in a working directory? At the
250
# moment you'll get an ugly error.
252
# TODO: What if we're in a subdirectory of a branch? Would like
253
# to allow that, but then the parent may need to understand that
254
# the children have disappeared, or should they be versioned in
257
# TODO: Take an argument/option for branch name.
258
Branch('.', init=True)
261
def cmd_diff(revision=None):
262
"""bzr diff: Show differences in working tree.
264
usage: bzr diff [-r REV]
267
Show changes since REV, rather than predecessor.
269
TODO: Given two revision arguments, show the difference between them.
271
TODO: Allow diff across branches.
273
TODO: Option to use external diff command; could be GNU diff, wdiff,
276
TODO: Diff selected files.
279
## TODO: Shouldn't be in the cmd function.
284
old_tree = b.basis_tree()
286
old_tree = b.revision_tree(b.lookup_revision(revision))
288
new_tree = b.working_tree()
289
old_inv = old_tree.inventory
290
new_inv = new_tree.inventory
292
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
296
DEVNULL = '/dev/null'
297
# Windows users, don't panic about this filename -- it is a
298
# special signal to GNU patch that the file should be created or
299
# deleted respectively.
301
# TODO: Generation of pseudo-diffs for added/deleted files could
302
# be usefully made into a much faster special case.
304
# TODO: Better to return them in sorted order I think.
306
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
309
# Don't show this by default; maybe do it if an option is passed
310
# idlabel = ' {%s}' % fid
313
# FIXME: Something about the diff format makes patch unhappy
314
# with newly-added files.
316
def diffit(*a, **kw):
317
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
320
if file_state in ['.', '?', 'I']:
322
elif file_state == 'A':
323
print '*** added %s %r' % (kind, new_name)
326
new_tree.get_file(fid).readlines(),
328
tofile=new_label + new_name + idlabel)
329
elif file_state == 'D':
330
assert isinstance(old_name, types.StringTypes)
331
print '*** deleted %s %r' % (kind, old_name)
333
diffit(old_tree.get_file(fid).readlines(), [],
334
fromfile=old_label + old_name + idlabel,
336
elif file_state in ['M', 'R']:
337
if file_state == 'M':
338
assert kind == 'file'
339
assert old_name == new_name
340
print '*** modified %s %r' % (kind, new_name)
341
elif file_state == 'R':
342
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
345
diffit(old_tree.get_file(fid).readlines(),
346
new_tree.get_file(fid).readlines(),
347
fromfile=old_label + old_name + idlabel,
348
tofile=new_label + new_name)
350
bailout("can't represent state %s {%s}" % (file_state, fid))
354
def cmd_deleted(show_ids=False):
355
"""List files deleted in the working tree.
357
TODO: Show files deleted since a previous revision, or between two revisions.
361
new = b.working_tree()
363
## TODO: Much more efficient way to do this: read in new
364
## directories with readdir, rather than stating each one. Same
365
## level of effort but possibly much less IO. (Or possibly not,
366
## if the directories are very large...)
368
for path, ie in old.inventory.iter_entries():
369
if not new.has_id(ie.file_id):
371
print '%-50s %s' % (path, ie.file_id)
377
def cmd_parse_inventory():
380
cElementTree.ElementTree().parse(file('.bzr/inventory'))
384
def cmd_load_inventory():
385
inv = Branch('.').basis_tree().inventory
389
def cmd_dump_new_inventory():
390
import bzrlib.newinventory
391
inv = Branch('.').basis_tree().inventory
392
bzrlib.newinventory.write_inventory(inv, sys.stdout)
395
def cmd_load_new_inventory():
396
import bzrlib.newinventory
397
bzrlib.newinventory.read_new_inventory(sys.stdin)
400
def cmd_dump_slacker_inventory():
401
import bzrlib.newinventory
402
inv = Branch('.').basis_tree().inventory
403
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
407
def cmd_root(filename=None):
408
"""Print the branch root."""
409
print bzrlib.branch.find_branch_root(filename)
412
def cmd_log(timezone='original'):
413
"""Show log of this branch.
415
:todo: Options for utc; to show ids; to limit range; etc.
417
Branch('.').write_log(show_timezone=timezone)
420
def cmd_ls(revision=None, verbose=False):
421
"""List files in a tree.
423
:todo: Take a revision or remote path and list that tree instead.
427
tree = b.working_tree()
429
tree = b.revision_tree(b.lookup_revision(revision))
431
for fp, fc, kind, fid in tree.list_files():
433
if kind == 'directory':
440
print '%-8s %s%s' % (fc, fp, kindch)
447
"""List unknown files"""
448
for f in Branch('.').unknowns():
453
def cmd_ignored(verbose=True):
454
"""List ignored files and the patterns that matched them.
456
tree = Branch('.').working_tree()
457
for path, file_class, kind, id in tree.list_files():
458
if file_class != 'I':
460
## XXX: Slightly inefficient since this was already calculated
461
pat = tree.is_ignored(path)
462
print '%-50s %s' % (path, pat)
465
def cmd_lookup_revision(revno):
469
bailout("usage: lookup-revision REVNO",
470
["REVNO is a non-negative revision number for this branch"])
472
print Branch('.').lookup_revision(revno) or NONE_STRING
476
def cmd_export(revno, dest):
477
"""Export past revision to destination directory."""
479
rh = b.lookup_revision(int(revno))
480
t = b.revision_tree(rh)
485
######################################################################
486
# internal/test commands
490
"""Print a newly-generated UUID."""
491
print bzrlib.osutils.uuid()
495
def cmd_local_time_offset():
496
print bzrlib.osutils.local_time_offset()
500
def cmd_commit(message=None, verbose=False):
501
"""Commit changes to a new revision.
504
Description of changes in this revision; free form text.
505
It is recommended that the first line be a single-sentence
508
Show status of changed files,
510
TODO: Commit only selected files.
512
TODO: Run hooks on tree to-be-committed, and after commit.
514
TODO: Strict commit that fails if there are unknown or deleted files.
518
bailout("please specify a commit message")
519
Branch('.').commit(message, verbose=verbose)
522
def cmd_check(dir='.'):
523
"""check: Consistency check of branch history.
525
usage: bzr check [-v] [BRANCH]
528
--verbose, -v Show progress of checking.
530
This command checks various invariants about the branch storage to
531
detect data corruption or bzr bugs.
534
bzrlib.check.check(Branch(dir, find_root=False))
537
def cmd_is(pred, *rest):
538
"""Test whether PREDICATE is true."""
540
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
542
bailout("unknown predicate: %s" % quotefn(pred))
546
except BzrCheckError:
547
# by default we don't print the message so that this can
548
# be used from shell scripts without producing noise
553
print bzrlib.osutils.username()
556
def cmd_user_email():
557
print bzrlib.osutils.user_email()
560
def cmd_gen_revision_id():
562
print bzrlib.branch._gen_revision_id(time.time())
565
def cmd_selftest(verbose=False):
566
"""Run internal test suite"""
567
## -v, if present, is seen by doctest; the argument is just here
568
## so our parser doesn't complain
570
## TODO: --verbose option
572
failures, tests = 0, 0
574
import doctest, bzrlib.store, bzrlib.tests
575
bzrlib.trace.verbose = False
577
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
578
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
579
mf, mt = doctest.testmod(m)
582
print '%-40s %3d tests' % (m.__name__, mt),
584
print '%3d FAILED!' % mf
588
print '%-40s %3d tests' % ('total', tests),
590
print '%3d FAILED!' % failures
597
cmd_doctest = cmd_selftest
600
######################################################################
604
def cmd_help(topic=None):
609
# otherwise, maybe the name of a command?
611
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
613
bailout("no help for %r" % topic)
617
bailout("sorry, no detailed help yet for %r" % topic)
625
print "bzr (bazaar-ng) %s" % bzrlib.__version__
626
print bzrlib.__copyright__
627
print "http://bazaar-ng.org/"
630
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
631
you may use, modify and redistribute it under the terms of the GNU
632
General Public License version 2 or later."""
636
"""Statement of optimism."""
637
print "it sure does!"
641
######################################################################
645
# list of all available options; the rhs can be either None for an
646
# option that takes no argument, or a constructor function that checks
666
# List of options that apply to particular commands; commands not
670
'commit': ['message', 'verbose'],
671
'deleted': ['show-ids'],
672
'diff': ['revision'],
673
'inventory': ['revision'],
675
'ls': ['revision', 'verbose'],
676
'remove': ['verbose'],
685
'export': ['revno', 'dest'],
686
'file-id': ['filename'],
687
'get-file-text': ['text_id'],
688
'get-inventory': ['inventory_id'],
689
'get-revision': ['revision_id'],
690
'get-revision-inventory': ['revision_id'],
694
'lookup-revision': ['revno'],
695
'relpath': ['filename'],
697
'root': ['filename?'],
702
def parse_args(argv):
703
"""Parse command line.
705
Arguments and options are parsed at this level before being passed
706
down to specific command handlers. This routine knows, from a
707
lookup table, something about the available options, what optargs
708
they take, and which commands will accept them.
710
>>> parse_args('--help'.split())
712
>>> parse_args('--version'.split())
713
([], {'version': True})
714
>>> parse_args('status --all'.split())
715
(['status'], {'all': True})
716
>>> parse_args('commit --message=biter'.split())
717
(['commit'], {'message': u'biter'})
722
# TODO: Maybe handle '--' to end options?
729
mutter(" got option %r" % a)
731
optname, optarg = a[2:].split('=', 1)
734
if optname not in OPTIONS:
735
bailout('unknown long option %r' % a)
738
if shortopt not in SHORT_OPTIONS:
739
bailout('unknown short option %r' % a)
740
optname = SHORT_OPTIONS[shortopt]
743
# XXX: Do we ever want to support this, e.g. for -r?
744
bailout('repeated option %r' % a)
746
optargfn = OPTIONS[optname]
750
bailout('option %r needs an argument' % a)
753
opts[optname] = optargfn(optarg)
756
bailout('option %r takes no argument' % optname)
765
def _match_args(cmd, args):
766
"""Check non-option arguments match required pattern.
768
>>> _match_args('status', ['asdasdsadasd'])
769
Traceback (most recent call last):
771
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
772
>>> _match_args('add', ['asdasdsadasd'])
773
{'file_list': ['asdasdsadasd']}
774
>>> _match_args('add', 'abc def gj'.split())
775
{'file_list': ['abc', 'def', 'gj']}
777
# match argument pattern
778
argform = cmd_args.get(cmd, [])
780
# TODO: Need a way to express 'cp SRC... DEST', where it matches
783
# step through args and argform, allowing appropriate 0-many matches
788
argdict[argname] = args.pop(0)
793
bailout("command %r needs one or more %s"
794
% (cmd, argname.upper()))
796
argdict[argname + '_list'] = args[:]
802
bailout("command %r requires argument %s"
803
% (cmd, argname.upper()))
805
argdict[argname] = args.pop(0)
808
bailout("extra arguments to command %s: %r"
816
"""Execute a command.
818
This is similar to main(), but without all the trappings for
819
logging and error handling.
822
args, opts = parse_args(argv[1:])
824
# TODO: pass down other arguments in case they asked for
825
# help on a command name?
828
elif 'version' in opts:
833
log_error('usage: bzr COMMAND\n')
834
log_error(' try "bzr help"\n')
838
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
840
bailout("unknown command " + `cmd`)
843
if 'profile' in opts:
849
# check options are reasonable
850
allowed = cmd_options.get(cmd, [])
852
if oname not in allowed:
853
bailout("option %r is not allowed for command %r"
856
# mix arguments and options into one dictionary
857
cmdargs = _match_args(cmd, args)
858
for k, v in opts.items():
859
cmdargs[k.replace('-', '_')] = v
863
prof = hotshot.Profile('.bzr.profile')
864
ret = prof.runcall(cmd_handler, **cmdargs) or 0
868
stats = hotshot.stats.load('.bzr.profile')
870
stats.sort_stats('time')
871
stats.print_stats(20)
873
return cmd_handler(**cmdargs) or 0
878
## TODO: Handle command-line options; probably know what options are valid for
881
## TODO: If the arguments are wrong, give a usage message rather
882
## than just a backtrace.
884
bzrlib.trace.create_tracefile(argv)
890
log_error('bzr: error: ' + e.args[0] + '\n')
893
log_error(' ' + h + '\n')
896
log_error('bzr: exception: %s\n' % e)
897
log_error(' see .bzr.log for details\n')
898
traceback.print_exc(None, bzrlib.trace._tracefile)
899
traceback.print_exc(None, sys.stderr)
902
# TODO: Maybe nicer handling of IOError?
906
if __name__ == '__main__':
907
sys.exit(main(sys.argv))
909
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
