/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):
539
    """List ignored files and the patterns that matched them."""
540
    def run(self):
541
        tree = Branch('.').working_tree()
542
        for path, file_class, kind, file_id in tree.list_files():
543
            if file_class != 'I':
544
                continue
545
            ## XXX: Slightly inefficient since this was already calculated
546
            pat = tree.is_ignored(path)
547
            print '%-50s %s' % (path, pat)
548
549
550
class cmd_lookup_revision(Command):
551
    """Lookup the revision-id from a revision-number
552
553
    example:
554
        bzr lookup-revision 33
555
        """
556
    hidden = True
338 by Martin Pool
- cleanup of some imports
557
    takes_args = ['revno']
558
    
329 by Martin Pool
- refactor command functions into command classes
559
    def run(self, revno):
560
        try:
561
            revno = int(revno)
562
        except ValueError:
338 by Martin Pool
- cleanup of some imports
563
            raise BzrCommandError("not a valid revision-number: %r" % revno)
564
565
        print Branch('.').lookup_revision(revno)
329 by Martin Pool
- refactor command functions into command classes
566
567
568
class cmd_export(Command):
569
    """Export past revision to destination directory.
570
571
    If no revision is specified this exports the last committed revision."""
572
    takes_args = ['dest']
573
    takes_options = ['revision']
394 by Martin Pool
- Fix argument handling in export command
574
    def run(self, dest, revision=None):
329 by Martin Pool
- refactor command functions into command classes
575
        b = Branch('.')
394 by Martin Pool
- Fix argument handling in export command
576
        if revision == None:
577
            rh = b.revision_history()[-1]
329 by Martin Pool
- refactor command functions into command classes
578
        else:
394 by Martin Pool
- Fix argument handling in export command
579
            rh = b.lookup_revision(int(revision))
329 by Martin Pool
- refactor command functions into command classes
580
        t = b.revision_tree(rh)
581
        t.export(dest)
582
583
584
class cmd_cat(Command):
585
    """Write a file's text from a previous revision."""
586
587
    takes_options = ['revision']
588
    takes_args = ['filename']
589
590
    def run(self, filename, revision=None):
591
        if revision == None:
592
            raise BzrCommandError("bzr cat requires a revision number")
593
        b = Branch('.')
594
        b.print_file(b.relpath(filename), int(revision))
595
596
597
class cmd_local_time_offset(Command):
598
    """Show the offset in seconds from GMT to local time."""
599
    hidden = True    
600
    def run(self):
601
        print bzrlib.osutils.local_time_offset()
602
603
604
605
class cmd_commit(Command):
606
    """Commit changes into a new revision.
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
607
608
    TODO: Commit only selected files.
609
610
    TODO: Run hooks on tree to-be-committed, and after commit.
611
612
    TODO: Strict commit that fails if there are unknown or deleted files.
613
    """
389 by Martin Pool
- new commit --file option!
614
    takes_options = ['message', 'file', 'verbose']
350 by Martin Pool
- refactor command aliases into command classes
615
    aliases = ['ci', 'checkin']
616
389 by Martin Pool
- new commit --file option!
617
    def run(self, message=None, file=None, verbose=False):
618
        ## Warning: shadows builtin file()
619
        if not message and not file:
620
            raise BzrCommandError("please specify a commit message",
621
                                  ["use either --message or --file"])
622
        elif message and file:
623
            raise BzrCommandError("please specify either --message or --file")
624
        
625
        if file:
626
            import codecs
627
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
628
329 by Martin Pool
- refactor command functions into command classes
629
        Branch('.').commit(message, verbose=verbose)
630
631
632
class cmd_check(Command):
633
    """Validate consistency of branch history.
232 by mbp at sourcefrog
Allow docstrings for help to be in PEP0257 format.
634
635
    This command checks various invariants about the branch storage to
636
    detect data corruption or bzr bugs.
637
    """
329 by Martin Pool
- refactor command functions into command classes
638
    takes_args = ['dir?']
639
    def run(self, dir='.'):
640
        import bzrlib.check
641
        bzrlib.check.check(Branch(dir, find_root=False))
642
643
644
645
class cmd_whoami(Command):
646
    """Show bzr user id."""
647
    takes_options = ['email']
286 by Martin Pool
- New bzr whoami --email option
648
    
329 by Martin Pool
- refactor command functions into command classes
649
    def run(self, email=False):
650
        if email:
651
            print bzrlib.osutils.user_email()
652
        else:
653
            print bzrlib.osutils.username()
654
655
656
class cmd_selftest(Command):
55 by mbp at sourcefrog
bzr selftest shows some counts of tests
657
    """Run internal test suite"""
329 by Martin Pool
- refactor command functions into command classes
658
    hidden = True
659
    def run(self):
660
        failures, tests = 0, 0
661
662
        import doctest, bzrlib.store, bzrlib.tests
663
        bzrlib.trace.verbose = False
664
665
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
666
            bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
667
            mf, mt = doctest.testmod(m)
668
            failures += mf
669
            tests += mt
670
            print '%-40s %3d tests' % (m.__name__, mt),
671
            if mf:
672
                print '%3d FAILED!' % mf
673
            else:
674
                print
675
676
        print '%-40s %3d tests' % ('total', tests),
677
        if failures:
678
            print '%3d FAILED!' % failures
55 by mbp at sourcefrog
bzr selftest shows some counts of tests
679
        else:
680
            print
681
329 by Martin Pool
- refactor command functions into command classes
682
683
684
class cmd_version(Command):
685
    """Show version of bzr"""
686
    def run(self):
687
        show_version()
688
689
def show_version():
690
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
691
    print bzrlib.__copyright__
692
    print "http://bazaar-ng.org/"
693
    print
694
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
695
    print "you may use, modify and redistribute it under the terms of the GNU"
696
    print "General Public License version 2 or later."
697
698
699
class cmd_rocks(Command):
700
    """Statement of optimism."""
701
    hidden = True
702
    def run(self):
703
        print "it sure does!"
704
705
706
class cmd_assert_fail(Command):
707
    """Test reporting of assertion failures"""
708
    hidden = True
709
    def run(self):
710
        assert False, "always fails"
711
712
713
class cmd_help(Command):
714
    """Show help on a command or other topic.
715
716
    For a list of all available commands, say 'bzr help commands'."""
717
    takes_args = ['topic?']
350 by Martin Pool
- refactor command aliases into command classes
718
    aliases = ['?']
329 by Martin Pool
- refactor command functions into command classes
719
    
720
    def run(self, topic=None):
351 by Martin Pool
- Split out help functions into bzrlib.help
721
        import help
722
        help.help(topic)
723
1 by mbp at sourcefrog
import from baz patch-364
724
725
######################################################################
726
# main routine
727
728
729
# list of all available options; the rhs can be either None for an
730
# option that takes no argument, or a constructor function that checks
731
# the type.
732
OPTIONS = {
733
    'all':                    None,
734
    'help':                   None,
389 by Martin Pool
- new commit --file option!
735
    'file':                   unicode,
1 by mbp at sourcefrog
import from baz patch-364
736
    'message':                unicode,
137 by mbp at sourcefrog
new --profile option
737
    'profile':                None,
1 by mbp at sourcefrog
import from baz patch-364
738
    'revision':               int,
739
    'show-ids':               None,
12 by mbp at sourcefrog
new --timezone option for bzr log
740
    'timezone':               str,
1 by mbp at sourcefrog
import from baz patch-364
741
    'verbose':                None,
742
    'version':                None,
286 by Martin Pool
- New bzr whoami --email option
743
    'email':                  None,
1 by mbp at sourcefrog
import from baz patch-364
744
    }
745
746
SHORT_OPTIONS = {
747
    'm':                      'message',
389 by Martin Pool
- new commit --file option!
748
    'F':                      'file', 
1 by mbp at sourcefrog
import from baz patch-364
749
    'r':                      'revision',
750
    'v':                      'verbose',
751
}
752
753
754
def parse_args(argv):
755
    """Parse command line.
756
    
757
    Arguments and options are parsed at this level before being passed
758
    down to specific command handlers.  This routine knows, from a
759
    lookup table, something about the available options, what optargs
760
    they take, and which commands will accept them.
761
31 by Martin Pool
fix up parse_args doctest
762
    >>> parse_args('--help'.split())
1 by mbp at sourcefrog
import from baz patch-364
763
    ([], {'help': True})
31 by Martin Pool
fix up parse_args doctest
764
    >>> parse_args('--version'.split())
1 by mbp at sourcefrog
import from baz patch-364
765
    ([], {'version': True})
31 by Martin Pool
fix up parse_args doctest
766
    >>> parse_args('status --all'.split())
1 by mbp at sourcefrog
import from baz patch-364
767
    (['status'], {'all': True})
31 by Martin Pool
fix up parse_args doctest
768
    >>> parse_args('commit --message=biter'.split())
17 by mbp at sourcefrog
allow --option=ARG syntax
769
    (['commit'], {'message': u'biter'})
1 by mbp at sourcefrog
import from baz patch-364
770
    """
771
    args = []
772
    opts = {}
773
774
    # TODO: Maybe handle '--' to end options?
775
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
776
    while argv:
777
        a = argv.pop(0)
1 by mbp at sourcefrog
import from baz patch-364
778
        if a[0] == '-':
264 by Martin Pool
parse_args: option names must be ascii
779
            # option names must not be unicode
780
            a = str(a)
17 by mbp at sourcefrog
allow --option=ARG syntax
781
            optarg = None
1 by mbp at sourcefrog
import from baz patch-364
782
            if a[1] == '-':
783
                mutter("  got option %r" % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
784
                if '=' in a:
785
                    optname, optarg = a[2:].split('=', 1)
786
                else:
787
                    optname = a[2:]
1 by mbp at sourcefrog
import from baz patch-364
788
                if optname not in OPTIONS:
789
                    bailout('unknown long option %r' % a)
790
            else:
791
                shortopt = a[1:]
792
                if shortopt not in SHORT_OPTIONS:
793
                    bailout('unknown short option %r' % a)
794
                optname = SHORT_OPTIONS[shortopt]
795
            
796
            if optname in opts:
797
                # XXX: Do we ever want to support this, e.g. for -r?
798
                bailout('repeated option %r' % a)
17 by mbp at sourcefrog
allow --option=ARG syntax
799
                
1 by mbp at sourcefrog
import from baz patch-364
800
            optargfn = OPTIONS[optname]
801
            if optargfn:
17 by mbp at sourcefrog
allow --option=ARG syntax
802
                if optarg == None:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
803
                    if not argv:
17 by mbp at sourcefrog
allow --option=ARG syntax
804
                        bailout('option %r needs an argument' % a)
805
                    else:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
806
                        optarg = argv.pop(0)
17 by mbp at sourcefrog
allow --option=ARG syntax
807
                opts[optname] = optargfn(optarg)
1 by mbp at sourcefrog
import from baz patch-364
808
            else:
17 by mbp at sourcefrog
allow --option=ARG syntax
809
                if optarg != None:
810
                    bailout('option %r takes no argument' % optname)
1 by mbp at sourcefrog
import from baz patch-364
811
                opts[optname] = True
812
        else:
813
            args.append(a)
814
815
    return args, opts
816
817
818
819
329 by Martin Pool
- refactor command functions into command classes
820
def _match_argform(cmd, takes_args, args):
1 by mbp at sourcefrog
import from baz patch-364
821
    argdict = {}
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
822
329 by Martin Pool
- refactor command functions into command classes
823
    # step through args and takes_args, allowing appropriate 0-many matches
824
    for ap in takes_args:
1 by mbp at sourcefrog
import from baz patch-364
825
        argname = ap[:-1]
826
        if ap[-1] == '?':
62 by mbp at sourcefrog
- new find_branch_root function; based on suggestion from aaron
827
            if args:
828
                argdict[argname] = args.pop(0)
196 by mbp at sourcefrog
selected-file diff
829
        elif ap[-1] == '*': # all remaining arguments
830
            if args:
831
                argdict[argname + '_list'] = args[:]
832
                args = []
833
            else:
834
                argdict[argname + '_list'] = None
1 by mbp at sourcefrog
import from baz patch-364
835
        elif ap[-1] == '+':
836
            if not args:
329 by Martin Pool
- refactor command functions into command classes
837
                raise BzrCommandError("command %r needs one or more %s"
1 by mbp at sourcefrog
import from baz patch-364
838
                        % (cmd, argname.upper()))
839
            else:
840
                argdict[argname + '_list'] = args[:]
841
                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
842
        elif ap[-1] == '$': # all but one
843
            if len(args) < 2:
329 by Martin Pool
- refactor command functions into command classes
844
                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
845
                        % (cmd, argname.upper()))
846
            argdict[argname + '_list'] = args[:-1]
847
            args[:-1] = []                
1 by mbp at sourcefrog
import from baz patch-364
848
        else:
849
            # just a plain arg
850
            argname = ap
851
            if not args:
329 by Martin Pool
- refactor command functions into command classes
852
                raise BzrCommandError("command %r requires argument %s"
1 by mbp at sourcefrog
import from baz patch-364
853
                        % (cmd, argname.upper()))
854
            else:
855
                argdict[argname] = args.pop(0)
856
            
857
    if args:
329 by Martin Pool
- refactor command functions into command classes
858
        raise BzrCommandError("extra argument to command %s: %s"
859
                              % (cmd, args[0]))
1 by mbp at sourcefrog
import from baz patch-364
860
861
    return argdict
862
863
864
865
def run_bzr(argv):
866
    """Execute a command.
867
868
    This is similar to main(), but without all the trappings for
245 by mbp at sourcefrog
- control files always in utf-8-unix format
869
    logging and error handling.  
1 by mbp at sourcefrog
import from baz patch-364
870
    """
251 by mbp at sourcefrog
- factor out locale.getpreferredencoding()
871
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
245 by mbp at sourcefrog
- control files always in utf-8-unix format
872
    
1 by mbp at sourcefrog
import from baz patch-364
873
    try:
26 by mbp at sourcefrog
fix StopIteration error on python2.3(?)
874
        args, opts = parse_args(argv[1:])
1 by mbp at sourcefrog
import from baz patch-364
875
        if 'help' in opts:
351 by Martin Pool
- Split out help functions into bzrlib.help
876
            import help
159 by mbp at sourcefrog
bzr commit --help now works
877
            if args:
351 by Martin Pool
- Split out help functions into bzrlib.help
878
                help.help(args[0])
159 by mbp at sourcefrog
bzr commit --help now works
879
            else:
351 by Martin Pool
- Split out help functions into bzrlib.help
880
                help.help()
1 by mbp at sourcefrog
import from baz patch-364
881
            return 0
882
        elif 'version' in opts:
336 by Martin Pool
- fix up 'bzr --version'
883
            show_version()
1 by mbp at sourcefrog
import from baz patch-364
884
            return 0
265 by Martin Pool
parse_args: command names must also be ascii
885
        cmd = str(args.pop(0))
1 by mbp at sourcefrog
import from baz patch-364
886
    except IndexError:
257 by Martin Pool
- Write less startup junk to .bzr.log
887
        log_error('usage: bzr COMMAND')
888
        log_error('  try "bzr help"')
1 by mbp at sourcefrog
import from baz patch-364
889
        return 1
115 by mbp at sourcefrog
todo
890
351 by Martin Pool
- Split out help functions into bzrlib.help
891
    canonical_cmd, cmd_class = get_cmd_class(cmd)
1 by mbp at sourcefrog
import from baz patch-364
892
137 by mbp at sourcefrog
new --profile option
893
    # global option
894
    if 'profile' in opts:
895
        profile = True
896
        del opts['profile']
897
    else:
898
        profile = False
1 by mbp at sourcefrog
import from baz patch-364
899
900
    # check options are reasonable
329 by Martin Pool
- refactor command functions into command classes
901
    allowed = cmd_class.takes_options
1 by mbp at sourcefrog
import from baz patch-364
902
    for oname in opts:
903
        if oname not in allowed:
381 by Martin Pool
- Better message when a wrong argument is given
904
            raise BzrCommandError("option '--%s' is not allowed for command %r"
329 by Martin Pool
- refactor command functions into command classes
905
                                  % (oname, cmd))
176 by mbp at sourcefrog
New cat command contributed by janmar.
906
137 by mbp at sourcefrog
new --profile option
907
    # mix arguments and options into one dictionary
329 by Martin Pool
- refactor command functions into command classes
908
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
909
    cmdopts = {}
136 by mbp at sourcefrog
new --show-ids option for 'deleted' command
910
    for k, v in opts.items():
329 by Martin Pool
- refactor command functions into command classes
911
        cmdopts[k.replace('-', '_')] = v
1 by mbp at sourcefrog
import from baz patch-364
912
137 by mbp at sourcefrog
new --profile option
913
    if profile:
338 by Martin Pool
- cleanup of some imports
914
        import hotshot, tempfile
239 by mbp at sourcefrog
- remove profiler temporary file when done
915
        pffileno, pfname = tempfile.mkstemp()
916
        try:
917
            prof = hotshot.Profile(pfname)
329 by Martin Pool
- refactor command functions into command classes
918
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
239 by mbp at sourcefrog
- remove profiler temporary file when done
919
            prof.close()
920
921
            import hotshot.stats
922
            stats = hotshot.stats.load(pfname)
923
            #stats.strip_dirs()
924
            stats.sort_stats('time')
925
            ## XXX: Might like to write to stderr or the trace file instead but
926
            ## print_stats seems hardcoded to stdout
927
            stats.print_stats(20)
928
            
337 by Martin Pool
- Clarify return codes from command objects
929
            return ret.status
239 by mbp at sourcefrog
- remove profiler temporary file when done
930
931
        finally:
932
            os.close(pffileno)
933
            os.remove(pfname)
137 by mbp at sourcefrog
new --profile option
934
    else:
337 by Martin Pool
- Clarify return codes from command objects
935
        cmdobj = cmd_class(cmdopts, cmdargs).status 
1 by mbp at sourcefrog
import from baz patch-364
936
937
359 by Martin Pool
- pychecker fixups
938
def _report_exception(summary, quiet=False):
267 by Martin Pool
- better reporting of errors
939
    import traceback
940
    log_error('bzr: ' + summary)
359 by Martin Pool
- pychecker fixups
941
    bzrlib.trace.log_exception()
317 by Martin Pool
- better error message for broken pipe
942
943
    if not quiet:
944
        tb = sys.exc_info()[2]
945
        exinfo = traceback.extract_tb(tb)
946
        if exinfo:
947
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
948
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
267 by Martin Pool
- better reporting of errors
949
950
951
1 by mbp at sourcefrog
import from baz patch-364
952
def main(argv):
317 by Martin Pool
- better error message for broken pipe
953
    import errno
954
    
344 by Martin Pool
- It's not an error to use the library without
955
    bzrlib.open_tracefile(argv)
260 by Martin Pool
- remove atexit() dependency for writing out execution times
956
1 by mbp at sourcefrog
import from baz patch-364
957
    try:
260 by Martin Pool
- remove atexit() dependency for writing out execution times
958
        try:
337 by Martin Pool
- Clarify return codes from command objects
959
            try:
960
                return run_bzr(argv)
961
            finally:
962
                # do this here inside the exception wrappers to catch EPIPE
963
                sys.stdout.flush()
260 by Martin Pool
- remove atexit() dependency for writing out execution times
964
        except BzrError, e:
329 by Martin Pool
- refactor command functions into command classes
965
            quiet = isinstance(e, (BzrCommandError))
359 by Martin Pool
- pychecker fixups
966
            _report_exception('error: ' + e.args[0], quiet=quiet)
260 by Martin Pool
- remove atexit() dependency for writing out execution times
967
            if len(e.args) > 1:
968
                for h in e.args[1]:
267 by Martin Pool
- better reporting of errors
969
                    # some explanation or hints
260 by Martin Pool
- remove atexit() dependency for writing out execution times
970
                    log_error('  ' + h)
971
            return 1
267 by Martin Pool
- better reporting of errors
972
        except AssertionError, e:
973
            msg = 'assertion failed'
974
            if str(e):
975
                msg += ': ' + str(e)
359 by Martin Pool
- pychecker fixups
976
            _report_exception(msg)
318 by Martin Pool
- better error message for Ctrl-c
977
            return 2
978
        except KeyboardInterrupt, e:
359 by Martin Pool
- pychecker fixups
979
            _report_exception('interrupted', quiet=True)
318 by Martin Pool
- better error message for Ctrl-c
980
            return 2
260 by Martin Pool
- remove atexit() dependency for writing out execution times
981
        except Exception, e:
317 by Martin Pool
- better error message for broken pipe
982
            quiet = False
419 by Martin Pool
- RemoteBranch.__str__ and repr
983
            if (isinstance(e, IOError) 
984
                and hasattr(e, 'errno')
985
                and e.errno == errno.EPIPE):
317 by Martin Pool
- better error message for broken pipe
986
                quiet = True
987
                msg = 'broken pipe'
988
            else:
989
                msg = str(e).rstrip('\n')
359 by Martin Pool
- pychecker fixups
990
            _report_exception(msg, quiet)
318 by Martin Pool
- better error message for Ctrl-c
991
            return 2
260 by Martin Pool
- remove atexit() dependency for writing out execution times
992
    finally:
993
        bzrlib.trace.close_trace()
1 by mbp at sourcefrog
import from baz patch-364
994
995
996
if __name__ == '__main__':
997
    sys.exit(main(sys.argv))