/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
329 by Martin Pool
- refactor command functions into command classes
1
# Copyright (C) 2004, 2005 by Canonical Ltd
1 by mbp at sourcefrog
import from baz patch-364
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
338 by Martin Pool
- cleanup of some imports
19
import sys, os, time, os.path
1 by mbp at sourcefrog
import from baz patch-364
20
from sets import Set
21
22
import bzrlib
23
from bzrlib.trace import mutter, note, log_error
329 by Martin Pool
- refactor command functions into command classes
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
1 by mbp at sourcefrog
import from baz patch-364
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
350 by Martin Pool
- refactor command aliases into command classes
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
351 by Martin Pool
- Split out help functions into bzrlib.help
40
def get_all_cmds():
350 by Martin Pool
- refactor command aliases into command classes
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
351 by Martin Pool
- Split out help functions into bzrlib.help
46
def get_cmd_class(cmd):
350 by Martin Pool
- refactor command aliases into command classes
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
272 by Martin Pool
- Add command aliases
52
    try:
350 by Martin Pool
- refactor command aliases into command classes
53
        return cmd, globals()[_squish_command_name(cmd)]
272 by Martin Pool
- Add command aliases
54
    except KeyError:
350 by Martin Pool
- refactor command aliases into command classes
55
        pass
56
57
    # look for any command which claims this as an alias
351 by Martin Pool
- Split out help functions into bzrlib.help
58
    for cmdname, cmdclass in get_all_cmds():
350 by Martin Pool
- refactor command aliases into command classes
59
        if cmd in cmdclass.aliases:
60
            return cmdname, cmdclass
61
    else:
349 by Martin Pool
Better error for incorrect commands
62
        raise BzrCommandError("unknown command %r" % cmd)
272 by Martin Pool
- Add command aliases
63
329 by Martin Pool
- refactor command functions into command classes
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
337 by Martin Pool
- Clarify return codes from command objects
108
        Return 0 or None if the command was successful, or a shell
109
        error code if not.
329 by Martin Pool
- refactor command functions into command classes
110
        """
337 by Martin Pool
- Clarify return codes from command objects
111
        return 0
329 by Martin Pool
- refactor command functions into command classes
112
113
114
115
class cmd_status(Command):
1 by mbp at sourcefrog
import from baz patch-364
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
    """
404 by Martin Pool
- bzr status now optionally takes filenames to check
122
    takes_args = ['file*']
329 by Martin Pool
- refactor command functions into command classes
123
    takes_options = ['all']
350 by Martin Pool
- refactor command aliases into command classes
124
    aliases = ['st', 'stat']
329 by Martin Pool
- refactor command functions into command classes
125
    
404 by Martin Pool
- bzr status now optionally takes filenames to check
126
    def run(self, all=False, file_list=None):
406 by Martin Pool
- bzr status only needs a read-lock
127
        b = Branch('.', lock_mode='r')
128
        b.show_status(show_all=all, file_list=file_list)
329 by Martin Pool
- refactor command functions into command classes
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):
70 by mbp at sourcefrog
Prepare for smart recursive add.
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.
279 by Martin Pool
todo
166
167
    TODO: Perhaps adding a file whose directly is not versioned should
168
    recursively add that parent, rather than giving an error?
70 by mbp at sourcefrog
Prepare for smart recursive add.
169
    """
329 by Martin Pool
- refactor command functions into command classes
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
386 by Martin Pool
- Typo (reported by uws)
177
class cmd_relpath(Command):
329 by Martin Pool
- refactor command functions into command classes
178
    """Show path of a file relative to root"""
392 by Martin Pool
- fix relpath and add tests
179
    takes_args = ['filename']
329 by Martin Pool
- refactor command functions into command classes
180
    
392 by Martin Pool
- fix relpath and add tests
181
    def run(self, filename):
182
        print Branch(filename).relpath(filename)
329 by Martin Pool
- refactor command functions into command classes
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):
168 by mbp at sourcefrog
new "rename" command
217
    """Change the name of an entry.
218
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
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?"""
329 by Martin Pool
- refactor command functions into command classes
230
    takes_args = ['from_name', 'to_name']
168 by mbp at sourcefrog
new "rename" command
231
    
329 by Martin Pool
- refactor command functions into command classes
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):
164 by mbp at sourcefrog
new 'renames' command
239
    """Show list of renamed files.
240
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
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
    """
329 by Martin Pool
- refactor command functions into command classes
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):
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
280
    """Print file_id of a particular file or directory.
281
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
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
    """
329 by Martin Pool
- refactor command functions into command classes
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):
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
298
    """Print path of file_ids to a file or directory.
299
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
300
    This prints one line for each directory down to the target,
301
    starting at the branch root."""
329 by Martin Pool
- refactor command functions into command classes
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
    
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
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
276 by Martin Pool
Doc
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
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
364
    TODO: If a directory is given, diff everything under that.
365
276 by Martin Pool
Doc
366
    TODO: Selected-file diff is inefficient and doesn't show you
367
          deleted files.
278 by Martin Pool
- Better workaround for trailing newlines in diffs
368
369
    TODO: This probably handles non-Unix newlines poorly.
329 by Martin Pool
- refactor command functions into command classes
370
    """
371
    
372
    takes_args = ['file*']
373
    takes_options = ['revision']
350 by Martin Pool
- refactor command aliases into command classes
374
    aliases = ['di']
329 by Martin Pool
- refactor command functions into command classes
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):
135 by mbp at sourcefrog
Simple new 'deleted' command
383
    """List files deleted in the working tree.
384
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
385
    TODO: Show files deleted since a previous revision, or between two revisions.
135 by mbp at sourcefrog
Simple new 'deleted' command
386
    """
329 by Martin Pool
- refactor command functions into command classes
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."""
416 by Martin Pool
- bzr log and bzr root now accept an http URL
412
        from branch import find_branch
413
        b = find_branch(filename)
414
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
329 by Martin Pool
- refactor command functions into command classes
415
416
417
class cmd_log(Command):
1 by mbp at sourcefrog
import from baz patch-364
418
    """Show log of this branch.
419
367 by Martin Pool
- New --show-ids option for bzr log
420
    TODO: Option to limit range.
421
422
    TODO: Perhaps show most-recent first with an option for last.
1 by mbp at sourcefrog
import from baz patch-364
423
    """
378 by Martin Pool
- New usage bzr log FILENAME
424
    takes_args = ['filename?']
367 by Martin Pool
- New --show-ids option for bzr log
425
    takes_options = ['timezone', 'verbose', 'show-ids']
378 by Martin Pool
- New usage bzr log FILENAME
426
    def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
416 by Martin Pool
- bzr log and bzr root now accept an http URL
427
        from branch import find_branch
428
        b = find_branch((filename or '.'), lock_mode='r')
378 by Martin Pool
- New usage bzr log FILENAME
429
        if filename:
430
            filename = b.relpath(filename)
431
        bzrlib.show_log(b, filename,
371 by Martin Pool
- Fix up bzr log command
432
                        show_timezone=timezone,
433
                        verbose=verbose,
434
                        show_ids=show_ids)
329 by Martin Pool
- refactor command functions into command classes
435
436
375 by Martin Pool
- New command touching-revisions and function to trace
437
438
class cmd_touching_revisions(Command):
439
    """Return revision-ids which affected a particular file."""
440
    hidden = True
441
    takes_args = ["filename"]
442
    def run(self, filename):
443
        b = Branch(filename, lock_mode='r')
444
        inv = b.read_working_inventory()
445
        file_id = inv.path2id(b.relpath(filename))
446
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
447
            print "%6d %s" % (revno, what)
448
449
329 by Martin Pool
- refactor command functions into command classes
450
class cmd_ls(Command):
1 by mbp at sourcefrog
import from baz patch-364
451
    """List files in a tree.
452
254 by Martin Pool
- Doc cleanups from Magnus Therning
453
    TODO: Take a revision or remote path and list that tree instead.
1 by mbp at sourcefrog
import from baz patch-364
454
    """
329 by Martin Pool
- refactor command functions into command classes
455
    hidden = True
456
    def run(self, revision=None, verbose=False):
457
        b = Branch('.')
458
        if revision == None:
459
            tree = b.working_tree()
460
        else:
461
            tree = b.revision_tree(b.lookup_revision(revision))
462
463
        for fp, fc, kind, fid in tree.list_files():
464
            if verbose:
465
                if kind == 'directory':
466
                    kindch = '/'
467
                elif kind == 'file':
468
                    kindch = ''
469
                else:
470
                    kindch = '???'
471
472
                print '%-8s %s%s' % (fc, fp, kindch)
1 by mbp at sourcefrog
import from baz patch-364
473
            else:
329 by Martin Pool
- refactor command functions into command classes
474
                print fp
475
476
477
478
class cmd_unknowns(Command):
1 by mbp at sourcefrog
import from baz patch-364
479
    """List unknown files"""
329 by Martin Pool
- refactor command functions into command classes
480
    def run(self):
481
        for f in Branch('.').unknowns():
482
            print quotefn(f)
483
484
485
486
class cmd_ignore(Command):
420 by Martin Pool
Doc
487
    """Ignore a command or pattern
488
489
    To remove patterns from the ignore list, edit the .bzrignore file.
490
491
    If the pattern contains a slash, it is compared to the whole path
492
    from the branch root.  Otherwise, it is comapred to only the last
493
    component of the path.
494
495
    Ignore patterns are case-insensitive on case-insensitive systems.
496
497
    Note: wildcards must be quoted from the shell on Unix.
498
499
    examples:
500
        bzr ignore ./Makefile
501
        bzr ignore '*.class'
502
    """
329 by Martin Pool
- refactor command functions into command classes
503
    takes_args = ['name_pattern']
310 by Martin Pool
- new 'bzr ignored' command!
504
    
329 by Martin Pool
- refactor command functions into command classes
505
    def run(self, name_pattern):
409 by Martin Pool
- New AtomicFile class
506
        from bzrlib.atomicfile import AtomicFile
507
        import codecs
508
329 by Martin Pool
- refactor command functions into command classes
509
        b = Branch('.')
410 by Martin Pool
- Fix ignore command and add tests
510
        ifn = b.abspath('.bzrignore')
329 by Martin Pool
- refactor command functions into command classes
511
409 by Martin Pool
- New AtomicFile class
512
        # FIXME: probably doesn't handle non-ascii patterns
513
410 by Martin Pool
- Fix ignore command and add tests
514
        if os.path.exists(ifn):
515
            f = b.controlfile(ifn, 'rt')
409 by Martin Pool
- New AtomicFile class
516
            igns = f.read()
517
            f.close()
518
        else:
519
            igns = ''
520
521
        if igns and igns[-1] != '\n':
522
            igns += '\n'
523
        igns += name_pattern + '\n'
524
410 by Martin Pool
- Fix ignore command and add tests
525
        f = AtomicFile(ifn, 'wt')
409 by Martin Pool
- New AtomicFile class
526
        f.write(igns)
527
        f.commit()
329 by Martin Pool
- refactor command functions into command classes
528
529
        inv = b.working_tree().inventory
530
        if inv.path2id('.bzrignore'):
531
            mutter('.bzrignore is already versioned')
532
        else:
533
            mutter('need to make new .bzrignore file versioned')
534
            b.add(['.bzrignore'])
535
536
537
538
class cmd_ignored(Command):
421 by Martin Pool
doc
539
    """List ignored files and the patterns that matched them.
540
541
    See also: bzr ignore"""
329 by Martin Pool
- refactor command functions into command classes
542
    def run(self):
543
        tree = Branch('.').working_tree()
544
        for path, file_class, kind, file_id in tree.list_files():
545
            if file_class != 'I':
546
                continue
547
            ## XXX: Slightly inefficient since this was already calculated
548
            pat = tree.is_ignored(path)
549
            print '%-50s %s' % (path, pat)
550
551
552
class cmd_lookup_revision(Command):
553
    """Lookup the revision-id from a revision-number
554
555
    example:
556
        bzr lookup-revision 33
421 by Martin Pool
doc
557
    """
329 by Martin Pool
- refactor command functions into command classes
558
    hidden = True
338 by Martin Pool
- cleanup of some imports
559
    takes_args = ['revno']
560
    
329 by Martin Pool
- refactor command functions into command classes
561
    def run(self, revno):
562
        try:
563
            revno = int(revno)
564
        except ValueError:
338 by Martin Pool
- cleanup of some imports
565
            raise BzrCommandError("not a valid revision-number: %r" % revno)
566
567
        print Branch('.').lookup_revision(revno)
329 by Martin Pool
- refactor command functions into command classes
568
569
570
class cmd_export(Command):
571
    """Export past revision to destination directory.
572
573
    If no revision is specified this exports the last committed revision."""
574
    takes_args = ['dest']
575
    takes_options = ['revision']
394 by Martin Pool
- Fix argument handling in export command
576
    def run(self, dest, revision=None):
329 by Martin Pool
- refactor command functions into command classes
577
        b = Branch('.')
394 by Martin Pool
- Fix argument handling in export command
578
        if revision == None:
579
            rh = b.revision_history()[-1]
329 by Martin Pool
- refactor command functions into command classes
580
        else:
394 by Martin Pool
- Fix argument handling in export command
581
            rh = b.lookup_revision(int(revision))
329 by Martin Pool
- refactor command functions into command classes
582
        t = b.revision_tree(rh)
583
        t.export(dest)
584
585
586
class cmd_cat(Command):
587
    """Write a file's text from a previous revision."""
588
589
    takes_options = ['revision']
590
    takes_args = ['filename']
591
592
    def run(self, filename, revision=None):
593
        if revision == None:
594
            raise BzrCommandError("bzr cat requires a revision number")
595
        b = Branch('.')
596
        b.print_file(b.relpath(filename), int(revision))
597
598
599
class cmd_local_time_offset(Command):
600
    """Show the offset in seconds from GMT to local time."""
601
    hidden = True    
602
    def run(self):
603
        print bzrlib.osutils.local_time_offset()
604
605
606
607
class cmd_commit(Command):
608
    """Commit changes into a new revision.
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
609
610
    TODO: Commit only selected files.
611
612
    TODO: Run hooks on tree to-be-committed, and after commit.
613
614
    TODO: Strict commit that fails if there are unknown or deleted files.
615
    """
389 by Martin Pool
- new commit --file option!
616
    takes_options = ['message', 'file', 'verbose']
350 by Martin Pool
- refactor command aliases into command classes
617
    aliases = ['ci', 'checkin']
618
389 by Martin Pool
- new commit --file option!
619
    def run(self, message=None, file=None, verbose=False):
620
        ## Warning: shadows builtin file()
621
        if not message and not file:
622
            raise BzrCommandError("please specify a commit message",
623
                                  ["use either --message or --file"])
624
        elif message and file:
625
            raise BzrCommandError("please specify either --message or --file")
626
        
627
        if file:
628
            import codecs
629
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
630
329 by Martin Pool
- refactor command functions into command classes
631
        Branch('.').commit(message, verbose=verbose)
632
633
634
class cmd_check(Command):
635
    """Validate consistency of branch history.
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
636
637
    This command checks various invariants about the branch storage to
638
    detect data corruption or bzr bugs.
639
    """
329 by Martin Pool
- refactor command functions into command classes
640
    takes_args = ['dir?']
641
    def run(self, dir='.'):
642
        import bzrlib.check
643
        bzrlib.check.check(Branch(dir, find_root=False))
644
645
646
647
class cmd_whoami(Command):
648
    """Show bzr user id."""
649
    takes_options = ['email']
286 by Martin Pool
- New bzr whoami --email option
650
    
329 by Martin Pool
- refactor command functions into command classes
651
    def run(self, email=False):
652
        if email:
653
            print bzrlib.osutils.user_email()
654
        else:
655
            print bzrlib.osutils.username()
656
657
658
class cmd_selftest(Command):
55 by mbp at sourcefrog
bzr selftest shows some counts of tests
659
    """Run internal test suite"""
329 by Martin Pool
- refactor command functions into command classes
660
    hidden = True
661
    def run(self):
662
        failures, tests = 0, 0
663
664
        import doctest, bzrlib.store, bzrlib.tests
665
        bzrlib.trace.verbose = False
666
667
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
668
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
669
            mf, mt = doctest.testmod(m)
670
            failures += mf
671
            tests += mt
672
            print '%-40s %3d tests' % (m.__name__, mt),
673
            if mf:
674
                print '%3d FAILED!' % mf
675
            else:
676
                print
677
678
        print '%-40s %3d tests' % ('total', tests),
679
        if failures:
680
            print '%3d FAILED!' % failures
55 by mbp at sourcefrog
bzr selftest shows some counts of tests
681
        else:
682
            print
683
329 by Martin Pool
- refactor command functions into command classes
684
685
686
class cmd_version(Command):
687
    """Show version of bzr"""
688
    def run(self):
689
        show_version()
690
691
def show_version():
692
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
693
    print bzrlib.__copyright__
694
    print "http://bazaar-ng.org/"
695
    print
696
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
697
    print "you may use, modify and redistribute it under the terms of the GNU"
698
    print "General Public License version 2 or later."
699
700
701
class cmd_rocks(Command):
702
    """Statement of optimism."""
703
    hidden = True
704
    def run(self):
705
        print "it sure does!"
706
707
708
class cmd_assert_fail(Command):
709
    """Test reporting of assertion failures"""
710
    hidden = True
711
    def run(self):
712
        assert False, "always fails"
713
714
715
class cmd_help(Command):
716
    """Show help on a command or other topic.
717
718
    For a list of all available commands, say 'bzr help commands'."""
719
    takes_args = ['topic?']
350 by Martin Pool
- refactor command aliases into command classes
720
    aliases = ['?']
329 by Martin Pool
- refactor command functions into command classes
721
    
722
    def run(self, topic=None):
351 by Martin Pool
- Split out help functions into bzrlib.help
723
        import help
724
        help.help(topic)
725
1 by mbp at sourcefrog
import from baz patch-364
726
727
######################################################################
728
# main routine
729
730
731
# list of all available options; the rhs can be either None for an
732
# option that takes no argument, or a constructor function that checks
733
# the type.
734
OPTIONS = {
735
    'all':                    None,
736
    'help':                   None,
389 by Martin Pool
- new commit --file option!
737
    'file':                   unicode,
1 by mbp at sourcefrog
import from baz patch-364
738
    'message':                unicode,
137 by mbp at sourcefrog
new --profile option
739
    'profile':                None,
1 by mbp at sourcefrog
import from baz patch-364
740
    'revision':               int,
741
    'show-ids':               None,
12 by mbp at sourcefrog
new --timezone option for bzr log
742
    'timezone':               str,
1 by mbp at sourcefrog
import from baz patch-364
743
    'verbose':                None,
744
    'version':                None,
286 by Martin Pool
- New bzr whoami --email option
745
    'email':                  None,
1 by mbp at sourcefrog
import from baz patch-364
746
    }
747
748
SHORT_OPTIONS = {
749
    'm':                      'message',
389 by Martin Pool
- new commit --file option!
750
    'F':                      'file', 
1 by mbp at sourcefrog
import from baz patch-364
751
    'r':                      'revision',
752
    'v':                      'verbose',
753
}
754
755
756
def parse_args(argv):
757
    """Parse command line.
758
    
759
    Arguments and options are parsed at this level before being passed
760
    down to specific command handlers.  This routine knows, from a
761
    lookup table, something about the available options, what optargs
762
    they take, and which commands will accept them.
763
31 by Martin Pool
fix up parse_args doctest
764
    >>> parse_args('--help'.split())
1 by mbp at sourcefrog
import from baz patch-364
765
    ([], {'help': True})
31 by Martin Pool
fix up parse_args doctest
766
    >>> parse_args('--version'.split())
1 by mbp at sourcefrog
import from baz patch-364
767
    ([], {'version': True})
31 by Martin Pool
fix up parse_args doctest
768
    >>> parse_args('status --all'.split())
1 by mbp at sourcefrog
import from baz patch-364
769
    (['status'], {'all': True})
31 by Martin Pool
fix up parse_args doctest
770
    >>> parse_args('commit --message=biter'.split())
17 by mbp at sourcefrog
allow --option=ARG syntax
771
    (['commit'], {'message': u'biter'})
1 by mbp at sourcefrog
import from baz patch-364
772
    """
773
    args = []
774
    opts = {}
775
776
    # TODO: Maybe handle '--' to end options?
777
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
778
    while argv:
779
        a = argv.pop(0)
1 by mbp at sourcefrog
import from baz patch-364
780
        if a[0] == '-':
264 by Martin Pool
parse_args: option names must be ascii
781
            # option names must not be unicode
782
            a = str(a)
17 by mbp at sourcefrog
allow --option=ARG syntax
783
            optarg = None
1 by mbp at sourcefrog
import from baz patch-364
784
            if a[1] == '-':
785
                mutter("  got option %r" % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
786
                if '=' in a:
787
                    optname, optarg = a[2:].split('=', 1)
788
                else:
789
                    optname = a[2:]
1 by mbp at sourcefrog
import from baz patch-364
790
                if optname not in OPTIONS:
791
                    bailout('unknown long option %r' % a)
792
            else:
793
                shortopt = a[1:]
794
                if shortopt not in SHORT_OPTIONS:
795
                    bailout('unknown short option %r' % a)
796
                optname = SHORT_OPTIONS[shortopt]
797
            
798
            if optname in opts:
799
                # XXX: Do we ever want to support this, e.g. for -r?
800
                bailout('repeated option %r' % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
801
                
1 by mbp at sourcefrog
import from baz patch-364
802
            optargfn = OPTIONS[optname]
803
            if optargfn:
17 by mbp at sourcefrog
allow --option=ARG syntax
804
                if optarg == None:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
805
                    if not argv:
17 by mbp at sourcefrog
allow --option=ARG syntax
806
                        bailout('option %r needs an argument' % a)
807
                    else:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
808
                        optarg = argv.pop(0)
17 by mbp at sourcefrog
allow --option=ARG syntax
809
                opts[optname] = optargfn(optarg)
1 by mbp at sourcefrog
import from baz patch-364
810
            else:
17 by mbp at sourcefrog
allow --option=ARG syntax
811
                if optarg != None:
812
                    bailout('option %r takes no argument' % optname)
1 by mbp at sourcefrog
import from baz patch-364
813
                opts[optname] = True
814
        else:
815
            args.append(a)
816
817
    return args, opts
818
819
820
821
329 by Martin Pool
- refactor command functions into command classes
822
def _match_argform(cmd, takes_args, args):
1 by mbp at sourcefrog
import from baz patch-364
823
    argdict = {}
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
824
329 by Martin Pool
- refactor command functions into command classes
825
    # step through args and takes_args, allowing appropriate 0-many matches
826
    for ap in takes_args:
1 by mbp at sourcefrog
import from baz patch-364
827
        argname = ap[:-1]
828
        if ap[-1] == '?':
62 by mbp at sourcefrog
- new find_branch_root function; based on suggestion from aaron
829
            if args:
830
                argdict[argname] = args.pop(0)
196 by mbp at sourcefrog
selected-file diff
831
        elif ap[-1] == '*': # all remaining arguments
832
            if args:
833
                argdict[argname + '_list'] = args[:]
834
                args = []
835
            else:
836
                argdict[argname + '_list'] = None
1 by mbp at sourcefrog
import from baz patch-364
837
        elif ap[-1] == '+':
838
            if not args:
329 by Martin Pool
- refactor command functions into command classes
839
                raise BzrCommandError("command %r needs one or more %s"
1 by mbp at sourcefrog
import from baz patch-364
840
                        % (cmd, argname.upper()))
841
            else:
842
                argdict[argname + '_list'] = args[:]
843
                args = []
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
844
        elif ap[-1] == '$': # all but one
845
            if len(args) < 2:
329 by Martin Pool
- refactor command functions into command classes
846
                raise BzrCommandError("command %r needs one or more %s"
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
847
                        % (cmd, argname.upper()))
848
            argdict[argname + '_list'] = args[:-1]
849
            args[:-1] = []                
1 by mbp at sourcefrog
import from baz patch-364
850
        else:
851
            # just a plain arg
852
            argname = ap
853
            if not args:
329 by Martin Pool
- refactor command functions into command classes
854
                raise BzrCommandError("command %r requires argument %s"
1 by mbp at sourcefrog
import from baz patch-364
855
                        % (cmd, argname.upper()))
856
            else:
857
                argdict[argname] = args.pop(0)
858
            
859
    if args:
329 by Martin Pool
- refactor command functions into command classes
860
        raise BzrCommandError("extra argument to command %s: %s"
861
                              % (cmd, args[0]))
1 by mbp at sourcefrog
import from baz patch-364
862
863
    return argdict
864
865
866
867
def run_bzr(argv):
868
    """Execute a command.
869
870
    This is similar to main(), but without all the trappings for
245 by mbp at sourcefrog
- control files always in utf-8-unix format
871
    logging and error handling.  
1 by mbp at sourcefrog
import from baz patch-364
872
    """
251 by mbp at sourcefrog
- factor out locale.getpreferredencoding()
873
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
245 by mbp at sourcefrog
- control files always in utf-8-unix format
874
    
1 by mbp at sourcefrog
import from baz patch-364
875
    try:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
876
        args, opts = parse_args(argv[1:])
1 by mbp at sourcefrog
import from baz patch-364
877
        if 'help' in opts:
351 by Martin Pool
- Split out help functions into bzrlib.help
878
            import help
159 by mbp at sourcefrog
bzr commit --help now works
879
            if args:
351 by Martin Pool
- Split out help functions into bzrlib.help
880
                help.help(args[0])
159 by mbp at sourcefrog
bzr commit --help now works
881
            else:
351 by Martin Pool
- Split out help functions into bzrlib.help
882
                help.help()
1 by mbp at sourcefrog
import from baz patch-364
883
            return 0
884
        elif 'version' in opts:
336 by Martin Pool
- fix up 'bzr --version'
885
            show_version()
1 by mbp at sourcefrog
import from baz patch-364
886
            return 0
265 by Martin Pool
parse_args: command names must also be ascii
887
        cmd = str(args.pop(0))
1 by mbp at sourcefrog
import from baz patch-364
888
    except IndexError:
257 by Martin Pool
- Write less startup junk to .bzr.log
889
        log_error('usage: bzr COMMAND')
890
        log_error('  try "bzr help"')
1 by mbp at sourcefrog
import from baz patch-364
891
        return 1
115 by mbp at sourcefrog
todo
892
351 by Martin Pool
- Split out help functions into bzrlib.help
893
    canonical_cmd, cmd_class = get_cmd_class(cmd)
1 by mbp at sourcefrog
import from baz patch-364
894
137 by mbp at sourcefrog
new --profile option
895
    # global option
896
    if 'profile' in opts:
897
        profile = True
898
        del opts['profile']
899
    else:
900
        profile = False
1 by mbp at sourcefrog
import from baz patch-364
901
902
    # check options are reasonable
329 by Martin Pool
- refactor command functions into command classes
903
    allowed = cmd_class.takes_options
1 by mbp at sourcefrog
import from baz patch-364
904
    for oname in opts:
905
        if oname not in allowed:
381 by Martin Pool
- Better message when a wrong argument is given
906
            raise BzrCommandError("option '--%s' is not allowed for command %r"
329 by Martin Pool
- refactor command functions into command classes
907
                                  % (oname, cmd))
176 by mbp at sourcefrog
New cat command contributed by janmar.
908
137 by mbp at sourcefrog
new --profile option
909
    # mix arguments and options into one dictionary
329 by Martin Pool
- refactor command functions into command classes
910
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
911
    cmdopts = {}
136 by mbp at sourcefrog
new --show-ids option for 'deleted' command
912
    for k, v in opts.items():
329 by Martin Pool
- refactor command functions into command classes
913
        cmdopts[k.replace('-', '_')] = v
1 by mbp at sourcefrog
import from baz patch-364
914
137 by mbp at sourcefrog
new --profile option
915
    if profile:
338 by Martin Pool
- cleanup of some imports
916
        import hotshot, tempfile
239 by mbp at sourcefrog
- remove profiler temporary file when done
917
        pffileno, pfname = tempfile.mkstemp()
918
        try:
919
            prof = hotshot.Profile(pfname)
329 by Martin Pool
- refactor command functions into command classes
920
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
239 by mbp at sourcefrog
- remove profiler temporary file when done
921
            prof.close()
922
923
            import hotshot.stats
924
            stats = hotshot.stats.load(pfname)
925
            #stats.strip_dirs()
926
            stats.sort_stats('time')
927
            ## XXX: Might like to write to stderr or the trace file instead but
928
            ## print_stats seems hardcoded to stdout
929
            stats.print_stats(20)
930
            
337 by Martin Pool
- Clarify return codes from command objects
931
            return ret.status
239 by mbp at sourcefrog
- remove profiler temporary file when done
932
933
        finally:
934
            os.close(pffileno)
935
            os.remove(pfname)
137 by mbp at sourcefrog
new --profile option
936
    else:
337 by Martin Pool
- Clarify return codes from command objects
937
        cmdobj = cmd_class(cmdopts, cmdargs).status 
1 by mbp at sourcefrog
import from baz patch-364
938
939
359 by Martin Pool
- pychecker fixups
940
def _report_exception(summary, quiet=False):
267 by Martin Pool
- better reporting of errors
941
    import traceback
942
    log_error('bzr: ' + summary)
359 by Martin Pool
- pychecker fixups
943
    bzrlib.trace.log_exception()
317 by Martin Pool
- better error message for broken pipe
944
945
    if not quiet:
946
        tb = sys.exc_info()[2]
947
        exinfo = traceback.extract_tb(tb)
948
        if exinfo:
949
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
950
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
267 by Martin Pool
- better reporting of errors
951
952
953
1 by mbp at sourcefrog
import from baz patch-364
954
def main(argv):
317 by Martin Pool
- better error message for broken pipe
955
    import errno
956
    
344 by Martin Pool
- It's not an error to use the library without
957
    bzrlib.open_tracefile(argv)
260 by Martin Pool
- remove atexit() dependency for writing out execution times
958
1 by mbp at sourcefrog
import from baz patch-364
959
    try:
260 by Martin Pool
- remove atexit() dependency for writing out execution times
960
        try:
337 by Martin Pool
- Clarify return codes from command objects
961
            try:
962
                return run_bzr(argv)
963
            finally:
964
                # do this here inside the exception wrappers to catch EPIPE
965
                sys.stdout.flush()
260 by Martin Pool
- remove atexit() dependency for writing out execution times
966
        except BzrError, e:
329 by Martin Pool
- refactor command functions into command classes
967
            quiet = isinstance(e, (BzrCommandError))
359 by Martin Pool
- pychecker fixups
968
            _report_exception('error: ' + e.args[0], quiet=quiet)
260 by Martin Pool
- remove atexit() dependency for writing out execution times
969
            if len(e.args) > 1:
970
                for h in e.args[1]:
267 by Martin Pool
- better reporting of errors
971
                    # some explanation or hints
260 by Martin Pool
- remove atexit() dependency for writing out execution times
972
                    log_error('  ' + h)
973
            return 1
267 by Martin Pool
- better reporting of errors
974
        except AssertionError, e:
975
            msg = 'assertion failed'
976
            if str(e):
977
                msg += ': ' + str(e)
359 by Martin Pool
- pychecker fixups
978
            _report_exception(msg)
318 by Martin Pool
- better error message for Ctrl-c
979
            return 2
980
        except KeyboardInterrupt, e:
359 by Martin Pool
- pychecker fixups
981
            _report_exception('interrupted', quiet=True)
318 by Martin Pool
- better error message for Ctrl-c
982
            return 2
260 by Martin Pool
- remove atexit() dependency for writing out execution times
983
        except Exception, e:
317 by Martin Pool
- better error message for broken pipe
984
            quiet = False
419 by Martin Pool
- RemoteBranch.__str__ and repr
985
            if (isinstance(e, IOError) 
986
                and hasattr(e, 'errno')
987
                and e.errno == errno.EPIPE):
317 by Martin Pool
- better error message for broken pipe
988
                quiet = True
989
                msg = 'broken pipe'
990
            else:
991
                msg = str(e).rstrip('\n')
359 by Martin Pool
- pychecker fixups
992
            _report_exception(msg, quiet)
318 by Martin Pool
- better error message for Ctrl-c
993
            return 2
260 by Martin Pool
- remove atexit() dependency for writing out execution times
994
    finally:
995
        bzrlib.trace.close_trace()
1 by mbp at sourcefrog
import from baz patch-364
996
997
998
if __name__ == '__main__':
999
    sys.exit(main(sys.argv))