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