~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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, WorkingTree, 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
    else:
 
62
        raise BzrCommandError("unknown command %r" % cmd)
 
63
 
 
64
 
 
65
class Command:
 
66
    """Base class for commands.
 
67
 
 
68
    The docstring for an actual command should give a single-line
 
69
    summary, then a complete description of the command.  A grammar
 
70
    description will be inserted.
 
71
 
 
72
    takes_args
 
73
        List of argument forms, marked with whether they are optional,
 
74
        repeated, etc.
 
75
 
 
76
    takes_options
 
77
        List of options that may be given for this command.
 
78
 
 
79
    hidden
 
80
        If true, this command isn't advertised.
 
81
    """
 
82
    aliases = []
 
83
    
 
84
    takes_args = []
 
85
    takes_options = []
 
86
 
 
87
    hidden = False
 
88
    
 
89
    def __init__(self, options, arguments):
 
90
        """Construct and run the command.
 
91
 
 
92
        Sets self.status to the return value of run()."""
 
93
        assert isinstance(options, dict)
 
94
        assert isinstance(arguments, dict)
 
95
        cmdargs = options.copy()
 
96
        cmdargs.update(arguments)
 
97
        assert self.__doc__ != Command.__doc__, \
 
98
               ("No help message set for %r" % self)
 
99
        self.status = self.run(**cmdargs)
 
100
 
 
101
    
 
102
    def run(self):
 
103
        """Override this in sub-classes.
 
104
 
 
105
        This is invoked with the options and arguments bound to
 
106
        keyword parameters.
 
107
 
 
108
        Return 0 or None if the command was successful, or a shell
 
109
        error code if not.
 
110
        """
 
111
        return 0
 
112
 
 
113
 
 
114
 
 
115
class cmd_status(Command):
 
116
    """Display status summary.
 
117
 
 
118
    For each file there is a single line giving its file state and name.
 
119
    The name is that in the current revision unless it is deleted or
 
120
    missing, in which case the old name is shown.
 
121
    """
 
122
    takes_options = ['all']
 
123
    aliases = ['st', 'stat']
 
124
    
 
125
    def run(self, all=False):
 
126
        #import bzrlib.status
 
127
        #bzrlib.status.tree_status(Branch('.'))
 
128
        Branch('.').show_status(show_all=all)
 
129
 
 
130
 
 
131
class cmd_cat_revision(Command):
 
132
    """Write out metadata for a revision."""
 
133
 
 
134
    hidden = True
 
135
    takes_args = ['revision_id']
 
136
    
 
137
    def run(self, revision_id):
 
138
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
139
 
 
140
 
 
141
class cmd_revno(Command):
 
142
    """Show current revision number.
 
143
 
 
144
    This is equal to the number of revisions on this branch."""
 
145
    def run(self):
 
146
        print Branch('.').revno()
 
147
 
 
148
    
 
149
class cmd_add(Command):
 
150
    """Add specified files or directories.
 
151
 
 
152
    In non-recursive mode, all the named items are added, regardless
 
153
    of whether they were previously ignored.  A warning is given if
 
154
    any of the named files are already versioned.
 
155
 
 
156
    In recursive mode (the default), files are treated the same way
 
157
    but the behaviour for directories is different.  Directories that
 
158
    are already versioned do not give a warning.  All directories,
 
159
    whether already versioned or not, are searched for files or
 
160
    subdirectories that are neither versioned or ignored, and these
 
161
    are added.  This search proceeds recursively into versioned
 
162
    directories.
 
163
 
 
164
    Therefore simply saying 'bzr add .' will version all files that
 
165
    are currently unknown.
 
166
 
 
167
    TODO: Perhaps adding a file whose directly is not versioned should
 
168
    recursively add that parent, rather than giving an error?
 
169
    """
 
170
    takes_args = ['file+']
 
171
    takes_options = ['verbose']
 
172
    
 
173
    def run(self, file_list, verbose=False):
 
174
        bzrlib.add.smart_add(file_list, verbose)
 
175
 
 
176
 
 
177
def Relpath(Command):
 
178
    """Show path of a file relative to root"""
 
179
    takes_args = ('filename')
 
180
    
 
181
    def run(self):
 
182
        print Branch(self.args['filename']).relpath(filename)
 
183
 
 
184
 
 
185
 
 
186
class cmd_inventory(Command):
 
187
    """Show inventory of the current working copy or a revision."""
 
188
    takes_options = ['revision']
 
189
    
 
190
    def run(self, revision=None):
 
191
        b = Branch('.')
 
192
        if revision == None:
 
193
            inv = b.read_working_inventory()
 
194
        else:
 
195
            inv = b.get_revision_inventory(b.lookup_revision(revision))
 
196
 
 
197
        for path, entry in inv.iter_entries():
 
198
            print '%-50s %s' % (entry.file_id, path)
 
199
 
 
200
 
 
201
class cmd_move(Command):
 
202
    """Move files to a different directory.
 
203
 
 
204
    examples:
 
205
        bzr move *.txt doc
 
206
 
 
207
    The destination must be a versioned directory in the same branch.
 
208
    """
 
209
    takes_args = ['source$', 'dest']
 
210
    def run(self, source_list, dest):
 
211
        b = Branch('.')
 
212
 
 
213
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
214
 
 
215
 
 
216
class cmd_rename(Command):
 
217
    """Change the name of an entry.
 
218
 
 
219
    examples:
 
220
      bzr rename frob.c frobber.c
 
221
      bzr rename src/frob.c lib/frob.c
 
222
 
 
223
    It is an error if the destination name exists.
 
224
 
 
225
    See also the 'move' command, which moves files into a different
 
226
    directory without changing their name.
 
227
 
 
228
    TODO: Some way to rename multiple files without invoking bzr for each
 
229
    one?"""
 
230
    takes_args = ['from_name', 'to_name']
 
231
    
 
232
    def run(self, from_name, to_name):
 
233
        b = Branch('.')
 
234
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
235
 
 
236
 
 
237
 
 
238
class cmd_renames(Command):
 
239
    """Show list of renamed files.
 
240
 
 
241
    TODO: Option to show renames between two historical versions.
 
242
 
 
243
    TODO: Only show renames under dir, rather than in the whole branch.
 
244
    """
 
245
    takes_args = ['dir?']
 
246
 
 
247
    def run(self, dir='.'):
 
248
        b = Branch(dir)
 
249
        old_inv = b.basis_tree().inventory
 
250
        new_inv = b.read_working_inventory()
 
251
 
 
252
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
253
        renames.sort()
 
254
        for old_name, new_name in renames:
 
255
            print "%s => %s" % (old_name, new_name)        
 
256
 
 
257
 
 
258
class cmd_info(Command):
 
259
    """Show statistical information for this branch"""
 
260
    def run(self):
 
261
        import info
 
262
        info.show_info(Branch('.'))        
 
263
 
 
264
 
 
265
class cmd_remove(Command):
 
266
    """Make a file unversioned.
 
267
 
 
268
    This makes bzr stop tracking changes to a versioned file.  It does
 
269
    not delete the working copy.
 
270
    """
 
271
    takes_args = ['file+']
 
272
    takes_options = ['verbose']
 
273
    
 
274
    def run(self, file_list, verbose=False):
 
275
        b = Branch(file_list[0])
 
276
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
277
 
 
278
 
 
279
class cmd_file_id(Command):
 
280
    """Print file_id of a particular file or directory.
 
281
 
 
282
    The file_id is assigned when the file is first added and remains the
 
283
    same through all revisions where the file exists, even when it is
 
284
    moved or renamed.
 
285
    """
 
286
    hidden = True
 
287
    takes_args = ['filename']
 
288
    def run(self, filename):
 
289
        b = Branch(filename)
 
290
        i = b.inventory.path2id(b.relpath(filename))
 
291
        if i == None:
 
292
            bailout("%r is not a versioned file" % filename)
 
293
        else:
 
294
            print i
 
295
 
 
296
 
 
297
class cmd_file_path(Command):
 
298
    """Print path of file_ids to a file or directory.
 
299
 
 
300
    This prints one line for each directory down to the target,
 
301
    starting at the branch root."""
 
302
    hidden = True
 
303
    takes_args = ['filename']
 
304
    def run(self, filename):
 
305
        b = Branch(filename)
 
306
        inv = b.inventory
 
307
        fid = inv.path2id(b.relpath(filename))
 
308
        if fid == None:
 
309
            bailout("%r is not a versioned file" % filename)
 
310
        for fip in inv.get_idpath(fid):
 
311
            print fip
 
312
 
 
313
 
 
314
class cmd_revision_history(Command):
 
315
    """Display list of revision ids on this branch."""
 
316
    def run(self):
 
317
        for patchid in Branch('.').revision_history():
 
318
            print patchid
 
319
 
 
320
 
 
321
class cmd_directories(Command):
 
322
    """Display list of versioned directories in this branch."""
 
323
    def run(self):
 
324
        for name, ie in Branch('.').read_working_inventory().directories():
 
325
            if name == '':
 
326
                print '.'
 
327
            else:
 
328
                print name
 
329
 
 
330
 
 
331
class cmd_init(Command):
 
332
    """Make a directory into a versioned branch.
 
333
 
 
334
    Use this to create an empty branch, or before importing an
 
335
    existing project.
 
336
 
 
337
    Recipe for importing a tree of files:
 
338
        cd ~/project
 
339
        bzr init
 
340
        bzr add -v .
 
341
        bzr status
 
342
        bzr commit -m 'imported project'
 
343
    """
 
344
    def run(self):
 
345
        Branch('.', init=True)
 
346
 
 
347
 
 
348
class cmd_diff(Command):
 
349
    """Show differences in working tree.
 
350
    
 
351
    If files are listed, only the changes in those files are listed.
 
352
    Otherwise, all changes for the tree are listed.
 
353
 
 
354
    TODO: Given two revision arguments, show the difference between them.
 
355
 
 
356
    TODO: Allow diff across branches.
 
357
 
 
358
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
359
          or a graphical diff.
 
360
 
 
361
    TODO: Python difflib is not exactly the same as unidiff; should
 
362
          either fix it up or prefer to use an external diff.
 
363
 
 
364
    TODO: If a directory is given, diff everything under that.
 
365
 
 
366
    TODO: Selected-file diff is inefficient and doesn't show you
 
367
          deleted files.
 
368
 
 
369
    TODO: This probably handles non-Unix newlines poorly.
 
370
    """
 
371
    
 
372
    takes_args = ['file*']
 
373
    takes_options = ['revision']
 
374
    aliases = ['di']
 
375
 
 
376
    def run(self, revision=None, file_list=None):
 
377
        from bzrlib.diff import show_diff
 
378
    
 
379
        show_diff(Branch('.'), revision, file_list)
 
380
 
 
381
 
 
382
class cmd_deleted(Command):
 
383
    """List files deleted in the working tree.
 
384
 
 
385
    TODO: Show files deleted since a previous revision, or between two revisions.
 
386
    """
 
387
    def run(self, show_ids=False):
 
388
        b = Branch('.')
 
389
        old = b.basis_tree()
 
390
        new = b.working_tree()
 
391
 
 
392
        ## TODO: Much more efficient way to do this: read in new
 
393
        ## directories with readdir, rather than stating each one.  Same
 
394
        ## level of effort but possibly much less IO.  (Or possibly not,
 
395
        ## if the directories are very large...)
 
396
 
 
397
        for path, ie in old.inventory.iter_entries():
 
398
            if not new.has_id(ie.file_id):
 
399
                if show_ids:
 
400
                    print '%-50s %s' % (path, ie.file_id)
 
401
                else:
 
402
                    print path
 
403
 
 
404
class cmd_root(Command):
 
405
    """Show the tree root directory.
 
406
 
 
407
    The root is the nearest enclosing directory with a .bzr control
 
408
    directory."""
 
409
    takes_args = ['filename?']
 
410
    def run(self, filename=None):
 
411
        """Print the branch root."""
 
412
        print bzrlib.branch.find_branch_root(filename)
 
413
 
 
414
 
 
415
 
 
416
class cmd_log(Command):
 
417
    """Show log of this branch.
 
418
 
 
419
    TODO: Options to show ids; to limit range; etc.
 
420
    """
 
421
    takes_options = ['timezone', 'verbose']
 
422
    def run(self, timezone='original', verbose=False):
 
423
        Branch('.', lock_mode='r').write_log(show_timezone=timezone, verbose=verbose)
 
424
 
 
425
 
 
426
class cmd_ls(Command):
 
427
    """List files in a tree.
 
428
 
 
429
    TODO: Take a revision or remote path and list that tree instead.
 
430
    """
 
431
    hidden = True
 
432
    def run(self, revision=None, verbose=False):
 
433
        b = Branch('.')
 
434
        if revision == None:
 
435
            tree = b.working_tree()
 
436
        else:
 
437
            tree = b.revision_tree(b.lookup_revision(revision))
 
438
 
 
439
        for fp, fc, kind, fid in tree.list_files():
 
440
            if verbose:
 
441
                if kind == 'directory':
 
442
                    kindch = '/'
 
443
                elif kind == 'file':
 
444
                    kindch = ''
 
445
                else:
 
446
                    kindch = '???'
 
447
 
 
448
                print '%-8s %s%s' % (fc, fp, kindch)
 
449
            else:
 
450
                print fp
 
451
 
 
452
 
 
453
 
 
454
class cmd_unknowns(Command):
 
455
    """List unknown files"""
 
456
    def run(self):
 
457
        for f in Branch('.').unknowns():
 
458
            print quotefn(f)
 
459
 
 
460
 
 
461
 
 
462
class cmd_ignore(Command):
 
463
    """Ignore a command or pattern"""
 
464
    takes_args = ['name_pattern']
 
465
    
 
466
    def run(self, name_pattern):
 
467
        b = Branch('.')
 
468
 
 
469
        # XXX: This will fail if it's a hardlink; should use an AtomicFile class.
 
470
        f = open(b.abspath('.bzrignore'), 'at')
 
471
        f.write(name_pattern + '\n')
 
472
        f.close()
 
473
 
 
474
        inv = b.working_tree().inventory
 
475
        if inv.path2id('.bzrignore'):
 
476
            mutter('.bzrignore is already versioned')
 
477
        else:
 
478
            mutter('need to make new .bzrignore file versioned')
 
479
            b.add(['.bzrignore'])
 
480
 
 
481
 
 
482
 
 
483
class cmd_ignored(Command):
 
484
    """List ignored files and the patterns that matched them."""
 
485
    def run(self):
 
486
        tree = Branch('.').working_tree()
 
487
        for path, file_class, kind, file_id in tree.list_files():
 
488
            if file_class != 'I':
 
489
                continue
 
490
            ## XXX: Slightly inefficient since this was already calculated
 
491
            pat = tree.is_ignored(path)
 
492
            print '%-50s %s' % (path, pat)
 
493
 
 
494
 
 
495
class cmd_lookup_revision(Command):
 
496
    """Lookup the revision-id from a revision-number
 
497
 
 
498
    example:
 
499
        bzr lookup-revision 33
 
500
        """
 
501
    hidden = True
 
502
    takes_args = ['revno']
 
503
    
 
504
    def run(self, revno):
 
505
        try:
 
506
            revno = int(revno)
 
507
        except ValueError:
 
508
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
509
 
 
510
        print Branch('.').lookup_revision(revno)
 
511
 
 
512
 
 
513
class cmd_export(Command):
 
514
    """Export past revision to destination directory.
 
515
 
 
516
    If no revision is specified this exports the last committed revision."""
 
517
    takes_args = ['dest']
 
518
    takes_options = ['revision']
 
519
    def run(self, dest, revno=None):
 
520
        b = Branch('.')
 
521
        if revno == None:
 
522
            rh = b.revision_history[-1]
 
523
        else:
 
524
            rh = b.lookup_revision(int(revno))
 
525
        t = b.revision_tree(rh)
 
526
        t.export(dest)
 
527
 
 
528
 
 
529
class cmd_cat(Command):
 
530
    """Write a file's text from a previous revision."""
 
531
 
 
532
    takes_options = ['revision']
 
533
    takes_args = ['filename']
 
534
 
 
535
    def run(self, filename, revision=None):
 
536
        if revision == None:
 
537
            raise BzrCommandError("bzr cat requires a revision number")
 
538
        b = Branch('.')
 
539
        b.print_file(b.relpath(filename), int(revision))
 
540
 
 
541
 
 
542
class cmd_local_time_offset(Command):
 
543
    """Show the offset in seconds from GMT to local time."""
 
544
    hidden = True    
 
545
    def run(self):
 
546
        print bzrlib.osutils.local_time_offset()
 
547
 
 
548
 
 
549
 
 
550
class cmd_commit(Command):
 
551
    """Commit changes into a new revision.
 
552
 
 
553
    TODO: Commit only selected files.
 
554
 
 
555
    TODO: Run hooks on tree to-be-committed, and after commit.
 
556
 
 
557
    TODO: Strict commit that fails if there are unknown or deleted files.
 
558
    """
 
559
    takes_options = ['message', 'verbose']
 
560
    aliases = ['ci', 'checkin']
 
561
 
 
562
    def run(self, message=None, verbose=False):
 
563
        if not message:
 
564
            raise BzrCommandError("please specify a commit message")
 
565
        Branch('.').commit(message, verbose=verbose)
 
566
 
 
567
 
 
568
class cmd_check(Command):
 
569
    """Validate consistency of branch history.
 
570
 
 
571
    This command checks various invariants about the branch storage to
 
572
    detect data corruption or bzr bugs.
 
573
    """
 
574
    takes_args = ['dir?']
 
575
    def run(self, dir='.'):
 
576
        import bzrlib.check
 
577
        bzrlib.check.check(Branch(dir, find_root=False))
 
578
 
 
579
 
 
580
 
 
581
class cmd_whoami(Command):
 
582
    """Show bzr user id."""
 
583
    takes_options = ['email']
 
584
    
 
585
    def run(self, email=False):
 
586
        if email:
 
587
            print bzrlib.osutils.user_email()
 
588
        else:
 
589
            print bzrlib.osutils.username()
 
590
 
 
591
 
 
592
class cmd_selftest(Command):
 
593
    """Run internal test suite"""
 
594
    hidden = True
 
595
    def run(self):
 
596
        failures, tests = 0, 0
 
597
 
 
598
        import doctest, bzrlib.store, bzrlib.tests
 
599
        bzrlib.trace.verbose = False
 
600
 
 
601
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
602
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
603
            mf, mt = doctest.testmod(m)
 
604
            failures += mf
 
605
            tests += mt
 
606
            print '%-40s %3d tests' % (m.__name__, mt),
 
607
            if mf:
 
608
                print '%3d FAILED!' % mf
 
609
            else:
 
610
                print
 
611
 
 
612
        print '%-40s %3d tests' % ('total', tests),
 
613
        if failures:
 
614
            print '%3d FAILED!' % failures
 
615
        else:
 
616
            print
 
617
 
 
618
 
 
619
 
 
620
class cmd_version(Command):
 
621
    """Show version of bzr"""
 
622
    def run(self):
 
623
        show_version()
 
624
 
 
625
def show_version():
 
626
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
627
    print bzrlib.__copyright__
 
628
    print "http://bazaar-ng.org/"
 
629
    print
 
630
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
631
    print "you may use, modify and redistribute it under the terms of the GNU"
 
632
    print "General Public License version 2 or later."
 
633
 
 
634
 
 
635
class cmd_rocks(Command):
 
636
    """Statement of optimism."""
 
637
    hidden = True
 
638
    def run(self):
 
639
        print "it sure does!"
 
640
 
 
641
 
 
642
class cmd_assert_fail(Command):
 
643
    """Test reporting of assertion failures"""
 
644
    hidden = True
 
645
    def run(self):
 
646
        assert False, "always fails"
 
647
 
 
648
 
 
649
class cmd_help(Command):
 
650
    """Show help on a command or other topic.
 
651
 
 
652
    For a list of all available commands, say 'bzr help commands'."""
 
653
    takes_args = ['topic?']
 
654
    aliases = ['?']
 
655
    
 
656
    def run(self, topic=None):
 
657
        import help
 
658
        help.help(topic)
 
659
 
 
660
 
 
661
######################################################################
 
662
# main routine
 
663
 
 
664
 
 
665
# list of all available options; the rhs can be either None for an
 
666
# option that takes no argument, or a constructor function that checks
 
667
# the type.
 
668
OPTIONS = {
 
669
    'all':                    None,
 
670
    'help':                   None,
 
671
    'message':                unicode,
 
672
    'profile':                None,
 
673
    'revision':               int,
 
674
    'show-ids':               None,
 
675
    'timezone':               str,
 
676
    'verbose':                None,
 
677
    'version':                None,
 
678
    'email':                  None,
 
679
    }
 
680
 
 
681
SHORT_OPTIONS = {
 
682
    'm':                      'message',
 
683
    'r':                      'revision',
 
684
    'v':                      'verbose',
 
685
}
 
686
 
 
687
 
 
688
def parse_args(argv):
 
689
    """Parse command line.
 
690
    
 
691
    Arguments and options are parsed at this level before being passed
 
692
    down to specific command handlers.  This routine knows, from a
 
693
    lookup table, something about the available options, what optargs
 
694
    they take, and which commands will accept them.
 
695
 
 
696
    >>> parse_args('--help'.split())
 
697
    ([], {'help': True})
 
698
    >>> parse_args('--version'.split())
 
699
    ([], {'version': True})
 
700
    >>> parse_args('status --all'.split())
 
701
    (['status'], {'all': True})
 
702
    >>> parse_args('commit --message=biter'.split())
 
703
    (['commit'], {'message': u'biter'})
 
704
    """
 
705
    args = []
 
706
    opts = {}
 
707
 
 
708
    # TODO: Maybe handle '--' to end options?
 
709
 
 
710
    while argv:
 
711
        a = argv.pop(0)
 
712
        if a[0] == '-':
 
713
            # option names must not be unicode
 
714
            a = str(a)
 
715
            optarg = None
 
716
            if a[1] == '-':
 
717
                mutter("  got option %r" % a)
 
718
                if '=' in a:
 
719
                    optname, optarg = a[2:].split('=', 1)
 
720
                else:
 
721
                    optname = a[2:]
 
722
                if optname not in OPTIONS:
 
723
                    bailout('unknown long option %r' % a)
 
724
            else:
 
725
                shortopt = a[1:]
 
726
                if shortopt not in SHORT_OPTIONS:
 
727
                    bailout('unknown short option %r' % a)
 
728
                optname = SHORT_OPTIONS[shortopt]
 
729
            
 
730
            if optname in opts:
 
731
                # XXX: Do we ever want to support this, e.g. for -r?
 
732
                bailout('repeated option %r' % a)
 
733
                
 
734
            optargfn = OPTIONS[optname]
 
735
            if optargfn:
 
736
                if optarg == None:
 
737
                    if not argv:
 
738
                        bailout('option %r needs an argument' % a)
 
739
                    else:
 
740
                        optarg = argv.pop(0)
 
741
                opts[optname] = optargfn(optarg)
 
742
            else:
 
743
                if optarg != None:
 
744
                    bailout('option %r takes no argument' % optname)
 
745
                opts[optname] = True
 
746
        else:
 
747
            args.append(a)
 
748
 
 
749
    return args, opts
 
750
 
 
751
 
 
752
 
 
753
 
 
754
def _match_argform(cmd, takes_args, args):
 
755
    argdict = {}
 
756
 
 
757
    # step through args and takes_args, allowing appropriate 0-many matches
 
758
    for ap in takes_args:
 
759
        argname = ap[:-1]
 
760
        if ap[-1] == '?':
 
761
            if args:
 
762
                argdict[argname] = args.pop(0)
 
763
        elif ap[-1] == '*': # all remaining arguments
 
764
            if args:
 
765
                argdict[argname + '_list'] = args[:]
 
766
                args = []
 
767
            else:
 
768
                argdict[argname + '_list'] = None
 
769
        elif ap[-1] == '+':
 
770
            if not args:
 
771
                raise BzrCommandError("command %r needs one or more %s"
 
772
                        % (cmd, argname.upper()))
 
773
            else:
 
774
                argdict[argname + '_list'] = args[:]
 
775
                args = []
 
776
        elif ap[-1] == '$': # all but one
 
777
            if len(args) < 2:
 
778
                raise BzrCommandError("command %r needs one or more %s"
 
779
                        % (cmd, argname.upper()))
 
780
            argdict[argname + '_list'] = args[:-1]
 
781
            args[:-1] = []                
 
782
        else:
 
783
            # just a plain arg
 
784
            argname = ap
 
785
            if not args:
 
786
                raise BzrCommandError("command %r requires argument %s"
 
787
                        % (cmd, argname.upper()))
 
788
            else:
 
789
                argdict[argname] = args.pop(0)
 
790
            
 
791
    if args:
 
792
        raise BzrCommandError("extra argument to command %s: %s"
 
793
                              % (cmd, args[0]))
 
794
 
 
795
    return argdict
 
796
 
 
797
 
 
798
 
 
799
def run_bzr(argv):
 
800
    """Execute a command.
 
801
 
 
802
    This is similar to main(), but without all the trappings for
 
803
    logging and error handling.  
 
804
    """
 
805
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
806
    
 
807
    try:
 
808
        args, opts = parse_args(argv[1:])
 
809
        if 'help' in opts:
 
810
            import help
 
811
            if args:
 
812
                help.help(args[0])
 
813
            else:
 
814
                help.help()
 
815
            return 0
 
816
        elif 'version' in opts:
 
817
            show_version()
 
818
            return 0
 
819
        cmd = str(args.pop(0))
 
820
    except IndexError:
 
821
        log_error('usage: bzr COMMAND')
 
822
        log_error('  try "bzr help"')
 
823
        return 1
 
824
 
 
825
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
826
 
 
827
    # global option
 
828
    if 'profile' in opts:
 
829
        profile = True
 
830
        del opts['profile']
 
831
    else:
 
832
        profile = False
 
833
 
 
834
    # check options are reasonable
 
835
    allowed = cmd_class.takes_options
 
836
    for oname in opts:
 
837
        if oname not in allowed:
 
838
            raise BzrCommandError("option %r is not allowed for command %r"
 
839
                                  % (oname, cmd))
 
840
 
 
841
    # mix arguments and options into one dictionary
 
842
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
 
843
    cmdopts = {}
 
844
    for k, v in opts.items():
 
845
        cmdopts[k.replace('-', '_')] = v
 
846
 
 
847
    if profile:
 
848
        import hotshot, tempfile
 
849
        pffileno, pfname = tempfile.mkstemp()
 
850
        try:
 
851
            prof = hotshot.Profile(pfname)
 
852
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
853
            prof.close()
 
854
 
 
855
            import hotshot.stats
 
856
            stats = hotshot.stats.load(pfname)
 
857
            #stats.strip_dirs()
 
858
            stats.sort_stats('time')
 
859
            ## XXX: Might like to write to stderr or the trace file instead but
 
860
            ## print_stats seems hardcoded to stdout
 
861
            stats.print_stats(20)
 
862
            
 
863
            return ret.status
 
864
 
 
865
        finally:
 
866
            os.close(pffileno)
 
867
            os.remove(pfname)
 
868
    else:
 
869
        cmdobj = cmd_class(cmdopts, cmdargs).status 
 
870
 
 
871
 
 
872
def _report_exception(summary, quiet=False):
 
873
    import traceback
 
874
    log_error('bzr: ' + summary)
 
875
    bzrlib.trace.log_exception()
 
876
 
 
877
    if not quiet:
 
878
        tb = sys.exc_info()[2]
 
879
        exinfo = traceback.extract_tb(tb)
 
880
        if exinfo:
 
881
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
 
882
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
883
 
 
884
 
 
885
 
 
886
def main(argv):
 
887
    import errno
 
888
    
 
889
    bzrlib.open_tracefile(argv)
 
890
 
 
891
    try:
 
892
        try:
 
893
            try:
 
894
                return run_bzr(argv)
 
895
            finally:
 
896
                # do this here inside the exception wrappers to catch EPIPE
 
897
                sys.stdout.flush()
 
898
        except BzrError, e:
 
899
            quiet = isinstance(e, (BzrCommandError))
 
900
            _report_exception('error: ' + e.args[0], quiet=quiet)
 
901
            if len(e.args) > 1:
 
902
                for h in e.args[1]:
 
903
                    # some explanation or hints
 
904
                    log_error('  ' + h)
 
905
            return 1
 
906
        except AssertionError, e:
 
907
            msg = 'assertion failed'
 
908
            if str(e):
 
909
                msg += ': ' + str(e)
 
910
            _report_exception(msg)
 
911
            return 2
 
912
        except KeyboardInterrupt, e:
 
913
            _report_exception('interrupted', quiet=True)
 
914
            return 2
 
915
        except Exception, e:
 
916
            quiet = False
 
917
            if isinstance(e, IOError) and e.errno == errno.EPIPE:
 
918
                quiet = True
 
919
                msg = 'broken pipe'
 
920
            else:
 
921
                msg = str(e).rstrip('\n')
 
922
            _report_exception(msg, quiet)
 
923
            return 2
 
924
    finally:
 
925
        bzrlib.trace.close_trace()
 
926
 
 
927
 
 
928
if __name__ == '__main__':
 
929
    sys.exit(main(sys.argv))