« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 84
- compare with another revision
- download diff
- download tarball
- view history from revision 84
- Committer: mbp at sourcefrog
- Date: 2005-03-25 01:16:46 UTC
- Revision ID: mbp@sourcefrog.net-20050325011646-e3f0af5d6bd1190c
- update version string
- put it in bzrlib
- put it in bzrlib
- files added:
- bzrlib/tests.py
- files removed:
- .rsyncexclude
- bzrlib/selftest
- contrib
- contrib/bash
- contrib/zsh
- effbot
- effbot/org
- patches
- plugins
- plugins/changeset
- tools
- urlgrabber
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
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
* No handling of subdirectories, symlinks or any non-text files.
29
30
* Insufficient error handling.
31
32
* Many commands unimplemented or partially implemented.
33
34
* Space-inefficient storage.
35
36
* No merge operators yet.
37
38
Interesting commands::
39
40
bzr help
41
Show summary help screen
42
bzr version
43
Show software version/licence/non-warranty.
44
bzr init
45
Start versioning the current directory
46
bzr add FILE...
47
Make files versioned.
48
bzr log
49
Show revision history.
50
bzr diff
51
Show changes from last revision to working copy.
52
bzr commit -m 'MESSAGE'
53
Store current state as new revision.
54
bzr export REVNO DESTINATION
55
Export the branch state at a previous version.
56
bzr status
57
Show summary of pending changes.
58
bzr remove FILE...
59
Make a file not versioned.
60
bzr info
61
Show statistics about this branch.
62
"""
63
64
65
66
67
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
68
import traceback, socket, fnmatch, difflib
69
from os import path
70
from sets import Set
71
from pprint import pprint
72
from stat import *
73
from glob import glob
20
74
21
75
import bzrlib
22
from bzrlib.trace import mutter, note, log_error, warning
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
25
from bzrlib import BZRDIR
26
27
28
plugin_cmds = {}
29
30
31
def register_command(cmd):
32
"Utility function to help register a command"
33
global plugin_cmds
34
k = cmd.__name__
35
if k.startswith("cmd_"):
36
k_unsquished = _unsquish_command_name(k)
37
else:
38
k_unsquished = k
39
if not plugin_cmds.has_key(k_unsquished):
40
plugin_cmds[k_unsquished] = cmd
41
else:
42
log_error('Two plugins defined the same command: %r' % k)
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
44
45
46
def _squish_command_name(cmd):
47
return 'cmd_' + cmd.replace('-', '_')
48
49
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
return cmd[4:].replace('_','-')
53
54
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
57
58
This always returns a list. The list will have one element for
59
60
It supports integers directly, but everything else it
61
defers for passing to Branch.get_revision_info()
62
63
>>> _parse_revision_str('234')
64
[234]
65
>>> _parse_revision_str('234..567')
66
[234, 567]
67
>>> _parse_revision_str('..')
68
[None, None]
69
>>> _parse_revision_str('..234')
70
[None, 234]
71
>>> _parse_revision_str('234..')
72
[234, None]
73
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
74
[234, 456, 789]
75
>>> _parse_revision_str('234....789') # Error?
76
[234, None, 789]
77
>>> _parse_revision_str('revid:test@other.com-234234')
78
['revid:test@other.com-234234']
79
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
80
['revid:test@other.com-234234', 'revid:test@other.com-234235']
81
>>> _parse_revision_str('revid:test@other.com-234234..23')
82
['revid:test@other.com-234234', 23]
83
>>> _parse_revision_str('date:2005-04-12')
84
['date:2005-04-12']
85
>>> _parse_revision_str('date:2005-04-12 12:24:33')
86
['date:2005-04-12 12:24:33']
87
>>> _parse_revision_str('date:2005-04-12T12:24:33')
88
['date:2005-04-12T12:24:33']
89
>>> _parse_revision_str('date:2005-04-12,12:24:33')
90
['date:2005-04-12,12:24:33']
91
>>> _parse_revision_str('-5..23')
92
[-5, 23]
93
>>> _parse_revision_str('-5')
94
[-5]
95
>>> _parse_revision_str('123a')
96
['123a']
97
>>> _parse_revision_str('abc')
98
['abc']
99
"""
100
import re
101
old_format_re = re.compile('\d*:\d*')
102
m = old_format_re.match(revstr)
103
if m:
104
warning('Colon separator for revision numbers is deprecated.'
105
' Use .. instead')
106
revs = []
107
for rev in revstr.split(':'):
108
if rev:
109
revs.append(int(rev))
110
else:
111
revs.append(None)
112
return revs
113
revs = []
114
for x in revstr.split('..'):
115
if not x:
116
revs.append(None)
117
else:
118
try:
119
revs.append(int(x))
120
except ValueError:
121
revs.append(x)
122
return revs
123
124
125
126
def _get_cmd_dict(plugins_override=True):
127
d = {}
128
for k, v in globals().iteritems():
129
if k.startswith("cmd_"):
130
d[_unsquish_command_name(k)] = v
131
# If we didn't load plugins, the plugin_cmds dict will be empty
132
if plugins_override:
133
d.update(plugin_cmds)
134
else:
135
d2 = plugin_cmds.copy()
136
d2.update(d)
137
d = d2
138
return d
139
140
141
def get_all_cmds(plugins_override=True):
142
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
144
yield k,v
145
146
147
def get_cmd_class(cmd, plugins_override=True):
148
"""Return the canonical name and command class for a command.
149
"""
150
cmd = str(cmd) # not unicode
151
152
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
154
try:
155
return cmd, cmds[cmd]
156
except KeyError:
157
pass
158
159
# look for any command which claims this as an alias
160
for cmdname, cmdclass in cmds.iteritems():
161
if cmd in cmdclass.aliases:
162
return cmdname, cmdclass
163
164
cmdclass = ExternalCommand.find_command(cmd)
165
if cmdclass:
166
return cmd, cmdclass
167
168
raise BzrCommandError("unknown command %r" % cmd)
169
170
171
class Command(object):
172
"""Base class for commands.
173
174
The docstring for an actual command should give a single-line
175
summary, then a complete description of the command. A grammar
176
description will be inserted.
177
178
takes_args
179
List of argument forms, marked with whether they are optional,
180
repeated, etc.
181
182
takes_options
183
List of options that may be given for this command.
184
185
hidden
186
If true, this command isn't advertised.
187
"""
188
aliases = []
189
190
takes_args = []
191
takes_options = []
192
193
hidden = False
194
195
def __init__(self, options, arguments):
196
"""Construct and run the command.
197
198
Sets self.status to the return value of run()."""
199
assert isinstance(options, dict)
200
assert isinstance(arguments, dict)
201
cmdargs = options.copy()
202
cmdargs.update(arguments)
203
assert self.__doc__ != Command.__doc__, \
204
("No help message set for %r" % self)
205
self.status = self.run(**cmdargs)
206
207
208
def run(self):
209
"""Override this in sub-classes.
210
211
This is invoked with the options and arguments bound to
212
keyword parameters.
213
214
Return 0 or None if the command was successful, or a shell
215
error code if not.
216
"""
217
return 0
218
219
220
class ExternalCommand(Command):
221
"""Class to wrap external commands.
222
223
We cheat a little here, when get_cmd_class() calls us we actually give it back
224
an object we construct that has the appropriate path, help, options etc for the
225
specified command.
226
227
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
228
method, which we override to call the Command.__init__ method. That then calls
229
our run method which is pretty straight forward.
230
231
The only wrinkle is that we have to map bzr's dictionary of options and arguments
232
back into command line options and arguments for the script.
233
"""
234
235
def find_command(cls, cmd):
236
import os.path
237
bzrpath = os.environ.get('BZRPATH', '')
238
239
for dir in bzrpath.split(os.pathsep):
240
path = os.path.join(dir, cmd)
241
if os.path.isfile(path):
242
return ExternalCommand(path)
243
244
return None
245
246
find_command = classmethod(find_command)
247
248
def __init__(self, path):
249
self.path = path
250
251
pipe = os.popen('%s --bzr-usage' % path, 'r')
252
self.takes_options = pipe.readline().split()
253
254
for opt in self.takes_options:
255
if not opt in OPTIONS:
256
raise BzrError("Unknown option '%s' returned by external command %s"
257
% (opt, path))
258
259
# TODO: Is there any way to check takes_args is valid here?
260
self.takes_args = pipe.readline().split()
261
262
if pipe.close() is not None:
263
raise BzrError("Failed funning '%s --bzr-usage'" % path)
264
265
pipe = os.popen('%s --bzr-help' % path, 'r')
266
self.__doc__ = pipe.read()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-help'" % path)
269
270
def __call__(self, options, arguments):
271
Command.__init__(self, options, arguments)
272
return self
273
274
def run(self, **kargs):
275
opts = []
276
args = []
277
278
keys = kargs.keys()
279
keys.sort()
280
for name in keys:
281
optname = name.replace('_','-')
282
value = kargs[name]
283
if OPTIONS.has_key(optname):
284
# it's an option
285
opts.append('--%s' % optname)
286
if value is not None and value is not True:
287
opts.append(str(value))
288
else:
289
# it's an arg, or arg list
290
if type(value) is not list:
291
value = [value]
292
for v in value:
293
if v is not None:
294
args.append(str(v))
295
296
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
297
return self.status
298
299
300
class cmd_status(Command):
76
from bzrlib.store import ImmutableStore
77
from bzrlib.trace import mutter, note, log_error
78
from bzrlib.errors import bailout, BzrError
79
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
80
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
81
from bzrlib.revision import Revision
82
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
format_date
84
85
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
86
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
87
88
## standard representation
89
NONE_STRING = '(none)'
90
EMPTY = 'empty'
91
92
93
## TODO: Perhaps a different version of inventory commands that
94
## returns iterators...
95
96
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
97
98
## TODO: Some kind of locking on branches. Perhaps there should be a
99
## parameter to the branch object saying whether we want a read or
100
## write lock; release it from destructor. Perhaps don't even need a
101
## read lock to look at immutable objects?
102
103
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
104
## to compare output?
105
106
## TODO: Some kind of global code to generate the right Branch object
107
## to work on. Almost, but not quite all, commands need one, and it
108
## can be taken either from their parameters or their working
109
## directory.
110
111
## TODO: rename command, needed soon: check destination doesn't exist
112
## either in working copy or tree; move working copy; update
113
## inventory; write out
114
115
## TODO: move command; check destination is a directory and will not
116
## clash; move it.
117
118
## TODO: command to show renames, one per line, as to->from
119
120
121
122
123
def cmd_status(all=False):
301
124
"""Display status summary.
302
125
303
This reports on versioned and unknown files, reporting them
304
grouped by state. Possible states are:
305
306
added
307
Versioned in the working copy but not in the previous revision.
308
309
removed
310
Versioned in the previous revision but removed or deleted
311
in the working copy.
312
313
renamed
314
Path of this file changed from the previous revision;
315
the text may also have changed. This includes files whose
316
parent directory was renamed.
317
318
modified
319
Text has changed since the previous revision.
320
321
unchanged
322
Nothing about this file has changed since the previous revision.
323
Only shown with --all.
324
325
unknown
326
Not versioned and not matching an ignore pattern.
327
328
To see ignored files use 'bzr ignored'. For details in the
329
changes to file texts, use 'bzr diff'.
330
331
If no arguments are specified, the status of the entire working
332
directory is shown. Otherwise, only the status of the specified
333
files or directories is reported. If a directory is given, status
334
is reported for everything inside that directory.
335
336
If a revision is specified, the changes since that revision are shown.
337
"""
338
takes_args = ['file*']
339
takes_options = ['all', 'show-ids', 'revision']
340
aliases = ['st', 'stat']
341
342
def run(self, all=False, show_ids=False, file_list=None):
343
if file_list:
344
b = find_branch(file_list[0])
345
file_list = [b.relpath(x) for x in file_list]
346
# special case: only one path was given and it's the root
347
# of the branch
348
if file_list == ['']:
349
file_list = None
350
else:
351
b = find_branch('.')
352
353
from bzrlib.status import show_status
354
show_status(b, show_unchanged=all, show_ids=show_ids,
355
specific_files=file_list)
356
357
358
class cmd_cat_revision(Command):
359
"""Write out metadata for a revision."""
360
361
hidden = True
362
takes_args = ['revision_id']
363
364
def run(self, revision_id):
365
from bzrlib.xml import pack_xml
366
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
367
368
369
class cmd_revno(Command):
370
"""Show current revision number.
371
372
This is equal to the number of revisions on this branch."""
373
def run(self):
374
print find_branch('.').revno()
375
376
class cmd_revision_info(Command):
377
"""Show revision number and revision id for a given revision identifier.
378
"""
379
hidden = True
380
takes_args = ['revision_info*']
381
takes_options = ['revision']
382
def run(self, revision=None, revision_info_list=None):
383
from bzrlib.branch import find_branch
384
385
revs = []
386
if revision is not None:
387
revs.extend(revision)
388
if revision_info_list is not None:
389
revs.extend(revision_info_list)
390
if len(revs) == 0:
391
raise BzrCommandError('You must supply a revision identifier')
392
393
b = find_branch('.')
394
395
for rev in revs:
396
print '%4d %s' % b.get_revision_info(rev)
397
398
399
class cmd_add(Command):
126
For each file there is a single line giving its file state and name.
127
The name is that in the current revision unless it is deleted or
128
missing, in which case the old name is shown.
129
130
:todo: Don't show unchanged files unless ``--all`` is given?
131
"""
132
Branch('.').show_status(show_all=all)
133
134
135
136
######################################################################
137
# examining history
138
def cmd_get_revision(revision_id):
139
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
141
142
def cmd_get_file_text(text_id):
143
"""Get contents of a file by hash."""
144
sf = Branch('.').text_store[text_id]
145
pumpfile(sf, sys.stdout)
146
147
148
149
######################################################################
150
# commands
151
152
153
def cmd_revno():
154
"""Show number of revisions on this branch"""
155
print Branch('.').revno()
156
157
158
159
def cmd_add(file_list, verbose=False):
400
160
"""Add specified files or directories.
401
161
402
162
In non-recursive mode, all the named items are added, regardless
413
173
414
174
Therefore simply saying 'bzr add .' will version all files that
415
175
are currently unknown.
416
417
TODO: Perhaps adding a file whose directly is not versioned should
418
recursively add that parent, rather than giving an error?
419
"""
420
takes_args = ['file+']
421
takes_options = ['verbose', 'no-recurse']
422
423
def run(self, file_list, verbose=False, no_recurse=False):
424
from bzrlib.add import smart_add
425
smart_add(file_list, verbose, not no_recurse)
426
427
428
429
class cmd_mkdir(Command):
430
"""Create a new versioned directory.
431
432
This is equivalent to creating the directory and then adding it.
433
"""
434
takes_args = ['dir+']
435
436
def run(self, dir_list):
437
b = None
438
439
for d in dir_list:
440
os.mkdir(d)
441
if not b:
442
b = find_branch(d)
443
b.add([d], verbose=True)
444
445
446
class cmd_relpath(Command):
447
"""Show path of a file relative to root"""
448
takes_args = ['filename']
449
hidden = True
450
451
def run(self, filename):
452
print find_branch(filename).relpath(filename)
453
454
455
456
class cmd_inventory(Command):
457
"""Show inventory of the current working copy or a revision."""
458
takes_options = ['revision', 'show-ids']
459
460
def run(self, revision=None, show_ids=False):
461
b = find_branch('.')
462
if revision == None:
463
inv = b.read_working_inventory()
464
else:
465
if len(revision) > 1:
466
raise BzrCommandError('bzr inventory --revision takes'
467
' exactly one revision identifier')
468
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
469
470
for path, entry in inv.entries():
471
if show_ids:
472
print '%-50s %s' % (path, entry.file_id)
473
else:
474
print path
475
476
477
class cmd_move(Command):
478
"""Move files to a different directory.
479
480
examples:
481
bzr move *.txt doc
482
483
The destination must be a versioned directory in the same branch.
484
"""
485
takes_args = ['source$', 'dest']
486
def run(self, source_list, dest):
487
b = find_branch('.')
488
489
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
490
491
492
class cmd_rename(Command):
493
"""Change the name of an entry.
494
495
examples:
496
bzr rename frob.c frobber.c
497
bzr rename src/frob.c lib/frob.c
498
499
It is an error if the destination name exists.
500
501
See also the 'move' command, which moves files into a different
502
directory without changing their name.
503
504
TODO: Some way to rename multiple files without invoking bzr for each
505
one?"""
506
takes_args = ['from_name', 'to_name']
507
508
def run(self, from_name, to_name):
509
b = find_branch('.')
510
b.rename_one(b.relpath(from_name), b.relpath(to_name))
511
512
513
514
515
516
class cmd_pull(Command):
517
"""Pull any changes from another branch into the current one.
518
519
If the location is omitted, the last-used location will be used.
520
Both the revision history and the working directory will be
521
updated.
522
523
This command only works on branches that have not diverged. Branches are
524
considered diverged if both branches have had commits without first
525
pulling from the other.
526
527
If branches have diverged, you can use 'bzr merge' to pull the text changes
528
from one into the other.
529
"""
530
takes_args = ['location?']
531
532
def run(self, location=None):
533
from bzrlib.merge import merge
534
import tempfile
535
from shutil import rmtree
536
import errno
537
538
br_to = find_branch('.')
539
stored_loc = None
540
try:
541
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
542
except IOError, e:
543
if e.errno != errno.ENOENT:
544
raise
545
if location is None:
546
if stored_loc is None:
547
raise BzrCommandError("No pull location known or specified.")
548
else:
549
print "Using last location: %s" % stored_loc
550
location = stored_loc
551
cache_root = tempfile.mkdtemp()
552
from bzrlib.branch import DivergedBranches
553
br_from = find_branch(location)
554
location = pull_loc(br_from)
555
old_revno = br_to.revno()
556
try:
557
from branch import find_cached_branch, DivergedBranches
558
br_from = find_cached_branch(location, cache_root)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
561
try:
562
br_to.update_revisions(br_from)
563
except DivergedBranches:
564
raise BzrCommandError("These branches have diverged."
565
" Try merge.")
566
567
merge(('.', -1), ('.', old_revno), check_clean=False)
568
if location != stored_loc:
569
br_to.controlfile("x-pull", "wb").write(location + "\n")
570
finally:
571
rmtree(cache_root)
572
573
574
575
class cmd_branch(Command):
576
"""Create a new copy of a branch.
577
578
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
579
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
580
581
To retrieve the branch as of a particular revision, supply the --revision
582
parameter, as in "branch foo/bar -r 5".
583
"""
584
takes_args = ['from_location', 'to_location?']
585
takes_options = ['revision']
586
587
def run(self, from_location, to_location=None, revision=None):
588
import errno
589
from bzrlib.merge import merge
590
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
591
find_cached_branch, Branch
592
from shutil import rmtree
593
from meta_store import CachedStore
594
import tempfile
595
cache_root = tempfile.mkdtemp()
596
597
if revision is None:
598
revision = [None]
599
elif len(revision) > 1:
600
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
601
602
try:
603
try:
604
br_from = find_cached_branch(from_location, cache_root)
605
except OSError, e:
606
if e.errno == errno.ENOENT:
607
raise BzrCommandError('Source location "%s" does not'
608
' exist.' % to_location)
609
else:
610
raise
611
612
if to_location is None:
613
to_location = os.path.basename(from_location.rstrip("/\\"))
614
615
try:
616
os.mkdir(to_location)
617
except OSError, e:
618
if e.errno == errno.EEXIST:
619
raise BzrCommandError('Target directory "%s" already'
620
' exists.' % to_location)
621
if e.errno == errno.ENOENT:
622
raise BzrCommandError('Parent of "%s" does not exist.' %
623
to_location)
624
else:
625
raise
626
br_to = Branch(to_location, init=True)
627
628
br_to.set_root_id(br_from.get_root_id())
629
630
if revision:
631
if revision[0] is None:
632
revno = br_from.revno()
633
else:
634
revno, rev_id = br_from.get_revision_info(revision[0])
635
try:
636
br_to.update_revisions(br_from, stop_revision=revno)
637
except NoSuchRevision:
638
rmtree(to_location)
639
msg = "The branch %s has no revision %d." % (from_location,
640
revno)
641
raise BzrCommandError(msg)
642
643
merge((to_location, -1), (to_location, 0), this_dir=to_location,
644
check_clean=False, ignore_zero=True)
645
from_location = pull_loc(br_from)
646
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
647
finally:
648
rmtree(cache_root)
649
650
651
def pull_loc(branch):
652
# TODO: Should perhaps just make attribute be 'base' in
653
# RemoteBranch and Branch?
654
if hasattr(branch, "baseurl"):
655
return branch.baseurl
656
else:
657
return branch.base
658
659
660
661
class cmd_renames(Command):
662
"""Show list of renamed files.
663
664
TODO: Option to show renames between two historical versions.
665
666
TODO: Only show renames under dir, rather than in the whole branch.
667
"""
668
takes_args = ['dir?']
669
670
def run(self, dir='.'):
671
b = find_branch(dir)
672
old_inv = b.basis_tree().inventory
673
new_inv = b.read_working_inventory()
674
675
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
676
renames.sort()
677
for old_name, new_name in renames:
678
print "%s => %s" % (old_name, new_name)
679
680
681
class cmd_info(Command):
682
"""Show statistical information about a branch."""
683
takes_args = ['branch?']
684
685
def run(self, branch=None):
686
import info
687
688
b = find_branch(branch)
689
info.show_info(b)
690
691
692
class cmd_remove(Command):
693
"""Make a file unversioned.
694
695
This makes bzr stop tracking changes to a versioned file. It does
696
not delete the working copy.
697
"""
698
takes_args = ['file+']
699
takes_options = ['verbose']
700
701
def run(self, file_list, verbose=False):
702
b = find_branch(file_list[0])
703
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
704
705
706
class cmd_file_id(Command):
707
"""Print file_id of a particular file or directory.
708
709
The file_id is assigned when the file is first added and remains the
710
same through all revisions where the file exists, even when it is
711
moved or renamed.
712
"""
713
hidden = True
714
takes_args = ['filename']
715
def run(self, filename):
716
b = find_branch(filename)
717
i = b.inventory.path2id(b.relpath(filename))
718
if i == None:
719
raise BzrError("%r is not a versioned file" % filename)
720
else:
721
print i
722
723
724
class cmd_file_path(Command):
725
"""Print path of file_ids to a file or directory.
726
727
This prints one line for each directory down to the target,
728
starting at the branch root."""
729
hidden = True
730
takes_args = ['filename']
731
def run(self, filename):
732
b = find_branch(filename)
733
inv = b.inventory
734
fid = inv.path2id(b.relpath(filename))
735
if fid == None:
736
raise BzrError("%r is not a versioned file" % filename)
737
for fip in inv.get_idpath(fid):
738
print fip
739
740
741
class cmd_revision_history(Command):
742
"""Display list of revision ids on this branch."""
743
hidden = True
744
def run(self):
745
for patchid in find_branch('.').revision_history():
746
print patchid
747
748
749
class cmd_directories(Command):
750
"""Display list of versioned directories in this branch."""
751
def run(self):
752
for name, ie in find_branch('.').read_working_inventory().directories():
753
if name == '':
754
print '.'
755
else:
756
print name
757
758
759
class cmd_init(Command):
760
"""Make a directory into a versioned branch.
761
762
Use this to create an empty branch, or before importing an
763
existing project.
764
765
Recipe for importing a tree of files:
766
cd ~/project
767
bzr init
768
bzr add -v .
769
bzr status
770
bzr commit -m 'imported project'
771
"""
772
def run(self):
773
from bzrlib.branch import Branch
774
Branch('.', init=True)
775
776
777
class cmd_diff(Command):
778
"""Show differences in working tree.
779
780
If files are listed, only the changes in those files are listed.
781
Otherwise, all changes for the tree are listed.
782
783
TODO: Given two revision arguments, show the difference between them.
784
785
TODO: Allow diff across branches.
786
787
TODO: Option to use external diff command; could be GNU diff, wdiff,
788
or a graphical diff.
789
790
TODO: Python difflib is not exactly the same as unidiff; should
791
either fix it up or prefer to use an external diff.
792
793
TODO: If a directory is given, diff everything under that.
794
795
TODO: Selected-file diff is inefficient and doesn't show you
796
deleted files.
797
798
TODO: This probably handles non-Unix newlines poorly.
799
"""
800
801
takes_args = ['file*']
802
takes_options = ['revision', 'diff-options']
803
aliases = ['di', 'dif']
804
805
def run(self, revision=None, file_list=None, diff_options=None):
806
from bzrlib.diff import show_diff
807
808
if file_list:
809
b = find_branch(file_list[0])
810
file_list = [b.relpath(f) for f in file_list]
811
if file_list == ['']:
812
# just pointing to top-of-tree
813
file_list = None
814
else:
815
b = find_branch('.')
816
817
# TODO: Make show_diff support taking 2 arguments
818
base_rev = None
819
if revision is not None:
820
if len(revision) != 1:
821
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
822
base_rev = revision[0]
823
824
show_diff(b, base_rev, specific_files=file_list,
825
external_diff_options=diff_options)
826
827
828
829
830
831
class cmd_deleted(Command):
832
"""List files deleted in the working tree.
833
834
TODO: Show files deleted since a previous revision, or between two revisions.
835
"""
836
def run(self, show_ids=False):
837
b = find_branch('.')
838
old = b.basis_tree()
839
new = b.working_tree()
840
841
## TODO: Much more efficient way to do this: read in new
842
## directories with readdir, rather than stating each one. Same
843
## level of effort but possibly much less IO. (Or possibly not,
844
## if the directories are very large...)
845
846
for path, ie in old.inventory.iter_entries():
847
if not new.has_id(ie.file_id):
848
if show_ids:
849
print '%-50s %s' % (path, ie.file_id)
850
else:
851
print path
852
853
854
class cmd_modified(Command):
855
"""List files modified in working tree."""
856
hidden = True
857
def run(self):
858
from bzrlib.diff import compare_trees
859
860
b = find_branch('.')
861
td = compare_trees(b.basis_tree(), b.working_tree())
862
863
for path, id, kind in td.modified:
864
print path
865
866
867
868
class cmd_added(Command):
869
"""List files added in working tree."""
870
hidden = True
871
def run(self):
872
b = find_branch('.')
873
wt = b.working_tree()
874
basis_inv = b.basis_tree().inventory
875
inv = wt.inventory
876
for file_id in inv:
877
if file_id in basis_inv:
878
continue
879
path = inv.id2path(file_id)
880
if not os.access(b.abspath(path), os.F_OK):
881
continue
882
print path
883
884
885
886
class cmd_root(Command):
887
"""Show the tree root directory.
888
889
The root is the nearest enclosing directory with a .bzr control
890
directory."""
891
takes_args = ['filename?']
892
def run(self, filename=None):
893
"""Print the branch root."""
894
b = find_branch(filename)
895
print getattr(b, 'base', None) or getattr(b, 'baseurl')
896
897
898
class cmd_log(Command):
176
"""
177
if True:
178
bzrlib.add.smart_add(file_list, verbose)
179
else:
180
# old way
181
assert file_list
182
b = Branch(file_list[0], find_root=True)
183
b.add([b.relpath(f) for f in file_list], verbose=verbose)
184
185
186
187
def cmd_relpath(filename):
188
print Branch(filename).relpath(filename)
189
190
191
def cmd_inventory(revision=None):
192
"""Show inventory of the current working copy."""
193
## TODO: Also optionally show a previous inventory
194
## TODO: Format options
195
b = Branch('.')
196
if revision == None:
197
inv = b.read_working_inventory()
198
else:
199
inv = b.get_revision_inventory(b.lookup_revision(revision))
200
201
for path, entry in inv.iter_entries():
202
print '%-50s %s' % (entry.file_id, path)
203
204
205
206
def cmd_info():
207
import info
208
info.show_info(Branch('.'))
209
210
211
212
def cmd_remove(file_list, verbose=False):
213
b = Branch(file_list[0])
214
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
215
216
217
218
def cmd_file_id(filename):
219
b = Branch(filename)
220
i = b.inventory.path2id(b.relpath(filename))
221
if i is None:
222
bailout("%s is not a versioned file" % filename)
223
else:
224
print i
225
226
227
def cmd_find_filename(fileid):
228
n = find_filename(fileid)
229
if n is None:
230
bailout("%s is not a live file id" % fileid)
231
else:
232
print n
233
234
235
def cmd_revision_history():
236
for patchid in Branch('.').revision_history():
237
print patchid
238
239
240
241
def cmd_init():
242
# TODO: Check we're not already in a working directory? At the
243
# moment you'll get an ugly error.
244
245
# TODO: What if we're in a subdirectory of a branch? Would like
246
# to allow that, but then the parent may need to understand that
247
# the children have disappeared, or should they be versioned in
248
# both?
249
250
# TODO: Take an argument/option for branch name.
251
Branch('.', init=True)
252
253
254
def cmd_diff(revision=None):
255
"""Show diff from basis to working copy.
256
257
:todo: Take one or two revision arguments, look up those trees,
258
and diff them.
259
260
:todo: Allow diff across branches.
261
262
:todo: Mangle filenames in diff to be more relevant.
263
264
:todo: Shouldn't be in the cmd function.
265
266
TODO: Option to use external diff command; could be GNU diff,
267
wdiff, or a graphical diff.
268
"""
269
270
b = Branch('.')
271
272
if revision == None:
273
old_tree = b.basis_tree()
274
else:
275
old_tree = b.revision_tree(b.lookup_revision(revision))
276
277
new_tree = b.working_tree()
278
old_inv = old_tree.inventory
279
new_inv = new_tree.inventory
280
281
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
282
old_label = ''
283
new_label = ''
284
285
DEVNULL = '/dev/null'
286
# Windows users, don't panic about this filename -- it is a
287
# special signal to GNU patch that the file should be created or
288
# deleted respectively.
289
290
# TODO: Generation of pseudo-diffs for added/deleted files could
291
# be usefully made into a much faster special case.
292
293
# TODO: Better to return them in sorted order I think.
294
295
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
296
d = None
297
298
# Don't show this by default; maybe do it if an option is passed
299
# idlabel = ' {%s}' % fid
300
idlabel = ''
301
302
# FIXME: Something about the diff format makes patch unhappy
303
# with newly-added files.
304
305
def diffit(*a, **kw):
306
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
307
print
308
309
if file_state in ['.', '?', 'I']:
310
continue
311
elif file_state == 'A':
312
print '*** added %s %r' % (kind, new_name)
313
if kind == 'file':
314
diffit([],
315
new_tree.get_file(fid).readlines(),
316
fromfile=DEVNULL,
317
tofile=new_label + new_name + idlabel)
318
elif file_state == 'D':
319
assert isinstance(old_name, types.StringTypes)
320
print '*** deleted %s %r' % (kind, old_name)
321
if kind == 'file':
322
diffit(old_tree.get_file(fid).readlines(), [],
323
fromfile=old_label + old_name + idlabel,
324
tofile=DEVNULL)
325
elif file_state in ['M', 'R']:
326
if file_state == 'M':
327
assert kind == 'file'
328
assert old_name == new_name
329
print '*** modified %s %r' % (kind, new_name)
330
elif file_state == 'R':
331
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
332
333
if kind == 'file':
334
diffit(old_tree.get_file(fid).readlines(),
335
new_tree.get_file(fid).readlines(),
336
fromfile=old_label + old_name + idlabel,
337
tofile=new_label + new_name)
338
else:
339
bailout("can't represent state %s {%s}" % (file_state, fid))
340
341
342
343
def cmd_root(filename=None):
344
"""Print the branch root."""
345
print bzrlib.branch.find_branch_root(filename)
346
347
348
def cmd_log(timezone='original'):
899
349
"""Show log of this branch.
900
350
901
To request a range of logs, you can use the command -r begin:end
902
-r revision requests a specific revision, -r :end or -r begin: are
903
also valid.
904
905
--message allows you to give a regular expression, which will be evaluated
906
so that only matching entries will be displayed.
907
908
TODO: Make --revision support uuid: and hash: [future tag:] notation.
909
351
:todo: Options for utc; to show ids; to limit range; etc.
910
352
"""
911
912
takes_args = ['filename?']
913
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
914
915
def run(self, filename=None, timezone='original',
916
verbose=False,
917
show_ids=False,
918
forward=False,
919
revision=None,
920
message=None,
921
long=False):
922
from bzrlib.branch import find_branch
923
from bzrlib.log import log_formatter, show_log
924
import codecs
925
926
direction = (forward and 'forward') or 'reverse'
927
928
if filename:
929
b = find_branch(filename)
930
fp = b.relpath(filename)
931
if fp:
932
file_id = b.read_working_inventory().path2id(fp)
933
else:
934
file_id = None # points to branch root
935
else:
936
b = find_branch('.')
937
file_id = None
938
939
if revision is None:
940
rev1 = None
941
rev2 = None
942
elif len(revision) == 1:
943
rev1 = rev2 = b.get_revision_info(revision[0])[0]
944
elif len(revision) == 2:
945
rev1 = b.get_revision_info(revision[0])[0]
946
rev2 = b.get_revision_info(revision[1])[0]
947
else:
948
raise BzrCommandError('bzr log --revision takes one or two values.')
949
950
if rev1 == 0:
951
rev1 = None
952
if rev2 == 0:
953
rev2 = None
954
955
mutter('encoding log as %r' % bzrlib.user_encoding)
956
957
# use 'replace' so that we don't abort if trying to write out
958
# in e.g. the default C locale.
959
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
960
961
if long:
962
log_format = 'long'
963
else:
964
log_format = 'short'
965
lf = log_formatter(log_format,
966
show_ids=show_ids,
967
to_file=outf,
968
show_timezone=timezone)
969
970
show_log(b,
971
lf,
972
file_id,
973
verbose=verbose,
974
direction=direction,
975
start_revision=rev1,
976
end_revision=rev2,
977
search=message)
978
979
980
981
class cmd_touching_revisions(Command):
982
"""Return revision-ids which affected a particular file.
983
984
A more user-friendly interface is "bzr log FILE"."""
985
hidden = True
986
takes_args = ["filename"]
987
def run(self, filename):
988
b = find_branch(filename)
989
inv = b.read_working_inventory()
990
file_id = inv.path2id(b.relpath(filename))
991
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
992
print "%6d %s" % (revno, what)
993
994
995
class cmd_ls(Command):
353
Branch('.').write_log(show_timezone=timezone)
354
355
356
def cmd_ls(revision=None, verbose=False):
996
357
"""List files in a tree.
997
358
998
TODO: Take a revision or remote path and list that tree instead.
999
"""
1000
hidden = True
1001
def run(self, revision=None, verbose=False):
1002
b = find_branch('.')
1003
if revision == None:
1004
tree = b.working_tree()
1005
else:
1006
tree = b.revision_tree(b.lookup_revision(revision))
1007
1008
for fp, fc, kind, fid in tree.list_files():
1009
if verbose:
1010
if kind == 'directory':
1011
kindch = '/'
1012
elif kind == 'file':
1013
kindch = ''
1014
else:
1015
kindch = '???'
1016
1017
print '%-8s %s%s' % (fc, fp, kindch)
1018
else:
1019
print fp
1020
1021
1022
1023
class cmd_unknowns(Command):
1024
"""List unknown files."""
1025
def run(self):
1026
from bzrlib.osutils import quotefn
1027
for f in find_branch('.').unknowns():
1028
print quotefn(f)
1029
1030
1031
1032
class cmd_ignore(Command):
1033
"""Ignore a command or pattern.
1034
1035
To remove patterns from the ignore list, edit the .bzrignore file.
1036
1037
If the pattern contains a slash, it is compared to the whole path
1038
from the branch root. Otherwise, it is comapred to only the last
1039
component of the path.
1040
1041
Ignore patterns are case-insensitive on case-insensitive systems.
1042
1043
Note: wildcards must be quoted from the shell on Unix.
1044
1045
examples:
1046
bzr ignore ./Makefile
1047
bzr ignore '*.class'
1048
"""
1049
takes_args = ['name_pattern']
1050
1051
def run(self, name_pattern):
1052
from bzrlib.atomicfile import AtomicFile
1053
import os.path
1054
1055
b = find_branch('.')
1056
ifn = b.abspath('.bzrignore')
1057
1058
if os.path.exists(ifn):
1059
f = open(ifn, 'rt')
1060
try:
1061
igns = f.read().decode('utf-8')
1062
finally:
1063
f.close()
1064
else:
1065
igns = ''
1066
1067
# TODO: If the file already uses crlf-style termination, maybe
1068
# we should use that for the newly added lines?
1069
1070
if igns and igns[-1] != '\n':
1071
igns += '\n'
1072
igns += name_pattern + '\n'
1073
1074
try:
1075
f = AtomicFile(ifn, 'wt')
1076
f.write(igns.encode('utf-8'))
1077
f.commit()
1078
finally:
1079
f.close()
1080
1081
inv = b.working_tree().inventory
1082
if inv.path2id('.bzrignore'):
1083
mutter('.bzrignore is already versioned')
1084
else:
1085
mutter('need to make new .bzrignore file versioned')
1086
b.add(['.bzrignore'])
1087
1088
1089
1090
class cmd_ignored(Command):
1091
"""List ignored files and the patterns that matched them.
1092
1093
See also: bzr ignore"""
1094
def run(self):
1095
tree = find_branch('.').working_tree()
1096
for path, file_class, kind, file_id in tree.list_files():
1097
if file_class != 'I':
1098
continue
1099
## XXX: Slightly inefficient since this was already calculated
1100
pat = tree.is_ignored(path)
1101
print '%-50s %s' % (path, pat)
1102
1103
1104
class cmd_lookup_revision(Command):
1105
"""Lookup the revision-id from a revision-number
1106
1107
example:
1108
bzr lookup-revision 33
1109
"""
1110
hidden = True
1111
takes_args = ['revno']
1112
1113
def run(self, revno):
1114
try:
1115
revno = int(revno)
1116
except ValueError:
1117
raise BzrCommandError("not a valid revision-number: %r" % revno)
1118
1119
print find_branch('.').lookup_revision(revno)
1120
1121
1122
class cmd_export(Command):
1123
"""Export past revision to destination directory.
1124
1125
If no revision is specified this exports the last committed revision.
1126
1127
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1128
given, try to find the format with the extension. If no extension
1129
is found exports to a directory (equivalent to --format=dir).
1130
1131
Root may be the top directory for tar, tgz and tbz2 formats. If none
1132
is given, the top directory will be the root name of the file."""
1133
# TODO: list known exporters
1134
takes_args = ['dest']
1135
takes_options = ['revision', 'format', 'root']
1136
def run(self, dest, revision=None, format=None, root=None):
1137
import os.path
1138
b = find_branch('.')
1139
if revision is None:
1140
rev_id = b.last_patch()
1141
else:
1142
if len(revision) != 1:
1143
raise BzrError('bzr export --revision takes exactly 1 argument')
1144
revno, rev_id = b.get_revision_info(revision[0])
1145
t = b.revision_tree(rev_id)
1146
root, ext = os.path.splitext(dest)
1147
if not format:
1148
if ext in (".tar",):
1149
format = "tar"
1150
elif ext in (".gz", ".tgz"):
1151
format = "tgz"
1152
elif ext in (".bz2", ".tbz2"):
1153
format = "tbz2"
1154
else:
1155
format = "dir"
1156
t.export(dest, format, root)
1157
1158
1159
class cmd_cat(Command):
1160
"""Write a file's text from a previous revision."""
1161
1162
takes_options = ['revision']
1163
takes_args = ['filename']
1164
1165
def run(self, filename, revision=None):
1166
if revision == None:
1167
raise BzrCommandError("bzr cat requires a revision number")
1168
elif len(revision) != 1:
1169
raise BzrCommandError("bzr cat --revision takes exactly one number")
1170
b = find_branch('.')
1171
b.print_file(b.relpath(filename), revision[0])
1172
1173
1174
class cmd_local_time_offset(Command):
1175
"""Show the offset in seconds from GMT to local time."""
1176
hidden = True
1177
def run(self):
1178
print bzrlib.osutils.local_time_offset()
1179
1180
1181
1182
class cmd_commit(Command):
1183
"""Commit changes into a new revision.
1184
1185
If selected files are specified, only changes to those files are
1186
committed. If a directory is specified then its contents are also
1187
committed.
1188
1189
A selected-file commit may fail in some cases where the committed
1190
tree would be invalid, such as trying to commit a file in a
1191
newly-added directory that is not itself committed.
1192
1193
TODO: Run hooks on tree to-be-committed, and after commit.
1194
1195
TODO: Strict commit that fails if there are unknown or deleted files.
1196
"""
1197
takes_args = ['selected*']
1198
takes_options = ['message', 'file', 'verbose', 'unchanged']
1199
aliases = ['ci', 'checkin']
1200
1201
def run(self, message=None, file=None, verbose=True, selected_list=None,
1202
unchanged=False):
1203
from bzrlib.errors import PointlessCommit
1204
from bzrlib.osutils import get_text_message
1205
1206
## Warning: shadows builtin file()
1207
if not message and not file:
1208
import cStringIO
1209
stdout = sys.stdout
1210
catcher = cStringIO.StringIO()
1211
sys.stdout = catcher
1212
cmd_status({"file_list":selected_list}, {})
1213
info = catcher.getvalue()
1214
sys.stdout = stdout
1215
message = get_text_message(info)
1216
1217
if message is None:
1218
raise BzrCommandError("please specify a commit message",
1219
["use either --message or --file"])
1220
elif message and file:
1221
raise BzrCommandError("please specify either --message or --file")
1222
1223
if file:
1224
import codecs
1225
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1226
1227
b = find_branch('.')
1228
1229
try:
1230
b.commit(message, verbose=verbose,
1231
specific_files=selected_list,
1232
allow_pointless=unchanged)
1233
except PointlessCommit:
1234
# FIXME: This should really happen before the file is read in;
1235
# perhaps prepare the commit; get the message; then actually commit
1236
raise BzrCommandError("no changes to commit",
1237
["use --unchanged to commit anyhow"])
1238
1239
1240
class cmd_check(Command):
1241
"""Validate consistency of branch history.
1242
1243
This command checks various invariants about the branch storage to
1244
detect data corruption or bzr bugs.
1245
1246
If given the --update flag, it will update some optional fields
1247
to help ensure data consistency.
1248
"""
1249
takes_args = ['dir?']
1250
1251
def run(self, dir='.'):
1252
from bzrlib.check import check
1253
check(find_branch(dir))
1254
1255
1256
1257
class cmd_upgrade(Command):
1258
"""Upgrade branch storage to current format.
1259
1260
This should normally be used only after the check command tells
1261
you to run it.
1262
"""
1263
takes_args = ['dir?']
1264
1265
def run(self, dir='.'):
1266
from bzrlib.upgrade import upgrade
1267
upgrade(find_branch(dir))
1268
1269
1270
1271
class cmd_whoami(Command):
1272
"""Show bzr user id."""
1273
takes_options = ['email']
1274
1275
def run(self, email=False):
1276
if email:
1277
print bzrlib.osutils.user_email()
1278
else:
1279
print bzrlib.osutils.username()
1280
1281
1282
class cmd_selftest(Command):
359
:todo: Take a revision or remote path and list that tree instead.
360
"""
361
b = Branch('.')
362
if revision == None:
363
tree = b.working_tree()
364
else:
365
tree = b.revision_tree(b.lookup_revision(revision))
366
367
for fp, fc, kind, fid in tree.list_files():
368
if verbose:
369
if kind == 'directory':
370
kindch = '/'
371
elif kind == 'file':
372
kindch = ''
373
else:
374
kindch = '???'
375
376
print '%-8s %s%s' % (fc, fp, kindch)
377
else:
378
print fp
379
380
381
382
def cmd_unknowns():
383
"""List unknown files"""
384
for f in Branch('.').unknowns():
385
print quotefn(f)
386
387
388
def cmd_lookup_revision(revno):
389
try:
390
revno = int(revno)
391
except ValueError:
392
bailout("usage: lookup-revision REVNO",
393
["REVNO is a non-negative revision number for this branch"])
394
395
print Branch('.').lookup_revision(revno) or NONE_STRING
396
397
398
399
def cmd_export(revno, dest):
400
"""Export past revision to destination directory."""
401
b = Branch('.')
402
rh = b.lookup_revision(int(revno))
403
t = b.revision_tree(rh)
404
t.export(dest)
405
406
407
408
######################################################################
409
# internal/test commands
410
411
412
def cmd_uuid():
413
"""Print a newly-generated UUID."""
414
print bzrlib.osutils.uuid()
415
416
417
418
def cmd_local_time_offset():
419
print bzrlib.osutils.local_time_offset()
420
421
422
423
def cmd_commit(message=None, verbose=False):
424
if not message:
425
bailout("please specify a commit message")
426
Branch('.').commit(message, verbose=verbose)
427
428
429
def cmd_check():
430
"""Check consistency of the branch."""
431
check()
432
433
434
def cmd_is(pred, *rest):
435
"""Test whether PREDICATE is true."""
436
try:
437
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
438
except KeyError:
439
bailout("unknown predicate: %s" % quotefn(pred))
440
441
try:
442
cmd_handler(*rest)
443
except BzrCheckError:
444
# by default we don't print the message so that this can
445
# be used from shell scripts without producing noise
446
sys.exit(1)
447
448
449
def cmd_username():
450
print bzrlib.osutils.username()
451
452
453
def cmd_user_email():
454
print bzrlib.osutils.user_email()
455
456
457
def cmd_gen_revision_id():
458
import time
459
print bzrlib.branch._gen_revision_id(time.time())
460
461
462
def cmd_selftest(verbose=False):
1283
463
"""Run internal test suite"""
1284
hidden = True
1285
def run(self):
1286
from bzrlib.selftest import selftest
1287
return int(not selftest())
1288
1289
1290
class cmd_version(Command):
1291
"""Show version of bzr."""
1292
def run(self):
1293
show_version()
1294
1295
def show_version():
464
## -v, if present, is seen by doctest; the argument is just here
465
## so our parser doesn't complain
466
467
## TODO: --verbose option
468
469
failures, tests = 0, 0
470
471
import doctest, bzrlib.store, bzrlib.tests
472
bzrlib.trace.verbose = False
473
474
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
475
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
476
mf, mt = doctest.testmod(m)
477
failures += mf
478
tests += mt
479
print '%-40s %3d tests' % (m.__name__, mt),
480
if mf:
481
print '%3d FAILED!' % mf
482
else:
483
print
484
485
print '%-40s %3d tests' % ('total', tests),
486
if failures:
487
print '%3d FAILED!' % failures
488
else:
489
print
490
491
492
493
# deprecated
494
cmd_doctest = cmd_selftest
495
496
497
######################################################################
498
# help
499
500
501
def cmd_help(topic=None):
502
if topic == None:
503
print __doc__
504
return
505
506
# otherwise, maybe the name of a command?
507
try:
508
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
509
except KeyError:
510
bailout("no help for %r" % topic)
511
512
doc = cmdfn.__doc__
513
if doc == None:
514
bailout("sorry, no detailed help yet for %r" % topic)
515
516
print doc
517
518
519
520
521
def cmd_version():
1296
522
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1297
# is bzrlib itself in a branch?
1298
bzrrev = bzrlib.get_bzr_revision()
1299
if bzrrev:
1300
print " (bzr checkout, revision %d {%s})" % bzrrev
1301
523
print bzrlib.__copyright__
1302
524
print "http://bazaar-ng.org/"
1303
525
print
1304
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1305
print "you may use, modify and redistribute it under the terms of the GNU"
1306
print "General Public License version 2 or later."
1307
1308
1309
class cmd_rocks(Command):
526
print \
527
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
528
you may use, modify and redistribute it under the terms of the GNU
529
General Public License version 2 or later."""
530
531
532
def cmd_rocks():
1310
533
"""Statement of optimism."""
1311
hidden = True
1312
def run(self):
1313
print "it sure does!"
1314
1315
def parse_spec(spec):
1316
"""
1317
>>> parse_spec(None)
1318
[None, None]
1319
>>> parse_spec("./")
1320
['./', None]
1321
>>> parse_spec("../@")
1322
['..', -1]
1323
>>> parse_spec("../f/@35")
1324
['../f', 35]
1325
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1326
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1327
"""
1328
if spec is None:
1329
return [None, None]
1330
if '/@' in spec:
1331
parsed = spec.split('/@')
1332
assert len(parsed) == 2
1333
if parsed[1] == "":
1334
parsed[1] = -1
1335
else:
1336
try:
1337
parsed[1] = int(parsed[1])
1338
except ValueError:
1339
pass # We can allow stuff like ./@revid:blahblahblah
1340
else:
1341
assert parsed[1] >=0
1342
else:
1343
parsed = [spec, None]
1344
return parsed
1345
1346
1347
1348
class cmd_merge(Command):
1349
"""Perform a three-way merge of trees.
1350
1351
The SPEC parameters are working tree or revision specifiers. Working trees
1352
are specified using standard paths or urls. No component of a directory
1353
path may begin with '@'.
1354
1355
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1356
1357
Revisions are specified using a dirname/@revno pair, where dirname is the
1358
branch directory and revno is the revision within that branch. If no revno
1359
is specified, the latest revision is used.
1360
1361
Revision examples: './@127', 'foo/@', '../@1'
1362
1363
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1364
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1365
as the BASE.
1366
1367
merge refuses to run if there are any uncommitted changes, unless
1368
--force is given.
1369
"""
1370
takes_args = ['other_spec', 'base_spec?']
1371
takes_options = ['force']
1372
1373
def run(self, other_spec, base_spec=None, force=False):
1374
from bzrlib.merge import merge
1375
merge(parse_spec(other_spec), parse_spec(base_spec),
1376
check_clean=(not force))
1377
1378
1379
1380
class cmd_revert(Command):
1381
"""Restore selected files from a previous revision.
1382
"""
1383
takes_args = ['file+']
1384
def run(self, file_list):
1385
from bzrlib.branch import find_branch
1386
1387
if not file_list:
1388
file_list = ['.']
1389
1390
b = find_branch(file_list[0])
1391
1392
b.revert([b.relpath(f) for f in file_list])
1393
1394
1395
class cmd_merge_revert(Command):
1396
"""Reverse all changes since the last commit.
1397
1398
Only versioned files are affected.
1399
1400
TODO: Store backups of any files that will be reverted, so
1401
that the revert can be undone.
1402
"""
1403
takes_options = ['revision']
1404
1405
def run(self, revision=None):
1406
from bzrlib.merge import merge
1407
if revision is None:
1408
revision = [-1]
1409
elif len(revision) != 1:
1410
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1411
merge(('.', revision[0]), parse_spec('.'),
1412
check_clean=False,
1413
ignore_zero=True)
1414
1415
1416
class cmd_assert_fail(Command):
1417
"""Test reporting of assertion failures"""
1418
hidden = True
1419
def run(self):
1420
assert False, "always fails"
1421
1422
1423
class cmd_help(Command):
1424
"""Show help on a command or other topic.
1425
1426
For a list of all available commands, say 'bzr help commands'."""
1427
takes_args = ['topic?']
1428
aliases = ['?']
1429
1430
def run(self, topic=None):
1431
import help
1432
help.help(topic)
1433
1434
1435
1436
1437
class cmd_plugins(Command):
1438
"""List plugins"""
1439
hidden = True
1440
def run(self):
1441
import bzrlib.plugin
1442
from inspect import getdoc
1443
from pprint import pprint
1444
for plugin in bzrlib.plugin.all_plugins:
1445
print plugin.__path__[0]
1446
d = getdoc(plugin)
1447
if d:
1448
print '\t', d.split('\n')[0]
1449
1450
#pprint(bzrlib.plugin.all_plugins)
1451
534
print "it sure does!"
535
536
537
538
######################################################################
539
# main routine
1452
540
1453
541
1454
542
# list of all available options; the rhs can be either None for an
1456
544
# the type.
1457
545
OPTIONS = {
1458
546
'all': None,
1459
'diff-options': str,
1460
547
'help': None,
1461
'file': unicode,
1462
'force': None,
1463
'format': unicode,
1464
'forward': None,
1465
548
'message': unicode,
1466
'no-recurse': None,
1467
'profile': None,
1468
'revision': _parse_revision_str,
549
'revision': int,
1469
550
'show-ids': None,
1470
551
'timezone': str,
1471
552
'verbose': None,
1472
553
'version': None,
1473
'email': None,
1474
'unchanged': None,
1475
'update': None,
1476
'long': None,
1477
'root': str,
1478
554
}
1479
555
1480
556
SHORT_OPTIONS = {
1481
'F': 'file',
1482
'h': 'help',
1483
557
'm': 'message',
1484
558
'r': 'revision',
1485
559
'v': 'verbose',
1486
'l': 'long',
1487
560
}
1488
561
562
# List of options that apply to particular commands; commands not
563
# listed take none.
564
cmd_options = {
565
'add': ['verbose'],
566
'commit': ['message', 'verbose'],
567
'diff': ['revision'],
568
'inventory': ['revision'],
569
'log': ['show-ids', 'timezone'],
570
'ls': ['revision', 'verbose'],
571
'remove': ['verbose'],
572
'status': ['all'],
573
}
574
575
576
cmd_args = {
577
'add': ['file+'],
578
'commit': [],
579
'diff': [],
580
'export': ['revno', 'dest'],
581
'file-id': ['filename'],
582
'get-file-text': ['text_id'],
583
'get-inventory': ['inventory_id'],
584
'get-revision': ['revision_id'],
585
'get-revision-inventory': ['revision_id'],
586
'help': ['topic?'],
587
'init': [],
588
'log': [],
589
'lookup-revision': ['revno'],
590
'relpath': ['filename'],
591
'remove': ['file+'],
592
'root': ['filename?'],
593
'status': [],
594
}
595
1489
596
1490
597
def parse_args(argv):
1491
598
"""Parse command line.
1503
610
(['status'], {'all': True})
1504
611
>>> parse_args('commit --message=biter'.split())
1505
612
(['commit'], {'message': u'biter'})
1506
>>> parse_args('log -r 500'.split())
1507
(['log'], {'revision': [500]})
1508
>>> parse_args('log -r500..600'.split())
1509
(['log'], {'revision': [500, 600]})
1510
>>> parse_args('log -vr500..600'.split())
1511
(['log'], {'verbose': True, 'revision': [500, 600]})
1512
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1513
(['log'], {'revision': ['v500', 600]})
1514
613
"""
1515
614
args = []
1516
615
opts = {}
1520
619
while argv:
1521
620
a = argv.pop(0)
1522
621
if a[0] == '-':
1523
# option names must not be unicode
1524
a = str(a)
1525
622
optarg = None
1526
623
if a[1] == '-':
1527
624
mutter(" got option %r" % a)
1530
627
else:
1531
628
optname = a[2:]
1532
629
if optname not in OPTIONS:
1533
raise BzrError('unknown long option %r' % a)
630
bailout('unknown long option %r' % a)
1534
631
else:
1535
632
shortopt = a[1:]
1536
if shortopt in SHORT_OPTIONS:
1537
# Multi-character options must have a space to delimit
1538
# their value
1539
optname = SHORT_OPTIONS[shortopt]
1540
else:
1541
# Single character short options, can be chained,
1542
# and have their value appended to their name
1543
shortopt = a[1:2]
1544
if shortopt not in SHORT_OPTIONS:
1545
# We didn't find the multi-character name, and we
1546
# didn't find the single char name
1547
raise BzrError('unknown short option %r' % a)
1548
optname = SHORT_OPTIONS[shortopt]
1549
1550
if a[2:]:
1551
# There are extra things on this option
1552
# see if it is the value, or if it is another
1553
# short option
1554
optargfn = OPTIONS[optname]
1555
if optargfn is None:
1556
# This option does not take an argument, so the
1557
# next entry is another short option, pack it back
1558
# into the list
1559
argv.insert(0, '-' + a[2:])
1560
else:
1561
# This option takes an argument, so pack it
1562
# into the array
1563
optarg = a[2:]
633
if shortopt not in SHORT_OPTIONS:
634
bailout('unknown short option %r' % a)
635
optname = SHORT_OPTIONS[shortopt]
1564
636
1565
637
if optname in opts:
1566
638
# XXX: Do we ever want to support this, e.g. for -r?
1567
raise BzrError('repeated option %r' % a)
639
bailout('repeated option %r' % a)
1568
640
1569
641
optargfn = OPTIONS[optname]
1570
642
if optargfn:
1571
643
if optarg == None:
1572
644
if not argv:
1573
raise BzrError('option %r needs an argument' % a)
645
bailout('option %r needs an argument' % a)
1574
646
else:
1575
647
optarg = argv.pop(0)
1576
648
opts[optname] = optargfn(optarg)
649
mutter(" option argument %r" % opts[optname])
1577
650
else:
1578
651
if optarg != None:
1579
raise BzrError('option %r takes no argument' % optname)
652
bailout('option %r takes no argument' % optname)
1580
653
opts[optname] = True
1581
654
else:
1582
655
args.append(a)
1585
658
1586
659
1587
660
661
def _match_args(cmd, args):
662
"""Check non-option arguments match required pattern.
1588
663
1589
def _match_argform(cmd, takes_args, args):
664
>>> _match_args('status', ['asdasdsadasd'])
665
Traceback (most recent call last):
666
...
667
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
668
>>> _match_args('add', ['asdasdsadasd'])
669
{'file_list': ['asdasdsadasd']}
670
>>> _match_args('add', 'abc def gj'.split())
671
{'file_list': ['abc', 'def', 'gj']}
672
"""
673
# match argument pattern
674
argform = cmd_args.get(cmd, [])
1590
675
argdict = {}
676
# TODO: Need a way to express 'cp SRC... DEST', where it matches
677
# all but one.
1591
678
1592
# step through args and takes_args, allowing appropriate 0-many matches
1593
for ap in takes_args:
679
# step through args and argform, allowing appropriate 0-many matches
680
for ap in argform:
1594
681
argname = ap[:-1]
1595
682
if ap[-1] == '?':
1596
683
if args:
1597
684
argdict[argname] = args.pop(0)
1598
elif ap[-1] == '*': # all remaining arguments
1599
if args:
1600
argdict[argname + '_list'] = args[:]
1601
args = []
1602
else:
1603
argdict[argname + '_list'] = None
685
elif ap[-1] == '*':
686
assert 0
1604
687
elif ap[-1] == '+':
1605
688
if not args:
1606
raise BzrCommandError("command %r needs one or more %s"
689
bailout("command %r needs one or more %s"
1607
690
% (cmd, argname.upper()))
1608
691
else:
1609
692
argdict[argname + '_list'] = args[:]
1610
693
args = []
1611
elif ap[-1] == '$': # all but one
1612
if len(args) < 2:
1613
raise BzrCommandError("command %r needs one or more %s"
1614
% (cmd, argname.upper()))
1615
argdict[argname + '_list'] = args[:-1]
1616
args[:-1] = []
1617
694
else:
1618
695
# just a plain arg
1619
696
argname = ap
1620
697
if not args:
1621
raise BzrCommandError("command %r requires argument %s"
698
bailout("command %r requires argument %s"
1622
699
% (cmd, argname.upper()))
1623
700
else:
1624
701
argdict[argname] = args.pop(0)
1625
702
1626
703
if args:
1627
raise BzrCommandError("extra argument to command %s: %s"
1628
% (cmd, args[0]))
704
bailout("extra arguments to command %s: %r"
705
% (cmd, args))
1629
706
1630
707
return argdict
1631
708
1632
709
1633
def _parse_master_args(argv):
1634
"""Parse the arguments that always go with the original command.
1635
These are things like bzr --no-plugins, etc.
1636
1637
There are now 2 types of option flags. Ones that come *before* the command,
1638
and ones that come *after* the command.
1639
Ones coming *before* the command are applied against all possible commands.
1640
And are generally applied before plugins are loaded.
1641
1642
The current list are:
1643
--builtin Allow plugins to load, but don't let them override builtin commands,
1644
they will still be allowed if they do not override a builtin.
1645
--no-plugins Don't load any plugins. This lets you get back to official source
1646
behavior.
1647
--profile Enable the hotspot profile before running the command.
1648
For backwards compatibility, this is also a non-master option.
1649
--version Spit out the version of bzr that is running and exit.
1650
This is also a non-master option.
1651
--help Run help and exit, also a non-master option (I think that should stay, though)
1652
1653
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1654
Traceback (most recent call last):
1655
...
1656
BzrCommandError: Invalid master option: 'test'
1657
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1658
>>> print argv
1659
['command']
1660
>>> print opts['version']
1661
True
1662
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1663
>>> print argv
1664
['command', '--more-options']
1665
>>> print opts['profile']
1666
True
1667
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1668
>>> print argv
1669
['command']
1670
>>> print opts['no-plugins']
1671
True
1672
>>> print opts['profile']
1673
False
1674
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1675
>>> print argv
1676
['command', '--profile']
1677
>>> print opts['profile']
1678
False
1679
"""
1680
master_opts = {'builtin':False,
1681
'no-plugins':False,
1682
'version':False,
1683
'profile':False,
1684
'help':False
1685
}
1686
1687
# This is the point where we could hook into argv[0] to determine
1688
# what front-end is supposed to be run
1689
# For now, we are just ignoring it.
1690
cmd_name = argv.pop(0)
1691
for arg in argv[:]:
1692
if arg[:2] != '--': # at the first non-option, we return the rest
1693
break
1694
arg = arg[2:] # Remove '--'
1695
if arg not in master_opts:
1696
# We could say that this is not an error, that we should
1697
# just let it be handled by the main section instead
1698
raise BzrCommandError('Invalid master option: %r' % arg)
1699
argv.pop(0) # We are consuming this entry
1700
master_opts[arg] = True
1701
return argv, master_opts
1702
1703
1704
710
1705
711
def run_bzr(argv):
1706
712
"""Execute a command.
1707
713
1708
714
This is similar to main(), but without all the trappings for
1709
logging and error handling.
715
logging and error handling.
1710
716
"""
1711
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1712
1713
717
try:
1714
# some options like --builtin and --no-plugins have special effects
1715
argv, master_opts = _parse_master_args(argv)
1716
if not master_opts['no-plugins']:
1717
from bzrlib.plugin import load_plugins
1718
load_plugins()
1719
1720
args, opts = parse_args(argv)
1721
1722
if master_opts['help']:
1723
from bzrlib.help import help
1724
if argv:
1725
help(argv[0])
1726
else:
1727
help()
1728
return 0
1729
718
args, opts = parse_args(argv[1:])
1730
719
if 'help' in opts:
1731
from bzrlib.help import help
1732
if args:
1733
help(args[0])
1734
else:
1735
help()
720
# TODO: pass down other arguments in case they asked for
721
# help on a command name?
722
cmd_help()
1736
723
return 0
1737
724
elif 'version' in opts:
1738
show_version()
725
cmd_version()
1739
726
return 0
1740
elif args and args[0] == 'builtin':
1741
include_plugins=False
1742
args = args[1:]
1743
cmd = str(args.pop(0))
727
cmd = args.pop(0)
1744
728
except IndexError:
1745
import help
1746
help.help()
729
log_error('usage: bzr COMMAND\n')
730
log_error(' try "bzr help"\n')
1747
731
return 1
1748
1749
1750
plugins_override = not (master_opts['builtin'])
1751
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1752
1753
profile = master_opts['profile']
1754
# For backwards compatibility, I would rather stick with --profile being a
1755
# master/global option
1756
if 'profile' in opts:
1757
profile = True
1758
del opts['profile']
732
733
try:
734
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
735
except KeyError:
736
bailout("unknown command " + `cmd`)
737
738
# TODO: special --profile option to turn on the Python profiler
1759
739
1760
740
# check options are reasonable
1761
allowed = cmd_class.takes_options
741
allowed = cmd_options.get(cmd, [])
1762
742
for oname in opts:
1763
743
if oname not in allowed:
1764
raise BzrCommandError("option '--%s' is not allowed for command %r"
1765
% (oname, cmd))
1766
1767
# mix arguments and options into one dictionary
1768
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1769
cmdopts = {}
1770
for k, v in opts.items():
1771
cmdopts[k.replace('-', '_')] = v
1772
1773
if profile:
1774
import hotshot, tempfile
1775
pffileno, pfname = tempfile.mkstemp()
1776
try:
1777
prof = hotshot.Profile(pfname)
1778
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1779
prof.close()
1780
1781
import hotshot.stats
1782
stats = hotshot.stats.load(pfname)
1783
#stats.strip_dirs()
1784
stats.sort_stats('time')
1785
## XXX: Might like to write to stderr or the trace file instead but
1786
## print_stats seems hardcoded to stdout
1787
stats.print_stats(20)
1788
1789
return ret.status
1790
1791
finally:
1792
os.close(pffileno)
1793
os.remove(pfname)
1794
else:
1795
return cmd_class(cmdopts, cmdargs).status
1796
1797
1798
def _report_exception(summary, quiet=False):
1799
import traceback
1800
log_error('bzr: ' + summary)
1801
bzrlib.trace.log_exception()
1802
1803
if not quiet:
1804
tb = sys.exc_info()[2]
1805
exinfo = traceback.extract_tb(tb)
1806
if exinfo:
1807
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1808
sys.stderr.write(' see ~/.bzr.log for debug information\n')
744
bailout("option %r is not allowed for command %r"
745
% (oname, cmd))
746
747
cmdargs = _match_args(cmd, args)
748
cmdargs.update(opts)
749
750
ret = cmd_handler(**cmdargs) or 0
1809
751
1810
752
1811
753
1812
754
def main(argv):
755
## TODO: Handle command-line options; probably know what options are valid for
756
## each command
757
758
## TODO: If the arguments are wrong, give a usage message rather
759
## than just a backtrace.
760
761
bzrlib.trace.create_tracefile(argv)
1813
762
1814
bzrlib.trace.open_tracefile(argv)
1815
1816
763
try:
1817
try:
1818
try:
1819
return run_bzr(argv)
1820
finally:
1821
# do this here inside the exception wrappers to catch EPIPE
1822
sys.stdout.flush()
1823
except BzrError, e:
1824
quiet = isinstance(e, (BzrCommandError))
1825
_report_exception('error: ' + e.args[0], quiet=quiet)
1826
if len(e.args) > 1:
1827
for h in e.args[1]:
1828
# some explanation or hints
1829
log_error(' ' + h)
1830
return 1
1831
except AssertionError, e:
1832
msg = 'assertion failed'
1833
if str(e):
1834
msg += ': ' + str(e)
1835
_report_exception(msg)
1836
return 2
1837
except KeyboardInterrupt, e:
1838
_report_exception('interrupted', quiet=True)
1839
return 2
1840
except Exception, e:
1841
import errno
1842
quiet = False
1843
if (isinstance(e, IOError)
1844
and hasattr(e, 'errno')
1845
and e.errno == errno.EPIPE):
1846
quiet = True
1847
msg = 'broken pipe'
1848
else:
1849
msg = str(e).rstrip('\n')
1850
_report_exception(msg, quiet)
1851
return 2
1852
finally:
1853
bzrlib.trace.close_trace()
764
ret = run_bzr(argv)
765
return ret
766
except BzrError, e:
767
log_error('bzr: error: ' + e.args[0] + '\n')
768
if len(e.args) > 1:
769
for h in e.args[1]:
770
log_error(' ' + h + '\n')
771
return 1
772
except Exception, e:
773
log_error('bzr: exception: %s\n' % e)
774
log_error(' see .bzr.log for details\n')
775
traceback.print_exc(None, bzrlib.trace._tracefile)
776
traceback.print_exc(None, sys.stderr)
777
return 1
778
779
# TODO: Maybe nicer handling of IOError?
780
1854
781
1855
782
1856
783
if __name__ == '__main__':
1857
784
sys.exit(main(sys.argv))
785
##import profile
786
##profile.run('main(sys.argv)')
787
Loggerhead is a web-based interface for Breezy
Version: 2.0.1