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 285
- compare with another revision
- download diff
- download tarball
- view history from revision 285
- Committer: Martin Pool
- Date: 2005-04-26 10:24:32 UTC
- Revision ID: mbp@sourcefrog.net-20050426102432-a15ab612512710bf
- update todos
- files added:
- .bzrignore
- bzrlib
- doc
- elementtree
- notes
- urlgrabber
- 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
http://bazaar-ng.org/
21
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
24
* Metadata format is not stable yet -- you may need to
25
discard history in the future.
26
27
* Many commands unimplemented or partially implemented.
28
29
* Space-inefficient storage.
30
31
* No merge operators yet.
32
33
Interesting commands:
34
35
bzr help [COMMAND]
36
Show help screen
37
bzr version
38
Show software version/licence/non-warranty.
39
bzr init
40
Start versioning the current directory
41
bzr add FILE...
42
Make files versioned.
43
bzr log
44
Show revision history.
45
bzr rename FROM TO
46
Rename one file.
47
bzr move FROM... DESTDIR
48
Move one or more files to a different directory.
49
bzr diff [FILE...]
50
Show changes from last revision to working copy.
51
bzr commit -m 'MESSAGE'
52
Store current state as new revision.
53
bzr export REVNO DESTINATION
54
Export the branch state at a previous version.
55
bzr status
56
Show summary of pending changes.
57
bzr remove FILE...
58
Make a file not versioned.
59
bzr info
60
Show statistics about this branch.
61
bzr check
62
Verify history is stored safely.
63
(for more type 'bzr help commands')
64
"""
65
66
67
68
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
70
from sets import Set
71
from pprint import pprint
72
from stat import *
73
from glob import glob
74
from inspect import getdoc
75
76
import bzrlib
77
from bzrlib.store import ImmutableStore
78
from bzrlib.trace import mutter, note, log_error
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
from bzrlib.revision import Revision
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
84
format_date
85
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
88
89
## standard representation
90
NONE_STRING = '(none)'
91
EMPTY = 'empty'
92
93
94
## TODO: Perhaps a different version of inventory commands that
95
## returns iterators...
96
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
98
99
## TODO: Some kind of locking on branches. Perhaps there should be a
100
## parameter to the branch object saying whether we want a read or
101
## write lock; release it from destructor. Perhaps don't even need a
102
## read lock to look at immutable objects?
103
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
## to compare output?
106
107
## TODO: Some kind of global code to generate the right Branch object
108
## to work on. Almost, but not quite all, commands need one, and it
109
## can be taken either from their parameters or their working
110
## directory.
111
112
113
114
cmd_aliases = {
115
'?': 'help',
116
'ci': 'commit',
117
'checkin': 'commit',
118
'di': 'diff',
119
'st': 'status',
120
'stat': 'status',
121
}
122
123
124
def get_cmd_handler(cmd):
125
cmd = str(cmd)
126
127
cmd = cmd_aliases.get(cmd, cmd)
128
129
try:
130
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
131
except KeyError:
132
raise BzrError("unknown command %r" % cmd)
133
134
return cmd, cmd_handler
135
136
137
138
def cmd_status(all=False):
139
"""Display status summary.
140
141
For each file there is a single line giving its file state and name.
142
The name is that in the current revision unless it is deleted or
143
missing, in which case the old name is shown.
144
"""
145
#import bzrlib.status
146
#bzrlib.status.tree_status(Branch('.'))
147
Branch('.').show_status(show_all=all)
148
149
150
151
######################################################################
152
# examining history
153
def cmd_get_revision(revision_id):
154
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
155
156
157
def cmd_get_file_text(text_id):
158
"""Get contents of a file by hash."""
159
sf = Branch('.').text_store[text_id]
160
pumpfile(sf, sys.stdout)
161
162
163
164
######################################################################
165
# commands
166
167
168
def cmd_revno():
169
"""Show number of revisions on this branch"""
170
print Branch('.').revno()
171
172
173
174
def cmd_add(file_list, verbose=False):
175
"""Add specified files or directories.
176
177
In non-recursive mode, all the named items are added, regardless
178
of whether they were previously ignored. A warning is given if
179
any of the named files are already versioned.
180
181
In recursive mode (the default), files are treated the same way
182
but the behaviour for directories is different. Directories that
183
are already versioned do not give a warning. All directories,
184
whether already versioned or not, are searched for files or
185
subdirectories that are neither versioned or ignored, and these
186
are added. This search proceeds recursively into versioned
187
directories.
188
189
Therefore simply saying 'bzr add .' will version all files that
190
are currently unknown.
191
192
TODO: Perhaps adding a file whose directly is not versioned should
193
recursively add that parent, rather than giving an error?
194
"""
195
bzrlib.add.smart_add(file_list, verbose)
196
197
198
def cmd_relpath(filename):
199
"""Show path of file relative to root"""
200
print Branch(filename).relpath(filename)
201
202
203
204
def cmd_inventory(revision=None):
205
"""Show inventory of the current working copy."""
206
## TODO: Also optionally show a previous inventory
207
## TODO: Format options
208
b = Branch('.')
209
if revision == None:
210
inv = b.read_working_inventory()
211
else:
212
inv = b.get_revision_inventory(b.lookup_revision(revision))
213
214
for path, entry in inv.iter_entries():
215
print '%-50s %s' % (entry.file_id, path)
216
217
218
219
# TODO: Maybe a 'mv' command that has the combined move/rename
220
# special behaviour of Unix?
221
222
def cmd_move(source_list, dest):
223
b = Branch('.')
224
225
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
226
227
228
229
def cmd_rename(from_name, to_name):
230
"""Change the name of an entry.
231
232
usage: bzr rename FROM_NAME TO_NAME
233
234
examples:
235
bzr rename frob.c frobber.c
236
bzr rename src/frob.c lib/frob.c
237
238
It is an error if the destination name exists.
239
240
See also the 'move' command, which moves files into a different
241
directory without changing their name.
242
243
TODO: Some way to rename multiple files without invoking bzr for each
244
one?"""
245
b = Branch('.')
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
247
248
249
250
251
def cmd_renames(dir='.'):
252
"""Show list of renamed files.
253
254
usage: bzr renames [BRANCH]
255
256
TODO: Option to show renames between two historical versions.
257
258
TODO: Only show renames under dir, rather than in the whole branch.
259
"""
260
b = Branch(dir)
261
old_inv = b.basis_tree().inventory
262
new_inv = b.read_working_inventory()
263
264
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
265
renames.sort()
266
for old_name, new_name in renames:
267
print "%s => %s" % (old_name, new_name)
268
269
270
271
def cmd_info():
272
"""info: Show statistical information for this branch
273
274
usage: bzr info"""
275
import info
276
info.show_info(Branch('.'))
277
278
279
280
def cmd_remove(file_list, verbose=False):
281
b = Branch(file_list[0])
282
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
283
284
285
286
def cmd_file_id(filename):
287
"""Print file_id of a particular file or directory.
288
289
usage: bzr file-id FILE
290
291
The file_id is assigned when the file is first added and remains the
292
same through all revisions where the file exists, even when it is
293
moved or renamed.
294
"""
295
b = Branch(filename)
296
i = b.inventory.path2id(b.relpath(filename))
297
if i == None:
298
bailout("%r is not a versioned file" % filename)
299
else:
300
print i
301
302
303
def cmd_file_id_path(filename):
304
"""Print path of file_ids to a file or directory.
305
306
usage: bzr file-id-path FILE
307
308
This prints one line for each directory down to the target,
309
starting at the branch root."""
310
b = Branch(filename)
311
inv = b.inventory
312
fid = inv.path2id(b.relpath(filename))
313
if fid == None:
314
bailout("%r is not a versioned file" % filename)
315
for fip in inv.get_idpath(fid):
316
print fip
317
318
319
def cmd_revision_history():
320
for patchid in Branch('.').revision_history():
321
print patchid
322
323
324
def cmd_directories():
325
for name, ie in Branch('.').read_working_inventory().directories():
326
if name == '':
327
print '.'
328
else:
329
print name
330
331
332
def cmd_missing():
333
for name, ie in Branch('.').working_tree().missing():
334
print name
335
336
337
def cmd_init():
338
# TODO: Check we're not already in a working directory? At the
339
# moment you'll get an ugly error.
340
341
# TODO: What if we're in a subdirectory of a branch? Would like
342
# to allow that, but then the parent may need to understand that
343
# the children have disappeared, or should they be versioned in
344
# both?
345
346
# TODO: Take an argument/option for branch name.
347
Branch('.', init=True)
348
349
350
def cmd_diff(revision=None, file_list=None):
351
"""bzr diff: Show differences in working tree.
352
353
usage: bzr diff [-r REV] [FILE...]
354
355
--revision REV
356
Show changes since REV, rather than predecessor.
357
358
If files are listed, only the changes in those files are listed.
359
Otherwise, all changes for the tree are listed.
360
361
TODO: Given two revision arguments, show the difference between them.
362
363
TODO: Allow diff across branches.
364
365
TODO: Option to use external diff command; could be GNU diff, wdiff,
366
or a graphical diff.
367
368
TODO: Python difflib is not exactly the same as unidiff; should
369
either fix it up or prefer to use an external diff.
370
371
TODO: If a directory is given, diff everything under that.
372
373
TODO: Selected-file diff is inefficient and doesn't show you
374
deleted files.
375
376
TODO: This probably handles non-Unix newlines poorly.
377
"""
378
379
## TODO: Shouldn't be in the cmd function.
380
381
b = Branch('.')
382
383
if revision == None:
384
old_tree = b.basis_tree()
385
else:
386
old_tree = b.revision_tree(b.lookup_revision(revision))
387
388
new_tree = b.working_tree()
389
390
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
391
old_label = ''
392
new_label = ''
393
394
DEVNULL = '/dev/null'
395
# Windows users, don't panic about this filename -- it is a
396
# special signal to GNU patch that the file should be created or
397
# deleted respectively.
398
399
# TODO: Generation of pseudo-diffs for added/deleted files could
400
# be usefully made into a much faster special case.
401
402
# TODO: Better to return them in sorted order I think.
403
404
if file_list:
405
file_list = [b.relpath(f) for f in file_list]
406
407
# FIXME: If given a file list, compare only those files rather
408
# than comparing everything and then throwing stuff away.
409
410
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
411
412
if file_list and (new_name not in file_list):
413
continue
414
415
# Don't show this by default; maybe do it if an option is passed
416
# idlabel = ' {%s}' % fid
417
idlabel = ''
418
419
# FIXME: Something about the diff format makes patch unhappy
420
# with newly-added files.
421
422
def diffit(oldlines, newlines, **kw):
423
424
# FIXME: difflib is wrong if there is no trailing newline.
425
# The syntax used by patch seems to be "\ No newline at
426
# end of file" following the last diff line from that
427
# file. This is not trivial to insert into the
428
# unified_diff output and it might be better to just fix
429
# or replace that function.
430
431
# In the meantime we at least make sure the patch isn't
432
# mangled.
433
434
435
# Special workaround for Python2.3, where difflib fails if
436
# both sequences are empty.
437
if not oldlines and not newlines:
438
return
439
440
nonl = False
441
442
if oldlines and (oldlines[-1][-1] != '\n'):
443
oldlines[-1] += '\n'
444
nonl = True
445
if newlines and (newlines[-1][-1] != '\n'):
446
newlines[-1] += '\n'
447
nonl = True
448
449
ud = difflib.unified_diff(oldlines, newlines, **kw)
450
sys.stdout.writelines(ud)
451
if nonl:
452
print "\\ No newline at end of file"
453
sys.stdout.write('\n')
454
455
if file_state in ['.', '?', 'I']:
456
continue
457
elif file_state == 'A':
458
print '*** added %s %r' % (kind, new_name)
459
if kind == 'file':
460
diffit([],
461
new_tree.get_file(fid).readlines(),
462
fromfile=DEVNULL,
463
tofile=new_label + new_name + idlabel)
464
elif file_state == 'D':
465
assert isinstance(old_name, types.StringTypes)
466
print '*** deleted %s %r' % (kind, old_name)
467
if kind == 'file':
468
diffit(old_tree.get_file(fid).readlines(), [],
469
fromfile=old_label + old_name + idlabel,
470
tofile=DEVNULL)
471
elif file_state in ['M', 'R']:
472
if file_state == 'M':
473
assert kind == 'file'
474
assert old_name == new_name
475
print '*** modified %s %r' % (kind, new_name)
476
elif file_state == 'R':
477
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
478
479
if kind == 'file':
480
diffit(old_tree.get_file(fid).readlines(),
481
new_tree.get_file(fid).readlines(),
482
fromfile=old_label + old_name + idlabel,
483
tofile=new_label + new_name)
484
else:
485
bailout("can't represent state %s {%s}" % (file_state, fid))
486
487
488
489
def cmd_deleted(show_ids=False):
490
"""List files deleted in the working tree.
491
492
TODO: Show files deleted since a previous revision, or between two revisions.
493
"""
494
b = Branch('.')
495
old = b.basis_tree()
496
new = b.working_tree()
497
498
## TODO: Much more efficient way to do this: read in new
499
## directories with readdir, rather than stating each one. Same
500
## level of effort but possibly much less IO. (Or possibly not,
501
## if the directories are very large...)
502
503
for path, ie in old.inventory.iter_entries():
504
if not new.has_id(ie.file_id):
505
if show_ids:
506
print '%-50s %s' % (path, ie.file_id)
507
else:
508
print path
509
510
511
512
def cmd_parse_inventory():
513
import cElementTree
514
515
cElementTree.ElementTree().parse(file('.bzr/inventory'))
516
517
518
519
def cmd_load_inventory():
520
"""Load inventory for timing purposes"""
521
Branch('.').basis_tree().inventory
522
523
524
def cmd_dump_inventory():
525
Branch('.').read_working_inventory().write_xml(sys.stdout)
526
527
528
def cmd_dump_new_inventory():
529
import bzrlib.newinventory
530
inv = Branch('.').basis_tree().inventory
531
bzrlib.newinventory.write_inventory(inv, sys.stdout)
532
533
534
def cmd_load_new_inventory():
535
import bzrlib.newinventory
536
bzrlib.newinventory.read_new_inventory(sys.stdin)
537
538
539
def cmd_dump_slacker_inventory():
540
import bzrlib.newinventory
541
inv = Branch('.').basis_tree().inventory
542
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
543
544
545
546
def cmd_dump_text_inventory():
547
import bzrlib.textinv
548
inv = Branch('.').basis_tree().inventory
549
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
550
551
552
def cmd_load_text_inventory():
553
import bzrlib.textinv
554
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
555
print 'loaded %d entries' % len(inv)
556
557
558
559
def cmd_root(filename=None):
560
"""Print the branch root."""
561
print bzrlib.branch.find_branch_root(filename)
562
563
564
def cmd_log(timezone='original', verbose=False):
565
"""Show log of this branch.
566
567
TODO: Options for utc; to show ids; to limit range; etc.
568
"""
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
570
571
572
def cmd_ls(revision=None, verbose=False):
573
"""List files in a tree.
574
575
TODO: Take a revision or remote path and list that tree instead.
576
"""
577
b = Branch('.')
578
if revision == None:
579
tree = b.working_tree()
580
else:
581
tree = b.revision_tree(b.lookup_revision(revision))
582
583
for fp, fc, kind, fid in tree.list_files():
584
if verbose:
585
if kind == 'directory':
586
kindch = '/'
587
elif kind == 'file':
588
kindch = ''
589
else:
590
kindch = '???'
591
592
print '%-8s %s%s' % (fc, fp, kindch)
593
else:
594
print fp
595
596
597
598
def cmd_unknowns():
599
"""List unknown files"""
600
for f in Branch('.').unknowns():
601
print quotefn(f)
602
603
604
605
def cmd_ignored():
606
"""List ignored files and the patterns that matched them.
607
"""
608
tree = Branch('.').working_tree()
609
for path, file_class, kind, file_id in tree.list_files():
610
if file_class != 'I':
611
continue
612
## XXX: Slightly inefficient since this was already calculated
613
pat = tree.is_ignored(path)
614
print '%-50s %s' % (path, pat)
615
616
617
def cmd_lookup_revision(revno):
618
try:
619
revno = int(revno)
620
except ValueError:
621
bailout("usage: lookup-revision REVNO",
622
["REVNO is a non-negative revision number for this branch"])
623
624
print Branch('.').lookup_revision(revno) or NONE_STRING
625
626
627
628
def cmd_export(revno, dest):
629
"""Export past revision to destination directory."""
630
b = Branch('.')
631
rh = b.lookup_revision(int(revno))
632
t = b.revision_tree(rh)
633
t.export(dest)
634
635
def cmd_cat(revision, filename):
636
"""Print file to stdout."""
637
b = Branch('.')
638
b.print_file(b.relpath(filename), int(revision))
639
640
641
######################################################################
642
# internal/test commands
643
644
645
def cmd_uuid():
646
"""Print a newly-generated UUID."""
647
print bzrlib.osutils.uuid()
648
649
650
651
def cmd_local_time_offset():
652
print bzrlib.osutils.local_time_offset()
653
654
655
656
def cmd_commit(message=None, verbose=False):
657
"""Commit changes to a new revision.
658
659
--message MESSAGE
660
Description of changes in this revision; free form text.
661
It is recommended that the first line be a single-sentence
662
summary.
663
--verbose
664
Show status of changed files,
665
666
TODO: Commit only selected files.
667
668
TODO: Run hooks on tree to-be-committed, and after commit.
669
670
TODO: Strict commit that fails if there are unknown or deleted files.
671
"""
672
673
if not message:
674
bailout("please specify a commit message")
675
Branch('.').commit(message, verbose=verbose)
676
677
678
def cmd_check(dir='.'):
679
"""check: Consistency check of branch history.
680
681
usage: bzr check [-v] [BRANCH]
682
683
options:
684
--verbose, -v Show progress of checking.
685
686
This command checks various invariants about the branch storage to
687
detect data corruption or bzr bugs.
688
"""
689
import bzrlib.check
690
bzrlib.check.check(Branch(dir, find_root=False))
691
692
693
def cmd_is(pred, *rest):
694
"""Test whether PREDICATE is true."""
695
try:
696
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
697
except KeyError:
698
bailout("unknown predicate: %s" % quotefn(pred))
699
700
try:
701
cmd_handler(*rest)
702
except BzrCheckError:
703
# by default we don't print the message so that this can
704
# be used from shell scripts without producing noise
705
sys.exit(1)
706
707
708
def cmd_whoami():
709
"""Show bzr user id.
710
711
usage: bzr whoami
712
713
TODO: Command to show only the email-address part as parsed out.
714
"""
715
print bzrlib.osutils.username()
716
717
718
def cmd_gen_revision_id():
719
print bzrlib.branch._gen_revision_id(time.time())
720
721
722
def cmd_selftest():
723
"""Run internal test suite"""
724
## -v, if present, is seen by doctest; the argument is just here
725
## so our parser doesn't complain
726
727
## TODO: --verbose option
728
729
failures, tests = 0, 0
730
731
import doctest, bzrlib.store, bzrlib.tests
732
bzrlib.trace.verbose = False
733
734
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
735
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
736
mf, mt = doctest.testmod(m)
737
failures += mf
738
tests += mt
739
print '%-40s %3d tests' % (m.__name__, mt),
740
if mf:
741
print '%3d FAILED!' % mf
742
else:
743
print
744
745
print '%-40s %3d tests' % ('total', tests),
746
if failures:
747
print '%3d FAILED!' % failures
748
else:
749
print
750
751
752
753
# deprecated
754
cmd_doctest = cmd_selftest
755
756
757
######################################################################
758
# help
759
760
761
def cmd_help(topic=None):
762
if topic == None:
763
print __doc__
764
elif topic == 'commands':
765
help_commands()
766
else:
767
# otherwise, maybe the name of a command?
768
topic, cmdfn = get_cmd_handler(topic)
769
770
doc = getdoc(cmdfn)
771
if doc == None:
772
bailout("sorry, no detailed help yet for %r" % topic)
773
774
print doc
775
776
777
def help_commands():
778
"""List all commands"""
779
accu = []
780
for k in globals().keys():
781
if k.startswith('cmd_'):
782
accu.append(k[4:].replace('_','-'))
783
accu.sort()
784
print "bzr commands: "
785
for x in accu:
786
print " " + x
787
print "note: some of these commands are internal-use or obsolete"
788
# TODO: Some kind of marker for internal-use commands?
789
# TODO: Show aliases?
790
791
792
793
794
def cmd_version():
795
print "bzr (bazaar-ng) %s" % bzrlib.__version__
796
print bzrlib.__copyright__
797
print "http://bazaar-ng.org/"
798
print
799
print \
800
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
801
you may use, modify and redistribute it under the terms of the GNU
802
General Public License version 2 or later."""
803
804
805
def cmd_rocks():
806
"""Statement of optimism."""
807
print "it sure does!"
808
809
810
811
######################################################################
812
# main routine
813
814
815
# list of all available options; the rhs can be either None for an
816
# option that takes no argument, or a constructor function that checks
817
# the type.
818
OPTIONS = {
819
'all': None,
820
'help': None,
821
'message': unicode,
822
'profile': None,
823
'revision': int,
824
'show-ids': None,
825
'timezone': str,
826
'verbose': None,
827
'version': None,
828
}
829
830
SHORT_OPTIONS = {
831
'm': 'message',
832
'r': 'revision',
833
'v': 'verbose',
834
}
835
836
# List of options that apply to particular commands; commands not
837
# listed take none.
838
cmd_options = {
839
'add': ['verbose'],
840
'cat': ['revision'],
841
'commit': ['message', 'verbose'],
842
'deleted': ['show-ids'],
843
'diff': ['revision'],
844
'inventory': ['revision'],
845
'log': ['timezone', 'verbose'],
846
'ls': ['revision', 'verbose'],
847
'remove': ['verbose'],
848
'status': ['all'],
849
}
850
851
852
cmd_args = {
853
'add': ['file+'],
854
'cat': ['filename'],
855
'commit': [],
856
'diff': ['file*'],
857
'export': ['revno', 'dest'],
858
'file-id': ['filename'],
859
'file-id-path': ['filename'],
860
'get-file-text': ['text_id'],
861
'get-inventory': ['inventory_id'],
862
'get-revision': ['revision_id'],
863
'get-revision-inventory': ['revision_id'],
864
'help': ['topic?'],
865
'init': [],
866
'log': [],
867
'lookup-revision': ['revno'],
868
'move': ['source$', 'dest'],
869
'relpath': ['filename'],
870
'remove': ['file+'],
871
'rename': ['from_name', 'to_name'],
872
'renames': ['dir?'],
873
'root': ['filename?'],
874
'status': [],
875
}
876
877
878
def parse_args(argv):
879
"""Parse command line.
880
881
Arguments and options are parsed at this level before being passed
882
down to specific command handlers. This routine knows, from a
883
lookup table, something about the available options, what optargs
884
they take, and which commands will accept them.
885
886
>>> parse_args('--help'.split())
887
([], {'help': True})
888
>>> parse_args('--version'.split())
889
([], {'version': True})
890
>>> parse_args('status --all'.split())
891
(['status'], {'all': True})
892
>>> parse_args('commit --message=biter'.split())
893
(['commit'], {'message': u'biter'})
894
"""
895
args = []
896
opts = {}
897
898
# TODO: Maybe handle '--' to end options?
899
900
while argv:
901
a = argv.pop(0)
902
if a[0] == '-':
903
# option names must not be unicode
904
a = str(a)
905
optarg = None
906
if a[1] == '-':
907
mutter(" got option %r" % a)
908
if '=' in a:
909
optname, optarg = a[2:].split('=', 1)
910
else:
911
optname = a[2:]
912
if optname not in OPTIONS:
913
bailout('unknown long option %r' % a)
914
else:
915
shortopt = a[1:]
916
if shortopt not in SHORT_OPTIONS:
917
bailout('unknown short option %r' % a)
918
optname = SHORT_OPTIONS[shortopt]
919
920
if optname in opts:
921
# XXX: Do we ever want to support this, e.g. for -r?
922
bailout('repeated option %r' % a)
923
924
optargfn = OPTIONS[optname]
925
if optargfn:
926
if optarg == None:
927
if not argv:
928
bailout('option %r needs an argument' % a)
929
else:
930
optarg = argv.pop(0)
931
opts[optname] = optargfn(optarg)
932
else:
933
if optarg != None:
934
bailout('option %r takes no argument' % optname)
935
opts[optname] = True
936
else:
937
args.append(a)
938
939
return args, opts
940
941
942
943
def _match_args(cmd, args):
944
"""Check non-option arguments match required pattern.
945
946
>>> _match_args('status', ['asdasdsadasd'])
947
Traceback (most recent call last):
948
...
949
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
950
>>> _match_args('add', ['asdasdsadasd'])
951
{'file_list': ['asdasdsadasd']}
952
>>> _match_args('add', 'abc def gj'.split())
953
{'file_list': ['abc', 'def', 'gj']}
954
"""
955
# match argument pattern
956
argform = cmd_args.get(cmd, [])
957
argdict = {}
958
# TODO: Need a way to express 'cp SRC... DEST', where it matches
959
# all but one.
960
961
# step through args and argform, allowing appropriate 0-many matches
962
for ap in argform:
963
argname = ap[:-1]
964
if ap[-1] == '?':
965
if args:
966
argdict[argname] = args.pop(0)
967
elif ap[-1] == '*': # all remaining arguments
968
if args:
969
argdict[argname + '_list'] = args[:]
970
args = []
971
else:
972
argdict[argname + '_list'] = None
973
elif ap[-1] == '+':
974
if not args:
975
bailout("command %r needs one or more %s"
976
% (cmd, argname.upper()))
977
else:
978
argdict[argname + '_list'] = args[:]
979
args = []
980
elif ap[-1] == '$': # all but one
981
if len(args) < 2:
982
bailout("command %r needs one or more %s"
983
% (cmd, argname.upper()))
984
argdict[argname + '_list'] = args[:-1]
985
args[:-1] = []
986
else:
987
# just a plain arg
988
argname = ap
989
if not args:
990
bailout("command %r requires argument %s"
991
% (cmd, argname.upper()))
992
else:
993
argdict[argname] = args.pop(0)
994
995
if args:
996
bailout("extra arguments to command %s: %r"
997
% (cmd, args))
998
999
return argdict
1000
1001
1002
1003
def run_bzr(argv):
1004
"""Execute a command.
1005
1006
This is similar to main(), but without all the trappings for
1007
logging and error handling.
1008
"""
1009
1010
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1011
1012
try:
1013
args, opts = parse_args(argv[1:])
1014
if 'help' in opts:
1015
# TODO: pass down other arguments in case they asked for
1016
# help on a command name?
1017
if args:
1018
cmd_help(args[0])
1019
else:
1020
cmd_help()
1021
return 0
1022
elif 'version' in opts:
1023
cmd_version()
1024
return 0
1025
cmd = str(args.pop(0))
1026
except IndexError:
1027
log_error('usage: bzr COMMAND')
1028
log_error(' try "bzr help"')
1029
return 1
1030
1031
canonical_cmd, cmd_handler = get_cmd_handler(cmd)
1032
1033
# global option
1034
if 'profile' in opts:
1035
profile = True
1036
del opts['profile']
1037
else:
1038
profile = False
1039
1040
# check options are reasonable
1041
allowed = cmd_options.get(canonical_cmd, [])
1042
for oname in opts:
1043
if oname not in allowed:
1044
bailout("option %r is not allowed for command %r"
1045
% (oname, cmd))
1046
1047
# TODO: give an error if there are any mandatory options which are
1048
# not specified? Or maybe there shouldn't be any "mandatory
1049
# options" (it is an oxymoron)
1050
1051
# mix arguments and options into one dictionary
1052
cmdargs = _match_args(canonical_cmd, args)
1053
for k, v in opts.items():
1054
cmdargs[k.replace('-', '_')] = v
1055
1056
if profile:
1057
import hotshot
1058
pffileno, pfname = tempfile.mkstemp()
1059
try:
1060
prof = hotshot.Profile(pfname)
1061
ret = prof.runcall(cmd_handler, **cmdargs) or 0
1062
prof.close()
1063
1064
import hotshot.stats
1065
stats = hotshot.stats.load(pfname)
1066
#stats.strip_dirs()
1067
stats.sort_stats('time')
1068
## XXX: Might like to write to stderr or the trace file instead but
1069
## print_stats seems hardcoded to stdout
1070
stats.print_stats(20)
1071
1072
return ret
1073
1074
finally:
1075
os.close(pffileno)
1076
os.remove(pfname)
1077
else:
1078
return cmd_handler(**cmdargs) or 0
1079
1080
1081
1082
def _report_exception(e, summary):
1083
import traceback
1084
log_error('bzr: ' + summary)
1085
bzrlib.trace.log_exception(e)
1086
tb = sys.exc_info()[2]
1087
exinfo = traceback.extract_tb(tb)
1088
if exinfo:
1089
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1090
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1091
1092
1093
def cmd_assert_fail():
1094
assert False, "always fails"
1095
1096
1097
def main(argv):
1098
bzrlib.trace.create_tracefile(argv)
1099
1100
try:
1101
try:
1102
ret = run_bzr(argv)
1103
return ret
1104
except BzrError, e:
1105
_report_exception(e, 'error: ' + e.args[0])
1106
if len(e.args) > 1:
1107
for h in e.args[1]:
1108
# some explanation or hints
1109
log_error(' ' + h)
1110
return 1
1111
except AssertionError, e:
1112
msg = 'assertion failed'
1113
if str(e):
1114
msg += ': ' + str(e)
1115
_report_exception(e, msg)
1116
except Exception, e:
1117
_report_exception(e, 'exception: %s' % str(e).rstrip('\n'))
1118
return 1
1119
finally:
1120
bzrlib.trace.close_trace()
1121
1122
## TODO: Trap AssertionError
1123
1124
# TODO: Maybe nicer handling of IOError especially for broken pipe.
1125
1126
1127
1128
if __name__ == '__main__':
1129
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0