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