« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 542
- compare with another revision
- download diff
- download tarball
- view history from revision 542
- Committer: Martin Pool
- Date: 2005-05-19 08:31:06 UTC
- Revision ID: mbp@sourcefrog.net-20050519083106-ebe71562d3bda4a7
- fix typo
- files added:
- .bzrignore
- bzrlib
- contrib
- contrib/bash
- contrib/zsh
- doc
- elementtree
- notes
- patches
- 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
21
import bzrlib
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
25
from bzrlib.tree import RevisionTree, EmptyTree, Tree
26
from bzrlib.revision import Revision
27
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
28
format_date
29
from bzrlib import merge
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: Option to show in forward order.
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 bzrlib import show_log, find_branch
595
596
if filename:
597
b = find_branch(filename, lock_mode='r')
598
fp = b.relpath(filename)
599
if fp:
600
file_id = b.read_working_inventory().path2id(fp)
601
else:
602
file_id = None # points to branch root
603
else:
604
b = find_branch('.', lock_mode='r')
605
file_id = None
606
607
show_log(b, file_id,
608
show_timezone=timezone,
609
verbose=verbose,
610
show_ids=show_ids,
611
to_file=sys.stdout)
612
613
614
615
class cmd_touching_revisions(Command):
616
"""Return revision-ids which affected a particular file.
617
618
A more user-friendly interface is "bzr log FILE"."""
619
hidden = True
620
takes_args = ["filename"]
621
def run(self, filename):
622
b = Branch(filename, lock_mode='r')
623
inv = b.read_working_inventory()
624
file_id = inv.path2id(b.relpath(filename))
625
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
626
print "%6d %s" % (revno, what)
627
628
629
class cmd_ls(Command):
630
"""List files in a tree.
631
632
TODO: Take a revision or remote path and list that tree instead.
633
"""
634
hidden = True
635
def run(self, revision=None, verbose=False):
636
b = Branch('.')
637
if revision == None:
638
tree = b.working_tree()
639
else:
640
tree = b.revision_tree(b.lookup_revision(revision))
641
642
for fp, fc, kind, fid in tree.list_files():
643
if verbose:
644
if kind == 'directory':
645
kindch = '/'
646
elif kind == 'file':
647
kindch = ''
648
else:
649
kindch = '???'
650
651
print '%-8s %s%s' % (fc, fp, kindch)
652
else:
653
print fp
654
655
656
657
class cmd_unknowns(Command):
658
"""List unknown files"""
659
def run(self):
660
for f in Branch('.').unknowns():
661
print quotefn(f)
662
663
664
665
class cmd_ignore(Command):
666
"""Ignore a command or pattern
667
668
To remove patterns from the ignore list, edit the .bzrignore file.
669
670
If the pattern contains a slash, it is compared to the whole path
671
from the branch root. Otherwise, it is comapred to only the last
672
component of the path.
673
674
Ignore patterns are case-insensitive on case-insensitive systems.
675
676
Note: wildcards must be quoted from the shell on Unix.
677
678
examples:
679
bzr ignore ./Makefile
680
bzr ignore '*.class'
681
"""
682
takes_args = ['name_pattern']
683
684
def run(self, name_pattern):
685
from bzrlib.atomicfile import AtomicFile
686
import codecs
687
688
b = Branch('.')
689
ifn = b.abspath('.bzrignore')
690
691
if os.path.exists(ifn):
692
f = open(ifn, 'rt')
693
try:
694
igns = f.read().decode('utf-8')
695
finally:
696
f.close()
697
else:
698
igns = ''
699
700
if igns and igns[-1] != '\n':
701
igns += '\n'
702
igns += name_pattern + '\n'
703
704
try:
705
f = AtomicFile(ifn, 'wt')
706
f.write(igns.encode('utf-8'))
707
f.commit()
708
finally:
709
f.close()
710
711
inv = b.working_tree().inventory
712
if inv.path2id('.bzrignore'):
713
mutter('.bzrignore is already versioned')
714
else:
715
mutter('need to make new .bzrignore file versioned')
716
b.add(['.bzrignore'])
717
718
719
720
class cmd_ignored(Command):
721
"""List ignored files and the patterns that matched them.
722
723
See also: bzr ignore"""
724
def run(self):
725
tree = Branch('.').working_tree()
726
for path, file_class, kind, file_id in tree.list_files():
727
if file_class != 'I':
728
continue
729
## XXX: Slightly inefficient since this was already calculated
730
pat = tree.is_ignored(path)
731
print '%-50s %s' % (path, pat)
732
733
734
class cmd_lookup_revision(Command):
735
"""Lookup the revision-id from a revision-number
736
737
example:
738
bzr lookup-revision 33
739
"""
740
hidden = True
741
takes_args = ['revno']
742
743
def run(self, revno):
744
try:
745
revno = int(revno)
746
except ValueError:
747
raise BzrCommandError("not a valid revision-number: %r" % revno)
748
749
print Branch('.').lookup_revision(revno)
750
751
752
class cmd_export(Command):
753
"""Export past revision to destination directory.
754
755
If no revision is specified this exports the last committed revision."""
756
takes_args = ['dest']
757
takes_options = ['revision']
758
def run(self, dest, revision=None):
759
b = Branch('.')
760
if revision == None:
761
rh = b.revision_history()[-1]
762
else:
763
rh = b.lookup_revision(int(revision))
764
t = b.revision_tree(rh)
765
t.export(dest)
766
767
768
class cmd_cat(Command):
769
"""Write a file's text from a previous revision."""
770
771
takes_options = ['revision']
772
takes_args = ['filename']
773
774
def run(self, filename, revision=None):
775
if revision == None:
776
raise BzrCommandError("bzr cat requires a revision number")
777
b = Branch('.')
778
b.print_file(b.relpath(filename), int(revision))
779
780
781
class cmd_local_time_offset(Command):
782
"""Show the offset in seconds from GMT to local time."""
783
hidden = True
784
def run(self):
785
print bzrlib.osutils.local_time_offset()
786
787
788
789
class cmd_commit(Command):
790
"""Commit changes into a new revision.
791
792
If selected files are specified, only changes to those files are
793
committed. If a directory is specified then its contents are also
794
committed.
795
796
A selected-file commit may fail in some cases where the committed
797
tree would be invalid, such as trying to commit a file in a
798
newly-added directory that is not itself committed.
799
800
TODO: Run hooks on tree to-be-committed, and after commit.
801
802
TODO: Strict commit that fails if there are unknown or deleted files.
803
"""
804
takes_args = ['selected*']
805
takes_options = ['message', 'file', 'verbose']
806
aliases = ['ci', 'checkin']
807
808
def run(self, message=None, file=None, verbose=True, selected_list=None):
809
from bzrlib.commit import commit
810
811
## Warning: shadows builtin file()
812
if not message and not file:
813
raise BzrCommandError("please specify a commit message",
814
["use either --message or --file"])
815
elif message and file:
816
raise BzrCommandError("please specify either --message or --file")
817
818
if file:
819
import codecs
820
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
821
822
b = Branch('.')
823
commit(b, message, verbose=verbose, specific_files=selected_list)
824
825
826
class cmd_check(Command):
827
"""Validate consistency of branch history.
828
829
This command checks various invariants about the branch storage to
830
detect data corruption or bzr bugs.
831
"""
832
takes_args = ['dir?']
833
def run(self, dir='.'):
834
import bzrlib.check
835
bzrlib.check.check(Branch(dir))
836
837
838
839
class cmd_whoami(Command):
840
"""Show bzr user id."""
841
takes_options = ['email']
842
843
def run(self, email=False):
844
if email:
845
print bzrlib.osutils.user_email()
846
else:
847
print bzrlib.osutils.username()
848
849
850
class cmd_selftest(Command):
851
"""Run internal test suite"""
852
hidden = True
853
def run(self):
854
failures, tests = 0, 0
855
856
import doctest, bzrlib.store
857
bzrlib.trace.verbose = False
858
859
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
860
bzrlib.tree, bzrlib.commands, bzrlib.add:
861
mf, mt = doctest.testmod(m)
862
failures += mf
863
tests += mt
864
print '%-40s %3d tests' % (m.__name__, mt),
865
if mf:
866
print '%3d FAILED!' % mf
867
else:
868
print
869
870
print '%-40s %3d tests' % ('total', tests),
871
if failures:
872
print '%3d FAILED!' % failures
873
return 1
874
else:
875
print
876
return 0
877
878
879
880
class cmd_version(Command):
881
"""Show version of bzr"""
882
def run(self):
883
show_version()
884
885
def show_version():
886
print "bzr (bazaar-ng) %s" % bzrlib.__version__
887
print bzrlib.__copyright__
888
print "http://bazaar-ng.org/"
889
print
890
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
891
print "you may use, modify and redistribute it under the terms of the GNU"
892
print "General Public License version 2 or later."
893
894
895
class cmd_rocks(Command):
896
"""Statement of optimism."""
897
hidden = True
898
def run(self):
899
print "it sure does!"
900
901
def parse_spec(spec):
902
if '/@' in spec:
903
parsed = spec.split('/@')
904
assert len(parsed) == 2
905
if parsed[1] == "":
906
parsed[1] = -1
907
else:
908
parsed[1] = int(parsed[1])
909
assert parsed[1] >=0
910
else:
911
parsed = [spec, None]
912
return parsed
913
914
class cmd_merge(Command):
915
"""Perform a three-way merge of trees."""
916
takes_args = ['other_spec', 'base_spec']
917
918
def run(self, other_spec, base_spec):
919
merge.merge(parse_spec(other_spec), parse_spec(base_spec))
920
921
class cmd_assert_fail(Command):
922
"""Test reporting of assertion failures"""
923
hidden = True
924
def run(self):
925
assert False, "always fails"
926
927
928
class cmd_help(Command):
929
"""Show help on a command or other topic.
930
931
For a list of all available commands, say 'bzr help commands'."""
932
takes_args = ['topic?']
933
aliases = ['?']
934
935
def run(self, topic=None):
936
import help
937
help.help(topic)
938
939
940
class cmd_update_stat_cache(Command):
941
"""Update stat-cache mapping inodes to SHA-1 hashes.
942
943
For testing only."""
944
hidden = True
945
def run(self):
946
import statcache
947
b = Branch('.')
948
statcache.update_cache(b.base, b.read_working_inventory())
949
950
951
######################################################################
952
# main routine
953
954
955
# list of all available options; the rhs can be either None for an
956
# option that takes no argument, or a constructor function that checks
957
# the type.
958
OPTIONS = {
959
'all': None,
960
'help': None,
961
'file': unicode,
962
'message': unicode,
963
'profile': None,
964
'revision': int,
965
'show-ids': None,
966
'timezone': str,
967
'verbose': None,
968
'version': None,
969
'email': None,
970
}
971
972
SHORT_OPTIONS = {
973
'm': 'message',
974
'F': 'file',
975
'r': 'revision',
976
'v': 'verbose',
977
}
978
979
980
def parse_args(argv):
981
"""Parse command line.
982
983
Arguments and options are parsed at this level before being passed
984
down to specific command handlers. This routine knows, from a
985
lookup table, something about the available options, what optargs
986
they take, and which commands will accept them.
987
988
>>> parse_args('--help'.split())
989
([], {'help': True})
990
>>> parse_args('--version'.split())
991
([], {'version': True})
992
>>> parse_args('status --all'.split())
993
(['status'], {'all': True})
994
>>> parse_args('commit --message=biter'.split())
995
(['commit'], {'message': u'biter'})
996
"""
997
args = []
998
opts = {}
999
1000
# TODO: Maybe handle '--' to end options?
1001
1002
while argv:
1003
a = argv.pop(0)
1004
if a[0] == '-':
1005
# option names must not be unicode
1006
a = str(a)
1007
optarg = None
1008
if a[1] == '-':
1009
mutter(" got option %r" % a)
1010
if '=' in a:
1011
optname, optarg = a[2:].split('=', 1)
1012
else:
1013
optname = a[2:]
1014
if optname not in OPTIONS:
1015
bailout('unknown long option %r' % a)
1016
else:
1017
shortopt = a[1:]
1018
if shortopt not in SHORT_OPTIONS:
1019
bailout('unknown short option %r' % a)
1020
optname = SHORT_OPTIONS[shortopt]
1021
1022
if optname in opts:
1023
# XXX: Do we ever want to support this, e.g. for -r?
1024
bailout('repeated option %r' % a)
1025
1026
optargfn = OPTIONS[optname]
1027
if optargfn:
1028
if optarg == None:
1029
if not argv:
1030
bailout('option %r needs an argument' % a)
1031
else:
1032
optarg = argv.pop(0)
1033
opts[optname] = optargfn(optarg)
1034
else:
1035
if optarg != None:
1036
bailout('option %r takes no argument' % optname)
1037
opts[optname] = True
1038
else:
1039
args.append(a)
1040
1041
return args, opts
1042
1043
1044
1045
1046
def _match_argform(cmd, takes_args, args):
1047
argdict = {}
1048
1049
# step through args and takes_args, allowing appropriate 0-many matches
1050
for ap in takes_args:
1051
argname = ap[:-1]
1052
if ap[-1] == '?':
1053
if args:
1054
argdict[argname] = args.pop(0)
1055
elif ap[-1] == '*': # all remaining arguments
1056
if args:
1057
argdict[argname + '_list'] = args[:]
1058
args = []
1059
else:
1060
argdict[argname + '_list'] = None
1061
elif ap[-1] == '+':
1062
if not args:
1063
raise BzrCommandError("command %r needs one or more %s"
1064
% (cmd, argname.upper()))
1065
else:
1066
argdict[argname + '_list'] = args[:]
1067
args = []
1068
elif ap[-1] == '$': # all but one
1069
if len(args) < 2:
1070
raise BzrCommandError("command %r needs one or more %s"
1071
% (cmd, argname.upper()))
1072
argdict[argname + '_list'] = args[:-1]
1073
args[:-1] = []
1074
else:
1075
# just a plain arg
1076
argname = ap
1077
if not args:
1078
raise BzrCommandError("command %r requires argument %s"
1079
% (cmd, argname.upper()))
1080
else:
1081
argdict[argname] = args.pop(0)
1082
1083
if args:
1084
raise BzrCommandError("extra argument to command %s: %s"
1085
% (cmd, args[0]))
1086
1087
return argdict
1088
1089
1090
1091
def run_bzr(argv):
1092
"""Execute a command.
1093
1094
This is similar to main(), but without all the trappings for
1095
logging and error handling.
1096
"""
1097
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1098
1099
try:
1100
args, opts = parse_args(argv[1:])
1101
if 'help' in opts:
1102
import help
1103
if args:
1104
help.help(args[0])
1105
else:
1106
help.help()
1107
return 0
1108
elif 'version' in opts:
1109
show_version()
1110
return 0
1111
cmd = str(args.pop(0))
1112
except IndexError:
1113
import help
1114
help.help()
1115
return 1
1116
1117
1118
canonical_cmd, cmd_class = get_cmd_class(cmd)
1119
1120
# global option
1121
if 'profile' in opts:
1122
profile = True
1123
del opts['profile']
1124
else:
1125
profile = False
1126
1127
# check options are reasonable
1128
allowed = cmd_class.takes_options
1129
for oname in opts:
1130
if oname not in allowed:
1131
raise BzrCommandError("option '--%s' is not allowed for command %r"
1132
% (oname, cmd))
1133
1134
# mix arguments and options into one dictionary
1135
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1136
cmdopts = {}
1137
for k, v in opts.items():
1138
cmdopts[k.replace('-', '_')] = v
1139
1140
if profile:
1141
import hotshot, tempfile
1142
pffileno, pfname = tempfile.mkstemp()
1143
try:
1144
prof = hotshot.Profile(pfname)
1145
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1146
prof.close()
1147
1148
import hotshot.stats
1149
stats = hotshot.stats.load(pfname)
1150
#stats.strip_dirs()
1151
stats.sort_stats('time')
1152
## XXX: Might like to write to stderr or the trace file instead but
1153
## print_stats seems hardcoded to stdout
1154
stats.print_stats(20)
1155
1156
return ret.status
1157
1158
finally:
1159
os.close(pffileno)
1160
os.remove(pfname)
1161
else:
1162
return cmd_class(cmdopts, cmdargs).status
1163
1164
1165
def _report_exception(summary, quiet=False):
1166
import traceback
1167
log_error('bzr: ' + summary)
1168
bzrlib.trace.log_exception()
1169
1170
if not quiet:
1171
tb = sys.exc_info()[2]
1172
exinfo = traceback.extract_tb(tb)
1173
if exinfo:
1174
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1175
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1176
1177
1178
1179
def main(argv):
1180
import errno
1181
1182
bzrlib.open_tracefile(argv)
1183
1184
try:
1185
try:
1186
try:
1187
return run_bzr(argv)
1188
finally:
1189
# do this here inside the exception wrappers to catch EPIPE
1190
sys.stdout.flush()
1191
except BzrError, e:
1192
quiet = isinstance(e, (BzrCommandError))
1193
_report_exception('error: ' + e.args[0], quiet=quiet)
1194
if len(e.args) > 1:
1195
for h in e.args[1]:
1196
# some explanation or hints
1197
log_error(' ' + h)
1198
return 1
1199
except AssertionError, e:
1200
msg = 'assertion failed'
1201
if str(e):
1202
msg += ': ' + str(e)
1203
_report_exception(msg)
1204
return 2
1205
except KeyboardInterrupt, e:
1206
_report_exception('interrupted', quiet=True)
1207
return 2
1208
except Exception, e:
1209
quiet = False
1210
if (isinstance(e, IOError)
1211
and hasattr(e, 'errno')
1212
and e.errno == errno.EPIPE):
1213
quiet = True
1214
msg = 'broken pipe'
1215
else:
1216
msg = str(e).rstrip('\n')
1217
_report_exception(msg, quiet)
1218
return 2
1219
finally:
1220
bzrlib.trace.close_trace()
1221
1222
1223
if __name__ == '__main__':
1224
sys.exit(main(sys.argv))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1