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
# Run internal consistency checks.
69
# Show some information about this branch.
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
83
from pprint import pprint
88
from bzrlib.store import ImmutableStore
89
from bzrlib.trace import mutter, note, log_error
90
from bzrlib.errors import bailout, BzrError
91
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
92
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
93
from bzrlib.revision import Revision
94
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
97
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
98
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
100
## standard representation
101
NONE_STRING = '(none)'
105
## TODO: Perhaps a different version of inventory commands that
106
## returns iterators...
108
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
110
## TODO: Some kind of locking on branches. Perhaps there should be a
111
## parameter to the branch object saying whether we want a read or
112
## write lock; release it from destructor. Perhaps don't even need a
113
## read lock to look at immutable objects?
115
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
116
## to compare output?
121
######################################################################
125
def cmd_status(all=False):
126
"""Display status summary.
128
For each file there is a single line giving its file state and name.
129
The name is that in the current revision unless it is deleted or
130
missing, in which case the old name is shown.
132
:todo: Don't show unchanged files unless ``--all`` is given?
134
Branch('.').show_status(show_all=all)
138
######################################################################
140
def cmd_get_revision(revision_id):
141
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
144
def cmd_get_inventory(inventory_id):
145
"""Return inventory in XML by hash"""
146
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
149
def cmd_get_revision_inventory(revision_id):
150
"""Output inventory for a revision."""
152
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
155
def cmd_get_file_text(text_id):
156
"""Get contents of a file by hash."""
157
sf = Branch('.').text_store[text_id]
158
pumpfile(sf, sys.stdout)
162
######################################################################
167
"""Show number of revisions on this branch"""
168
print Branch('.').revno()
171
def cmd_add(file_list, verbose=False):
172
"""Add specified files.
174
Fails if the files are already added.
176
Branch('.').add(file_list, verbose=verbose)
179
def cmd_inventory(revision=None):
180
"""Show inventory of the current working copy."""
181
## TODO: Also optionally show a previous inventory
182
## TODO: Format options
185
inv = b.read_working_inventory()
187
inv = b.get_revision_inventory(b.lookup_revision(revision))
189
for path, entry in inv.iter_entries():
190
print '%-50s %s' % (entry.file_id, path)
196
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
197
print 'revision number:', b.revno()
199
count_version_dirs = 0
201
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
202
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
204
count_status[fs] += 1
205
if fs not in ['I', '?'] and st_tup[4] == 'directory':
206
count_version_dirs += 1
209
print 'in the working tree:'
210
for name, fs in (('unchanged', '.'),
211
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
212
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
214
print ' %5d %s' % (count_status[fs], name)
215
print ' %5d versioned subdirectories' % count_version_dirs
219
def cmd_remove(file_list, verbose=False):
220
Branch('.').remove(file_list, verbose=verbose)
224
def cmd_file_id(filename):
225
i = Branch('.').read_working_inventory().path2id(filename)
227
bailout("%s is not a versioned file" % filename)
232
def cmd_find_filename(fileid):
233
n = find_filename(fileid)
235
bailout("%s is not a live file id" % fileid)
240
def cmd_revision_history():
241
for patchid in Branch('.').revision_history():
247
# TODO: Check we're not already in a working directory? At the
248
# moment you'll get an ugly error.
250
# TODO: What if we're in a subdirectory of a branch? Would like
251
# to allow that, but then the parent may need to understand that
252
# the children have disappeared, or should they be versioned in
255
# TODO: Take an argument/option for branch name.
256
Branch('.', init=True)
259
def cmd_diff(revision=None):
260
"""Show diff from basis to working copy.
262
:todo: Take one or two revision arguments, look up those trees,
265
:todo: Allow diff across branches.
267
:todo: Mangle filenames in diff to be more relevant.
269
:todo: Shouldn't be in the cmd function.
275
old_tree = b.basis_tree()
277
old_tree = b.revision_tree(b.lookup_revision(revision))
279
new_tree = b.working_tree()
280
old_inv = old_tree.inventory
281
new_inv = new_tree.inventory
283
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
287
DEVNULL = '/dev/null'
288
# Windows users, don't panic about this filename -- it is a
289
# special signal to GNU patch that the file should be created or
290
# deleted respectively.
292
# TODO: Generation of pseudo-diffs for added/deleted files could
293
# be usefully made into a much faster special case.
295
# TODO: Better to return them in sorted order I think.
297
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
300
# Don't show this by default; maybe do it if an option is passed
301
# idlabel = ' {%s}' % fid
304
# FIXME: Something about the diff format makes patch unhappy
305
# with newly-added files.
307
def diffit(*a, **kw):
308
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
311
if file_state in ['.', '?', 'I']:
313
elif file_state == 'A':
314
print '*** added %s %r' % (kind, new_name)
317
new_tree.get_file(fid).readlines(),
319
tofile=new_label + new_name + idlabel)
320
elif file_state == 'D':
321
assert isinstance(old_name, types.StringTypes)
322
print '*** deleted %s %r' % (kind, old_name)
324
diffit(old_tree.get_file(fid).readlines(), [],
325
fromfile=old_label + old_name + idlabel,
327
elif file_state in ['M', 'R']:
328
if file_state == 'M':
329
assert kind == 'file'
330
assert old_name == new_name
331
print '*** modified %s %r' % (kind, new_name)
332
elif file_state == 'R':
333
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
336
diffit(old_tree.get_file(fid).readlines(),
337
new_tree.get_file(fid).readlines(),
338
fromfile=old_label + old_name + idlabel,
339
tofile=new_label + new_name)
341
bailout("can't represent state %s {%s}" % (file_state, fid))
345
def cmd_log(timezone='original'):
346
"""Show log of this branch.
348
:todo: Options for utc; to show ids; to limit range; etc.
350
Branch('.').write_log(show_timezone=timezone)
353
def cmd_ls(revision=None, verbose=False):
354
"""List files in a tree.
356
:todo: Take a revision or remote path and list that tree instead.
360
tree = b.working_tree()
362
tree = b.revision_tree(b.lookup_revision(revision))
364
for fp, fc, kind, fid in tree.list_files():
366
if kind == 'directory':
373
print '%-8s %s%s' % (fc, fp, kindch)
380
"""List unknown files"""
381
for f in Branch('.').unknowns():
385
def cmd_lookup_revision(revno):
389
bailout("usage: lookup-revision REVNO",
390
["REVNO is a non-negative revision number for this branch"])
392
print Branch('.').lookup_revision(revno) or NONE_STRING
396
def cmd_export(revno, dest):
397
"""Export past revision to destination directory."""
399
rh = b.lookup_revision(int(revno))
400
t = b.revision_tree(rh)
405
######################################################################
406
# internal/test commands
410
"""Print a newly-generated UUID."""
415
def cmd_local_time_offset():
416
print bzrlib.osutils.local_time_offset()
420
def cmd_commit(message, verbose=False):
421
Branch('.').commit(message, verbose=verbose)
425
"""Check consistency of the branch."""
429
def cmd_is(pred, *rest):
430
"""Test whether PREDICATE is true."""
432
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
434
bailout("unknown predicate: %s" % quotefn(pred))
438
except BzrCheckError:
439
# by default we don't print the message so that this can
440
# be used from shell scripts without producing noise
445
print bzrlib.osutils.username()
448
def cmd_user_email():
449
print bzrlib.osutils.user_email()
452
def cmd_gen_revision_id():
454
print bzrlib.branch._gen_revision_id(time.time())
458
"""Run internal doctest suite"""
459
## -v, if present, is seen by doctest; the argument is just here
460
## so our parser doesn't complain
462
## TODO: --verbose option
464
import bzr, doctest, bzrlib.store
465
bzrlib.trace.verbose = False
467
doctest.testmod(bzrlib.store)
468
doctest.testmod(bzrlib.inventory)
469
doctest.testmod(bzrlib.branch)
470
doctest.testmod(bzrlib.osutils)
471
doctest.testmod(bzrlib.tree)
473
# more strenuous tests;
475
doctest.testmod(bzrlib.tests)
478
######################################################################
483
# TODO: Specific help for particular commands
488
print "bzr (bazaar-ng) %s" % __version__
490
print "http://bazaar-ng.org/"
493
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
494
you may use, modify and redistribute it under the terms of the GNU
495
General Public License version 2 or later."""
499
"""Statement of optimism."""
500
print "it sure does!"
504
######################################################################
508
# list of all available options; the rhs can be either None for an
509
# option that takes no argument, or a constructor function that checks
528
# List of options that apply to particular commands; commands not
532
'commit': ['message', 'verbose'],
533
'diff': ['revision'],
534
'inventory': ['revision'],
535
'log': ['show-ids', 'timezone'],
536
'ls': ['revision', 'verbose'],
537
'remove': ['verbose'],
547
'file-id': ['filename'],
548
'get-file-text': ['text_id'],
549
'get-inventory': ['inventory_id'],
550
'get-revision': ['revision_id'],
551
'get-revision-inventory': ['revision_id'],
553
'lookup-revision': ['revno'],
554
'export': ['revno', 'dest'],
560
def parse_args(argv):
561
"""Parse command line.
563
Arguments and options are parsed at this level before being passed
564
down to specific command handlers. This routine knows, from a
565
lookup table, something about the available options, what optargs
566
they take, and which commands will accept them.
568
>>> parse_args('bzr --help'.split())
570
>>> parse_args('bzr --version'.split())
571
([], {'version': True})
572
>>> parse_args('bzr status --all'.split())
573
(['status'], {'all': True})
574
>>> parse_args('bzr commit --message=biter'.split())
575
(['commit'], {'message': u'biter'})
580
# TODO: Maybe handle '--' to end options?
588
mutter(" got option %r" % a)
590
optname, optarg = a[2:].split('=', 1)
593
if optname not in OPTIONS:
594
bailout('unknown long option %r' % a)
597
if shortopt not in SHORT_OPTIONS:
598
bailout('unknown short option %r' % a)
599
optname = SHORT_OPTIONS[shortopt]
602
# XXX: Do we ever want to support this, e.g. for -r?
603
bailout('repeated option %r' % a)
605
optargfn = OPTIONS[optname]
609
bailout('option %r needs an argument' % a)
612
opts[optname] = optargfn(optarg)
613
mutter(" option argument %r" % opts[optname])
616
bailout('option %r takes no argument' % optname)
625
def _match_args(cmd, args):
626
"""Check non-option arguments match required pattern.
628
>>> _match_args('status', ['asdasdsadasd'])
629
Traceback (most recent call last):
631
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
632
>>> _match_args('add', ['asdasdsadasd'])
633
{'file_list': ['asdasdsadasd']}
634
>>> _match_args('add', 'abc def gj'.split())
635
{'file_list': ['abc', 'def', 'gj']}
637
# match argument pattern
638
argform = cmd_args.get(cmd, [])
640
# TODO: Need a way to express 'cp SRC... DEST', where it matches
650
bailout("command %r needs one or more %s"
651
% (cmd, argname.upper()))
653
argdict[argname + '_list'] = args[:]
659
bailout("command %r requires argument %s"
660
% (cmd, argname.upper()))
662
argdict[argname] = args.pop(0)
665
bailout("extra arguments to command %s: %r"
673
"""Execute a command.
675
This is similar to main(), but without all the trappings for
676
logging and error handling.
679
args, opts = parse_args(argv)
681
# TODO: pass down other arguments in case they asked for
682
# help on a command name?
685
elif 'version' in opts:
690
log_error('usage: bzr COMMAND\n')
691
log_error(' try "bzr help"\n')
695
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
697
bailout("unknown command " + `cmd`)
699
# TODO: special --profile option to turn on the Python profiler
701
# check options are reasonable
702
allowed = cmd_options.get(cmd, [])
704
if oname not in allowed:
705
bailout("option %r is not allowed for command %r"
708
cmdargs = _match_args(cmd, args)
711
ret = cmd_handler(**cmdargs) or 0
716
## TODO: Handle command-line options; probably know what options are valid for
719
## TODO: If the arguments are wrong, give a usage message rather
720
## than just a backtrace.
723
t = bzrlib.trace._tracefile
724
t.write('-' * 60 + '\n')
725
t.write('bzr invoked at %s\n' % format_date(time.time()))
726
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
727
t.write(' arguments: %r\n' % argv)
729
starttime = os.times()[4]
732
t.write(' platform: %s\n' % platform.platform())
733
t.write(' python: %s\n' % platform.python_version())
738
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
740
mutter(" %.3f elapsed" % (times[4] - starttime))
744
log_error('bzr: error: ' + e.args[0] + '\n')
747
log_error(' ' + h + '\n')
750
log_error('bzr: exception: %s\n' % e)
751
log_error(' see .bzr.log for details\n')
752
traceback.print_exc(None, bzrlib.trace._tracefile)
753
traceback.print_exc(None, sys.stderr)
756
# TODO: Maybe nicer handling of IOError?
760
if __name__ == '__main__':
761
sys.exit(main(sys.argv))
763
##profile.run('main(sys.argv)')
added
removed
bzr.py
