« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 484
- compare with another revision
- download diff
- download tarball
- view history from revision 484
- Committer: Martin Pool
- Date: 2005-05-11 08:12:23 UTC
- Revision ID: mbp@sourcefrog.net-20050511081223-7c935881e8145274
todo
- files added:
- .bzrignore
- bzrlib
- contrib
- contrib/bash
- contrib/zsh
- doc
- elementtree
- notes
- urlgrabber
- files removed:
- .bzrignore
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
18
19
import sys, os, time, os.path
20
from sets import Set
21
22
import bzrlib
23
from bzrlib.trace import mutter, note, log_error
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
from bzrlib.tree import RevisionTree, EmptyTree, Tree
27
from bzrlib.revision import Revision
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
29
format_date
30
31
32
def _squish_command_name(cmd):
33
return 'cmd_' + cmd.replace('-', '_')
34
35
36
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
38
return cmd[4:].replace('_','-')
39
40
def get_all_cmds():
41
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
45
46
def get_cmd_class(cmd):
47
"""Return the canonical name and command class for a command.
48
"""
49
cmd = str(cmd) # not unicode
50
51
# first look up this command under the specified name
52
try:
53
return cmd, globals()[_squish_command_name(cmd)]
54
except KeyError:
55
pass
56
57
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
61
62
cmdclass = ExternalCommand.find_command(cmd)
63
if cmdclass:
64
return cmd, cmdclass
65
66
raise BzrCommandError("unknown command %r" % cmd)
67
68
69
class Command:
70
"""Base class for commands.
71
72
The docstring for an actual command should give a single-line
73
summary, then a complete description of the command. A grammar
74
description will be inserted.
75
76
takes_args
77
List of argument forms, marked with whether they are optional,
78
repeated, etc.
79
80
takes_options
81
List of options that may be given for this command.
82
83
hidden
84
If true, this command isn't advertised.
85
"""
86
aliases = []
87
88
takes_args = []
89
takes_options = []
90
91
hidden = False
92
93
def __init__(self, options, arguments):
94
"""Construct and run the command.
95
96
Sets self.status to the return value of run()."""
97
assert isinstance(options, dict)
98
assert isinstance(arguments, dict)
99
cmdargs = options.copy()
100
cmdargs.update(arguments)
101
assert self.__doc__ != Command.__doc__, \
102
("No help message set for %r" % self)
103
self.status = self.run(**cmdargs)
104
105
106
def run(self):
107
"""Override this in sub-classes.
108
109
This is invoked with the options and arguments bound to
110
keyword parameters.
111
112
Return 0 or None if the command was successful, or a shell
113
error code if not.
114
"""
115
return 0
116
117
118
class ExternalCommand(Command):
119
"""Class to wrap external commands.
120
121
We cheat a little here, when get_cmd_class() calls us we actually give it back
122
an object we construct that has the appropriate path, help, options etc for the
123
specified command.
124
125
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
126
method, which we override to call the Command.__init__ method. That then calls
127
our run method which is pretty straight forward.
128
129
The only wrinkle is that we have to map bzr's dictionary of options and arguments
130
back into command line options and arguments for the script.
131
"""
132
133
def find_command(cls, cmd):
134
bzrpath = os.environ.get('BZRPATH', '')
135
136
for dir in bzrpath.split(':'):
137
path = os.path.join(dir, cmd)
138
if os.path.isfile(path):
139
return ExternalCommand(path)
140
141
return None
142
143
find_command = classmethod(find_command)
144
145
def __init__(self, path):
146
self.path = path
147
148
# TODO: If either of these fail, we should detect that and
149
# assume that path is not really a bzr plugin after all.
150
151
pipe = os.popen('%s --bzr-usage' % path, 'r')
152
self.takes_options = pipe.readline().split()
153
self.takes_args = pipe.readline().split()
154
pipe.close()
155
156
pipe = os.popen('%s --bzr-help' % path, 'r')
157
self.__doc__ = pipe.read()
158
pipe.close()
159
160
def __call__(self, options, arguments):
161
Command.__init__(self, options, arguments)
162
return self
163
164
def run(self, **kargs):
165
opts = []
166
args = []
167
168
keys = kargs.keys()
169
keys.sort()
170
for name in keys:
171
value = kargs[name]
172
if OPTIONS.has_key(name):
173
# it's an option
174
opts.append('--%s' % name)
175
if value is not None and value is not True:
176
opts.append(str(value))
177
else:
178
# it's an arg, or arg list
179
if type(value) is not list:
180
value = [value]
181
for v in value:
182
if v is not None:
183
args.append(str(v))
184
185
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
186
return self.status
187
188
189
class cmd_status(Command):
190
"""Display status summary.
191
192
This reports on versioned and unknown files, reporting them
193
grouped by state. Possible states are:
194
195
added
196
Versioned in the working copy but not in the previous revision.
197
198
removed
199
Versioned in the previous revision but removed or deleted
200
in the working copy.
201
202
renamed
203
Path of this file changed from the previous revision;
204
the text may also have changed. This includes files whose
205
parent directory was renamed.
206
207
modified
208
Text has changed since the previous revision.
209
210
unchanged
211
Nothing about this file has changed since the previous revision.
212
Only shown with --all.
213
214
unknown
215
Not versioned and not matching an ignore pattern.
216
217
To see ignored files use 'bzr ignored'. For details in the
218
changes to file texts, use 'bzr diff'.
219
220
If no arguments are specified, the status of the entire working
221
directory is shown. Otherwise, only the status of the specified
222
files or directories is reported. If a directory is given, status
223
is reported for everything inside that directory.
224
"""
225
takes_args = ['file*']
226
takes_options = ['all', 'show-ids']
227
aliases = ['st', 'stat']
228
229
def run(self, all=False, show_ids=False, file_list=None):
230
if file_list:
231
b = Branch(file_list[0], lock_mode='r')
232
file_list = [b.relpath(x) for x in file_list]
233
# special case: only one path was given and it's the root
234
# of the branch
235
if file_list == ['']:
236
file_list = None
237
else:
238
b = Branch('.', lock_mode='r')
239
import status
240
status.show_status(b, show_unchanged=all, show_ids=show_ids,
241
specific_files=file_list)
242
243
244
class cmd_cat_revision(Command):
245
"""Write out metadata for a revision."""
246
247
hidden = True
248
takes_args = ['revision_id']
249
250
def run(self, revision_id):
251
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
252
253
254
class cmd_revno(Command):
255
"""Show current revision number.
256
257
This is equal to the number of revisions on this branch."""
258
def run(self):
259
print Branch('.').revno()
260
261
262
class cmd_add(Command):
263
"""Add specified files or directories.
264
265
In non-recursive mode, all the named items are added, regardless
266
of whether they were previously ignored. A warning is given if
267
any of the named files are already versioned.
268
269
In recursive mode (the default), files are treated the same way
270
but the behaviour for directories is different. Directories that
271
are already versioned do not give a warning. All directories,
272
whether already versioned or not, are searched for files or
273
subdirectories that are neither versioned or ignored, and these
274
are added. This search proceeds recursively into versioned
275
directories.
276
277
Therefore simply saying 'bzr add .' will version all files that
278
are currently unknown.
279
280
TODO: Perhaps adding a file whose directly is not versioned should
281
recursively add that parent, rather than giving an error?
282
"""
283
takes_args = ['file+']
284
takes_options = ['verbose']
285
286
def run(self, file_list, verbose=False):
287
bzrlib.add.smart_add(file_list, verbose)
288
289
290
class cmd_relpath(Command):
291
"""Show path of a file relative to root"""
292
takes_args = ['filename']
293
294
def run(self, filename):
295
print Branch(filename).relpath(filename)
296
297
298
299
class cmd_inventory(Command):
300
"""Show inventory of the current working copy or a revision."""
301
takes_options = ['revision']
302
303
def run(self, revision=None):
304
b = Branch('.')
305
if revision == None:
306
inv = b.read_working_inventory()
307
else:
308
inv = b.get_revision_inventory(b.lookup_revision(revision))
309
310
for path, entry in inv.iter_entries():
311
print '%-50s %s' % (entry.file_id, path)
312
313
314
class cmd_move(Command):
315
"""Move files to a different directory.
316
317
examples:
318
bzr move *.txt doc
319
320
The destination must be a versioned directory in the same branch.
321
"""
322
takes_args = ['source$', 'dest']
323
def run(self, source_list, dest):
324
b = Branch('.')
325
326
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
327
328
329
class cmd_rename(Command):
330
"""Change the name of an entry.
331
332
examples:
333
bzr rename frob.c frobber.c
334
bzr rename src/frob.c lib/frob.c
335
336
It is an error if the destination name exists.
337
338
See also the 'move' command, which moves files into a different
339
directory without changing their name.
340
341
TODO: Some way to rename multiple files without invoking bzr for each
342
one?"""
343
takes_args = ['from_name', 'to_name']
344
345
def run(self, from_name, to_name):
346
b = Branch('.')
347
b.rename_one(b.relpath(from_name), b.relpath(to_name))
348
349
350
351
class cmd_renames(Command):
352
"""Show list of renamed files.
353
354
TODO: Option to show renames between two historical versions.
355
356
TODO: Only show renames under dir, rather than in the whole branch.
357
"""
358
takes_args = ['dir?']
359
360
def run(self, dir='.'):
361
b = Branch(dir)
362
old_inv = b.basis_tree().inventory
363
new_inv = b.read_working_inventory()
364
365
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
366
renames.sort()
367
for old_name, new_name in renames:
368
print "%s => %s" % (old_name, new_name)
369
370
371
class cmd_info(Command):
372
"""Show statistical information about a branch."""
373
takes_args = ['branch?']
374
375
def run(self, branch=None):
376
import info
377
378
from branch import find_branch
379
b = find_branch(branch)
380
info.show_info(b)
381
382
383
class cmd_remove(Command):
384
"""Make a file unversioned.
385
386
This makes bzr stop tracking changes to a versioned file. It does
387
not delete the working copy.
388
"""
389
takes_args = ['file+']
390
takes_options = ['verbose']
391
392
def run(self, file_list, verbose=False):
393
b = Branch(file_list[0])
394
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
395
396
397
class cmd_file_id(Command):
398
"""Print file_id of a particular file or directory.
399
400
The file_id is assigned when the file is first added and remains the
401
same through all revisions where the file exists, even when it is
402
moved or renamed.
403
"""
404
hidden = True
405
takes_args = ['filename']
406
def run(self, filename):
407
b = Branch(filename)
408
i = b.inventory.path2id(b.relpath(filename))
409
if i == None:
410
bailout("%r is not a versioned file" % filename)
411
else:
412
print i
413
414
415
class cmd_file_path(Command):
416
"""Print path of file_ids to a file or directory.
417
418
This prints one line for each directory down to the target,
419
starting at the branch root."""
420
hidden = True
421
takes_args = ['filename']
422
def run(self, filename):
423
b = Branch(filename)
424
inv = b.inventory
425
fid = inv.path2id(b.relpath(filename))
426
if fid == None:
427
bailout("%r is not a versioned file" % filename)
428
for fip in inv.get_idpath(fid):
429
print fip
430
431
432
class cmd_revision_history(Command):
433
"""Display list of revision ids on this branch."""
434
def run(self):
435
for patchid in Branch('.').revision_history():
436
print patchid
437
438
439
class cmd_directories(Command):
440
"""Display list of versioned directories in this branch."""
441
def run(self):
442
for name, ie in Branch('.').read_working_inventory().directories():
443
if name == '':
444
print '.'
445
else:
446
print name
447
448
449
class cmd_init(Command):
450
"""Make a directory into a versioned branch.
451
452
Use this to create an empty branch, or before importing an
453
existing project.
454
455
Recipe for importing a tree of files:
456
cd ~/project
457
bzr init
458
bzr add -v .
459
bzr status
460
bzr commit -m 'imported project'
461
"""
462
def run(self):
463
Branch('.', init=True)
464
465
466
class cmd_diff(Command):
467
"""Show differences in working tree.
468
469
If files are listed, only the changes in those files are listed.
470
Otherwise, all changes for the tree are listed.
471
472
TODO: Given two revision arguments, show the difference between them.
473
474
TODO: Allow diff across branches.
475
476
TODO: Option to use external diff command; could be GNU diff, wdiff,
477
or a graphical diff.
478
479
TODO: Python difflib is not exactly the same as unidiff; should
480
either fix it up or prefer to use an external diff.
481
482
TODO: If a directory is given, diff everything under that.
483
484
TODO: Selected-file diff is inefficient and doesn't show you
485
deleted files.
486
487
TODO: This probably handles non-Unix newlines poorly.
488
"""
489
490
takes_args = ['file*']
491
takes_options = ['revision']
492
aliases = ['di']
493
494
def run(self, revision=None, file_list=None):
495
from bzrlib.diff import show_diff
496
497
show_diff(Branch('.'), revision, specific_files=file_list)
498
499
500
501
502
503
class cmd_deleted(Command):
504
"""List files deleted in the working tree.
505
506
TODO: Show files deleted since a previous revision, or between two revisions.
507
"""
508
def run(self, show_ids=False):
509
b = Branch('.')
510
old = b.basis_tree()
511
new = b.working_tree()
512
513
## TODO: Much more efficient way to do this: read in new
514
## directories with readdir, rather than stating each one. Same
515
## level of effort but possibly much less IO. (Or possibly not,
516
## if the directories are very large...)
517
518
for path, ie in old.inventory.iter_entries():
519
if not new.has_id(ie.file_id):
520
if show_ids:
521
print '%-50s %s' % (path, ie.file_id)
522
else:
523
print path
524
525
526
class cmd_modified(Command):
527
"""List files modified in working tree."""
528
hidden = True
529
def run(self):
530
import statcache
531
b = Branch('.')
532
inv = b.read_working_inventory()
533
sc = statcache.update_cache(b, inv)
534
basis = b.basis_tree()
535
basis_inv = basis.inventory
536
537
# We used to do this through iter_entries(), but that's slow
538
# when most of the files are unmodified, as is usually the
539
# case. So instead we iterate by inventory entry, and only
540
# calculate paths as necessary.
541
542
for file_id in basis_inv:
543
cacheentry = sc.get(file_id)
544
if not cacheentry: # deleted
545
continue
546
ie = basis_inv[file_id]
547
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
548
path = inv.id2path(file_id)
549
print path
550
551
552
553
class cmd_added(Command):
554
"""List files added in working tree."""
555
hidden = True
556
def run(self):
557
b = Branch('.')
558
wt = b.working_tree()
559
basis_inv = b.basis_tree().inventory
560
inv = wt.inventory
561
for file_id in inv:
562
if file_id in basis_inv:
563
continue
564
path = inv.id2path(file_id)
565
if not os.access(b.abspath(path), os.F_OK):
566
continue
567
print path
568
569
570
571
class cmd_root(Command):
572
"""Show the tree root directory.
573
574
The root is the nearest enclosing directory with a .bzr control
575
directory."""
576
takes_args = ['filename?']
577
def run(self, filename=None):
578
"""Print the branch root."""
579
from branch import find_branch
580
b = find_branch(filename)
581
print getattr(b, 'base', None) or getattr(b, 'baseurl')
582
583
584
class cmd_log(Command):
585
"""Show log of this branch.
586
587
TODO: Option to limit range.
588
589
TODO: Perhaps show most-recent first with an option for last.
590
"""
591
takes_args = ['filename?']
592
takes_options = ['timezone', 'verbose', 'show-ids']
593
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
594
from branch import find_branch
595
b = find_branch((filename or '.'), lock_mode='r')
596
if filename:
597
filename = b.relpath(filename)
598
bzrlib.show_log(b, filename,
599
show_timezone=timezone,
600
verbose=verbose,
601
show_ids=show_ids)
602
603
604
605
class cmd_touching_revisions(Command):
606
"""Return revision-ids which affected a particular file."""
607
hidden = True
608
takes_args = ["filename"]
609
def run(self, filename):
610
b = Branch(filename, lock_mode='r')
611
inv = b.read_working_inventory()
612
file_id = inv.path2id(b.relpath(filename))
613
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
614
print "%6d %s" % (revno, what)
615
616
617
class cmd_ls(Command):
618
"""List files in a tree.
619
620
TODO: Take a revision or remote path and list that tree instead.
621
"""
622
hidden = True
623
def run(self, revision=None, verbose=False):
624
b = Branch('.')
625
if revision == None:
626
tree = b.working_tree()
627
else:
628
tree = b.revision_tree(b.lookup_revision(revision))
629
630
for fp, fc, kind, fid in tree.list_files():
631
if verbose:
632
if kind == 'directory':
633
kindch = '/'
634
elif kind == 'file':
635
kindch = ''
636
else:
637
kindch = '???'
638
639
print '%-8s %s%s' % (fc, fp, kindch)
640
else:
641
print fp
642
643
644
645
class cmd_unknowns(Command):
646
"""List unknown files"""
647
def run(self):
648
for f in Branch('.').unknowns():
649
print quotefn(f)
650
651
652
653
class cmd_ignore(Command):
654
"""Ignore a command or pattern
655
656
To remove patterns from the ignore list, edit the .bzrignore file.
657
658
If the pattern contains a slash, it is compared to the whole path
659
from the branch root. Otherwise, it is comapred to only the last
660
component of the path.
661
662
Ignore patterns are case-insensitive on case-insensitive systems.
663
664
Note: wildcards must be quoted from the shell on Unix.
665
666
examples:
667
bzr ignore ./Makefile
668
bzr ignore '*.class'
669
"""
670
takes_args = ['name_pattern']
671
672
def run(self, name_pattern):
673
from bzrlib.atomicfile import AtomicFile
674
import codecs
675
676
b = Branch('.')
677
ifn = b.abspath('.bzrignore')
678
679
# FIXME: probably doesn't handle non-ascii patterns
680
681
if os.path.exists(ifn):
682
f = b.controlfile(ifn, 'rt')
683
igns = f.read()
684
f.close()
685
else:
686
igns = ''
687
688
if igns and igns[-1] != '\n':
689
igns += '\n'
690
igns += name_pattern + '\n'
691
692
f = AtomicFile(ifn, 'wt')
693
f.write(igns)
694
f.commit()
695
696
inv = b.working_tree().inventory
697
if inv.path2id('.bzrignore'):
698
mutter('.bzrignore is already versioned')
699
else:
700
mutter('need to make new .bzrignore file versioned')
701
b.add(['.bzrignore'])
702
703
704
705
class cmd_ignored(Command):
706
"""List ignored files and the patterns that matched them.
707
708
See also: bzr ignore"""
709
def run(self):
710
tree = Branch('.').working_tree()
711
for path, file_class, kind, file_id in tree.list_files():
712
if file_class != 'I':
713
continue
714
## XXX: Slightly inefficient since this was already calculated
715
pat = tree.is_ignored(path)
716
print '%-50s %s' % (path, pat)
717
718
719
class cmd_lookup_revision(Command):
720
"""Lookup the revision-id from a revision-number
721
722
example:
723
bzr lookup-revision 33
724
"""
725
hidden = True
726
takes_args = ['revno']
727
728
def run(self, revno):
729
try:
730
revno = int(revno)
731
except ValueError:
732
raise BzrCommandError("not a valid revision-number: %r" % revno)
733
734
print Branch('.').lookup_revision(revno)
735
736
737
class cmd_export(Command):
738
"""Export past revision to destination directory.
739
740
If no revision is specified this exports the last committed revision."""
741
takes_args = ['dest']
742
takes_options = ['revision']
743
def run(self, dest, revision=None):
744
b = Branch('.')
745
if revision == None:
746
rh = b.revision_history()[-1]
747
else:
748
rh = b.lookup_revision(int(revision))
749
t = b.revision_tree(rh)
750
t.export(dest)
751
752
753
class cmd_cat(Command):
754
"""Write a file's text from a previous revision."""
755
756
takes_options = ['revision']
757
takes_args = ['filename']
758
759
def run(self, filename, revision=None):
760
if revision == None:
761
raise BzrCommandError("bzr cat requires a revision number")
762
b = Branch('.')
763
b.print_file(b.relpath(filename), int(revision))
764
765
766
class cmd_local_time_offset(Command):
767
"""Show the offset in seconds from GMT to local time."""
768
hidden = True
769
def run(self):
770
print bzrlib.osutils.local_time_offset()
771
772
773
774
class cmd_commit(Command):
775
"""Commit changes into a new revision.
776
777
TODO: Commit only selected files.
778
779
TODO: Run hooks on tree to-be-committed, and after commit.
780
781
TODO: Strict commit that fails if there are unknown or deleted files.
782
"""
783
takes_options = ['message', 'file', 'verbose']
784
aliases = ['ci', 'checkin']
785
786
def run(self, message=None, file=None, verbose=False):
787
## Warning: shadows builtin file()
788
if not message and not file:
789
raise BzrCommandError("please specify a commit message",
790
["use either --message or --file"])
791
elif message and file:
792
raise BzrCommandError("please specify either --message or --file")
793
794
if file:
795
import codecs
796
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
797
798
Branch('.').commit(message, verbose=verbose)
799
800
801
class cmd_check(Command):
802
"""Validate consistency of branch history.
803
804
This command checks various invariants about the branch storage to
805
detect data corruption or bzr bugs.
806
"""
807
takes_args = ['dir?']
808
def run(self, dir='.'):
809
import bzrlib.check
810
bzrlib.check.check(Branch(dir, find_root=False))
811
812
813
814
class cmd_whoami(Command):
815
"""Show bzr user id."""
816
takes_options = ['email']
817
818
def run(self, email=False):
819
if email:
820
print bzrlib.osutils.user_email()
821
else:
822
print bzrlib.osutils.username()
823
824
825
class cmd_selftest(Command):
826
"""Run internal test suite"""
827
hidden = True
828
def run(self):
829
failures, tests = 0, 0
830
831
import doctest, bzrlib.store, bzrlib.tests
832
bzrlib.trace.verbose = False
833
834
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
835
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
836
mf, mt = doctest.testmod(m)
837
failures += mf
838
tests += mt
839
print '%-40s %3d tests' % (m.__name__, mt),
840
if mf:
841
print '%3d FAILED!' % mf
842
else:
843
print
844
845
print '%-40s %3d tests' % ('total', tests),
846
if failures:
847
print '%3d FAILED!' % failures
848
else:
849
print
850
851
852
853
class cmd_version(Command):
854
"""Show version of bzr"""
855
def run(self):
856
show_version()
857
858
def show_version():
859
print "bzr (bazaar-ng) %s" % bzrlib.__version__
860
print bzrlib.__copyright__
861
print "http://bazaar-ng.org/"
862
print
863
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
864
print "you may use, modify and redistribute it under the terms of the GNU"
865
print "General Public License version 2 or later."
866
867
868
class cmd_rocks(Command):
869
"""Statement of optimism."""
870
hidden = True
871
def run(self):
872
print "it sure does!"
873
874
875
class cmd_assert_fail(Command):
876
"""Test reporting of assertion failures"""
877
hidden = True
878
def run(self):
879
assert False, "always fails"
880
881
882
class cmd_help(Command):
883
"""Show help on a command or other topic.
884
885
For a list of all available commands, say 'bzr help commands'."""
886
takes_args = ['topic?']
887
aliases = ['?']
888
889
def run(self, topic=None):
890
import help
891
help.help(topic)
892
893
894
class cmd_update_stat_cache(Command):
895
"""Update stat-cache mapping inodes to SHA-1 hashes.
896
897
For testing only."""
898
hidden = True
899
def run(self):
900
import statcache
901
b = Branch('.')
902
statcache.update_cache(b.base, b.read_working_inventory())
903
904
905
######################################################################
906
# main routine
907
908
909
# list of all available options; the rhs can be either None for an
910
# option that takes no argument, or a constructor function that checks
911
# the type.
912
OPTIONS = {
913
'all': None,
914
'help': None,
915
'file': unicode,
916
'message': unicode,
917
'profile': None,
918
'revision': int,
919
'show-ids': None,
920
'timezone': str,
921
'verbose': None,
922
'version': None,
923
'email': None,
924
}
925
926
SHORT_OPTIONS = {
927
'm': 'message',
928
'F': 'file',
929
'r': 'revision',
930
'v': 'verbose',
931
}
932
933
934
def parse_args(argv):
935
"""Parse command line.
936
937
Arguments and options are parsed at this level before being passed
938
down to specific command handlers. This routine knows, from a
939
lookup table, something about the available options, what optargs
940
they take, and which commands will accept them.
941
942
>>> parse_args('--help'.split())
943
([], {'help': True})
944
>>> parse_args('--version'.split())
945
([], {'version': True})
946
>>> parse_args('status --all'.split())
947
(['status'], {'all': True})
948
>>> parse_args('commit --message=biter'.split())
949
(['commit'], {'message': u'biter'})
950
"""
951
args = []
952
opts = {}
953
954
# TODO: Maybe handle '--' to end options?
955
956
while argv:
957
a = argv.pop(0)
958
if a[0] == '-':
959
# option names must not be unicode
960
a = str(a)
961
optarg = None
962
if a[1] == '-':
963
mutter(" got option %r" % a)
964
if '=' in a:
965
optname, optarg = a[2:].split('=', 1)
966
else:
967
optname = a[2:]
968
if optname not in OPTIONS:
969
bailout('unknown long option %r' % a)
970
else:
971
shortopt = a[1:]
972
if shortopt not in SHORT_OPTIONS:
973
bailout('unknown short option %r' % a)
974
optname = SHORT_OPTIONS[shortopt]
975
976
if optname in opts:
977
# XXX: Do we ever want to support this, e.g. for -r?
978
bailout('repeated option %r' % a)
979
980
optargfn = OPTIONS[optname]
981
if optargfn:
982
if optarg == None:
983
if not argv:
984
bailout('option %r needs an argument' % a)
985
else:
986
optarg = argv.pop(0)
987
opts[optname] = optargfn(optarg)
988
else:
989
if optarg != None:
990
bailout('option %r takes no argument' % optname)
991
opts[optname] = True
992
else:
993
args.append(a)
994
995
return args, opts
996
997
998
999
1000
def _match_argform(cmd, takes_args, args):
1001
argdict = {}
1002
1003
# step through args and takes_args, allowing appropriate 0-many matches
1004
for ap in takes_args:
1005
argname = ap[:-1]
1006
if ap[-1] == '?':
1007
if args:
1008
argdict[argname] = args.pop(0)
1009
elif ap[-1] == '*': # all remaining arguments
1010
if args:
1011
argdict[argname + '_list'] = args[:]
1012
args = []
1013
else:
1014
argdict[argname + '_list'] = None
1015
elif ap[-1] == '+':
1016
if not args:
1017
raise BzrCommandError("command %r needs one or more %s"
1018
% (cmd, argname.upper()))
1019
else:
1020
argdict[argname + '_list'] = args[:]
1021
args = []
1022
elif ap[-1] == '$': # all but one
1023
if len(args) < 2:
1024
raise BzrCommandError("command %r needs one or more %s"
1025
% (cmd, argname.upper()))
1026
argdict[argname + '_list'] = args[:-1]
1027
args[:-1] = []
1028
else:
1029
# just a plain arg
1030
argname = ap
1031
if not args:
1032
raise BzrCommandError("command %r requires argument %s"
1033
% (cmd, argname.upper()))
1034
else:
1035
argdict[argname] = args.pop(0)
1036
1037
if args:
1038
raise BzrCommandError("extra argument to command %s: %s"
1039
% (cmd, args[0]))
1040
1041
return argdict
1042
1043
1044
1045
def run_bzr(argv):
1046
"""Execute a command.
1047
1048
This is similar to main(), but without all the trappings for
1049
logging and error handling.
1050
"""
1051
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1052
1053
try:
1054
args, opts = parse_args(argv[1:])
1055
if 'help' in opts:
1056
import help
1057
if args:
1058
help.help(args[0])
1059
else:
1060
help.help()
1061
return 0
1062
elif 'version' in opts:
1063
show_version()
1064
return 0
1065
cmd = str(args.pop(0))
1066
except IndexError:
1067
import help
1068
help.help()
1069
return 1
1070
1071
1072
canonical_cmd, cmd_class = get_cmd_class(cmd)
1073
1074
# global option
1075
if 'profile' in opts:
1076
profile = True
1077
del opts['profile']
1078
else:
1079
profile = False
1080
1081
# check options are reasonable
1082
allowed = cmd_class.takes_options
1083
for oname in opts:
1084
if oname not in allowed:
1085
raise BzrCommandError("option '--%s' is not allowed for command %r"
1086
% (oname, cmd))
1087
1088
# mix arguments and options into one dictionary
1089
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1090
cmdopts = {}
1091
for k, v in opts.items():
1092
cmdopts[k.replace('-', '_')] = v
1093
1094
if profile:
1095
import hotshot, tempfile
1096
pffileno, pfname = tempfile.mkstemp()
1097
try:
1098
prof = hotshot.Profile(pfname)
1099
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1100
prof.close()
1101
1102
import hotshot.stats
1103
stats = hotshot.stats.load(pfname)
1104
#stats.strip_dirs()
1105
stats.sort_stats('time')
1106
## XXX: Might like to write to stderr or the trace file instead but
1107
## print_stats seems hardcoded to stdout
1108
stats.print_stats(20)
1109
1110
return ret.status
1111
1112
finally:
1113
os.close(pffileno)
1114
os.remove(pfname)
1115
else:
1116
cmdobj = cmd_class(cmdopts, cmdargs).status
1117
1118
1119
def _report_exception(summary, quiet=False):
1120
import traceback
1121
log_error('bzr: ' + summary)
1122
bzrlib.trace.log_exception()
1123
1124
if not quiet:
1125
tb = sys.exc_info()[2]
1126
exinfo = traceback.extract_tb(tb)
1127
if exinfo:
1128
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1129
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1130
1131
1132
1133
def main(argv):
1134
import errno
1135
1136
bzrlib.open_tracefile(argv)
1137
1138
try:
1139
try:
1140
try:
1141
return run_bzr(argv)
1142
finally:
1143
# do this here inside the exception wrappers to catch EPIPE
1144
sys.stdout.flush()
1145
except BzrError, e:
1146
quiet = isinstance(e, (BzrCommandError))
1147
_report_exception('error: ' + e.args[0], quiet=quiet)
1148
if len(e.args) > 1:
1149
for h in e.args[1]:
1150
# some explanation or hints
1151
log_error(' ' + h)
1152
return 1
1153
except AssertionError, e:
1154
msg = 'assertion failed'
1155
if str(e):
1156
msg += ': ' + str(e)
1157
_report_exception(msg)
1158
return 2
1159
except KeyboardInterrupt, e:
1160
_report_exception('interrupted', quiet=True)
1161
return 2
1162
except Exception, e:
1163
quiet = False
1164
if (isinstance(e, IOError)
1165
and hasattr(e, 'errno')
1166
and e.errno == errno.EPIPE):
1167
quiet = True
1168
msg = 'broken pipe'
1169
else:
1170
msg = str(e).rstrip('\n')
1171
_report_exception(msg, quiet)
1172
return 2
1173
finally:
1174
bzrlib.trace.close_trace()
1175
1176
1177
if __name__ == '__main__':
1178
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1