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