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
121
## TODO: rename command, needed soon: check destination doesn't exist
122
## either in working copy or tree; move working copy; update
123
## inventory; write out
125
## TODO: move command; check destination is a directory and will not
128
## TODO: command to show renames, one per line, as to->from
133
def cmd_status(all=False):
134
"""Display status summary.
136
For each file there is a single line giving its file state and name.
137
The name is that in the current revision unless it is deleted or
138
missing, in which case the old name is shown.
140
:todo: Don't show unchanged files unless ``--all`` is given?
142
Branch('.').show_status(show_all=all)
146
######################################################################
148
def cmd_get_revision(revision_id):
149
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
152
def cmd_get_file_text(text_id):
153
"""Get contents of a file by hash."""
154
sf = Branch('.').text_store[text_id]
155
pumpfile(sf, sys.stdout)
159
######################################################################
164
"""Show number of revisions on this branch"""
165
print Branch('.').revno()
168
def cmd_add(file_list, verbose=False):
169
"""Add specified files.
171
Fails if the files are already added.
173
Branch('.').add(file_list, verbose=verbose)
176
def cmd_inventory(revision=None):
177
"""Show inventory of the current working copy."""
178
## TODO: Also optionally show a previous inventory
179
## TODO: Format options
182
inv = b.read_working_inventory()
184
inv = b.get_revision_inventory(b.lookup_revision(revision))
186
for path, entry in inv.iter_entries():
187
print '%-50s %s' % (entry.file_id, path)
193
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
195
def plural(n, base='', pl=None):
203
count_version_dirs = 0
205
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
206
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
208
count_status[fs] += 1
209
if fs not in ['I', '?'] and st_tup[4] == 'directory':
210
count_version_dirs += 1
213
print 'in the working tree:'
214
for name, fs in (('unchanged', '.'),
215
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
216
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
218
print ' %5d %s' % (count_status[fs], name)
219
print ' %5d versioned subdirector%s' % (count_version_dirs,
220
plural(count_version_dirs, 'y', 'ies'))
223
print 'branch history:'
224
history = b.revision_history()
226
print ' %5d revision%s' % (revno, plural(revno))
229
committers.add(b.get_revision(rev).committer)
230
print ' %5d committer%s' % (len(committers), plural(len(committers)))
232
firstrev = b.get_revision(history[0])
233
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
234
print ' %5d day%s old' % (age, plural(age))
235
print ' first revision: %s' % format_date(firstrev.timestamp,
238
lastrev = b.get_revision(history[-1])
239
print ' latest revision: %s' % format_date(lastrev.timestamp,
245
def cmd_remove(file_list, verbose=False):
246
Branch('.').remove(file_list, verbose=verbose)
250
def cmd_file_id(filename):
251
i = Branch('.').read_working_inventory().path2id(filename)
253
bailout("%s is not a versioned file" % filename)
258
def cmd_find_filename(fileid):
259
n = find_filename(fileid)
261
bailout("%s is not a live file id" % fileid)
266
def cmd_revision_history():
267
for patchid in Branch('.').revision_history():
273
# TODO: Check we're not already in a working directory? At the
274
# moment you'll get an ugly error.
276
# TODO: What if we're in a subdirectory of a branch? Would like
277
# to allow that, but then the parent may need to understand that
278
# the children have disappeared, or should they be versioned in
281
# TODO: Take an argument/option for branch name.
282
Branch('.', init=True)
285
def cmd_diff(revision=None):
286
"""Show diff from basis to working copy.
288
:todo: Take one or two revision arguments, look up those trees,
291
:todo: Allow diff across branches.
293
:todo: Mangle filenames in diff to be more relevant.
295
:todo: Shouldn't be in the cmd function.
301
old_tree = b.basis_tree()
303
old_tree = b.revision_tree(b.lookup_revision(revision))
305
new_tree = b.working_tree()
306
old_inv = old_tree.inventory
307
new_inv = new_tree.inventory
309
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
313
DEVNULL = '/dev/null'
314
# Windows users, don't panic about this filename -- it is a
315
# special signal to GNU patch that the file should be created or
316
# deleted respectively.
318
# TODO: Generation of pseudo-diffs for added/deleted files could
319
# be usefully made into a much faster special case.
321
# TODO: Better to return them in sorted order I think.
323
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
326
# Don't show this by default; maybe do it if an option is passed
327
# idlabel = ' {%s}' % fid
330
# FIXME: Something about the diff format makes patch unhappy
331
# with newly-added files.
333
def diffit(*a, **kw):
334
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
337
if file_state in ['.', '?', 'I']:
339
elif file_state == 'A':
340
print '*** added %s %r' % (kind, new_name)
343
new_tree.get_file(fid).readlines(),
345
tofile=new_label + new_name + idlabel)
346
elif file_state == 'D':
347
assert isinstance(old_name, types.StringTypes)
348
print '*** deleted %s %r' % (kind, old_name)
350
diffit(old_tree.get_file(fid).readlines(), [],
351
fromfile=old_label + old_name + idlabel,
353
elif file_state in ['M', 'R']:
354
if file_state == 'M':
355
assert kind == 'file'
356
assert old_name == new_name
357
print '*** modified %s %r' % (kind, new_name)
358
elif file_state == 'R':
359
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
362
diffit(old_tree.get_file(fid).readlines(),
363
new_tree.get_file(fid).readlines(),
364
fromfile=old_label + old_name + idlabel,
365
tofile=new_label + new_name)
367
bailout("can't represent state %s {%s}" % (file_state, fid))
371
def cmd_find_branch_root(filename=None):
372
print bzrlib.branch.find_branch_root(filename)
375
def cmd_log(timezone='original'):
376
"""Show log of this branch.
378
:todo: Options for utc; to show ids; to limit range; etc.
380
Branch('.').write_log(show_timezone=timezone)
383
def cmd_ls(revision=None, verbose=False):
384
"""List files in a tree.
386
:todo: Take a revision or remote path and list that tree instead.
390
tree = b.working_tree()
392
tree = b.revision_tree(b.lookup_revision(revision))
394
for fp, fc, kind, fid in tree.list_files():
396
if kind == 'directory':
403
print '%-8s %s%s' % (fc, fp, kindch)
410
"""List unknown files"""
411
for f in Branch('.').unknowns():
415
def cmd_lookup_revision(revno):
419
bailout("usage: lookup-revision REVNO",
420
["REVNO is a non-negative revision number for this branch"])
422
print Branch('.').lookup_revision(revno) or NONE_STRING
426
def cmd_export(revno, dest):
427
"""Export past revision to destination directory."""
429
rh = b.lookup_revision(int(revno))
430
t = b.revision_tree(rh)
435
######################################################################
436
# internal/test commands
440
"""Print a newly-generated UUID."""
445
def cmd_local_time_offset():
446
print bzrlib.osutils.local_time_offset()
450
def cmd_commit(message=None, verbose=False):
452
bailout("please specify a commit message")
453
Branch('.').commit(message, verbose=verbose)
457
"""Check consistency of the branch."""
461
def cmd_is(pred, *rest):
462
"""Test whether PREDICATE is true."""
464
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
466
bailout("unknown predicate: %s" % quotefn(pred))
470
except BzrCheckError:
471
# by default we don't print the message so that this can
472
# be used from shell scripts without producing noise
477
print bzrlib.osutils.username()
480
def cmd_user_email():
481
print bzrlib.osutils.user_email()
484
def cmd_gen_revision_id():
486
print bzrlib.branch._gen_revision_id(time.time())
489
def cmd_selftest(verbose=False):
490
"""Run internal test suite"""
491
## -v, if present, is seen by doctest; the argument is just here
492
## so our parser doesn't complain
494
## TODO: --verbose option
496
failures, tests = 0, 0
498
import doctest, bzrlib.store, bzrlib.tests
499
bzrlib.trace.verbose = False
501
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
502
bzrlib.tree, bzrlib.tests, bzrlib.commands:
503
mf, mt = doctest.testmod(m)
506
print '%-40s %3d tests' % (m.__name__, mt),
508
print '%3d FAILED!' % mf
512
print '%-40s %3d tests' % ('total', tests),
514
print '%3d FAILED!' % failures
521
cmd_doctest = cmd_selftest
524
######################################################################
529
# TODO: Specific help for particular commands
534
print "bzr (bazaar-ng) %s" % __version__
536
print "http://bazaar-ng.org/"
539
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
540
you may use, modify and redistribute it under the terms of the GNU
541
General Public License version 2 or later."""
545
"""Statement of optimism."""
546
print "it sure does!"
550
######################################################################
554
# list of all available options; the rhs can be either None for an
555
# option that takes no argument, or a constructor function that checks
574
# List of options that apply to particular commands; commands not
578
'commit': ['message', 'verbose'],
579
'diff': ['revision'],
580
'inventory': ['revision'],
581
'log': ['show-ids', 'timezone'],
582
'ls': ['revision', 'verbose'],
583
'remove': ['verbose'],
593
'file-id': ['filename'],
594
'find-branch-root': ['filename?'],
595
'get-file-text': ['text_id'],
596
'get-inventory': ['inventory_id'],
597
'get-revision': ['revision_id'],
598
'get-revision-inventory': ['revision_id'],
600
'lookup-revision': ['revno'],
601
'export': ['revno', 'dest'],
607
def parse_args(argv):
608
"""Parse command line.
610
Arguments and options are parsed at this level before being passed
611
down to specific command handlers. This routine knows, from a
612
lookup table, something about the available options, what optargs
613
they take, and which commands will accept them.
615
>>> parse_args('--help'.split())
617
>>> parse_args('--version'.split())
618
([], {'version': True})
619
>>> parse_args('status --all'.split())
620
(['status'], {'all': True})
621
>>> parse_args('commit --message=biter'.split())
622
(['commit'], {'message': u'biter'})
627
# TODO: Maybe handle '--' to end options?
634
mutter(" got option %r" % a)
636
optname, optarg = a[2:].split('=', 1)
639
if optname not in OPTIONS:
640
bailout('unknown long option %r' % a)
643
if shortopt not in SHORT_OPTIONS:
644
bailout('unknown short option %r' % a)
645
optname = SHORT_OPTIONS[shortopt]
648
# XXX: Do we ever want to support this, e.g. for -r?
649
bailout('repeated option %r' % a)
651
optargfn = OPTIONS[optname]
655
bailout('option %r needs an argument' % a)
658
opts[optname] = optargfn(optarg)
659
mutter(" option argument %r" % opts[optname])
662
bailout('option %r takes no argument' % optname)
671
def _match_args(cmd, args):
672
"""Check non-option arguments match required pattern.
674
>>> _match_args('status', ['asdasdsadasd'])
675
Traceback (most recent call last):
677
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
678
>>> _match_args('add', ['asdasdsadasd'])
679
{'file_list': ['asdasdsadasd']}
680
>>> _match_args('add', 'abc def gj'.split())
681
{'file_list': ['abc', 'def', 'gj']}
683
# match argument pattern
684
argform = cmd_args.get(cmd, [])
686
# TODO: Need a way to express 'cp SRC... DEST', where it matches
689
# step through args and argform, allowing appropriate 0-many matches
694
argdict[argname] = args.pop(0)
699
bailout("command %r needs one or more %s"
700
% (cmd, argname.upper()))
702
argdict[argname + '_list'] = args[:]
708
bailout("command %r requires argument %s"
709
% (cmd, argname.upper()))
711
argdict[argname] = args.pop(0)
714
bailout("extra arguments to command %s: %r"
722
"""Execute a command.
724
This is similar to main(), but without all the trappings for
725
logging and error handling.
728
args, opts = parse_args(argv[1:])
730
# TODO: pass down other arguments in case they asked for
731
# help on a command name?
734
elif 'version' in opts:
739
log_error('usage: bzr COMMAND\n')
740
log_error(' try "bzr help"\n')
744
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
746
bailout("unknown command " + `cmd`)
748
# TODO: special --profile option to turn on the Python profiler
750
# check options are reasonable
751
allowed = cmd_options.get(cmd, [])
753
if oname not in allowed:
754
bailout("option %r is not allowed for command %r"
757
cmdargs = _match_args(cmd, args)
760
ret = cmd_handler(**cmdargs) or 0
765
## TODO: Handle command-line options; probably know what options are valid for
768
## TODO: If the arguments are wrong, give a usage message rather
769
## than just a backtrace.
771
bzrlib.trace.create_tracefile(argv)
777
log_error('bzr: error: ' + e.args[0] + '\n')
780
log_error(' ' + h + '\n')
783
log_error('bzr: exception: %s\n' % e)
784
log_error(' see .bzr.log for details\n')
785
traceback.print_exc(None, bzrlib.trace._tracefile)
786
traceback.print_exc(None, sys.stderr)
789
# TODO: Maybe nicer handling of IOError?
793
if __name__ == '__main__':
794
sys.exit(main(sys.argv))
796
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
