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 111
- compare with another revision
- download diff
- download tarball
- view history from revision 111
- Committer: mbp at sourcefrog
- Date: 2005-03-28 02:40:49 UTC
- Revision ID: mbp@sourcefrog.net-20050328024049-9e1d1fea5e834ae7
Make fields wider in 'bzr info' output to accomodate big trees
- files added:
- .bzrignore
- bzrlib
- doc
- elementtree
- notes
- files removed:
- .bzrignore
- notes
- tests
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
4
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
9
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
14
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19
"""Bazaar-NG -- a free distributed version-control tool
20
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
23
Current limitation include:
24
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
27
28
* Insufficient error handling.
29
30
* Many commands unimplemented or partially implemented.
31
32
* Space-inefficient storage.
33
34
* No merge operators yet.
35
36
Interesting commands::
37
38
bzr help [COMMAND]
39
Show help screen
40
bzr version
41
Show software version/licence/non-warranty.
42
bzr init
43
Start versioning the current directory
44
bzr add FILE...
45
Make files versioned.
46
bzr log
47
Show revision history.
48
bzr diff
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
54
bzr status
55
Show summary of pending changes.
56
bzr remove FILE...
57
Make a file not versioned.
58
bzr info
59
Show statistics about this branch.
60
"""
61
62
63
64
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
67
from os import path
68
from sets import Set
69
from pprint import pprint
70
from stat import *
71
from glob import glob
72
73
import bzrlib
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
format_date
82
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
86
## standard representation
87
NONE_STRING = '(none)'
88
EMPTY = 'empty'
89
90
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
93
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
100
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
103
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
107
## directory.
108
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
112
113
## TODO: move command; check destination is a directory and will not
114
## clash; move it.
115
116
## TODO: command to show renames, one per line, as to->from
117
118
119
120
121
def cmd_status(all=False):
122
"""Display status summary.
123
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
127
128
:todo: Don't show unchanged files unless ``--all`` is given?
129
"""
130
Branch('.').show_status(show_all=all)
131
132
133
134
######################################################################
135
# examining history
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
139
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
144
145
146
147
######################################################################
148
# commands
149
150
151
def cmd_revno():
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
154
155
156
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
159
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
163
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
170
directories.
171
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
174
"""
175
bzrlib.add.smart_add(file_list, verbose)
176
177
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
181
182
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
187
b = Branch('.')
188
if revision == None:
189
inv = b.read_working_inventory()
190
else:
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
192
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
195
196
197
198
def cmd_info():
199
import info
200
info.show_info(Branch('.'))
201
202
203
204
def cmd_remove(file_list, verbose=False):
205
b = Branch(file_list[0])
206
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
207
208
209
210
def cmd_file_id(filename):
211
b = Branch(filename)
212
i = b.inventory.path2id(b.relpath(filename))
213
if i is None:
214
bailout("%s is not a versioned file" % filename)
215
else:
216
print i
217
218
219
def cmd_find_filename(fileid):
220
n = find_filename(fileid)
221
if n is None:
222
bailout("%s is not a live file id" % fileid)
223
else:
224
print n
225
226
227
def cmd_revision_history():
228
for patchid in Branch('.').revision_history():
229
print patchid
230
231
232
233
def cmd_init():
234
# TODO: Check we're not already in a working directory? At the
235
# moment you'll get an ugly error.
236
237
# TODO: What if we're in a subdirectory of a branch? Would like
238
# to allow that, but then the parent may need to understand that
239
# the children have disappeared, or should they be versioned in
240
# both?
241
242
# TODO: Take an argument/option for branch name.
243
Branch('.', init=True)
244
245
246
def cmd_diff(revision=None):
247
"""bzr diff: Show differences in working tree.
248
249
usage: bzr diff [-r REV]
250
251
--revision REV
252
Show changes since REV, rather than predecessor.
253
254
TODO: Given two revision arguments, show the difference between them.
255
256
TODO: Allow diff across branches.
257
258
TODO: Option to use external diff command; could be GNU diff, wdiff,
259
or a graphical diff.
260
261
TODO: Diff selected files.
262
"""
263
264
## TODO: Shouldn't be in the cmd function.
265
266
b = Branch('.')
267
268
if revision == None:
269
old_tree = b.basis_tree()
270
else:
271
old_tree = b.revision_tree(b.lookup_revision(revision))
272
273
new_tree = b.working_tree()
274
old_inv = old_tree.inventory
275
new_inv = new_tree.inventory
276
277
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
278
old_label = ''
279
new_label = ''
280
281
DEVNULL = '/dev/null'
282
# Windows users, don't panic about this filename -- it is a
283
# special signal to GNU patch that the file should be created or
284
# deleted respectively.
285
286
# TODO: Generation of pseudo-diffs for added/deleted files could
287
# be usefully made into a much faster special case.
288
289
# TODO: Better to return them in sorted order I think.
290
291
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
292
d = None
293
294
# Don't show this by default; maybe do it if an option is passed
295
# idlabel = ' {%s}' % fid
296
idlabel = ''
297
298
# FIXME: Something about the diff format makes patch unhappy
299
# with newly-added files.
300
301
def diffit(*a, **kw):
302
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
303
print
304
305
if file_state in ['.', '?', 'I']:
306
continue
307
elif file_state == 'A':
308
print '*** added %s %r' % (kind, new_name)
309
if kind == 'file':
310
diffit([],
311
new_tree.get_file(fid).readlines(),
312
fromfile=DEVNULL,
313
tofile=new_label + new_name + idlabel)
314
elif file_state == 'D':
315
assert isinstance(old_name, types.StringTypes)
316
print '*** deleted %s %r' % (kind, old_name)
317
if kind == 'file':
318
diffit(old_tree.get_file(fid).readlines(), [],
319
fromfile=old_label + old_name + idlabel,
320
tofile=DEVNULL)
321
elif file_state in ['M', 'R']:
322
if file_state == 'M':
323
assert kind == 'file'
324
assert old_name == new_name
325
print '*** modified %s %r' % (kind, new_name)
326
elif file_state == 'R':
327
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
328
329
if kind == 'file':
330
diffit(old_tree.get_file(fid).readlines(),
331
new_tree.get_file(fid).readlines(),
332
fromfile=old_label + old_name + idlabel,
333
tofile=new_label + new_name)
334
else:
335
bailout("can't represent state %s {%s}" % (file_state, fid))
336
337
338
339
def cmd_root(filename=None):
340
"""Print the branch root."""
341
print bzrlib.branch.find_branch_root(filename)
342
343
344
def cmd_log(timezone='original'):
345
"""Show log of this branch.
346
347
:todo: Options for utc; to show ids; to limit range; etc.
348
"""
349
Branch('.').write_log(show_timezone=timezone)
350
351
352
def cmd_ls(revision=None, verbose=False):
353
"""List files in a tree.
354
355
:todo: Take a revision or remote path and list that tree instead.
356
"""
357
b = Branch('.')
358
if revision == None:
359
tree = b.working_tree()
360
else:
361
tree = b.revision_tree(b.lookup_revision(revision))
362
363
for fp, fc, kind, fid in tree.list_files():
364
if verbose:
365
if kind == 'directory':
366
kindch = '/'
367
elif kind == 'file':
368
kindch = ''
369
else:
370
kindch = '???'
371
372
print '%-8s %s%s' % (fc, fp, kindch)
373
else:
374
print fp
375
376
377
378
def cmd_unknowns():
379
"""List unknown files"""
380
for f in Branch('.').unknowns():
381
print quotefn(f)
382
383
384
def cmd_lookup_revision(revno):
385
try:
386
revno = int(revno)
387
except ValueError:
388
bailout("usage: lookup-revision REVNO",
389
["REVNO is a non-negative revision number for this branch"])
390
391
print Branch('.').lookup_revision(revno) or NONE_STRING
392
393
394
395
def cmd_export(revno, dest):
396
"""Export past revision to destination directory."""
397
b = Branch('.')
398
rh = b.lookup_revision(int(revno))
399
t = b.revision_tree(rh)
400
t.export(dest)
401
402
403
404
######################################################################
405
# internal/test commands
406
407
408
def cmd_uuid():
409
"""Print a newly-generated UUID."""
410
print bzrlib.osutils.uuid()
411
412
413
414
def cmd_local_time_offset():
415
print bzrlib.osutils.local_time_offset()
416
417
418
419
def cmd_commit(message=None, verbose=False):
420
"""Commit changes to a new revision.
421
422
--message MESSAGE
423
Description of changes in this revision; free form text.
424
It is recommended that the first line be a single-sentence
425
summary.
426
--verbose
427
Show status of changed files,
428
429
TODO: Commit only selected files.
430
431
TODO: Run hooks on tree to-be-committed, and after commit.
432
433
TODO: Strict commit that fails if there are unknown or deleted files.
434
"""
435
436
if not message:
437
bailout("please specify a commit message")
438
Branch('.').commit(message, verbose=verbose)
439
440
441
def cmd_check():
442
"""Check consistency of the branch."""
443
check()
444
445
446
def cmd_is(pred, *rest):
447
"""Test whether PREDICATE is true."""
448
try:
449
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
450
except KeyError:
451
bailout("unknown predicate: %s" % quotefn(pred))
452
453
try:
454
cmd_handler(*rest)
455
except BzrCheckError:
456
# by default we don't print the message so that this can
457
# be used from shell scripts without producing noise
458
sys.exit(1)
459
460
461
def cmd_username():
462
print bzrlib.osutils.username()
463
464
465
def cmd_user_email():
466
print bzrlib.osutils.user_email()
467
468
469
def cmd_gen_revision_id():
470
import time
471
print bzrlib.branch._gen_revision_id(time.time())
472
473
474
def cmd_selftest(verbose=False):
475
"""Run internal test suite"""
476
## -v, if present, is seen by doctest; the argument is just here
477
## so our parser doesn't complain
478
479
## TODO: --verbose option
480
481
failures, tests = 0, 0
482
483
import doctest, bzrlib.store, bzrlib.tests
484
bzrlib.trace.verbose = False
485
486
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
487
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
488
mf, mt = doctest.testmod(m)
489
failures += mf
490
tests += mt
491
print '%-40s %3d tests' % (m.__name__, mt),
492
if mf:
493
print '%3d FAILED!' % mf
494
else:
495
print
496
497
print '%-40s %3d tests' % ('total', tests),
498
if failures:
499
print '%3d FAILED!' % failures
500
else:
501
print
502
503
504
505
# deprecated
506
cmd_doctest = cmd_selftest
507
508
509
######################################################################
510
# help
511
512
513
def cmd_help(topic=None):
514
if topic == None:
515
print __doc__
516
return
517
518
# otherwise, maybe the name of a command?
519
try:
520
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
521
except KeyError:
522
bailout("no help for %r" % topic)
523
524
doc = cmdfn.__doc__
525
if doc == None:
526
bailout("sorry, no detailed help yet for %r" % topic)
527
528
print doc
529
530
531
532
533
def cmd_version():
534
print "bzr (bazaar-ng) %s" % bzrlib.__version__
535
print bzrlib.__copyright__
536
print "http://bazaar-ng.org/"
537
print
538
print \
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."""
542
543
544
def cmd_rocks():
545
"""Statement of optimism."""
546
print "it sure does!"
547
548
549
550
######################################################################
551
# main routine
552
553
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
556
# the type.
557
OPTIONS = {
558
'all': None,
559
'help': None,
560
'message': unicode,
561
'revision': int,
562
'show-ids': None,
563
'timezone': str,
564
'verbose': None,
565
'version': None,
566
}
567
568
SHORT_OPTIONS = {
569
'm': 'message',
570
'r': 'revision',
571
'v': 'verbose',
572
}
573
574
# List of options that apply to particular commands; commands not
575
# listed take none.
576
cmd_options = {
577
'add': ['verbose'],
578
'commit': ['message', 'verbose'],
579
'diff': ['revision'],
580
'inventory': ['revision'],
581
'log': ['show-ids', 'timezone'],
582
'ls': ['revision', 'verbose'],
583
'remove': ['verbose'],
584
'status': ['all'],
585
}
586
587
588
cmd_args = {
589
'add': ['file+'],
590
'commit': [],
591
'diff': [],
592
'export': ['revno', 'dest'],
593
'file-id': ['filename'],
594
'get-file-text': ['text_id'],
595
'get-inventory': ['inventory_id'],
596
'get-revision': ['revision_id'],
597
'get-revision-inventory': ['revision_id'],
598
'help': ['topic?'],
599
'init': [],
600
'log': [],
601
'lookup-revision': ['revno'],
602
'relpath': ['filename'],
603
'remove': ['file+'],
604
'root': ['filename?'],
605
'status': [],
606
}
607
608
609
def parse_args(argv):
610
"""Parse command line.
611
612
Arguments and options are parsed at this level before being passed
613
down to specific command handlers. This routine knows, from a
614
lookup table, something about the available options, what optargs
615
they take, and which commands will accept them.
616
617
>>> parse_args('--help'.split())
618
([], {'help': True})
619
>>> parse_args('--version'.split())
620
([], {'version': True})
621
>>> parse_args('status --all'.split())
622
(['status'], {'all': True})
623
>>> parse_args('commit --message=biter'.split())
624
(['commit'], {'message': u'biter'})
625
"""
626
args = []
627
opts = {}
628
629
# TODO: Maybe handle '--' to end options?
630
631
while argv:
632
a = argv.pop(0)
633
if a[0] == '-':
634
optarg = None
635
if a[1] == '-':
636
mutter(" got option %r" % a)
637
if '=' in a:
638
optname, optarg = a[2:].split('=', 1)
639
else:
640
optname = a[2:]
641
if optname not in OPTIONS:
642
bailout('unknown long option %r' % a)
643
else:
644
shortopt = a[1:]
645
if shortopt not in SHORT_OPTIONS:
646
bailout('unknown short option %r' % a)
647
optname = SHORT_OPTIONS[shortopt]
648
649
if optname in opts:
650
# XXX: Do we ever want to support this, e.g. for -r?
651
bailout('repeated option %r' % a)
652
653
optargfn = OPTIONS[optname]
654
if optargfn:
655
if optarg == None:
656
if not argv:
657
bailout('option %r needs an argument' % a)
658
else:
659
optarg = argv.pop(0)
660
opts[optname] = optargfn(optarg)
661
mutter(" option argument %r" % opts[optname])
662
else:
663
if optarg != None:
664
bailout('option %r takes no argument' % optname)
665
opts[optname] = True
666
else:
667
args.append(a)
668
669
return args, opts
670
671
672
673
def _match_args(cmd, args):
674
"""Check non-option arguments match required pattern.
675
676
>>> _match_args('status', ['asdasdsadasd'])
677
Traceback (most recent call last):
678
...
679
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
680
>>> _match_args('add', ['asdasdsadasd'])
681
{'file_list': ['asdasdsadasd']}
682
>>> _match_args('add', 'abc def gj'.split())
683
{'file_list': ['abc', 'def', 'gj']}
684
"""
685
# match argument pattern
686
argform = cmd_args.get(cmd, [])
687
argdict = {}
688
# TODO: Need a way to express 'cp SRC... DEST', where it matches
689
# all but one.
690
691
# step through args and argform, allowing appropriate 0-many matches
692
for ap in argform:
693
argname = ap[:-1]
694
if ap[-1] == '?':
695
if args:
696
argdict[argname] = args.pop(0)
697
elif ap[-1] == '*':
698
assert 0
699
elif ap[-1] == '+':
700
if not args:
701
bailout("command %r needs one or more %s"
702
% (cmd, argname.upper()))
703
else:
704
argdict[argname + '_list'] = args[:]
705
args = []
706
else:
707
# just a plain arg
708
argname = ap
709
if not args:
710
bailout("command %r requires argument %s"
711
% (cmd, argname.upper()))
712
else:
713
argdict[argname] = args.pop(0)
714
715
if args:
716
bailout("extra arguments to command %s: %r"
717
% (cmd, args))
718
719
return argdict
720
721
722
723
def run_bzr(argv):
724
"""Execute a command.
725
726
This is similar to main(), but without all the trappings for
727
logging and error handling.
728
"""
729
try:
730
args, opts = parse_args(argv[1:])
731
if 'help' in opts:
732
# TODO: pass down other arguments in case they asked for
733
# help on a command name?
734
cmd_help()
735
return 0
736
elif 'version' in opts:
737
cmd_version()
738
return 0
739
cmd = args.pop(0)
740
except IndexError:
741
log_error('usage: bzr COMMAND\n')
742
log_error(' try "bzr help"\n')
743
return 1
744
745
try:
746
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
747
except KeyError:
748
bailout("unknown command " + `cmd`)
749
750
# TODO: special --profile option to turn on the Python profiler
751
752
# check options are reasonable
753
allowed = cmd_options.get(cmd, [])
754
for oname in opts:
755
if oname not in allowed:
756
bailout("option %r is not allowed for command %r"
757
% (oname, cmd))
758
759
cmdargs = _match_args(cmd, args)
760
cmdargs.update(opts)
761
762
ret = cmd_handler(**cmdargs) or 0
763
764
765
766
def main(argv):
767
## TODO: Handle command-line options; probably know what options are valid for
768
## each command
769
770
## TODO: If the arguments are wrong, give a usage message rather
771
## than just a backtrace.
772
773
bzrlib.trace.create_tracefile(argv)
774
775
try:
776
ret = run_bzr(argv)
777
return ret
778
except BzrError, e:
779
log_error('bzr: error: ' + e.args[0] + '\n')
780
if len(e.args) > 1:
781
for h in e.args[1]:
782
log_error(' ' + h + '\n')
783
return 1
784
except Exception, e:
785
log_error('bzr: exception: %s\n' % e)
786
log_error(' see .bzr.log for details\n')
787
traceback.print_exc(None, bzrlib.trace._tracefile)
788
traceback.print_exc(None, sys.stderr)
789
return 1
790
791
# TODO: Maybe nicer handling of IOError?
792
793
794
795
if __name__ == '__main__':
796
sys.exit(main(sys.argv))
797
##import profile
798
##profile.run('main(sys.argv)')
799
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0