To get this branch, use:
bzr branch
http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 56
- compare with another revision
- download diff
- download tarball
- view history from revision 56
- Committer: mbp at sourcefrog
- Date: 2005-03-22 00:21:11 UTC
- Revision ID: mbp@sourcefrog.net-20050322002111-c7f303d8fe447057
more add tests
- files added:
- .bzrignore
- bzrlib
- doc
- notes
- files removed:
- .bzrignore
- notes
- tests
added
removed
bzrlib/commands.py
1
#! /usr/bin/python
2
3
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
6
7
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.
12
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.
17
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
21
22
"""Bazaar-NG -- a free distributed version-control tool
23
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
25
26
Current limitation include:
27
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
30
31
* No handling of subdirectories, symlinks or any non-text files.
32
33
* Insufficient error handling.
34
35
* Many commands unimplemented or partially implemented.
36
37
* Space-inefficient storage.
38
39
* No merge operators yet.
40
41
Interesting commands::
42
43
bzr help
44
Show summary help screen
45
bzr version
46
Show software version/licence/non-warranty.
47
bzr init
48
Start versioning the current directory
49
bzr add FILE...
50
Make files versioned.
51
bzr log
52
Show revision history.
53
bzr diff
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.
59
bzr status
60
Show summary of pending changes.
61
bzr remove FILE...
62
Make a file not versioned.
63
"""
64
65
# not currently working:
66
# bzr info
67
# Show some information about this branch.
68
69
70
71
__copyright__ = "Copyright 2005 Canonical Development Ltd."
72
__author__ = "Martin Pool <mbp@canonical.com>"
73
__docformat__ = "restructuredtext en"
74
__version__ = '0.0.0'
75
76
77
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
78
import traceback, socket, fnmatch, difflib
79
from os import path
80
from sets import Set
81
from pprint import pprint
82
from stat import *
83
from glob import glob
84
85
import bzrlib
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, \
93
format_date
94
95
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
96
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
97
98
## standard representation
99
NONE_STRING = '(none)'
100
EMPTY = 'empty'
101
102
103
## TODO: Perhaps a different version of inventory commands that
104
## returns iterators...
105
106
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
107
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?
112
113
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
114
## to compare output?
115
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
119
## directory.
120
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
124
125
## TODO: move command; check destination is a directory and will not
126
## clash; move it.
127
128
## TODO: command to show renames, one per line, as to->from
129
130
131
132
133
def cmd_status(all=False):
134
"""Display status summary.
135
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.
139
140
:todo: Don't show unchanged files unless ``--all`` is given?
141
"""
142
Branch('.').show_status(show_all=all)
143
144
145
146
######################################################################
147
# examining history
148
def cmd_get_revision(revision_id):
149
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
150
151
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)
156
157
158
159
######################################################################
160
# commands
161
162
163
def cmd_revno():
164
"""Show number of revisions on this branch"""
165
print Branch('.').revno()
166
167
168
def cmd_add(file_list, verbose=False):
169
"""Add specified files.
170
171
Fails if the files are already added.
172
"""
173
Branch('.').add(file_list, verbose=verbose)
174
175
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
180
b = Branch('.')
181
if revision == None:
182
inv = b.read_working_inventory()
183
else:
184
inv = b.get_revision_inventory(b.lookup_revision(revision))
185
186
for path, entry in inv.iter_entries():
187
print '%-50s %s' % (entry.file_id, path)
188
189
190
191
def cmd_info():
192
b = Branch('.')
193
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
194
195
def plural(n, base='', pl=None):
196
if n == 1:
197
return base
198
elif pl is not None:
199
return pl
200
else:
201
return 's'
202
203
count_version_dirs = 0
204
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()):
207
fs = st_tup[0]
208
count_status[fs] += 1
209
if fs not in ['I', '?'] and st_tup[4] == 'directory':
210
count_version_dirs += 1
211
212
print
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'),
217
):
218
print ' %5d %s' % (count_status[fs], name)
219
print ' %5d versioned subdirector%s' % (count_version_dirs,
220
plural(count_version_dirs, 'y', 'ies'))
221
222
print
223
print 'branch history:'
224
history = b.revision_history()
225
revno = len(history)
226
print ' %5d revision%s' % (revno, plural(revno))
227
committers = Set()
228
for rev in history:
229
committers.add(b.get_revision(rev).committer)
230
print ' %5d committer%s' % (len(committers), plural(len(committers)))
231
if revno > 0:
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,
236
firstrev.timezone)
237
238
lastrev = b.get_revision(history[-1])
239
print ' latest revision: %s' % format_date(lastrev.timestamp,
240
lastrev.timezone)
241
242
243
244
245
def cmd_remove(file_list, verbose=False):
246
Branch('.').remove(file_list, verbose=verbose)
247
248
249
250
def cmd_file_id(filename):
251
i = Branch('.').read_working_inventory().path2id(filename)
252
if i is None:
253
bailout("%s is not a versioned file" % filename)
254
else:
255
print i
256
257
258
def cmd_find_filename(fileid):
259
n = find_filename(fileid)
260
if n is None:
261
bailout("%s is not a live file id" % fileid)
262
else:
263
print n
264
265
266
def cmd_revision_history():
267
for patchid in Branch('.').revision_history():
268
print patchid
269
270
271
272
def cmd_init():
273
# TODO: Check we're not already in a working directory? At the
274
# moment you'll get an ugly error.
275
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
279
# both?
280
281
# TODO: Take an argument/option for branch name.
282
Branch('.', init=True)
283
284
285
def cmd_diff(revision=None):
286
"""Show diff from basis to working copy.
287
288
:todo: Take one or two revision arguments, look up those trees,
289
and diff them.
290
291
:todo: Allow diff across branches.
292
293
:todo: Mangle filenames in diff to be more relevant.
294
295
:todo: Shouldn't be in the cmd function.
296
"""
297
298
b = Branch('.')
299
300
if revision == None:
301
old_tree = b.basis_tree()
302
else:
303
old_tree = b.revision_tree(b.lookup_revision(revision))
304
305
new_tree = b.working_tree()
306
old_inv = old_tree.inventory
307
new_inv = new_tree.inventory
308
309
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
310
old_label = ''
311
new_label = ''
312
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.
317
318
# TODO: Generation of pseudo-diffs for added/deleted files could
319
# be usefully made into a much faster special case.
320
321
# TODO: Better to return them in sorted order I think.
322
323
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
324
d = None
325
326
# Don't show this by default; maybe do it if an option is passed
327
# idlabel = ' {%s}' % fid
328
idlabel = ''
329
330
# FIXME: Something about the diff format makes patch unhappy
331
# with newly-added files.
332
333
def diffit(*a, **kw):
334
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
335
print
336
337
if file_state in ['.', '?', 'I']:
338
continue
339
elif file_state == 'A':
340
print '*** added %s %r' % (kind, new_name)
341
if kind == 'file':
342
diffit([],
343
new_tree.get_file(fid).readlines(),
344
fromfile=DEVNULL,
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)
349
if kind == 'file':
350
diffit(old_tree.get_file(fid).readlines(), [],
351
fromfile=old_label + old_name + idlabel,
352
tofile=DEVNULL)
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)
360
361
if kind == 'file':
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)
366
else:
367
bailout("can't represent state %s {%s}" % (file_state, fid))
368
369
370
371
def cmd_log(timezone='original'):
372
"""Show log of this branch.
373
374
:todo: Options for utc; to show ids; to limit range; etc.
375
"""
376
Branch('.').write_log(show_timezone=timezone)
377
378
379
def cmd_ls(revision=None, verbose=False):
380
"""List files in a tree.
381
382
:todo: Take a revision or remote path and list that tree instead.
383
"""
384
b = Branch('.')
385
if revision == None:
386
tree = b.working_tree()
387
else:
388
tree = b.revision_tree(b.lookup_revision(revision))
389
390
for fp, fc, kind, fid in tree.list_files():
391
if verbose:
392
if kind == 'directory':
393
kindch = '/'
394
elif kind == 'file':
395
kindch = ''
396
else:
397
kindch = '???'
398
399
print '%-8s %s%s' % (fc, fp, kindch)
400
else:
401
print fp
402
403
404
405
def cmd_unknowns():
406
"""List unknown files"""
407
for f in Branch('.').unknowns():
408
print quotefn(f)
409
410
411
def cmd_lookup_revision(revno):
412
try:
413
revno = int(revno)
414
except ValueError:
415
bailout("usage: lookup-revision REVNO",
416
["REVNO is a non-negative revision number for this branch"])
417
418
print Branch('.').lookup_revision(revno) or NONE_STRING
419
420
421
422
def cmd_export(revno, dest):
423
"""Export past revision to destination directory."""
424
b = Branch('.')
425
rh = b.lookup_revision(int(revno))
426
t = b.revision_tree(rh)
427
t.export(dest)
428
429
430
431
######################################################################
432
# internal/test commands
433
434
435
def cmd_uuid():
436
"""Print a newly-generated UUID."""
437
print uuid()
438
439
440
441
def cmd_local_time_offset():
442
print bzrlib.osutils.local_time_offset()
443
444
445
446
def cmd_commit(message, verbose=False):
447
Branch('.').commit(message, verbose=verbose)
448
449
450
def cmd_check():
451
"""Check consistency of the branch."""
452
check()
453
454
455
def cmd_is(pred, *rest):
456
"""Test whether PREDICATE is true."""
457
try:
458
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
459
except KeyError:
460
bailout("unknown predicate: %s" % quotefn(pred))
461
462
try:
463
cmd_handler(*rest)
464
except BzrCheckError:
465
# by default we don't print the message so that this can
466
# be used from shell scripts without producing noise
467
sys.exit(1)
468
469
470
def cmd_username():
471
print bzrlib.osutils.username()
472
473
474
def cmd_user_email():
475
print bzrlib.osutils.user_email()
476
477
478
def cmd_gen_revision_id():
479
import time
480
print bzrlib.branch._gen_revision_id(time.time())
481
482
483
def cmd_selftest(verbose=False):
484
"""Run internal test suite"""
485
## -v, if present, is seen by doctest; the argument is just here
486
## so our parser doesn't complain
487
488
## TODO: --verbose option
489
490
failures, tests = 0, 0
491
492
import doctest, bzrlib.store, bzrlib.tests
493
bzrlib.trace.verbose = False
494
495
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
496
bzrlib.tree, bzrlib.tests:
497
mf, mt = doctest.testmod(m)
498
failures += mf
499
tests += mt
500
print '%-40s %3d tests' % (m.__name__, mt),
501
if mf:
502
print '%3d FAILED!' % mf
503
else:
504
print
505
506
print '%-40s %3d tests' % ('total', tests),
507
if failures:
508
print '%3d FAILED!' % failures
509
else:
510
print
511
512
513
514
# deprecated
515
cmd_doctest = cmd_selftest
516
517
518
######################################################################
519
# help
520
521
522
def cmd_help():
523
# TODO: Specific help for particular commands
524
print __doc__
525
526
527
def cmd_version():
528
print "bzr (bazaar-ng) %s" % __version__
529
print __copyright__
530
print "http://bazaar-ng.org/"
531
print
532
print \
533
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
534
you may use, modify and redistribute it under the terms of the GNU
535
General Public License version 2 or later."""
536
537
538
def cmd_rocks():
539
"""Statement of optimism."""
540
print "it sure does!"
541
542
543
544
######################################################################
545
# main routine
546
547
548
# list of all available options; the rhs can be either None for an
549
# option that takes no argument, or a constructor function that checks
550
# the type.
551
OPTIONS = {
552
'all': None,
553
'help': None,
554
'message': unicode,
555
'revision': int,
556
'show-ids': None,
557
'timezone': str,
558
'verbose': None,
559
'version': None,
560
}
561
562
SHORT_OPTIONS = {
563
'm': 'message',
564
'r': 'revision',
565
'v': 'verbose',
566
}
567
568
# List of options that apply to particular commands; commands not
569
# listed take none.
570
cmd_options = {
571
'add': ['verbose'],
572
'commit': ['message', 'verbose'],
573
'diff': ['revision'],
574
'inventory': ['revision'],
575
'log': ['show-ids', 'timezone'],
576
'ls': ['revision', 'verbose'],
577
'remove': ['verbose'],
578
'status': ['all'],
579
}
580
581
582
cmd_args = {
583
'init': [],
584
'add': ['file+'],
585
'commit': [],
586
'diff': [],
587
'file-id': ['filename'],
588
'get-file-text': ['text_id'],
589
'get-inventory': ['inventory_id'],
590
'get-revision': ['revision_id'],
591
'get-revision-inventory': ['revision_id'],
592
'log': [],
593
'lookup-revision': ['revno'],
594
'export': ['revno', 'dest'],
595
'remove': ['file+'],
596
'status': [],
597
}
598
599
600
def parse_args(argv):
601
"""Parse command line.
602
603
Arguments and options are parsed at this level before being passed
604
down to specific command handlers. This routine knows, from a
605
lookup table, something about the available options, what optargs
606
they take, and which commands will accept them.
607
608
>>> parse_args('--help'.split())
609
([], {'help': True})
610
>>> parse_args('--version'.split())
611
([], {'version': True})
612
>>> parse_args('status --all'.split())
613
(['status'], {'all': True})
614
>>> parse_args('commit --message=biter'.split())
615
(['commit'], {'message': u'biter'})
616
"""
617
args = []
618
opts = {}
619
620
# TODO: Maybe handle '--' to end options?
621
622
while argv:
623
a = argv.pop(0)
624
if a[0] == '-':
625
optarg = None
626
if a[1] == '-':
627
mutter(" got option %r" % a)
628
if '=' in a:
629
optname, optarg = a[2:].split('=', 1)
630
else:
631
optname = a[2:]
632
if optname not in OPTIONS:
633
bailout('unknown long option %r' % a)
634
else:
635
shortopt = a[1:]
636
if shortopt not in SHORT_OPTIONS:
637
bailout('unknown short option %r' % a)
638
optname = SHORT_OPTIONS[shortopt]
639
640
if optname in opts:
641
# XXX: Do we ever want to support this, e.g. for -r?
642
bailout('repeated option %r' % a)
643
644
optargfn = OPTIONS[optname]
645
if optargfn:
646
if optarg == None:
647
if not argv:
648
bailout('option %r needs an argument' % a)
649
else:
650
optarg = argv.pop(0)
651
opts[optname] = optargfn(optarg)
652
mutter(" option argument %r" % opts[optname])
653
else:
654
if optarg != None:
655
bailout('option %r takes no argument' % optname)
656
opts[optname] = True
657
else:
658
args.append(a)
659
660
return args, opts
661
662
663
664
def _match_args(cmd, args):
665
"""Check non-option arguments match required pattern.
666
667
>>> _match_args('status', ['asdasdsadasd'])
668
Traceback (most recent call last):
669
...
670
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
671
>>> _match_args('add', ['asdasdsadasd'])
672
{'file_list': ['asdasdsadasd']}
673
>>> _match_args('add', 'abc def gj'.split())
674
{'file_list': ['abc', 'def', 'gj']}
675
"""
676
# match argument pattern
677
argform = cmd_args.get(cmd, [])
678
argdict = {}
679
# TODO: Need a way to express 'cp SRC... DEST', where it matches
680
# all but one.
681
682
for ap in argform:
683
argname = ap[:-1]
684
if ap[-1] == '?':
685
assert 0
686
elif ap[-1] == '*':
687
assert 0
688
elif ap[-1] == '+':
689
if not args:
690
bailout("command %r needs one or more %s"
691
% (cmd, argname.upper()))
692
else:
693
argdict[argname + '_list'] = args[:]
694
args = []
695
else:
696
# just a plain arg
697
argname = ap
698
if not args:
699
bailout("command %r requires argument %s"
700
% (cmd, argname.upper()))
701
else:
702
argdict[argname] = args.pop(0)
703
704
if args:
705
bailout("extra arguments to command %s: %r"
706
% (cmd, args))
707
708
return argdict
709
710
711
712
def run_bzr(argv):
713
"""Execute a command.
714
715
This is similar to main(), but without all the trappings for
716
logging and error handling.
717
"""
718
try:
719
args, opts = parse_args(argv[1:])
720
if 'help' in opts:
721
# TODO: pass down other arguments in case they asked for
722
# help on a command name?
723
cmd_help()
724
return 0
725
elif 'version' in opts:
726
cmd_version()
727
return 0
728
cmd = args.pop(0)
729
except IndexError:
730
log_error('usage: bzr COMMAND\n')
731
log_error(' try "bzr help"\n')
732
return 1
733
734
try:
735
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
736
except KeyError:
737
bailout("unknown command " + `cmd`)
738
739
# TODO: special --profile option to turn on the Python profiler
740
741
# check options are reasonable
742
allowed = cmd_options.get(cmd, [])
743
for oname in opts:
744
if oname not in allowed:
745
bailout("option %r is not allowed for command %r"
746
% (oname, cmd))
747
748
cmdargs = _match_args(cmd, args)
749
cmdargs.update(opts)
750
751
ret = cmd_handler(**cmdargs) or 0
752
753
754
755
def main(argv):
756
## TODO: Handle command-line options; probably know what options are valid for
757
## each command
758
759
## TODO: If the arguments are wrong, give a usage message rather
760
## than just a backtrace.
761
762
try:
763
# TODO: Lift into separate function in trace.py
764
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
765
# Perhaps that should eventually go into the platform library?
766
# TODO: If the file doesn't exist, add a note describing it.
767
t = bzrlib.trace._tracefile
768
t.write('-' * 60 + '\n')
769
t.write('bzr invoked at %s\n' % format_date(time.time()))
770
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
771
t.write(' arguments: %r\n' % argv)
772
773
starttime = os.times()[4]
774
775
import platform
776
t.write(' platform: %s\n' % platform.platform())
777
t.write(' python: %s\n' % platform.python_version())
778
779
ret = run_bzr(argv)
780
781
times = os.times()
782
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
783
% times[:4])
784
mutter(" %.3f elapsed" % (times[4] - starttime))
785
786
return ret
787
except BzrError, e:
788
log_error('bzr: error: ' + e.args[0] + '\n')
789
if len(e.args) > 1:
790
for h in e.args[1]:
791
log_error(' ' + h + '\n')
792
return 1
793
except Exception, e:
794
log_error('bzr: exception: %s\n' % e)
795
log_error(' see .bzr.log for details\n')
796
traceback.print_exc(None, bzrlib.trace._tracefile)
797
traceback.print_exc(None, sys.stderr)
798
return 1
799
800
# TODO: Maybe nicer handling of IOError?
801
802
803
804
if __name__ == '__main__':
805
sys.exit(main(sys.argv))
806
##import profile
807
##profile.run('main(sys.argv)')
808
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0