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