4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
8
# This program is free software; you can redistribute it and/or modify
9
# it under the terms of the GNU General Public License as published by
10
# the Free Software Foundation; either version 2 of the License, or
11
# (at your option) any later version.
13
# This program is distributed in the hope that it will be useful,
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
# GNU General Public License for more details.
18
# You should have received a copy of the GNU General Public License
19
# along with this program; if not, write to the Free Software
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Show some information about this branch.
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
81
from pprint import pprint
86
from bzrlib.store import ImmutableStore
87
from bzrlib.trace import mutter, note, log_error
88
from bzrlib.errors import bailout, BzrError
89
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
90
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
91
from bzrlib.revision import Revision
92
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
98
## standard representation
99
NONE_STRING = '(none)'
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
108
## TODO: Some kind of locking on branches. Perhaps there should be a
109
## parameter to the branch object saying whether we want a read or
110
## write lock; release it from destructor. Perhaps don't even need a
111
## read lock to look at immutable objects?
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
116
## TODO: Some kind of global code to generate the right Branch object
117
## to work on. Almost, but not quite all, commands need one, and it
118
## can be taken either from their parameters or their working
123
def cmd_status(all=False):
124
"""Display status summary.
126
For each file there is a single line giving its file state and name.
127
The name is that in the current revision unless it is deleted or
128
missing, in which case the old name is shown.
130
:todo: Don't show unchanged files unless ``--all`` is given?
132
Branch('.').show_status(show_all=all)
136
######################################################################
138
def cmd_get_revision(revision_id):
139
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
142
def cmd_get_file_text(text_id):
143
"""Get contents of a file by hash."""
144
sf = Branch('.').text_store[text_id]
145
pumpfile(sf, sys.stdout)
149
######################################################################
154
"""Show number of revisions on this branch"""
155
print Branch('.').revno()
158
def cmd_add(file_list, verbose=False):
159
"""Add specified files.
161
Fails if the files are already added.
163
Branch('.').add(file_list, verbose=verbose)
166
def cmd_inventory(revision=None):
167
"""Show inventory of the current working copy."""
168
## TODO: Also optionally show a previous inventory
169
## TODO: Format options
172
inv = b.read_working_inventory()
174
inv = b.get_revision_inventory(b.lookup_revision(revision))
176
for path, entry in inv.iter_entries():
177
print '%-50s %s' % (entry.file_id, path)
183
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
185
def plural(n, base='', pl=None):
193
count_version_dirs = 0
195
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
196
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
198
count_status[fs] += 1
199
if fs not in ['I', '?'] and st_tup[4] == 'directory':
200
count_version_dirs += 1
203
print 'in the working tree:'
204
for name, fs in (('unchanged', '.'),
205
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
206
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
208
print ' %5d %s' % (count_status[fs], name)
209
print ' %5d versioned subdirector%s' % (count_version_dirs,
210
plural(count_version_dirs, 'y', 'ies'))
213
print 'branch history:'
214
history = b.revision_history()
216
print ' %5d revision%s' % (revno, plural(revno))
219
committers.add(b.get_revision(rev).committer)
220
print ' %5d committer%s' % (len(committers), plural(len(committers)))
222
firstrev = b.get_revision(history[0])
223
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
224
print ' %5d day%s old' % (age, plural(age))
225
print ' first revision: %s' % format_date(firstrev.timestamp,
228
lastrev = b.get_revision(history[-1])
229
print ' latest revision: %s' % format_date(lastrev.timestamp,
235
def cmd_remove(file_list, verbose=False):
236
Branch('.').remove(file_list, verbose=verbose)
240
def cmd_file_id(filename):
241
i = Branch('.').read_working_inventory().path2id(filename)
243
bailout("%s is not a versioned file" % filename)
248
def cmd_find_filename(fileid):
249
n = find_filename(fileid)
251
bailout("%s is not a live file id" % fileid)
256
def cmd_revision_history():
257
for patchid in Branch('.').revision_history():
263
# TODO: Check we're not already in a working directory? At the
264
# moment you'll get an ugly error.
266
# TODO: What if we're in a subdirectory of a branch? Would like
267
# to allow that, but then the parent may need to understand that
268
# the children have disappeared, or should they be versioned in
271
# TODO: Take an argument/option for branch name.
272
Branch('.', init=True)
275
def cmd_diff(revision=None):
276
"""Show diff from basis to working copy.
278
:todo: Take one or two revision arguments, look up those trees,
281
:todo: Allow diff across branches.
283
:todo: Mangle filenames in diff to be more relevant.
285
:todo: Shouldn't be in the cmd function.
291
old_tree = b.basis_tree()
293
old_tree = b.revision_tree(b.lookup_revision(revision))
295
new_tree = b.working_tree()
296
old_inv = old_tree.inventory
297
new_inv = new_tree.inventory
299
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
303
DEVNULL = '/dev/null'
304
# Windows users, don't panic about this filename -- it is a
305
# special signal to GNU patch that the file should be created or
306
# deleted respectively.
308
# TODO: Generation of pseudo-diffs for added/deleted files could
309
# be usefully made into a much faster special case.
311
# TODO: Better to return them in sorted order I think.
313
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
316
# Don't show this by default; maybe do it if an option is passed
317
# idlabel = ' {%s}' % fid
320
# FIXME: Something about the diff format makes patch unhappy
321
# with newly-added files.
323
def diffit(*a, **kw):
324
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
327
if file_state in ['.', '?', 'I']:
329
elif file_state == 'A':
330
print '*** added %s %r' % (kind, new_name)
333
new_tree.get_file(fid).readlines(),
335
tofile=new_label + new_name + idlabel)
336
elif file_state == 'D':
337
assert isinstance(old_name, types.StringTypes)
338
print '*** deleted %s %r' % (kind, old_name)
340
diffit(old_tree.get_file(fid).readlines(), [],
341
fromfile=old_label + old_name + idlabel,
343
elif file_state in ['M', 'R']:
344
if file_state == 'M':
345
assert kind == 'file'
346
assert old_name == new_name
347
print '*** modified %s %r' % (kind, new_name)
348
elif file_state == 'R':
349
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
352
diffit(old_tree.get_file(fid).readlines(),
353
new_tree.get_file(fid).readlines(),
354
fromfile=old_label + old_name + idlabel,
355
tofile=new_label + new_name)
357
bailout("can't represent state %s {%s}" % (file_state, fid))
361
def cmd_log(timezone='original'):
362
"""Show log of this branch.
364
:todo: Options for utc; to show ids; to limit range; etc.
366
Branch('.').write_log(show_timezone=timezone)
369
def cmd_ls(revision=None, verbose=False):
370
"""List files in a tree.
372
:todo: Take a revision or remote path and list that tree instead.
376
tree = b.working_tree()
378
tree = b.revision_tree(b.lookup_revision(revision))
380
for fp, fc, kind, fid in tree.list_files():
382
if kind == 'directory':
389
print '%-8s %s%s' % (fc, fp, kindch)
396
"""List unknown files"""
397
for f in Branch('.').unknowns():
401
def cmd_lookup_revision(revno):
405
bailout("usage: lookup-revision REVNO",
406
["REVNO is a non-negative revision number for this branch"])
408
print Branch('.').lookup_revision(revno) or NONE_STRING
412
def cmd_export(revno, dest):
413
"""Export past revision to destination directory."""
415
rh = b.lookup_revision(int(revno))
416
t = b.revision_tree(rh)
421
######################################################################
422
# internal/test commands
426
"""Print a newly-generated UUID."""
431
def cmd_local_time_offset():
432
print bzrlib.osutils.local_time_offset()
436
def cmd_commit(message, verbose=False):
437
Branch('.').commit(message, verbose=verbose)
441
"""Check consistency of the branch."""
445
def cmd_is(pred, *rest):
446
"""Test whether PREDICATE is true."""
448
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
450
bailout("unknown predicate: %s" % quotefn(pred))
454
except BzrCheckError:
455
# by default we don't print the message so that this can
456
# be used from shell scripts without producing noise
461
print bzrlib.osutils.username()
464
def cmd_user_email():
465
print bzrlib.osutils.user_email()
468
def cmd_gen_revision_id():
470
print bzrlib.branch._gen_revision_id(time.time())
474
"""Run internal doctest suite"""
475
## -v, if present, is seen by doctest; the argument is just here
476
## so our parser doesn't complain
478
## TODO: --verbose option
480
import bzr, doctest, bzrlib.store
481
bzrlib.trace.verbose = False
483
doctest.testmod(bzrlib.store)
484
doctest.testmod(bzrlib.inventory)
485
doctest.testmod(bzrlib.branch)
486
doctest.testmod(bzrlib.osutils)
487
doctest.testmod(bzrlib.tree)
489
# more strenuous tests;
491
doctest.testmod(bzrlib.tests)
494
######################################################################
499
# TODO: Specific help for particular commands
504
print "bzr (bazaar-ng) %s" % __version__
506
print "http://bazaar-ng.org/"
509
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
510
you may use, modify and redistribute it under the terms of the GNU
511
General Public License version 2 or later."""
515
"""Statement of optimism."""
516
print "it sure does!"
520
######################################################################
524
# list of all available options; the rhs can be either None for an
525
# option that takes no argument, or a constructor function that checks
544
# List of options that apply to particular commands; commands not
548
'commit': ['message', 'verbose'],
549
'diff': ['revision'],
550
'inventory': ['revision'],
551
'log': ['show-ids', 'timezone'],
552
'ls': ['revision', 'verbose'],
553
'remove': ['verbose'],
563
'file-id': ['filename'],
564
'get-file-text': ['text_id'],
565
'get-inventory': ['inventory_id'],
566
'get-revision': ['revision_id'],
567
'get-revision-inventory': ['revision_id'],
569
'lookup-revision': ['revno'],
570
'export': ['revno', 'dest'],
576
def parse_args(argv):
577
"""Parse command line.
579
Arguments and options are parsed at this level before being passed
580
down to specific command handlers. This routine knows, from a
581
lookup table, something about the available options, what optargs
582
they take, and which commands will accept them.
584
>>> parse_args('--help'.split())
586
>>> parse_args('--version'.split())
587
([], {'version': True})
588
>>> parse_args('status --all'.split())
589
(['status'], {'all': True})
590
>>> parse_args('commit --message=biter'.split())
591
(['commit'], {'message': u'biter'})
596
# TODO: Maybe handle '--' to end options?
603
mutter(" got option %r" % a)
605
optname, optarg = a[2:].split('=', 1)
608
if optname not in OPTIONS:
609
bailout('unknown long option %r' % a)
612
if shortopt not in SHORT_OPTIONS:
613
bailout('unknown short option %r' % a)
614
optname = SHORT_OPTIONS[shortopt]
617
# XXX: Do we ever want to support this, e.g. for -r?
618
bailout('repeated option %r' % a)
620
optargfn = OPTIONS[optname]
624
bailout('option %r needs an argument' % a)
627
opts[optname] = optargfn(optarg)
628
mutter(" option argument %r" % opts[optname])
631
bailout('option %r takes no argument' % optname)
640
def _match_args(cmd, args):
641
"""Check non-option arguments match required pattern.
643
>>> _match_args('status', ['asdasdsadasd'])
644
Traceback (most recent call last):
646
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
647
>>> _match_args('add', ['asdasdsadasd'])
648
{'file_list': ['asdasdsadasd']}
649
>>> _match_args('add', 'abc def gj'.split())
650
{'file_list': ['abc', 'def', 'gj']}
652
# match argument pattern
653
argform = cmd_args.get(cmd, [])
655
# TODO: Need a way to express 'cp SRC... DEST', where it matches
666
bailout("command %r needs one or more %s"
667
% (cmd, argname.upper()))
669
argdict[argname + '_list'] = args[:]
675
bailout("command %r requires argument %s"
676
% (cmd, argname.upper()))
678
argdict[argname] = args.pop(0)
681
bailout("extra arguments to command %s: %r"
689
"""Execute a command.
691
This is similar to main(), but without all the trappings for
692
logging and error handling.
695
args, opts = parse_args(argv[1:])
697
# TODO: pass down other arguments in case they asked for
698
# help on a command name?
701
elif 'version' in opts:
706
log_error('usage: bzr COMMAND\n')
707
log_error(' try "bzr help"\n')
711
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
713
bailout("unknown command " + `cmd`)
715
# TODO: special --profile option to turn on the Python profiler
717
# check options are reasonable
718
allowed = cmd_options.get(cmd, [])
720
if oname not in allowed:
721
bailout("option %r is not allowed for command %r"
724
cmdargs = _match_args(cmd, args)
727
ret = cmd_handler(**cmdargs) or 0
732
## TODO: Handle command-line options; probably know what options are valid for
735
## TODO: If the arguments are wrong, give a usage message rather
736
## than just a backtrace.
739
# TODO: Lift into separate function in trace.py
740
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
741
# Perhaps that should eventually go into the platform library?
742
# TODO: If the file doesn't exist, add a note describing it.
743
t = bzrlib.trace._tracefile
744
t.write('-' * 60 + '\n')
745
t.write('bzr invoked at %s\n' % format_date(time.time()))
746
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
747
t.write(' arguments: %r\n' % argv)
749
starttime = os.times()[4]
752
t.write(' platform: %s\n' % platform.platform())
753
t.write(' python: %s\n' % platform.python_version())
758
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
760
mutter(" %.3f elapsed" % (times[4] - starttime))
764
log_error('bzr: error: ' + e.args[0] + '\n')
767
log_error(' ' + h + '\n')
770
log_error('bzr: exception: %s\n' % e)
771
log_error(' see .bzr.log for details\n')
772
traceback.print_exc(None, bzrlib.trace._tracefile)
773
traceback.print_exc(None, sys.stderr)
776
# TODO: Maybe nicer handling of IOError?
780
if __name__ == '__main__':
781
sys.exit(main(sys.argv))
783
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
