~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-04-15 01:31:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
3
 
2
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
 
 
18
 
 
19
 
import sys, os
 
19
"""Bazaar-NG -- a free distributed version-control tool
 
20
 
 
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
22
 
 
23
Current limitation include:
 
24
 
 
25
* Metadata format is not stable yet -- you may need to
 
26
  discard history in the future.
 
27
 
 
28
* Insufficient error handling.
 
29
 
 
30
* Many commands unimplemented or partially implemented.
 
31
 
 
32
* Space-inefficient storage.
 
33
 
 
34
* No merge operators yet.
 
35
 
 
36
Interesting commands::
 
37
 
 
38
  bzr help [COMMAND]
 
39
       Show help screen
 
40
  bzr version
 
41
       Show software version/licence/non-warranty.
 
42
  bzr init
 
43
       Start versioning the current directory
 
44
  bzr add FILE...
 
45
       Make files versioned.
 
46
  bzr log
 
47
       Show revision history.
 
48
  bzr diff [FILE...]
 
49
       Show changes from last revision to working copy.
 
50
  bzr commit -m 'MESSAGE'
 
51
       Store current state as new revision.
 
52
  bzr export REVNO DESTINATION
 
53
       Export the branch state at a previous version.
 
54
  bzr status
 
55
       Show summary of pending changes.
 
56
  bzr remove FILE...
 
57
       Make a file not versioned.
 
58
  bzr info
 
59
       Show statistics about this branch.
 
60
"""
 
61
 
 
62
 
 
63
 
 
64
 
 
65
import sys, os, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
 
66
from sets import Set
 
67
from pprint import pprint
 
68
from stat import *
 
69
from glob import glob
 
70
from inspect import getdoc
20
71
 
21
72
import bzrlib
 
73
from bzrlib.store import ImmutableStore
22
74
from bzrlib.trace import mutter, note, log_error
23
 
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
 
from bzrlib.osutils import quotefn
25
 
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
 
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
 
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
 
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
 
78
from bzrlib.revision import Revision
 
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
26
80
     format_date
27
81
 
28
 
 
29
 
def _squish_command_name(cmd):
30
 
    return 'cmd_' + cmd.replace('-', '_')
31
 
 
32
 
 
33
 
def _unsquish_command_name(cmd):
34
 
    assert cmd.startswith("cmd_")
35
 
    return cmd[4:].replace('_','-')
36
 
 
37
 
def _parse_revision_str(revstr):
38
 
    """This handles a revision string -> revno. 
39
 
 
40
 
    There are several possibilities:
41
 
 
42
 
        '234'       -> 234
43
 
        '234:345'   -> [234, 345]
44
 
        ':234'      -> [None, 234]
45
 
        '234:'      -> [234, None]
46
 
 
47
 
    In the future we will also support:
48
 
        'uuid:blah-blah-blah'   -> ?
49
 
        'hash:blahblahblah'     -> ?
50
 
        potentially:
51
 
        'tag:mytag'             -> ?
52
 
    """
53
 
    if revstr.find(':') != -1:
54
 
        revs = revstr.split(':')
55
 
        if len(revs) > 2:
56
 
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
57
 
 
58
 
        if not revs[0]:
59
 
            revs[0] = None
60
 
        else:
61
 
            revs[0] = int(revs[0])
62
 
 
63
 
        if not revs[1]:
64
 
            revs[1] = None
65
 
        else:
66
 
            revs[1] = int(revs[1])
67
 
    else:
68
 
        revs = int(revstr)
69
 
    return revs
70
 
 
71
 
def get_all_cmds():
72
 
    """Return canonical name and class for all registered commands."""
73
 
    for k, v in globals().iteritems():
74
 
        if k.startswith("cmd_"):
75
 
            yield _unsquish_command_name(k), v
76
 
 
77
 
def get_cmd_class(cmd):
78
 
    """Return the canonical name and command class for a command.
79
 
    """
80
 
    cmd = str(cmd)                      # not unicode
81
 
 
82
 
    # first look up this command under the specified name
83
 
    try:
84
 
        return cmd, globals()[_squish_command_name(cmd)]
85
 
    except KeyError:
86
 
        pass
87
 
 
88
 
    # look for any command which claims this as an alias
89
 
    for cmdname, cmdclass in get_all_cmds():
90
 
        if cmd in cmdclass.aliases:
91
 
            return cmdname, cmdclass
92
 
 
93
 
    cmdclass = ExternalCommand.find_command(cmd)
94
 
    if cmdclass:
95
 
        return cmd, cmdclass
96
 
 
97
 
    raise BzrCommandError("unknown command %r" % cmd)
98
 
 
99
 
 
100
 
class Command(object):
101
 
    """Base class for commands.
102
 
 
103
 
    The docstring for an actual command should give a single-line
104
 
    summary, then a complete description of the command.  A grammar
105
 
    description will be inserted.
106
 
 
107
 
    takes_args
108
 
        List of argument forms, marked with whether they are optional,
109
 
        repeated, etc.
110
 
 
111
 
    takes_options
112
 
        List of options that may be given for this command.
113
 
 
114
 
    hidden
115
 
        If true, this command isn't advertised.
116
 
    """
117
 
    aliases = []
118
 
    
119
 
    takes_args = []
120
 
    takes_options = []
121
 
 
122
 
    hidden = False
123
 
    
124
 
    def __init__(self, options, arguments):
125
 
        """Construct and run the command.
126
 
 
127
 
        Sets self.status to the return value of run()."""
128
 
        assert isinstance(options, dict)
129
 
        assert isinstance(arguments, dict)
130
 
        cmdargs = options.copy()
131
 
        cmdargs.update(arguments)
132
 
        assert self.__doc__ != Command.__doc__, \
133
 
               ("No help message set for %r" % self)
134
 
        self.status = self.run(**cmdargs)
135
 
 
136
 
    
137
 
    def run(self):
138
 
        """Override this in sub-classes.
139
 
 
140
 
        This is invoked with the options and arguments bound to
141
 
        keyword parameters.
142
 
 
143
 
        Return 0 or None if the command was successful, or a shell
144
 
        error code if not.
145
 
        """
146
 
        return 0
147
 
 
148
 
 
149
 
class ExternalCommand(Command):
150
 
    """Class to wrap external commands.
151
 
 
152
 
    We cheat a little here, when get_cmd_class() calls us we actually give it back
153
 
    an object we construct that has the appropriate path, help, options etc for the
154
 
    specified command.
155
 
 
156
 
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
157
 
    method, which we override to call the Command.__init__ method. That then calls
158
 
    our run method which is pretty straight forward.
159
 
 
160
 
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
161
 
    back into command line options and arguments for the script.
162
 
    """
163
 
 
164
 
    def find_command(cls, cmd):
165
 
        import os.path
166
 
        bzrpath = os.environ.get('BZRPATH', '')
167
 
 
168
 
        for dir in bzrpath.split(':'):
169
 
            path = os.path.join(dir, cmd)
170
 
            if os.path.isfile(path):
171
 
                return ExternalCommand(path)
172
 
 
173
 
        return None
174
 
 
175
 
    find_command = classmethod(find_command)
176
 
 
177
 
    def __init__(self, path):
178
 
        self.path = path
179
 
 
180
 
        # TODO: If either of these fail, we should detect that and
181
 
        # assume that path is not really a bzr plugin after all.
182
 
 
183
 
        pipe = os.popen('%s --bzr-usage' % path, 'r')
184
 
        self.takes_options = pipe.readline().split()
185
 
        self.takes_args = pipe.readline().split()
186
 
        pipe.close()
187
 
 
188
 
        pipe = os.popen('%s --bzr-help' % path, 'r')
189
 
        self.__doc__ = pipe.read()
190
 
        pipe.close()
191
 
 
192
 
    def __call__(self, options, arguments):
193
 
        Command.__init__(self, options, arguments)
194
 
        return self
195
 
 
196
 
    def run(self, **kargs):
197
 
        opts = []
198
 
        args = []
199
 
 
200
 
        keys = kargs.keys()
201
 
        keys.sort()
202
 
        for name in keys:
203
 
            value = kargs[name]
204
 
            if OPTIONS.has_key(name):
205
 
                # it's an option
206
 
                opts.append('--%s' % name)
207
 
                if value is not None and value is not True:
208
 
                    opts.append(str(value))
209
 
            else:
210
 
                # it's an arg, or arg list
211
 
                if type(value) is not list:
212
 
                    value = [value]
213
 
                for v in value:
214
 
                    if v is not None:
215
 
                        args.append(str(v))
216
 
 
217
 
        self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
218
 
        return self.status
219
 
 
220
 
 
221
 
class cmd_status(Command):
 
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
 
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
 
84
 
 
85
## standard representation
 
86
NONE_STRING = '(none)'
 
87
EMPTY = 'empty'
 
88
 
 
89
 
 
90
## TODO: Perhaps a different version of inventory commands that
 
91
## returns iterators...
 
92
 
 
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
 
94
 
 
95
## TODO: Some kind of locking on branches.  Perhaps there should be a
 
96
## parameter to the branch object saying whether we want a read or
 
97
## write lock; release it from destructor.  Perhaps don't even need a
 
98
## read lock to look at immutable objects?
 
99
 
 
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
 
101
## to compare output?
 
102
 
 
103
## TODO: Some kind of global code to generate the right Branch object
 
104
## to work on.  Almost, but not quite all, commands need one, and it
 
105
## can be taken either from their parameters or their working
 
106
## directory.
 
107
 
 
108
## TODO: rename command, needed soon: check destination doesn't exist
 
109
## either in working copy or tree; move working copy; update
 
110
## inventory; write out
 
111
 
 
112
## TODO: move command; check destination is a directory and will not
 
113
## clash; move it.
 
114
 
 
115
## TODO: command to show renames, one per line, as to->from
 
116
 
 
117
 
 
118
 
 
119
 
 
120
def cmd_status(all=False):
222
121
    """Display status summary.
223
122
 
224
 
    This reports on versioned and unknown files, reporting them
225
 
    grouped by state.  Possible states are:
226
 
 
227
 
    added
228
 
        Versioned in the working copy but not in the previous revision.
229
 
 
230
 
    removed
231
 
        Versioned in the previous revision but removed or deleted
232
 
        in the working copy.
233
 
 
234
 
    renamed
235
 
        Path of this file changed from the previous revision;
236
 
        the text may also have changed.  This includes files whose
237
 
        parent directory was renamed.
238
 
 
239
 
    modified
240
 
        Text has changed since the previous revision.
241
 
 
242
 
    unchanged
243
 
        Nothing about this file has changed since the previous revision.
244
 
        Only shown with --all.
245
 
 
246
 
    unknown
247
 
        Not versioned and not matching an ignore pattern.
248
 
 
249
 
    To see ignored files use 'bzr ignored'.  For details in the
250
 
    changes to file texts, use 'bzr diff'.
251
 
 
252
 
    If no arguments are specified, the status of the entire working
253
 
    directory is shown.  Otherwise, only the status of the specified
254
 
    files or directories is reported.  If a directory is given, status
255
 
    is reported for everything inside that directory.
 
123
    For each file there is a single line giving its file state and name.
 
124
    The name is that in the current revision unless it is deleted or
 
125
    missing, in which case the old name is shown.
256
126
    """
257
 
    takes_args = ['file*']
258
 
    takes_options = ['all', 'show-ids']
259
 
    aliases = ['st', 'stat']
260
 
    
261
 
    def run(self, all=False, show_ids=False, file_list=None):
262
 
        if file_list:
263
 
            b = Branch(file_list[0])
264
 
            file_list = [b.relpath(x) for x in file_list]
265
 
            # special case: only one path was given and it's the root
266
 
            # of the branch
267
 
            if file_list == ['']:
268
 
                file_list = None
269
 
        else:
270
 
            b = Branch('.')
271
 
        import status
272
 
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
273
 
                           specific_files=file_list)
274
 
 
275
 
 
276
 
class cmd_cat_revision(Command):
277
 
    """Write out metadata for a revision."""
278
 
 
279
 
    hidden = True
280
 
    takes_args = ['revision_id']
281
 
    
282
 
    def run(self, revision_id):
283
 
        Branch('.').get_revision(revision_id).write_xml(sys.stdout)
284
 
 
285
 
 
286
 
class cmd_revno(Command):
287
 
    """Show current revision number.
288
 
 
289
 
    This is equal to the number of revisions on this branch."""
290
 
    def run(self):
291
 
        print Branch('.').revno()
292
 
 
293
 
    
294
 
class cmd_add(Command):
 
127
    #import bzrlib.status
 
128
    #bzrlib.status.tree_status(Branch('.'))
 
129
    Branch('.').show_status(show_all=all)
 
130
 
 
131
 
 
132
 
 
133
######################################################################
 
134
# examining history
 
135
def cmd_get_revision(revision_id):
 
136
    Branch('.').get_revision(revision_id).write_xml(sys.stdout)
 
137
 
 
138
 
 
139
def cmd_get_file_text(text_id):
 
140
    """Get contents of a file by hash."""
 
141
    sf = Branch('.').text_store[text_id]
 
142
    pumpfile(sf, sys.stdout)
 
143
 
 
144
 
 
145
 
 
146
######################################################################
 
147
# commands
 
148
    
 
149
 
 
150
def cmd_revno():
 
151
    """Show number of revisions on this branch"""
 
152
    print Branch('.').revno()
 
153
    
 
154
 
 
155
    
 
156
def cmd_add(file_list, verbose=False):
295
157
    """Add specified files or directories.
296
158
 
297
159
    In non-recursive mode, all the named items are added, regardless
308
170
 
309
171
    Therefore simply saying 'bzr add .' will version all files that
310
172
    are currently unknown.
311
 
 
312
 
    TODO: Perhaps adding a file whose directly is not versioned should
313
 
    recursively add that parent, rather than giving an error?
314
 
    """
315
 
    takes_args = ['file+']
316
 
    takes_options = ['verbose']
317
 
    
318
 
    def run(self, file_list, verbose=False):
319
 
        bzrlib.add.smart_add(file_list, verbose)
320
 
 
321
 
 
322
 
class cmd_relpath(Command):
323
 
    """Show path of a file relative to root"""
324
 
    takes_args = ['filename']
325
 
    hidden = True
326
 
    
327
 
    def run(self, filename):
328
 
        print Branch(filename).relpath(filename)
329
 
 
330
 
 
331
 
 
332
 
class cmd_inventory(Command):
333
 
    """Show inventory of the current working copy or a revision."""
334
 
    takes_options = ['revision', 'show-ids']
335
 
    
336
 
    def run(self, revision=None, show_ids=False):
337
 
        b = Branch('.')
338
 
        if revision == None:
339
 
            inv = b.read_working_inventory()
340
 
        else:
341
 
            inv = b.get_revision_inventory(b.lookup_revision(revision))
342
 
 
343
 
        for path, entry in inv.entries():
344
 
            if show_ids:
345
 
                print '%-50s %s' % (path, entry.file_id)
346
 
            else:
347
 
                print path
348
 
 
349
 
 
350
 
class cmd_move(Command):
351
 
    """Move files to a different directory.
352
 
 
353
 
    examples:
354
 
        bzr move *.txt doc
355
 
 
356
 
    The destination must be a versioned directory in the same branch.
357
 
    """
358
 
    takes_args = ['source$', 'dest']
359
 
    def run(self, source_list, dest):
360
 
        b = Branch('.')
361
 
 
362
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
363
 
 
364
 
 
365
 
class cmd_rename(Command):
 
173
    """
 
174
    bzrlib.add.smart_add(file_list, verbose)
 
175
    
 
176
 
 
177
def cmd_relpath(filename):
 
178
    """Show path of file relative to root"""
 
179
    print Branch(filename).relpath(filename)
 
180
 
 
181
 
 
182
 
 
183
def cmd_inventory(revision=None):
 
184
    """Show inventory of the current working copy."""
 
185
    ## TODO: Also optionally show a previous inventory
 
186
    ## TODO: Format options
 
187
    b = Branch('.')
 
188
    if revision == None:
 
189
        inv = b.read_working_inventory()
 
190
    else:
 
191
        inv = b.get_revision_inventory(b.lookup_revision(revision))
 
192
        
 
193
    for path, entry in inv.iter_entries():
 
194
        print '%-50s %s' % (entry.file_id, path)
 
195
 
 
196
 
 
197
 
 
198
# TODO: Maybe a 'mv' command that has the combined move/rename
 
199
# special behaviour of Unix?
 
200
 
 
201
def cmd_move(source_list, dest):
 
202
    b = Branch('.')
 
203
 
 
204
    b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
205
 
 
206
 
 
207
 
 
208
def cmd_rename(from_name, to_name):
366
209
    """Change the name of an entry.
367
210
 
 
211
    usage: bzr rename FROM_NAME TO_NAME
 
212
 
368
213
    examples:
369
214
      bzr rename frob.c frobber.c
370
215
      bzr rename src/frob.c lib/frob.c
376
221
 
377
222
    TODO: Some way to rename multiple files without invoking bzr for each
378
223
    one?"""
379
 
    takes_args = ['from_name', 'to_name']
 
224
    b = Branch('.')
 
225
    b.rename_one(b.relpath(from_name), b.relpath(to_name))
380
226
    
381
 
    def run(self, from_name, to_name):
382
 
        b = Branch('.')
383
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
384
 
 
385
 
 
386
 
 
387
 
class cmd_renames(Command):
 
227
 
 
228
 
 
229
 
 
230
def cmd_renames(dir='.'):
388
231
    """Show list of renamed files.
389
232
 
 
233
    usage: bzr renames [BRANCH]
 
234
 
390
235
    TODO: Option to show renames between two historical versions.
391
236
 
392
237
    TODO: Only show renames under dir, rather than in the whole branch.
393
238
    """
394
 
    takes_args = ['dir?']
395
 
 
396
 
    def run(self, dir='.'):
397
 
        b = Branch(dir)
398
 
        old_inv = b.basis_tree().inventory
399
 
        new_inv = b.read_working_inventory()
400
 
 
401
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
402
 
        renames.sort()
403
 
        for old_name, new_name in renames:
404
 
            print "%s => %s" % (old_name, new_name)        
405
 
 
406
 
 
407
 
class cmd_info(Command):
408
 
    """Show statistical information about a branch."""
409
 
    takes_args = ['branch?']
410
 
    
411
 
    def run(self, branch=None):
412
 
        import info
413
 
 
414
 
        from branch import find_branch
415
 
        b = find_branch(branch)
416
 
        info.show_info(b)
417
 
 
418
 
 
419
 
class cmd_remove(Command):
420
 
    """Make a file unversioned.
421
 
 
422
 
    This makes bzr stop tracking changes to a versioned file.  It does
423
 
    not delete the working copy.
424
 
    """
425
 
    takes_args = ['file+']
426
 
    takes_options = ['verbose']
427
 
    
428
 
    def run(self, file_list, verbose=False):
429
 
        b = Branch(file_list[0])
430
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
431
 
 
432
 
 
433
 
class cmd_file_id(Command):
 
239
    b = Branch(dir)
 
240
    old_inv = b.basis_tree().inventory
 
241
    new_inv = b.read_working_inventory()
 
242
    
 
243
    renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
244
    renames.sort()
 
245
    for old_name, new_name in renames:
 
246
        print "%s => %s" % (old_name, new_name)        
 
247
 
 
248
 
 
249
 
 
250
def cmd_info():
 
251
    """info: Show statistical information for this branch
 
252
 
 
253
    usage: bzr info"""
 
254
    import info
 
255
    info.show_info(Branch('.'))        
 
256
    
 
257
 
 
258
 
 
259
def cmd_remove(file_list, verbose=False):
 
260
    b = Branch(file_list[0])
 
261
    b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
262
 
 
263
 
 
264
 
 
265
def cmd_file_id(filename):
434
266
    """Print file_id of a particular file or directory.
435
267
 
 
268
    usage: bzr file-id FILE
 
269
 
436
270
    The file_id is assigned when the file is first added and remains the
437
271
    same through all revisions where the file exists, even when it is
438
272
    moved or renamed.
439
273
    """
440
 
    hidden = True
441
 
    takes_args = ['filename']
442
 
    def run(self, filename):
443
 
        b = Branch(filename)
444
 
        i = b.inventory.path2id(b.relpath(filename))
445
 
        if i == None:
446
 
            bailout("%r is not a versioned file" % filename)
447
 
        else:
448
 
            print i
449
 
 
450
 
 
451
 
class cmd_file_path(Command):
 
274
    b = Branch(filename)
 
275
    i = b.inventory.path2id(b.relpath(filename))
 
276
    if i == None:
 
277
        bailout("%r is not a versioned file" % filename)
 
278
    else:
 
279
        print i
 
280
 
 
281
 
 
282
def cmd_file_id_path(filename):
452
283
    """Print path of file_ids to a file or directory.
453
284
 
 
285
    usage: bzr file-id-path FILE
 
286
 
454
287
    This prints one line for each directory down to the target,
455
288
    starting at the branch root."""
456
 
    hidden = True
457
 
    takes_args = ['filename']
458
 
    def run(self, filename):
459
 
        b = Branch(filename)
460
 
        inv = b.inventory
461
 
        fid = inv.path2id(b.relpath(filename))
462
 
        if fid == None:
463
 
            bailout("%r is not a versioned file" % filename)
464
 
        for fip in inv.get_idpath(fid):
465
 
            print fip
466
 
 
467
 
 
468
 
class cmd_revision_history(Command):
469
 
    """Display list of revision ids on this branch."""
470
 
    hidden = True
471
 
    def run(self):
472
 
        for patchid in Branch('.').revision_history():
473
 
            print patchid
474
 
 
475
 
 
476
 
class cmd_directories(Command):
477
 
    """Display list of versioned directories in this branch."""
478
 
    def run(self):
479
 
        for name, ie in Branch('.').read_working_inventory().directories():
480
 
            if name == '':
481
 
                print '.'
482
 
            else:
483
 
                print name
484
 
 
485
 
 
486
 
class cmd_init(Command):
487
 
    """Make a directory into a versioned branch.
488
 
 
489
 
    Use this to create an empty branch, or before importing an
490
 
    existing project.
491
 
 
492
 
    Recipe for importing a tree of files:
493
 
        cd ~/project
494
 
        bzr init
495
 
        bzr add -v .
496
 
        bzr status
497
 
        bzr commit -m 'imported project'
498
 
    """
499
 
    def run(self):
500
 
        Branch('.', init=True)
501
 
 
502
 
 
503
 
class cmd_diff(Command):
504
 
    """Show differences in working tree.
505
 
    
 
289
    b = Branch(filename)
 
290
    inv = b.inventory
 
291
    fid = inv.path2id(b.relpath(filename))
 
292
    if fid == None:
 
293
        bailout("%r is not a versioned file" % filename)
 
294
    for fip in inv.get_idpath(fid):
 
295
        print fip
 
296
 
 
297
 
 
298
def cmd_revision_history():
 
299
    for patchid in Branch('.').revision_history():
 
300
        print patchid
 
301
 
 
302
 
 
303
def cmd_directories():
 
304
    for name, ie in Branch('.').read_working_inventory().directories():
 
305
        if name == '':
 
306
            print '.'
 
307
        else:
 
308
            print name
 
309
 
 
310
 
 
311
def cmd_missing():
 
312
    for name, ie in Branch('.').working_tree().missing():
 
313
        print name
 
314
 
 
315
 
 
316
def cmd_init():
 
317
    # TODO: Check we're not already in a working directory?  At the
 
318
    # moment you'll get an ugly error.
 
319
    
 
320
    # TODO: What if we're in a subdirectory of a branch?  Would like
 
321
    # to allow that, but then the parent may need to understand that
 
322
    # the children have disappeared, or should they be versioned in
 
323
    # both?
 
324
 
 
325
    # TODO: Take an argument/option for branch name.
 
326
    Branch('.', init=True)
 
327
 
 
328
 
 
329
def cmd_diff(revision=None, file_list=None):
 
330
    """bzr diff: Show differences in working tree.
 
331
    
 
332
    usage: bzr diff [-r REV] [FILE...]
 
333
 
 
334
    --revision REV
 
335
         Show changes since REV, rather than predecessor.
 
336
 
506
337
    If files are listed, only the changes in those files are listed.
507
338
    Otherwise, all changes for the tree are listed.
508
339
 
513
344
    TODO: Option to use external diff command; could be GNU diff, wdiff,
514
345
          or a graphical diff.
515
346
 
516
 
    TODO: Python difflib is not exactly the same as unidiff; should
517
 
          either fix it up or prefer to use an external diff.
518
 
 
519
347
    TODO: If a directory is given, diff everything under that.
520
348
 
521
 
    TODO: Selected-file diff is inefficient and doesn't show you
522
 
          deleted files.
523
 
 
524
 
    TODO: This probably handles non-Unix newlines poorly.
525
 
    """
 
349
    TODO: Selected-file diff is inefficient and doesn't show you deleted files.
 
350
"""
 
351
 
 
352
    ## TODO: Shouldn't be in the cmd function.
 
353
 
 
354
    b = Branch('.')
 
355
 
 
356
    if revision == None:
 
357
        old_tree = b.basis_tree()
 
358
    else:
 
359
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
360
        
 
361
    new_tree = b.working_tree()
 
362
 
 
363
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
364
    old_label = ''
 
365
    new_label = ''
 
366
 
 
367
    DEVNULL = '/dev/null'
 
368
    # Windows users, don't panic about this filename -- it is a
 
369
    # special signal to GNU patch that the file should be created or
 
370
    # deleted respectively.
 
371
 
 
372
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
373
    # be usefully made into a much faster special case.
 
374
 
 
375
    # TODO: Better to return them in sorted order I think.
 
376
 
 
377
    # FIXME: If given a file list, compare only those files rather
 
378
    # than comparing everything and then throwing stuff away.
526
379
    
527
 
    takes_args = ['file*']
528
 
    takes_options = ['revision', 'diff-options']
529
 
    aliases = ['di']
530
 
 
531
 
    def run(self, revision=None, file_list=None, diff_options=None):
532
 
        from bzrlib.diff import show_diff
533
 
        from bzrlib import find_branch
534
 
 
535
 
        if file_list:
536
 
            b = find_branch(file_list[0])
537
 
            file_list = [b.relpath(f) for f in file_list]
538
 
            if file_list == ['']:
539
 
                # just pointing to top-of-tree
540
 
                file_list = None
 
380
    for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
 
381
 
 
382
        if file_list and new_name not in file_list:
 
383
            continue
 
384
        
 
385
        # Don't show this by default; maybe do it if an option is passed
 
386
        # idlabel = '      {%s}' % fid
 
387
        idlabel = ''
 
388
 
 
389
        # FIXME: Something about the diff format makes patch unhappy
 
390
        # with newly-added files.
 
391
 
 
392
        def diffit(oldlines, newlines, **kw):
 
393
            # FIXME: difflib is wrong if there is no trailing newline.
 
394
 
 
395
            # Special workaround for Python2.3, where difflib fails if
 
396
            # both sequences are empty.
 
397
            if oldlines or newlines:
 
398
                sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
 
399
            print
 
400
        
 
401
        if file_state in ['.', '?', 'I']:
 
402
            continue
 
403
        elif file_state == 'A':
 
404
            print '*** added %s %r' % (kind, new_name)
 
405
            if kind == 'file':
 
406
                diffit([],
 
407
                       new_tree.get_file(fid).readlines(),
 
408
                       fromfile=DEVNULL,
 
409
                       tofile=new_label + new_name + idlabel)
 
410
        elif file_state == 'D':
 
411
            assert isinstance(old_name, types.StringTypes)
 
412
            print '*** deleted %s %r' % (kind, old_name)
 
413
            if kind == 'file':
 
414
                diffit(old_tree.get_file(fid).readlines(), [],
 
415
                       fromfile=old_label + old_name + idlabel,
 
416
                       tofile=DEVNULL)
 
417
        elif file_state in ['M', 'R']:
 
418
            if file_state == 'M':
 
419
                assert kind == 'file'
 
420
                assert old_name == new_name
 
421
                print '*** modified %s %r' % (kind, new_name)
 
422
            elif file_state == 'R':
 
423
                print '*** renamed %s %r => %r' % (kind, old_name, new_name)
 
424
 
 
425
            if kind == 'file':
 
426
                diffit(old_tree.get_file(fid).readlines(),
 
427
                       new_tree.get_file(fid).readlines(),
 
428
                       fromfile=old_label + old_name + idlabel,
 
429
                       tofile=new_label + new_name)
541
430
        else:
542
 
            b = Branch('.')
543
 
    
544
 
        show_diff(b, revision, specific_files=file_list,
545
 
                  external_diff_options=diff_options)
546
 
 
547
 
 
548
 
        
549
 
 
550
 
 
551
 
class cmd_deleted(Command):
 
431
            bailout("can't represent state %s {%s}" % (file_state, fid))
 
432
 
 
433
 
 
434
 
 
435
def cmd_deleted(show_ids=False):
552
436
    """List files deleted in the working tree.
553
437
 
554
438
    TODO: Show files deleted since a previous revision, or between two revisions.
555
439
    """
556
 
    def run(self, show_ids=False):
557
 
        b = Branch('.')
558
 
        old = b.basis_tree()
559
 
        new = b.working_tree()
560
 
 
561
 
        ## TODO: Much more efficient way to do this: read in new
562
 
        ## directories with readdir, rather than stating each one.  Same
563
 
        ## level of effort but possibly much less IO.  (Or possibly not,
564
 
        ## if the directories are very large...)
565
 
 
566
 
        for path, ie in old.inventory.iter_entries():
567
 
            if not new.has_id(ie.file_id):
568
 
                if show_ids:
569
 
                    print '%-50s %s' % (path, ie.file_id)
570
 
                else:
571
 
                    print path
572
 
 
573
 
 
574
 
class cmd_modified(Command):
575
 
    """List files modified in working tree."""
576
 
    hidden = True
577
 
    def run(self):
578
 
        import statcache
579
 
        b = Branch('.')
580
 
        inv = b.read_working_inventory()
581
 
        sc = statcache.update_cache(b, inv)
582
 
        basis = b.basis_tree()
583
 
        basis_inv = basis.inventory
584
 
        
585
 
        # We used to do this through iter_entries(), but that's slow
586
 
        # when most of the files are unmodified, as is usually the
587
 
        # case.  So instead we iterate by inventory entry, and only
588
 
        # calculate paths as necessary.
589
 
 
590
 
        for file_id in basis_inv:
591
 
            cacheentry = sc.get(file_id)
592
 
            if not cacheentry:                 # deleted
593
 
                continue
594
 
            ie = basis_inv[file_id]
595
 
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
596
 
                path = inv.id2path(file_id)
 
440
    b = Branch('.')
 
441
    old = b.basis_tree()
 
442
    new = b.working_tree()
 
443
 
 
444
    ## TODO: Much more efficient way to do this: read in new
 
445
    ## directories with readdir, rather than stating each one.  Same
 
446
    ## level of effort but possibly much less IO.  (Or possibly not,
 
447
    ## if the directories are very large...)
 
448
 
 
449
    for path, ie in old.inventory.iter_entries():
 
450
        if not new.has_id(ie.file_id):
 
451
            if show_ids:
 
452
                print '%-50s %s' % (path, ie.file_id)
 
453
            else:
597
454
                print path
598
455
 
599
456
 
600
457
 
601
 
class cmd_added(Command):
602
 
    """List files added in working tree."""
603
 
    hidden = True
604
 
    def run(self):
605
 
        b = Branch('.')
606
 
        wt = b.working_tree()
607
 
        basis_inv = b.basis_tree().inventory
608
 
        inv = wt.inventory
609
 
        for file_id in inv:
610
 
            if file_id in basis_inv:
611
 
                continue
612
 
            path = inv.id2path(file_id)
613
 
            if not os.access(b.abspath(path), os.F_OK):
614
 
                continue
615
 
            print path
 
458
def cmd_parse_inventory():
 
459
    import cElementTree
 
460
    
 
461
    cElementTree.ElementTree().parse(file('.bzr/inventory'))
 
462
 
 
463
 
 
464
 
 
465
def cmd_load_inventory():
 
466
    """Load inventory for timing purposes"""
 
467
    Branch('.').basis_tree().inventory
 
468
 
 
469
 
 
470
def cmd_dump_inventory():
 
471
    Branch('.').read_working_inventory().write_xml(sys.stdout)
 
472
 
 
473
 
 
474
def cmd_dump_new_inventory():
 
475
    import bzrlib.newinventory
 
476
    inv = Branch('.').basis_tree().inventory
 
477
    bzrlib.newinventory.write_inventory(inv, sys.stdout)
 
478
 
 
479
 
 
480
def cmd_load_new_inventory():
 
481
    import bzrlib.newinventory
 
482
    bzrlib.newinventory.read_new_inventory(sys.stdin)
616
483
                
617
 
        
618
 
 
619
 
class cmd_root(Command):
620
 
    """Show the tree root directory.
621
 
 
622
 
    The root is the nearest enclosing directory with a .bzr control
623
 
    directory."""
624
 
    takes_args = ['filename?']
625
 
    def run(self, filename=None):
626
 
        """Print the branch root."""
627
 
        from branch import find_branch
628
 
        b = find_branch(filename)
629
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
630
 
 
631
 
 
632
 
class cmd_log(Command):
 
484
    
 
485
def cmd_dump_slacker_inventory():
 
486
    import bzrlib.newinventory
 
487
    inv = Branch('.').basis_tree().inventory
 
488
    bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
 
489
 
 
490
 
 
491
 
 
492
def cmd_dump_text_inventory():
 
493
    import bzrlib.textinv
 
494
    inv = Branch('.').basis_tree().inventory
 
495
    bzrlib.textinv.write_text_inventory(inv, sys.stdout)
 
496
 
 
497
 
 
498
def cmd_load_text_inventory():
 
499
    import bzrlib.textinv
 
500
    inv = bzrlib.textinv.read_text_inventory(sys.stdin)
 
501
    print 'loaded %d entries' % len(inv)
 
502
    
 
503
    
 
504
 
 
505
def cmd_root(filename=None):
 
506
    """Print the branch root."""
 
507
    print bzrlib.branch.find_branch_root(filename)
 
508
    
 
509
 
 
510
def cmd_log(timezone='original', verbose=False):
633
511
    """Show log of this branch.
634
512
 
635
 
    To request a range of logs, you can use the command -r begin:end
636
 
    -r revision requests a specific revision, -r :end or -r begin: are
637
 
    also valid.
638
 
 
639
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
640
 
  
 
513
    TODO: Options for utc; to show ids; to limit range; etc.
641
514
    """
642
 
 
643
 
    takes_args = ['filename?']
644
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
645
 
    
646
 
    def run(self, filename=None, timezone='original',
647
 
            verbose=False,
648
 
            show_ids=False,
649
 
            forward=False,
650
 
            revision=None):
651
 
        from bzrlib import show_log, find_branch
652
 
        import codecs
653
 
 
654
 
        direction = (forward and 'forward') or 'reverse'
655
 
        
656
 
        if filename:
657
 
            b = find_branch(filename)
658
 
            fp = b.relpath(filename)
659
 
            if fp:
660
 
                file_id = b.read_working_inventory().path2id(fp)
661
 
            else:
662
 
                file_id = None  # points to branch root
663
 
        else:
664
 
            b = find_branch('.')
665
 
            file_id = None
666
 
 
667
 
        if revision == None:
668
 
            revision = [None, None]
669
 
        elif isinstance(revision, int):
670
 
            revision = [revision, revision]
671
 
        else:
672
 
            # pair of revisions?
673
 
            pass
674
 
            
675
 
        assert len(revision) == 2
676
 
 
677
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
678
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout)
679
 
 
680
 
        show_log(b, file_id,
681
 
                 show_timezone=timezone,
682
 
                 verbose=verbose,
683
 
                 show_ids=show_ids,
684
 
                 to_file=outf,
685
 
                 direction=direction,
686
 
                 start_revision=revision[0],
687
 
                 end_revision=revision[1])
688
 
 
689
 
 
690
 
 
691
 
class cmd_touching_revisions(Command):
692
 
    """Return revision-ids which affected a particular file.
693
 
 
694
 
    A more user-friendly interface is "bzr log FILE"."""
695
 
    hidden = True
696
 
    takes_args = ["filename"]
697
 
    def run(self, filename):
698
 
        b = Branch(filename)
699
 
        inv = b.read_working_inventory()
700
 
        file_id = inv.path2id(b.relpath(filename))
701
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
702
 
            print "%6d %s" % (revno, what)
703
 
 
704
 
 
705
 
class cmd_ls(Command):
 
515
    Branch('.').write_log(show_timezone=timezone, verbose=verbose)
 
516
 
 
517
 
 
518
def cmd_ls(revision=None, verbose=False):
706
519
    """List files in a tree.
707
520
 
708
521
    TODO: Take a revision or remote path and list that tree instead.
709
522
    """
710
 
    hidden = True
711
 
    def run(self, revision=None, verbose=False):
712
 
        b = Branch('.')
713
 
        if revision == None:
714
 
            tree = b.working_tree()
 
523
    b = Branch('.')
 
524
    if revision == None:
 
525
        tree = b.working_tree()
 
526
    else:
 
527
        tree = b.revision_tree(b.lookup_revision(revision))
 
528
        
 
529
    for fp, fc, kind, fid in tree.list_files():
 
530
        if verbose:
 
531
            if kind == 'directory':
 
532
                kindch = '/'
 
533
            elif kind == 'file':
 
534
                kindch = ''
 
535
            else:
 
536
                kindch = '???'
 
537
                
 
538
            print '%-8s %s%s' % (fc, fp, kindch)
715
539
        else:
716
 
            tree = b.revision_tree(b.lookup_revision(revision))
717
 
 
718
 
        for fp, fc, kind, fid in tree.list_files():
719
 
            if verbose:
720
 
                if kind == 'directory':
721
 
                    kindch = '/'
722
 
                elif kind == 'file':
723
 
                    kindch = ''
724
 
                else:
725
 
                    kindch = '???'
726
 
 
727
 
                print '%-8s %s%s' % (fc, fp, kindch)
728
 
            else:
729
 
                print fp
730
 
 
731
 
 
732
 
 
733
 
class cmd_unknowns(Command):
 
540
            print fp
 
541
    
 
542
    
 
543
 
 
544
def cmd_unknowns():
734
545
    """List unknown files"""
735
 
    def run(self):
736
 
        for f in Branch('.').unknowns():
737
 
            print quotefn(f)
738
 
 
739
 
 
740
 
 
741
 
class cmd_ignore(Command):
742
 
    """Ignore a command or pattern
743
 
 
744
 
    To remove patterns from the ignore list, edit the .bzrignore file.
745
 
 
746
 
    If the pattern contains a slash, it is compared to the whole path
747
 
    from the branch root.  Otherwise, it is comapred to only the last
748
 
    component of the path.
749
 
 
750
 
    Ignore patterns are case-insensitive on case-insensitive systems.
751
 
 
752
 
    Note: wildcards must be quoted from the shell on Unix.
753
 
 
754
 
    examples:
755
 
        bzr ignore ./Makefile
756
 
        bzr ignore '*.class'
757
 
    """
758
 
    takes_args = ['name_pattern']
759
 
    
760
 
    def run(self, name_pattern):
761
 
        from bzrlib.atomicfile import AtomicFile
762
 
        import os.path
763
 
 
764
 
        b = Branch('.')
765
 
        ifn = b.abspath('.bzrignore')
766
 
 
767
 
        if os.path.exists(ifn):
768
 
            f = open(ifn, 'rt')
769
 
            try:
770
 
                igns = f.read().decode('utf-8')
771
 
            finally:
772
 
                f.close()
773
 
        else:
774
 
            igns = ''
775
 
 
776
 
        # TODO: If the file already uses crlf-style termination, maybe
777
 
        # we should use that for the newly added lines?
778
 
 
779
 
        if igns and igns[-1] != '\n':
780
 
            igns += '\n'
781
 
        igns += name_pattern + '\n'
782
 
 
783
 
        try:
784
 
            f = AtomicFile(ifn, 'wt')
785
 
            f.write(igns.encode('utf-8'))
786
 
            f.commit()
787
 
        finally:
788
 
            f.close()
789
 
 
790
 
        inv = b.working_tree().inventory
791
 
        if inv.path2id('.bzrignore'):
792
 
            mutter('.bzrignore is already versioned')
793
 
        else:
794
 
            mutter('need to make new .bzrignore file versioned')
795
 
            b.add(['.bzrignore'])
796
 
 
797
 
 
798
 
 
799
 
class cmd_ignored(Command):
 
546
    for f in Branch('.').unknowns():
 
547
        print quotefn(f)
 
548
 
 
549
 
 
550
 
 
551
def cmd_ignored():
800
552
    """List ignored files and the patterns that matched them.
801
 
 
802
 
    See also: bzr ignore"""
803
 
    def run(self):
804
 
        tree = Branch('.').working_tree()
805
 
        for path, file_class, kind, file_id in tree.list_files():
806
 
            if file_class != 'I':
807
 
                continue
808
 
            ## XXX: Slightly inefficient since this was already calculated
809
 
            pat = tree.is_ignored(path)
810
 
            print '%-50s %s' % (path, pat)
811
 
 
812
 
 
813
 
class cmd_lookup_revision(Command):
814
 
    """Lookup the revision-id from a revision-number
815
 
 
816
 
    example:
817
 
        bzr lookup-revision 33
818
 
    """
819
 
    hidden = True
820
 
    takes_args = ['revno']
821
 
    
822
 
    def run(self, revno):
823
 
        try:
824
 
            revno = int(revno)
825
 
        except ValueError:
826
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
827
 
 
828
 
        print Branch('.').lookup_revision(revno)
829
 
 
830
 
 
831
 
class cmd_export(Command):
832
 
    """Export past revision to destination directory.
833
 
 
834
 
    If no revision is specified this exports the last committed revision."""
835
 
    takes_args = ['dest']
836
 
    takes_options = ['revision']
837
 
    def run(self, dest, revision=None):
838
 
        b = Branch('.')
839
 
        if revision == None:
840
 
            rh = b.revision_history()[-1]
841
 
        else:
842
 
            rh = b.lookup_revision(int(revision))
843
 
        t = b.revision_tree(rh)
844
 
        t.export(dest)
845
 
 
846
 
 
847
 
class cmd_cat(Command):
848
 
    """Write a file's text from a previous revision."""
849
 
 
850
 
    takes_options = ['revision']
851
 
    takes_args = ['filename']
852
 
 
853
 
    def run(self, filename, revision=None):
854
 
        if revision == None:
855
 
            raise BzrCommandError("bzr cat requires a revision number")
856
 
        b = Branch('.')
857
 
        b.print_file(b.relpath(filename), int(revision))
858
 
 
859
 
 
860
 
class cmd_local_time_offset(Command):
861
 
    """Show the offset in seconds from GMT to local time."""
862
 
    hidden = True    
863
 
    def run(self):
864
 
        print bzrlib.osutils.local_time_offset()
865
 
 
866
 
 
867
 
 
868
 
class cmd_commit(Command):
869
 
    """Commit changes into a new revision.
870
 
 
871
 
    If selected files are specified, only changes to those files are
872
 
    committed.  If a directory is specified then its contents are also
873
 
    committed.
874
 
 
875
 
    A selected-file commit may fail in some cases where the committed
876
 
    tree would be invalid, such as trying to commit a file in a
877
 
    newly-added directory that is not itself committed.
 
553
      """
 
554
    tree = Branch('.').working_tree()
 
555
    for path, file_class, kind, file_id in tree.list_files():
 
556
        if file_class != 'I':
 
557
            continue
 
558
        ## XXX: Slightly inefficient since this was already calculated
 
559
        pat = tree.is_ignored(path)
 
560
        print '%-50s %s' % (path, pat)
 
561
 
 
562
 
 
563
def cmd_lookup_revision(revno):
 
564
    try:
 
565
        revno = int(revno)
 
566
    except ValueError:
 
567
        bailout("usage: lookup-revision REVNO",
 
568
                ["REVNO is a non-negative revision number for this branch"])
 
569
 
 
570
    print Branch('.').lookup_revision(revno) or NONE_STRING
 
571
 
 
572
 
 
573
 
 
574
def cmd_export(revno, dest):
 
575
    """Export past revision to destination directory."""
 
576
    b = Branch('.')
 
577
    rh = b.lookup_revision(int(revno))
 
578
    t = b.revision_tree(rh)
 
579
    t.export(dest)
 
580
 
 
581
def cmd_cat(revision, filename):
 
582
    """Print file to stdout."""
 
583
    b = Branch('.')
 
584
    b.print_file(b.relpath(filename), int(revision))
 
585
 
 
586
 
 
587
######################################################################
 
588
# internal/test commands
 
589
 
 
590
 
 
591
def cmd_uuid():
 
592
    """Print a newly-generated UUID."""
 
593
    print bzrlib.osutils.uuid()
 
594
 
 
595
 
 
596
 
 
597
def cmd_local_time_offset():
 
598
    print bzrlib.osutils.local_time_offset()
 
599
 
 
600
 
 
601
 
 
602
def cmd_commit(message=None, verbose=False):
 
603
    """Commit changes to a new revision.
 
604
 
 
605
    --message MESSAGE
 
606
        Description of changes in this revision; free form text.
 
607
        It is recommended that the first line be a single-sentence
 
608
        summary.
 
609
    --verbose
 
610
        Show status of changed files,
 
611
 
 
612
    TODO: Commit only selected files.
878
613
 
879
614
    TODO: Run hooks on tree to-be-committed, and after commit.
880
615
 
881
616
    TODO: Strict commit that fails if there are unknown or deleted files.
882
617
    """
883
 
    takes_args = ['selected*']
884
 
    takes_options = ['message', 'file', 'verbose']
885
 
    aliases = ['ci', 'checkin']
886
 
 
887
 
    def run(self, message=None, file=None, verbose=True, selected_list=None):
888
 
        from bzrlib.commit import commit
889
 
 
890
 
        ## Warning: shadows builtin file()
891
 
        if not message and not file:
892
 
            raise BzrCommandError("please specify a commit message",
893
 
                                  ["use either --message or --file"])
894
 
        elif message and file:
895
 
            raise BzrCommandError("please specify either --message or --file")
896
 
        
897
 
        if file:
898
 
            import codecs
899
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
900
 
 
901
 
        b = Branch('.')
902
 
        commit(b, message, verbose=verbose, specific_files=selected_list)
903
 
 
904
 
 
905
 
class cmd_check(Command):
906
 
    """Validate consistency of branch history.
 
618
 
 
619
    if not message:
 
620
        bailout("please specify a commit message")
 
621
    Branch('.').commit(message, verbose=verbose)
 
622
 
 
623
 
 
624
def cmd_check(dir='.'):
 
625
    """check: Consistency check of branch history.
 
626
 
 
627
    usage: bzr check [-v] [BRANCH]
 
628
 
 
629
    options:
 
630
      --verbose, -v         Show progress of checking.
907
631
 
908
632
    This command checks various invariants about the branch storage to
909
633
    detect data corruption or bzr bugs.
910
634
    """
911
 
    takes_args = ['dir?']
912
 
    def run(self, dir='.'):
913
 
        import bzrlib.check
914
 
        bzrlib.check.check(Branch(dir))
915
 
 
916
 
 
917
 
 
918
 
class cmd_whoami(Command):
919
 
    """Show bzr user id."""
920
 
    takes_options = ['email']
921
 
    
922
 
    def run(self, email=False):
923
 
        if email:
924
 
            print bzrlib.osutils.user_email()
925
 
        else:
926
 
            print bzrlib.osutils.username()
927
 
 
928
 
 
929
 
class cmd_selftest(Command):
 
635
    import bzrlib.check
 
636
    bzrlib.check.check(Branch(dir, find_root=False))
 
637
 
 
638
 
 
639
def cmd_is(pred, *rest):
 
640
    """Test whether PREDICATE is true."""
 
641
    try:
 
642
        cmd_handler = globals()['assert_' + pred.replace('-', '_')]
 
643
    except KeyError:
 
644
        bailout("unknown predicate: %s" % quotefn(pred))
 
645
        
 
646
    try:
 
647
        cmd_handler(*rest)
 
648
    except BzrCheckError:
 
649
        # by default we don't print the message so that this can
 
650
        # be used from shell scripts without producing noise
 
651
        sys.exit(1)
 
652
 
 
653
 
 
654
def cmd_username():
 
655
    print bzrlib.osutils.username()
 
656
 
 
657
 
 
658
def cmd_user_email():
 
659
    print bzrlib.osutils.user_email()
 
660
 
 
661
 
 
662
def cmd_gen_revision_id():
 
663
    print bzrlib.branch._gen_revision_id(time.time())
 
664
 
 
665
 
 
666
def cmd_selftest():
930
667
    """Run internal test suite"""
931
 
    hidden = True
932
 
    def run(self):
933
 
        failures, tests = 0, 0
934
 
 
935
 
        import doctest, bzrlib.store
936
 
        bzrlib.trace.verbose = False
937
 
 
938
 
        for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
939
 
            bzrlib.tree, bzrlib.commands, bzrlib.add:
940
 
            mf, mt = doctest.testmod(m)
941
 
            failures += mf
942
 
            tests += mt
943
 
            print '%-40s %3d tests' % (m.__name__, mt),
944
 
            if mf:
945
 
                print '%3d FAILED!' % mf
946
 
            else:
947
 
                print
948
 
 
949
 
        print '%-40s %3d tests' % ('total', tests),
950
 
        if failures:
951
 
            print '%3d FAILED!' % failures
952
 
            return 1
 
668
    ## -v, if present, is seen by doctest; the argument is just here
 
669
    ## so our parser doesn't complain
 
670
 
 
671
    ## TODO: --verbose option
 
672
 
 
673
    failures, tests = 0, 0
 
674
    
 
675
    import doctest, bzrlib.store, bzrlib.tests
 
676
    bzrlib.trace.verbose = False
 
677
 
 
678
    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
 
679
        bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
 
680
        mf, mt = doctest.testmod(m)
 
681
        failures += mf
 
682
        tests += mt
 
683
        print '%-40s %3d tests' % (m.__name__, mt),
 
684
        if mf:
 
685
            print '%3d FAILED!' % mf
953
686
        else:
954
687
            print
955
 
            return 0
956
 
 
957
 
 
958
 
 
959
 
class cmd_version(Command):
960
 
    """Show version of bzr"""
961
 
    def run(self):
962
 
        show_version()
963
 
 
964
 
def show_version():
 
688
 
 
689
    print '%-40s %3d tests' % ('total', tests),
 
690
    if failures:
 
691
        print '%3d FAILED!' % failures
 
692
    else:
 
693
        print
 
694
 
 
695
 
 
696
 
 
697
# deprecated
 
698
cmd_doctest = cmd_selftest
 
699
 
 
700
 
 
701
######################################################################
 
702
# help
 
703
 
 
704
 
 
705
def cmd_help(topic=None):
 
706
    if topic == None:
 
707
        print __doc__
 
708
        return
 
709
 
 
710
    # otherwise, maybe the name of a command?
 
711
    try:
 
712
        cmdfn = globals()['cmd_' + topic.replace('-', '_')]
 
713
    except KeyError:
 
714
        bailout("no help for %r" % topic)
 
715
 
 
716
    doc = getdoc(cmdfn)
 
717
    if doc == None:
 
718
        bailout("sorry, no detailed help yet for %r" % topic)
 
719
 
 
720
    print doc
 
721
        
 
722
 
 
723
 
 
724
 
 
725
def cmd_version():
965
726
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
966
727
    print bzrlib.__copyright__
967
728
    print "http://bazaar-ng.org/"
968
729
    print
969
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
970
 
    print "you may use, modify and redistribute it under the terms of the GNU"
971
 
    print "General Public License version 2 or later."
972
 
 
973
 
 
974
 
class cmd_rocks(Command):
 
730
    print \
 
731
"""bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and
 
732
you may use, modify and redistribute it under the terms of the GNU 
 
733
General Public License version 2 or later."""
 
734
 
 
735
 
 
736
def cmd_rocks():
975
737
    """Statement of optimism."""
976
 
    hidden = True
977
 
    def run(self):
978
 
        print "it sure does!"
979
 
 
980
 
def parse_spec(spec):
981
 
    if '/@' in spec:
982
 
        parsed = spec.split('/@')
983
 
        assert len(parsed) == 2
984
 
        if parsed[1] == "":
985
 
            parsed[1] = -1
986
 
        else:
987
 
            parsed[1] = int(parsed[1])
988
 
            assert parsed[1] >=0
989
 
    else:
990
 
        parsed = [spec, None]
991
 
    return parsed
992
 
 
993
 
class cmd_merge(Command):
994
 
    """Perform a three-way merge of trees."""
995
 
    takes_args = ['other_spec', 'base_spec']
996
 
 
997
 
    def run(self, other_spec, base_spec):
998
 
        from bzrlib.merge import merge
999
 
        merge(parse_spec(other_spec), parse_spec(base_spec))
1000
 
 
1001
 
class cmd_assert_fail(Command):
1002
 
    """Test reporting of assertion failures"""
1003
 
    hidden = True
1004
 
    def run(self):
1005
 
        assert False, "always fails"
1006
 
 
1007
 
 
1008
 
class cmd_help(Command):
1009
 
    """Show help on a command or other topic.
1010
 
 
1011
 
    For a list of all available commands, say 'bzr help commands'."""
1012
 
    takes_args = ['topic?']
1013
 
    aliases = ['?']
1014
 
    
1015
 
    def run(self, topic=None):
1016
 
        import help
1017
 
        help.help(topic)
1018
 
 
1019
 
 
1020
 
class cmd_update_stat_cache(Command):
1021
 
    """Update stat-cache mapping inodes to SHA-1 hashes.
1022
 
 
1023
 
    For testing only."""
1024
 
    hidden = True
1025
 
    def run(self):
1026
 
        import statcache
1027
 
        b = Branch('.')
1028
 
        statcache.update_cache(b.base, b.read_working_inventory())
1029
 
 
 
738
    print "it sure does!"
 
739
 
 
740
 
 
741
 
 
742
######################################################################
 
743
# main routine
1030
744
 
1031
745
 
1032
746
# list of all available options; the rhs can be either None for an
1034
748
# the type.
1035
749
OPTIONS = {
1036
750
    'all':                    None,
1037
 
    'diff-options':           str,
1038
751
    'help':                   None,
1039
 
    'file':                   unicode,
1040
 
    'forward':                None,
1041
752
    'message':                unicode,
1042
753
    'profile':                None,
1043
 
    'revision':               _parse_revision_str,
 
754
    'revision':               int,
1044
755
    'show-ids':               None,
1045
756
    'timezone':               str,
1046
757
    'verbose':                None,
1047
758
    'version':                None,
1048
 
    'email':                  None,
1049
759
    }
1050
760
 
1051
761
SHORT_OPTIONS = {
1052
 
    'F':                      'file', 
1053
 
    'h':                      'help',
1054
762
    'm':                      'message',
1055
763
    'r':                      'revision',
1056
764
    'v':                      'verbose',
1057
765
}
1058
766
 
 
767
# List of options that apply to particular commands; commands not
 
768
# listed take none.
 
769
cmd_options = {
 
770
    'add':                    ['verbose'],
 
771
    'cat':                    ['revision'],
 
772
    'commit':                 ['message', 'verbose'],
 
773
    'deleted':                ['show-ids'],
 
774
    'diff':                   ['revision'],
 
775
    'inventory':              ['revision'],
 
776
    'log':                    ['timezone', 'verbose'],
 
777
    'ls':                     ['revision', 'verbose'],
 
778
    'remove':                 ['verbose'],
 
779
    'status':                 ['all'],
 
780
    }
 
781
 
 
782
 
 
783
cmd_args = {
 
784
    'add':                    ['file+'],
 
785
    'cat':                    ['filename'],
 
786
    'commit':                 [],
 
787
    'diff':                   ['file*'],
 
788
    'export':                 ['revno', 'dest'],
 
789
    'file-id':                ['filename'],
 
790
    'file-id-path':           ['filename'],
 
791
    'get-file-text':          ['text_id'],
 
792
    'get-inventory':          ['inventory_id'],
 
793
    'get-revision':           ['revision_id'],
 
794
    'get-revision-inventory': ['revision_id'],
 
795
    'help':                   ['topic?'],
 
796
    'init':                   [],
 
797
    'log':                    [],
 
798
    'lookup-revision':        ['revno'],
 
799
    'move':                   ['source$', 'dest'],
 
800
    'relpath':                ['filename'],
 
801
    'remove':                 ['file+'],
 
802
    'rename':                 ['from_name', 'to_name'],
 
803
    'renames':                ['dir?'],
 
804
    'root':                   ['filename?'],
 
805
    'status':                 [],
 
806
    }
 
807
 
1059
808
 
1060
809
def parse_args(argv):
1061
810
    """Parse command line.
1082
831
    while argv:
1083
832
        a = argv.pop(0)
1084
833
        if a[0] == '-':
1085
 
            # option names must not be unicode
1086
 
            a = str(a)
1087
834
            optarg = None
1088
835
            if a[1] == '-':
1089
836
                mutter("  got option %r" % a)
1122
869
 
1123
870
 
1124
871
 
 
872
def _match_args(cmd, args):
 
873
    """Check non-option arguments match required pattern.
1125
874
 
1126
 
def _match_argform(cmd, takes_args, args):
 
875
    >>> _match_args('status', ['asdasdsadasd'])
 
876
    Traceback (most recent call last):
 
877
    ...
 
878
    BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
 
879
    >>> _match_args('add', ['asdasdsadasd'])
 
880
    {'file_list': ['asdasdsadasd']}
 
881
    >>> _match_args('add', 'abc def gj'.split())
 
882
    {'file_list': ['abc', 'def', 'gj']}
 
883
    """
 
884
    # match argument pattern
 
885
    argform = cmd_args.get(cmd, [])
1127
886
    argdict = {}
 
887
    # TODO: Need a way to express 'cp SRC... DEST', where it matches
 
888
    # all but one.
1128
889
 
1129
 
    # step through args and takes_args, allowing appropriate 0-many matches
1130
 
    for ap in takes_args:
 
890
    # step through args and argform, allowing appropriate 0-many matches
 
891
    for ap in argform:
1131
892
        argname = ap[:-1]
1132
893
        if ap[-1] == '?':
1133
894
            if args:
1140
901
                argdict[argname + '_list'] = None
1141
902
        elif ap[-1] == '+':
1142
903
            if not args:
1143
 
                raise BzrCommandError("command %r needs one or more %s"
 
904
                bailout("command %r needs one or more %s"
1144
905
                        % (cmd, argname.upper()))
1145
906
            else:
1146
907
                argdict[argname + '_list'] = args[:]
1147
908
                args = []
1148
909
        elif ap[-1] == '$': # all but one
1149
910
            if len(args) < 2:
1150
 
                raise BzrCommandError("command %r needs one or more %s"
 
911
                bailout("command %r needs one or more %s"
1151
912
                        % (cmd, argname.upper()))
1152
913
            argdict[argname + '_list'] = args[:-1]
1153
914
            args[:-1] = []                
1155
916
            # just a plain arg
1156
917
            argname = ap
1157
918
            if not args:
1158
 
                raise BzrCommandError("command %r requires argument %s"
 
919
                bailout("command %r requires argument %s"
1159
920
                        % (cmd, argname.upper()))
1160
921
            else:
1161
922
                argdict[argname] = args.pop(0)
1162
923
            
1163
924
    if args:
1164
 
        raise BzrCommandError("extra argument to command %s: %s"
1165
 
                              % (cmd, args[0]))
 
925
        bailout("extra arguments to command %s: %r"
 
926
                % (cmd, args))
1166
927
 
1167
928
    return argdict
1168
929
 
1174
935
    This is similar to main(), but without all the trappings for
1175
936
    logging and error handling.  
1176
937
    """
 
938
 
1177
939
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1178
940
    
1179
941
    try:
1180
942
        args, opts = parse_args(argv[1:])
1181
943
        if 'help' in opts:
1182
 
            import help
 
944
            # TODO: pass down other arguments in case they asked for
 
945
            # help on a command name?
1183
946
            if args:
1184
 
                help.help(args[0])
 
947
                cmd_help(args[0])
1185
948
            else:
1186
 
                help.help()
 
949
                cmd_help()
1187
950
            return 0
1188
951
        elif 'version' in opts:
1189
 
            show_version()
 
952
            cmd_version()
1190
953
            return 0
1191
 
        cmd = str(args.pop(0))
 
954
        cmd = args.pop(0)
1192
955
    except IndexError:
1193
 
        import help
1194
 
        help.help()
 
956
        log_error('usage: bzr COMMAND\n')
 
957
        log_error('  try "bzr help"\n')
1195
958
        return 1
1196
 
          
1197
959
 
1198
 
    canonical_cmd, cmd_class = get_cmd_class(cmd)
 
960
    try:
 
961
        cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
 
962
    except KeyError:
 
963
        bailout("unknown command " + `cmd`)
1199
964
 
1200
965
    # global option
1201
966
    if 'profile' in opts:
1205
970
        profile = False
1206
971
 
1207
972
    # check options are reasonable
1208
 
    allowed = cmd_class.takes_options
 
973
    allowed = cmd_options.get(cmd, [])
1209
974
    for oname in opts:
1210
975
        if oname not in allowed:
1211
 
            raise BzrCommandError("option '--%s' is not allowed for command %r"
1212
 
                                  % (oname, cmd))
 
976
            bailout("option %r is not allowed for command %r"
 
977
                    % (oname, cmd))
 
978
 
 
979
    # TODO: give an error if there are any mandatory options which are
 
980
    # not specified?  Or maybe there shouldn't be any "mandatory
 
981
    # options" (it is an oxymoron)
1213
982
 
1214
983
    # mix arguments and options into one dictionary
1215
 
    cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1216
 
    cmdopts = {}
 
984
    cmdargs = _match_args(cmd, args)
1217
985
    for k, v in opts.items():
1218
 
        cmdopts[k.replace('-', '_')] = v
 
986
        cmdargs[str(k.replace('-', '_'))] = v
1219
987
 
1220
988
    if profile:
1221
 
        import hotshot, tempfile
 
989
        import hotshot
1222
990
        pffileno, pfname = tempfile.mkstemp()
1223
991
        try:
1224
992
            prof = hotshot.Profile(pfname)
1225
 
            ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
 
993
            ret = prof.runcall(cmd_handler, **cmdargs) or 0
1226
994
            prof.close()
1227
995
 
1228
996
            import hotshot.stats
1233
1001
            ## print_stats seems hardcoded to stdout
1234
1002
            stats.print_stats(20)
1235
1003
            
1236
 
            return ret.status
 
1004
            return ret
1237
1005
 
1238
1006
        finally:
1239
1007
            os.close(pffileno)
1240
1008
            os.remove(pfname)
1241
1009
    else:
1242
 
        return cmd_class(cmdopts, cmdargs).status 
1243
 
 
1244
 
 
1245
 
def _report_exception(summary, quiet=False):
1246
 
    import traceback
1247
 
    log_error('bzr: ' + summary)
1248
 
    bzrlib.trace.log_exception()
1249
 
 
1250
 
    if not quiet:
1251
 
        tb = sys.exc_info()[2]
1252
 
        exinfo = traceback.extract_tb(tb)
1253
 
        if exinfo:
1254
 
            sys.stderr.write('  at %s:%d in %s()\n' % exinfo[-1][:3])
1255
 
        sys.stderr.write('  see ~/.bzr.log for debug information\n')
 
1010
        return cmd_handler(**cmdargs) or 0
1256
1011
 
1257
1012
 
1258
1013
 
1259
1014
def main(argv):
1260
 
    import errno
 
1015
    ## TODO: Handle command-line options; probably know what options are valid for
 
1016
    ## each command
 
1017
 
 
1018
    ## TODO: If the arguments are wrong, give a usage message rather
 
1019
    ## than just a backtrace.
 
1020
 
 
1021
    bzrlib.trace.create_tracefile(argv)
1261
1022
    
1262
 
    bzrlib.open_tracefile(argv)
1263
 
 
1264
1023
    try:
1265
 
        try:
1266
 
            try:
1267
 
                return run_bzr(argv)
1268
 
            finally:
1269
 
                # do this here inside the exception wrappers to catch EPIPE
1270
 
                sys.stdout.flush()
1271
 
        except BzrError, e:
1272
 
            quiet = isinstance(e, (BzrCommandError))
1273
 
            _report_exception('error: ' + e.args[0], quiet=quiet)
1274
 
            if len(e.args) > 1:
1275
 
                for h in e.args[1]:
1276
 
                    # some explanation or hints
1277
 
                    log_error('  ' + h)
1278
 
            return 1
1279
 
        except AssertionError, e:
1280
 
            msg = 'assertion failed'
1281
 
            if str(e):
1282
 
                msg += ': ' + str(e)
1283
 
            _report_exception(msg)
1284
 
            return 2
1285
 
        except KeyboardInterrupt, e:
1286
 
            _report_exception('interrupted', quiet=True)
1287
 
            return 2
1288
 
        except Exception, e:
1289
 
            quiet = False
1290
 
            if (isinstance(e, IOError) 
1291
 
                and hasattr(e, 'errno')
1292
 
                and e.errno == errno.EPIPE):
1293
 
                quiet = True
1294
 
                msg = 'broken pipe'
1295
 
            else:
1296
 
                msg = str(e).rstrip('\n')
1297
 
            _report_exception(msg, quiet)
1298
 
            return 2
1299
 
    finally:
1300
 
        bzrlib.trace.close_trace()
 
1024
        ret = run_bzr(argv)
 
1025
        return ret
 
1026
    except BzrError, e:
 
1027
        log_error('bzr: error: ' + e.args[0] + '\n')
 
1028
        if len(e.args) > 1:
 
1029
            for h in e.args[1]:
 
1030
                log_error('  ' + h + '\n')
 
1031
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
1032
        log_error('(see $HOME/.bzr.log for debug information)\n')
 
1033
        return 1
 
1034
    except Exception, e:
 
1035
        log_error('bzr: exception: %s\n' % e)
 
1036
        log_error('(see $HOME/.bzr.log for debug information)\n')
 
1037
        traceback.print_exc(None, bzrlib.trace._tracefile)
 
1038
        ## traceback.print_exc(None, sys.stderr)
 
1039
        return 1
 
1040
 
 
1041
    ## TODO: Trap AssertionError
 
1042
 
 
1043
    # TODO: Maybe nicer handling of IOError especially for broken pipe.
 
1044
 
1301
1045
 
1302
1046
 
1303
1047
if __name__ == '__main__':
1304
1048
    sys.exit(main(sys.argv))
 
1049
    ##import profile
 
1050
    ##profile.run('main(sys.argv)')