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 130
- compare with another revision
- download diff
- download tarball
- view history from revision 130
- Committer: mbp at sourcefrog
- Date: 2005-03-29 01:26:19 UTC
- Revision ID: mbp@sourcefrog.net-20050329012619-dd8959fc63b3a074
- fixup checks on retrieved files to cope with compression,
and have less checks now there's a check command again
- move code to destroy stores into the ScratchStore subclass
and have less checks now there's a check command again
- move code to destroy stores into the ScratchStore subclass
- 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
"""info: Show statistical information for this branch
200
201
usage: bzr info"""
202
import info
203
info.show_info(Branch('.'))
204
205
206
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
211
212
213
def cmd_file_id(filename):
214
b = Branch(filename)
215
i = b.inventory.path2id(b.relpath(filename))
216
if i is None:
217
bailout("%s is not a versioned file" % filename)
218
else:
219
print i
220
221
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
224
if n is None:
225
bailout("%s is not a live file id" % fileid)
226
else:
227
print n
228
229
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
232
print patchid
233
234
235
236
def cmd_init():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
239
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
243
# both?
244
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
247
248
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
251
252
usage: bzr diff [-r REV]
253
254
--revision REV
255
Show changes since REV, rather than predecessor.
256
257
TODO: Given two revision arguments, show the difference between them.
258
259
TODO: Allow diff across branches.
260
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
262
or a graphical diff.
263
264
TODO: Diff selected files.
265
"""
266
267
## TODO: Shouldn't be in the cmd function.
268
269
b = Branch('.')
270
271
if revision == None:
272
old_tree = b.basis_tree()
273
else:
274
old_tree = b.revision_tree(b.lookup_revision(revision))
275
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
279
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
281
old_label = ''
282
new_label = ''
283
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
288
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
291
292
# TODO: Better to return them in sorted order I think.
293
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
295
d = None
296
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
299
idlabel = ''
300
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
303
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
306
print
307
308
if file_state in ['.', '?', 'I']:
309
continue
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
312
if kind == 'file':
313
diffit([],
314
new_tree.get_file(fid).readlines(),
315
fromfile=DEVNULL,
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
320
if kind == 'file':
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
323
tofile=DEVNULL)
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
331
332
if kind == 'file':
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
337
else:
338
bailout("can't represent state %s {%s}" % (file_state, fid))
339
340
341
342
def cmd_root(filename=None):
343
"""Print the branch root."""
344
print bzrlib.branch.find_branch_root(filename)
345
346
347
def cmd_log(timezone='original'):
348
"""Show log of this branch.
349
350
:todo: Options for utc; to show ids; to limit range; etc.
351
"""
352
Branch('.').write_log(show_timezone=timezone)
353
354
355
def cmd_ls(revision=None, verbose=False):
356
"""List files in a tree.
357
358
:todo: Take a revision or remote path and list that tree instead.
359
"""
360
b = Branch('.')
361
if revision == None:
362
tree = b.working_tree()
363
else:
364
tree = b.revision_tree(b.lookup_revision(revision))
365
366
for fp, fc, kind, fid in tree.list_files():
367
if verbose:
368
if kind == 'directory':
369
kindch = '/'
370
elif kind == 'file':
371
kindch = ''
372
else:
373
kindch = '???'
374
375
print '%-8s %s%s' % (fc, fp, kindch)
376
else:
377
print fp
378
379
380
381
def cmd_unknowns():
382
"""List unknown files"""
383
for f in Branch('.').unknowns():
384
print quotefn(f)
385
386
387
def cmd_lookup_revision(revno):
388
try:
389
revno = int(revno)
390
except ValueError:
391
bailout("usage: lookup-revision REVNO",
392
["REVNO is a non-negative revision number for this branch"])
393
394
print Branch('.').lookup_revision(revno) or NONE_STRING
395
396
397
398
def cmd_export(revno, dest):
399
"""Export past revision to destination directory."""
400
b = Branch('.')
401
rh = b.lookup_revision(int(revno))
402
t = b.revision_tree(rh)
403
t.export(dest)
404
405
406
407
######################################################################
408
# internal/test commands
409
410
411
def cmd_uuid():
412
"""Print a newly-generated UUID."""
413
print bzrlib.osutils.uuid()
414
415
416
417
def cmd_local_time_offset():
418
print bzrlib.osutils.local_time_offset()
419
420
421
422
def cmd_commit(message=None, verbose=False):
423
"""Commit changes to a new revision.
424
425
--message MESSAGE
426
Description of changes in this revision; free form text.
427
It is recommended that the first line be a single-sentence
428
summary.
429
--verbose
430
Show status of changed files,
431
432
TODO: Commit only selected files.
433
434
TODO: Run hooks on tree to-be-committed, and after commit.
435
436
TODO: Strict commit that fails if there are unknown or deleted files.
437
"""
438
439
if not message:
440
bailout("please specify a commit message")
441
Branch('.').commit(message, verbose=verbose)
442
443
444
def cmd_check(dir='.'):
445
"""check: Consistency check of branch history.
446
447
usage: bzr check [-v] [BRANCH]
448
449
options:
450
--verbose, -v Show progress of checking.
451
452
This command checks various invariants about the branch storage to
453
detect data corruption or bzr bugs.
454
"""
455
import bzrlib.check
456
bzrlib.check.check(Branch(dir, find_root=False))
457
458
459
def cmd_is(pred, *rest):
460
"""Test whether PREDICATE is true."""
461
try:
462
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
463
except KeyError:
464
bailout("unknown predicate: %s" % quotefn(pred))
465
466
try:
467
cmd_handler(*rest)
468
except BzrCheckError:
469
# by default we don't print the message so that this can
470
# be used from shell scripts without producing noise
471
sys.exit(1)
472
473
474
def cmd_username():
475
print bzrlib.osutils.username()
476
477
478
def cmd_user_email():
479
print bzrlib.osutils.user_email()
480
481
482
def cmd_gen_revision_id():
483
import time
484
print bzrlib.branch._gen_revision_id(time.time())
485
486
487
def cmd_selftest(verbose=False):
488
"""Run internal test suite"""
489
## -v, if present, is seen by doctest; the argument is just here
490
## so our parser doesn't complain
491
492
## TODO: --verbose option
493
494
failures, tests = 0, 0
495
496
import doctest, bzrlib.store, bzrlib.tests
497
bzrlib.trace.verbose = False
498
499
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
500
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
501
mf, mt = doctest.testmod(m)
502
failures += mf
503
tests += mt
504
print '%-40s %3d tests' % (m.__name__, mt),
505
if mf:
506
print '%3d FAILED!' % mf
507
else:
508
print
509
510
print '%-40s %3d tests' % ('total', tests),
511
if failures:
512
print '%3d FAILED!' % failures
513
else:
514
print
515
516
517
518
# deprecated
519
cmd_doctest = cmd_selftest
520
521
522
######################################################################
523
# help
524
525
526
def cmd_help(topic=None):
527
if topic == None:
528
print __doc__
529
return
530
531
# otherwise, maybe the name of a command?
532
try:
533
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
534
except KeyError:
535
bailout("no help for %r" % topic)
536
537
doc = cmdfn.__doc__
538
if doc == None:
539
bailout("sorry, no detailed help yet for %r" % topic)
540
541
print doc
542
543
544
545
546
def cmd_version():
547
print "bzr (bazaar-ng) %s" % bzrlib.__version__
548
print bzrlib.__copyright__
549
print "http://bazaar-ng.org/"
550
print
551
print \
552
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
553
you may use, modify and redistribute it under the terms of the GNU
554
General Public License version 2 or later."""
555
556
557
def cmd_rocks():
558
"""Statement of optimism."""
559
print "it sure does!"
560
561
562
563
######################################################################
564
# main routine
565
566
567
# list of all available options; the rhs can be either None for an
568
# option that takes no argument, or a constructor function that checks
569
# the type.
570
OPTIONS = {
571
'all': None,
572
'help': None,
573
'message': unicode,
574
'revision': int,
575
'show-ids': None,
576
'timezone': str,
577
'verbose': None,
578
'version': None,
579
}
580
581
SHORT_OPTIONS = {
582
'm': 'message',
583
'r': 'revision',
584
'v': 'verbose',
585
}
586
587
# List of options that apply to particular commands; commands not
588
# listed take none.
589
cmd_options = {
590
'add': ['verbose'],
591
'commit': ['message', 'verbose'],
592
'diff': ['revision'],
593
'inventory': ['revision'],
594
'log': ['show-ids', 'timezone'],
595
'ls': ['revision', 'verbose'],
596
'remove': ['verbose'],
597
'status': ['all'],
598
}
599
600
601
cmd_args = {
602
'add': ['file+'],
603
'commit': [],
604
'diff': [],
605
'export': ['revno', 'dest'],
606
'file-id': ['filename'],
607
'get-file-text': ['text_id'],
608
'get-inventory': ['inventory_id'],
609
'get-revision': ['revision_id'],
610
'get-revision-inventory': ['revision_id'],
611
'help': ['topic?'],
612
'init': [],
613
'log': [],
614
'lookup-revision': ['revno'],
615
'relpath': ['filename'],
616
'remove': ['file+'],
617
'root': ['filename?'],
618
'status': [],
619
}
620
621
622
def parse_args(argv):
623
"""Parse command line.
624
625
Arguments and options are parsed at this level before being passed
626
down to specific command handlers. This routine knows, from a
627
lookup table, something about the available options, what optargs
628
they take, and which commands will accept them.
629
630
>>> parse_args('--help'.split())
631
([], {'help': True})
632
>>> parse_args('--version'.split())
633
([], {'version': True})
634
>>> parse_args('status --all'.split())
635
(['status'], {'all': True})
636
>>> parse_args('commit --message=biter'.split())
637
(['commit'], {'message': u'biter'})
638
"""
639
args = []
640
opts = {}
641
642
# TODO: Maybe handle '--' to end options?
643
644
while argv:
645
a = argv.pop(0)
646
if a[0] == '-':
647
optarg = None
648
if a[1] == '-':
649
mutter(" got option %r" % a)
650
if '=' in a:
651
optname, optarg = a[2:].split('=', 1)
652
else:
653
optname = a[2:]
654
if optname not in OPTIONS:
655
bailout('unknown long option %r' % a)
656
else:
657
shortopt = a[1:]
658
if shortopt not in SHORT_OPTIONS:
659
bailout('unknown short option %r' % a)
660
optname = SHORT_OPTIONS[shortopt]
661
662
if optname in opts:
663
# XXX: Do we ever want to support this, e.g. for -r?
664
bailout('repeated option %r' % a)
665
666
optargfn = OPTIONS[optname]
667
if optargfn:
668
if optarg == None:
669
if not argv:
670
bailout('option %r needs an argument' % a)
671
else:
672
optarg = argv.pop(0)
673
opts[optname] = optargfn(optarg)
674
mutter(" option argument %r" % opts[optname])
675
else:
676
if optarg != None:
677
bailout('option %r takes no argument' % optname)
678
opts[optname] = True
679
else:
680
args.append(a)
681
682
return args, opts
683
684
685
686
def _match_args(cmd, args):
687
"""Check non-option arguments match required pattern.
688
689
>>> _match_args('status', ['asdasdsadasd'])
690
Traceback (most recent call last):
691
...
692
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
693
>>> _match_args('add', ['asdasdsadasd'])
694
{'file_list': ['asdasdsadasd']}
695
>>> _match_args('add', 'abc def gj'.split())
696
{'file_list': ['abc', 'def', 'gj']}
697
"""
698
# match argument pattern
699
argform = cmd_args.get(cmd, [])
700
argdict = {}
701
# TODO: Need a way to express 'cp SRC... DEST', where it matches
702
# all but one.
703
704
# step through args and argform, allowing appropriate 0-many matches
705
for ap in argform:
706
argname = ap[:-1]
707
if ap[-1] == '?':
708
if args:
709
argdict[argname] = args.pop(0)
710
elif ap[-1] == '*':
711
assert 0
712
elif ap[-1] == '+':
713
if not args:
714
bailout("command %r needs one or more %s"
715
% (cmd, argname.upper()))
716
else:
717
argdict[argname + '_list'] = args[:]
718
args = []
719
else:
720
# just a plain arg
721
argname = ap
722
if not args:
723
bailout("command %r requires argument %s"
724
% (cmd, argname.upper()))
725
else:
726
argdict[argname] = args.pop(0)
727
728
if args:
729
bailout("extra arguments to command %s: %r"
730
% (cmd, args))
731
732
return argdict
733
734
735
736
def run_bzr(argv):
737
"""Execute a command.
738
739
This is similar to main(), but without all the trappings for
740
logging and error handling.
741
"""
742
try:
743
args, opts = parse_args(argv[1:])
744
if 'help' in opts:
745
# TODO: pass down other arguments in case they asked for
746
# help on a command name?
747
cmd_help()
748
return 0
749
elif 'version' in opts:
750
cmd_version()
751
return 0
752
cmd = args.pop(0)
753
except IndexError:
754
log_error('usage: bzr COMMAND\n')
755
log_error(' try "bzr help"\n')
756
return 1
757
758
try:
759
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
760
except KeyError:
761
bailout("unknown command " + `cmd`)
762
763
# TODO: special --profile option to turn on the Python profiler
764
765
# check options are reasonable
766
allowed = cmd_options.get(cmd, [])
767
for oname in opts:
768
if oname not in allowed:
769
bailout("option %r is not allowed for command %r"
770
% (oname, cmd))
771
772
cmdargs = _match_args(cmd, args)
773
cmdargs.update(opts)
774
775
ret = cmd_handler(**cmdargs) or 0
776
777
778
779
def main(argv):
780
## TODO: Handle command-line options; probably know what options are valid for
781
## each command
782
783
## TODO: If the arguments are wrong, give a usage message rather
784
## than just a backtrace.
785
786
bzrlib.trace.create_tracefile(argv)
787
788
try:
789
ret = run_bzr(argv)
790
return ret
791
except BzrError, e:
792
log_error('bzr: error: ' + e.args[0] + '\n')
793
if len(e.args) > 1:
794
for h in e.args[1]:
795
log_error(' ' + h + '\n')
796
return 1
797
except Exception, e:
798
log_error('bzr: exception: %s\n' % e)
799
log_error(' see .bzr.log for details\n')
800
traceback.print_exc(None, bzrlib.trace._tracefile)
801
traceback.print_exc(None, sys.stderr)
802
return 1
803
804
# TODO: Maybe nicer handling of IOError?
805
806
807
808
if __name__ == '__main__':
809
sys.exit(main(sys.argv))
810
##import profile
811
##profile.run('main(sys.argv)')
812
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0