1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Bazaar-NG -- a free distributed version-control tool
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
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.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
69
from pprint import pprint
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
113
## TODO: move command; check destination is a directory and will not
116
## TODO: command to show renames, one per line, as to->from
121
def cmd_status(all=False):
122
"""Display status summary.
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
128
:todo: Don't show unchanged files unless ``--all`` is given?
130
Branch('.').show_status(show_all=all)
134
######################################################################
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
147
######################################################################
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
157
def cmd_add(file_list, verbose=False):
158
"""Add specified files or directories.
160
In non-recursive mode, all the named items are added, regardless
161
of whether they were previously ignored. A warning is given if
162
any of the named files are already versioned.
164
In recursive mode (the default), files are treated the same way
165
but the behaviour for directories is different. Directories that
166
are already versioned do not give a warning. All directories,
167
whether already versioned or not, are searched for files or
168
subdirectories that are neither versioned or ignored, and these
169
are added. This search proceeds recursively into versioned
172
Therefore simply saying 'bzr add .' will version all files that
173
are currently unknown.
175
bzrlib.add.smart_add(file_list, verbose)
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
184
def cmd_inventory(revision=None):
185
"""Show inventory of the current working copy."""
186
## TODO: Also optionally show a previous inventory
187
## TODO: Format options
190
inv = b.read_working_inventory()
192
inv = b.get_revision_inventory(b.lookup_revision(revision))
194
for path, entry in inv.iter_entries():
195
print '%-50s %s' % (entry.file_id, path)
199
def cmd_mv(source_list, dest):
202
b.rename([b.relpath(s) for s in source_list], b.relpath(dest))
206
def cmd_renames(dir='.'):
207
"""Show list of renamed files.
209
usage: bzr renames [BRANCH]
211
TODO: Option to show renames between two historical versions.
213
TODO: Only show renames under dir, rather than in the whole branch.
216
old_inv = b.basis_tree().inventory
217
new_inv = b.read_working_inventory()
219
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
221
for old_name, new_name in renames:
222
print "%s => %s" % (old_name, new_name)
227
"""info: Show statistical information for this branch
231
info.show_info(Branch('.'))
235
def cmd_remove(file_list, verbose=False):
236
b = Branch(file_list[0])
237
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
241
def cmd_file_id(filename):
243
i = b.inventory.path2id(b.relpath(filename))
245
bailout("%s is not a versioned file" % filename)
250
def cmd_find_filename(fileid):
251
n = find_filename(fileid)
253
bailout("%s is not a live file id" % fileid)
258
def cmd_revision_history():
259
for patchid in Branch('.').revision_history():
263
def cmd_directories():
264
for name, ie in Branch('.').read_working_inventory().directories():
272
for name, ie in Branch('.').working_tree().missing():
277
# TODO: Check we're not already in a working directory? At the
278
# moment you'll get an ugly error.
280
# TODO: What if we're in a subdirectory of a branch? Would like
281
# to allow that, but then the parent may need to understand that
282
# the children have disappeared, or should they be versioned in
285
# TODO: Take an argument/option for branch name.
286
Branch('.', init=True)
289
def cmd_diff(revision=None):
290
"""bzr diff: Show differences in working tree.
292
usage: bzr diff [-r REV]
295
Show changes since REV, rather than predecessor.
297
TODO: Given two revision arguments, show the difference between them.
299
TODO: Allow diff across branches.
301
TODO: Option to use external diff command; could be GNU diff, wdiff,
304
TODO: Diff selected files.
307
## TODO: Shouldn't be in the cmd function.
312
old_tree = b.basis_tree()
314
old_tree = b.revision_tree(b.lookup_revision(revision))
316
new_tree = b.working_tree()
317
old_inv = old_tree.inventory
318
new_inv = new_tree.inventory
320
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
324
DEVNULL = '/dev/null'
325
# Windows users, don't panic about this filename -- it is a
326
# special signal to GNU patch that the file should be created or
327
# deleted respectively.
329
# TODO: Generation of pseudo-diffs for added/deleted files could
330
# be usefully made into a much faster special case.
332
# TODO: Better to return them in sorted order I think.
334
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
337
# Don't show this by default; maybe do it if an option is passed
338
# idlabel = ' {%s}' % fid
341
# FIXME: Something about the diff format makes patch unhappy
342
# with newly-added files.
344
def diffit(oldlines, newlines, **kw):
345
# FIXME: difflib is wrong if there is no trailing newline.
347
# Special workaround for Python2.3, where difflib fails if
348
# both sequences are empty.
349
if oldlines or newlines:
350
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
353
if file_state in ['.', '?', 'I']:
355
elif file_state == 'A':
356
print '*** added %s %r' % (kind, new_name)
359
new_tree.get_file(fid).readlines(),
361
tofile=new_label + new_name + idlabel)
362
elif file_state == 'D':
363
assert isinstance(old_name, types.StringTypes)
364
print '*** deleted %s %r' % (kind, old_name)
366
diffit(old_tree.get_file(fid).readlines(), [],
367
fromfile=old_label + old_name + idlabel,
369
elif file_state in ['M', 'R']:
370
if file_state == 'M':
371
assert kind == 'file'
372
assert old_name == new_name
373
print '*** modified %s %r' % (kind, new_name)
374
elif file_state == 'R':
375
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
378
diffit(old_tree.get_file(fid).readlines(),
379
new_tree.get_file(fid).readlines(),
380
fromfile=old_label + old_name + idlabel,
381
tofile=new_label + new_name)
383
bailout("can't represent state %s {%s}" % (file_state, fid))
387
def cmd_deleted(show_ids=False):
388
"""List files deleted in the working tree.
390
TODO: Show files deleted since a previous revision, or between two revisions.
394
new = b.working_tree()
396
## TODO: Much more efficient way to do this: read in new
397
## directories with readdir, rather than stating each one. Same
398
## level of effort but possibly much less IO. (Or possibly not,
399
## if the directories are very large...)
401
for path, ie in old.inventory.iter_entries():
402
if not new.has_id(ie.file_id):
404
print '%-50s %s' % (path, ie.file_id)
410
def cmd_parse_inventory():
413
cElementTree.ElementTree().parse(file('.bzr/inventory'))
417
def cmd_load_inventory():
418
inv = Branch('.').basis_tree().inventory
422
def cmd_dump_new_inventory():
423
import bzrlib.newinventory
424
inv = Branch('.').basis_tree().inventory
425
bzrlib.newinventory.write_inventory(inv, sys.stdout)
428
def cmd_load_new_inventory():
429
import bzrlib.newinventory
430
bzrlib.newinventory.read_new_inventory(sys.stdin)
433
def cmd_dump_slacker_inventory():
434
import bzrlib.newinventory
435
inv = Branch('.').basis_tree().inventory
436
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
440
def cmd_root(filename=None):
441
"""Print the branch root."""
442
print bzrlib.branch.find_branch_root(filename)
445
def cmd_log(timezone='original'):
446
"""Show log of this branch.
448
:todo: Options for utc; to show ids; to limit range; etc.
450
Branch('.').write_log(show_timezone=timezone)
453
def cmd_ls(revision=None, verbose=False):
454
"""List files in a tree.
456
:todo: Take a revision or remote path and list that tree instead.
460
tree = b.working_tree()
462
tree = b.revision_tree(b.lookup_revision(revision))
464
for fp, fc, kind, fid in tree.list_files():
466
if kind == 'directory':
473
print '%-8s %s%s' % (fc, fp, kindch)
480
"""List unknown files"""
481
for f in Branch('.').unknowns():
486
def cmd_ignored(verbose=True):
487
"""List ignored files and the patterns that matched them.
489
tree = Branch('.').working_tree()
490
for path, file_class, kind, id in tree.list_files():
491
if file_class != 'I':
493
## XXX: Slightly inefficient since this was already calculated
494
pat = tree.is_ignored(path)
495
print '%-50s %s' % (path, pat)
498
def cmd_lookup_revision(revno):
502
bailout("usage: lookup-revision REVNO",
503
["REVNO is a non-negative revision number for this branch"])
505
print Branch('.').lookup_revision(revno) or NONE_STRING
509
def cmd_export(revno, dest):
510
"""Export past revision to destination directory."""
512
rh = b.lookup_revision(int(revno))
513
t = b.revision_tree(rh)
518
######################################################################
519
# internal/test commands
523
"""Print a newly-generated UUID."""
524
print bzrlib.osutils.uuid()
528
def cmd_local_time_offset():
529
print bzrlib.osutils.local_time_offset()
533
def cmd_commit(message=None, verbose=False):
534
"""Commit changes to a new revision.
537
Description of changes in this revision; free form text.
538
It is recommended that the first line be a single-sentence
541
Show status of changed files,
543
TODO: Commit only selected files.
545
TODO: Run hooks on tree to-be-committed, and after commit.
547
TODO: Strict commit that fails if there are unknown or deleted files.
551
bailout("please specify a commit message")
552
Branch('.').commit(message, verbose=verbose)
555
def cmd_check(dir='.'):
556
"""check: Consistency check of branch history.
558
usage: bzr check [-v] [BRANCH]
561
--verbose, -v Show progress of checking.
563
This command checks various invariants about the branch storage to
564
detect data corruption or bzr bugs.
567
bzrlib.check.check(Branch(dir, find_root=False))
570
def cmd_is(pred, *rest):
571
"""Test whether PREDICATE is true."""
573
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
575
bailout("unknown predicate: %s" % quotefn(pred))
579
except BzrCheckError:
580
# by default we don't print the message so that this can
581
# be used from shell scripts without producing noise
586
print bzrlib.osutils.username()
589
def cmd_user_email():
590
print bzrlib.osutils.user_email()
593
def cmd_gen_revision_id():
595
print bzrlib.branch._gen_revision_id(time.time())
598
def cmd_selftest(verbose=False):
599
"""Run internal test suite"""
600
## -v, if present, is seen by doctest; the argument is just here
601
## so our parser doesn't complain
603
## TODO: --verbose option
605
failures, tests = 0, 0
607
import doctest, bzrlib.store, bzrlib.tests
608
bzrlib.trace.verbose = False
610
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
611
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
612
mf, mt = doctest.testmod(m)
615
print '%-40s %3d tests' % (m.__name__, mt),
617
print '%3d FAILED!' % mf
621
print '%-40s %3d tests' % ('total', tests),
623
print '%3d FAILED!' % failures
630
cmd_doctest = cmd_selftest
633
######################################################################
637
def cmd_help(topic=None):
642
# otherwise, maybe the name of a command?
644
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
646
bailout("no help for %r" % topic)
650
bailout("sorry, no detailed help yet for %r" % topic)
658
print "bzr (bazaar-ng) %s" % bzrlib.__version__
659
print bzrlib.__copyright__
660
print "http://bazaar-ng.org/"
663
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
664
you may use, modify and redistribute it under the terms of the GNU
665
General Public License version 2 or later."""
669
"""Statement of optimism."""
670
print "it sure does!"
674
######################################################################
678
# list of all available options; the rhs can be either None for an
679
# option that takes no argument, or a constructor function that checks
699
# List of options that apply to particular commands; commands not
703
'commit': ['message', 'verbose'],
704
'deleted': ['show-ids'],
705
'diff': ['revision'],
706
'inventory': ['revision'],
708
'ls': ['revision', 'verbose'],
709
'remove': ['verbose'],
718
'export': ['revno', 'dest'],
719
'file-id': ['filename'],
720
'get-file-text': ['text_id'],
721
'get-inventory': ['inventory_id'],
722
'get-revision': ['revision_id'],
723
'get-revision-inventory': ['revision_id'],
727
'lookup-revision': ['revno'],
728
'mv': ['source$', 'dest'],
729
'relpath': ['filename'],
732
'root': ['filename?'],
737
def parse_args(argv):
738
"""Parse command line.
740
Arguments and options are parsed at this level before being passed
741
down to specific command handlers. This routine knows, from a
742
lookup table, something about the available options, what optargs
743
they take, and which commands will accept them.
745
>>> parse_args('--help'.split())
747
>>> parse_args('--version'.split())
748
([], {'version': True})
749
>>> parse_args('status --all'.split())
750
(['status'], {'all': True})
751
>>> parse_args('commit --message=biter'.split())
752
(['commit'], {'message': u'biter'})
757
# TODO: Maybe handle '--' to end options?
764
mutter(" got option %r" % a)
766
optname, optarg = a[2:].split('=', 1)
769
if optname not in OPTIONS:
770
bailout('unknown long option %r' % a)
773
if shortopt not in SHORT_OPTIONS:
774
bailout('unknown short option %r' % a)
775
optname = SHORT_OPTIONS[shortopt]
778
# XXX: Do we ever want to support this, e.g. for -r?
779
bailout('repeated option %r' % a)
781
optargfn = OPTIONS[optname]
785
bailout('option %r needs an argument' % a)
788
opts[optname] = optargfn(optarg)
791
bailout('option %r takes no argument' % optname)
800
def _match_args(cmd, args):
801
"""Check non-option arguments match required pattern.
803
>>> _match_args('status', ['asdasdsadasd'])
804
Traceback (most recent call last):
806
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
807
>>> _match_args('add', ['asdasdsadasd'])
808
{'file_list': ['asdasdsadasd']}
809
>>> _match_args('add', 'abc def gj'.split())
810
{'file_list': ['abc', 'def', 'gj']}
812
# match argument pattern
813
argform = cmd_args.get(cmd, [])
815
# TODO: Need a way to express 'cp SRC... DEST', where it matches
818
# step through args and argform, allowing appropriate 0-many matches
823
argdict[argname] = args.pop(0)
828
bailout("command %r needs one or more %s"
829
% (cmd, argname.upper()))
831
argdict[argname + '_list'] = args[:]
833
elif ap[-1] == '$': # all but one
835
bailout("command %r needs one or more %s"
836
% (cmd, argname.upper()))
837
argdict[argname + '_list'] = args[:-1]
843
bailout("command %r requires argument %s"
844
% (cmd, argname.upper()))
846
argdict[argname] = args.pop(0)
849
bailout("extra arguments to command %s: %r"
857
"""Execute a command.
859
This is similar to main(), but without all the trappings for
860
logging and error handling.
863
args, opts = parse_args(argv[1:])
865
# TODO: pass down other arguments in case they asked for
866
# help on a command name?
872
elif 'version' in opts:
877
log_error('usage: bzr COMMAND\n')
878
log_error(' try "bzr help"\n')
882
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
884
bailout("unknown command " + `cmd`)
887
if 'profile' in opts:
893
# check options are reasonable
894
allowed = cmd_options.get(cmd, [])
896
if oname not in allowed:
897
bailout("option %r is not allowed for command %r"
900
# mix arguments and options into one dictionary
901
cmdargs = _match_args(cmd, args)
902
for k, v in opts.items():
903
cmdargs[k.replace('-', '_')] = v
907
prof = hotshot.Profile('.bzr.profile')
908
ret = prof.runcall(cmd_handler, **cmdargs) or 0
912
stats = hotshot.stats.load('.bzr.profile')
914
stats.sort_stats('time')
915
stats.print_stats(20)
917
return cmd_handler(**cmdargs) or 0
922
## TODO: Handle command-line options; probably know what options are valid for
925
## TODO: If the arguments are wrong, give a usage message rather
926
## than just a backtrace.
928
bzrlib.trace.create_tracefile(argv)
934
log_error('bzr: error: ' + e.args[0] + '\n')
937
log_error(' ' + h + '\n')
940
log_error('bzr: exception: %s\n' % e)
941
log_error(' see .bzr.log for details\n')
942
traceback.print_exc(None, bzrlib.trace._tracefile)
943
traceback.print_exc(None, sys.stderr)
946
# TODO: Maybe nicer handling of IOError?
950
if __name__ == '__main__':
951
sys.exit(main(sys.argv))
953
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
