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 52
- compare with another revision
- download diff
- download tarball
- view history from revision 52
- Committer: mbp at sourcefrog
- Date: 2005-03-21 22:29:49 UTC
- Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure
- 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_doctest():
484
"""Run internal doctest 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
import doctest, bzrlib.store
491
bzrlib.trace.verbose = False
492
doctest.testmod(bzrlib.store)
493
doctest.testmod(bzrlib.inventory)
494
doctest.testmod(bzrlib.branch)
495
doctest.testmod(bzrlib.osutils)
496
doctest.testmod(bzrlib.tree)
497
498
# more strenuous tests;
499
import bzrlib.tests
500
doctest.testmod(bzrlib.tests)
501
502
503
######################################################################
504
# help
505
506
507
def cmd_help():
508
# TODO: Specific help for particular commands
509
print __doc__
510
511
512
def cmd_version():
513
print "bzr (bazaar-ng) %s" % __version__
514
print __copyright__
515
print "http://bazaar-ng.org/"
516
print
517
print \
518
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
519
you may use, modify and redistribute it under the terms of the GNU
520
General Public License version 2 or later."""
521
522
523
def cmd_rocks():
524
"""Statement of optimism."""
525
print "it sure does!"
526
527
528
529
######################################################################
530
# main routine
531
532
533
# list of all available options; the rhs can be either None for an
534
# option that takes no argument, or a constructor function that checks
535
# the type.
536
OPTIONS = {
537
'all': None,
538
'help': None,
539
'message': unicode,
540
'revision': int,
541
'show-ids': None,
542
'timezone': str,
543
'verbose': None,
544
'version': None,
545
}
546
547
SHORT_OPTIONS = {
548
'm': 'message',
549
'r': 'revision',
550
'v': 'verbose',
551
}
552
553
# List of options that apply to particular commands; commands not
554
# listed take none.
555
cmd_options = {
556
'add': ['verbose'],
557
'commit': ['message', 'verbose'],
558
'diff': ['revision'],
559
'inventory': ['revision'],
560
'log': ['show-ids', 'timezone'],
561
'ls': ['revision', 'verbose'],
562
'remove': ['verbose'],
563
'status': ['all'],
564
}
565
566
567
cmd_args = {
568
'init': [],
569
'add': ['file+'],
570
'commit': [],
571
'diff': [],
572
'file-id': ['filename'],
573
'get-file-text': ['text_id'],
574
'get-inventory': ['inventory_id'],
575
'get-revision': ['revision_id'],
576
'get-revision-inventory': ['revision_id'],
577
'log': [],
578
'lookup-revision': ['revno'],
579
'export': ['revno', 'dest'],
580
'remove': ['file+'],
581
'status': [],
582
}
583
584
585
def parse_args(argv):
586
"""Parse command line.
587
588
Arguments and options are parsed at this level before being passed
589
down to specific command handlers. This routine knows, from a
590
lookup table, something about the available options, what optargs
591
they take, and which commands will accept them.
592
593
>>> parse_args('--help'.split())
594
([], {'help': True})
595
>>> parse_args('--version'.split())
596
([], {'version': True})
597
>>> parse_args('status --all'.split())
598
(['status'], {'all': True})
599
>>> parse_args('commit --message=biter'.split())
600
(['commit'], {'message': u'biter'})
601
"""
602
args = []
603
opts = {}
604
605
# TODO: Maybe handle '--' to end options?
606
607
while argv:
608
a = argv.pop(0)
609
if a[0] == '-':
610
optarg = None
611
if a[1] == '-':
612
mutter(" got option %r" % a)
613
if '=' in a:
614
optname, optarg = a[2:].split('=', 1)
615
else:
616
optname = a[2:]
617
if optname not in OPTIONS:
618
bailout('unknown long option %r' % a)
619
else:
620
shortopt = a[1:]
621
if shortopt not in SHORT_OPTIONS:
622
bailout('unknown short option %r' % a)
623
optname = SHORT_OPTIONS[shortopt]
624
625
if optname in opts:
626
# XXX: Do we ever want to support this, e.g. for -r?
627
bailout('repeated option %r' % a)
628
629
optargfn = OPTIONS[optname]
630
if optargfn:
631
if optarg == None:
632
if not argv:
633
bailout('option %r needs an argument' % a)
634
else:
635
optarg = argv.pop(0)
636
opts[optname] = optargfn(optarg)
637
mutter(" option argument %r" % opts[optname])
638
else:
639
if optarg != None:
640
bailout('option %r takes no argument' % optname)
641
opts[optname] = True
642
else:
643
args.append(a)
644
645
return args, opts
646
647
648
649
def _match_args(cmd, args):
650
"""Check non-option arguments match required pattern.
651
652
>>> _match_args('status', ['asdasdsadasd'])
653
Traceback (most recent call last):
654
...
655
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
656
>>> _match_args('add', ['asdasdsadasd'])
657
{'file_list': ['asdasdsadasd']}
658
>>> _match_args('add', 'abc def gj'.split())
659
{'file_list': ['abc', 'def', 'gj']}
660
"""
661
# match argument pattern
662
argform = cmd_args.get(cmd, [])
663
argdict = {}
664
# TODO: Need a way to express 'cp SRC... DEST', where it matches
665
# all but one.
666
667
for ap in argform:
668
argname = ap[:-1]
669
if ap[-1] == '?':
670
assert 0
671
elif ap[-1] == '*':
672
assert 0
673
elif ap[-1] == '+':
674
if not args:
675
bailout("command %r needs one or more %s"
676
% (cmd, argname.upper()))
677
else:
678
argdict[argname + '_list'] = args[:]
679
args = []
680
else:
681
# just a plain arg
682
argname = ap
683
if not args:
684
bailout("command %r requires argument %s"
685
% (cmd, argname.upper()))
686
else:
687
argdict[argname] = args.pop(0)
688
689
if args:
690
bailout("extra arguments to command %s: %r"
691
% (cmd, args))
692
693
return argdict
694
695
696
697
def run_bzr(argv):
698
"""Execute a command.
699
700
This is similar to main(), but without all the trappings for
701
logging and error handling.
702
"""
703
try:
704
args, opts = parse_args(argv[1:])
705
if 'help' in opts:
706
# TODO: pass down other arguments in case they asked for
707
# help on a command name?
708
cmd_help()
709
return 0
710
elif 'version' in opts:
711
cmd_version()
712
return 0
713
cmd = args.pop(0)
714
except IndexError:
715
log_error('usage: bzr COMMAND\n')
716
log_error(' try "bzr help"\n')
717
return 1
718
719
try:
720
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
721
except KeyError:
722
bailout("unknown command " + `cmd`)
723
724
# TODO: special --profile option to turn on the Python profiler
725
726
# check options are reasonable
727
allowed = cmd_options.get(cmd, [])
728
for oname in opts:
729
if oname not in allowed:
730
bailout("option %r is not allowed for command %r"
731
% (oname, cmd))
732
733
cmdargs = _match_args(cmd, args)
734
cmdargs.update(opts)
735
736
ret = cmd_handler(**cmdargs) or 0
737
738
739
740
def main(argv):
741
## TODO: Handle command-line options; probably know what options are valid for
742
## each command
743
744
## TODO: If the arguments are wrong, give a usage message rather
745
## than just a backtrace.
746
747
try:
748
# TODO: Lift into separate function in trace.py
749
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
750
# Perhaps that should eventually go into the platform library?
751
# TODO: If the file doesn't exist, add a note describing it.
752
t = bzrlib.trace._tracefile
753
t.write('-' * 60 + '\n')
754
t.write('bzr invoked at %s\n' % format_date(time.time()))
755
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
756
t.write(' arguments: %r\n' % argv)
757
758
starttime = os.times()[4]
759
760
import platform
761
t.write(' platform: %s\n' % platform.platform())
762
t.write(' python: %s\n' % platform.python_version())
763
764
ret = run_bzr(argv)
765
766
times = os.times()
767
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
768
% times[:4])
769
mutter(" %.3f elapsed" % (times[4] - starttime))
770
771
return ret
772
except BzrError, e:
773
log_error('bzr: error: ' + e.args[0] + '\n')
774
if len(e.args) > 1:
775
for h in e.args[1]:
776
log_error(' ' + h + '\n')
777
return 1
778
except Exception, e:
779
log_error('bzr: exception: %s\n' % e)
780
log_error(' see .bzr.log for details\n')
781
traceback.print_exc(None, bzrlib.trace._tracefile)
782
traceback.print_exc(None, sys.stderr)
783
return 1
784
785
# TODO: Maybe nicer handling of IOError?
786
787
788
789
if __name__ == '__main__':
790
sys.exit(main(sys.argv))
791
##import profile
792
##profile.run('main(sys.argv)')
793
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0