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, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
67
from pprint import pprint
72
from bzrlib.store import ImmutableStore
73
from bzrlib.trace import mutter, note, log_error
74
from bzrlib.errors import bailout, BzrError, BzrCheckError
75
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
76
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
77
from bzrlib.revision import Revision
78
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
81
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
82
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
84
## standard representation
85
NONE_STRING = '(none)'
89
## TODO: Perhaps a different version of inventory commands that
90
## returns iterators...
92
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
94
## TODO: Some kind of locking on branches. Perhaps there should be a
95
## parameter to the branch object saying whether we want a read or
96
## write lock; release it from destructor. Perhaps don't even need a
97
## read lock to look at immutable objects?
99
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
100
## to compare output?
102
## TODO: Some kind of global code to generate the right Branch object
103
## to work on. Almost, but not quite all, commands need one, and it
104
## can be taken either from their parameters or their working
107
## TODO: rename command, needed soon: check destination doesn't exist
108
## either in working copy or tree; move working copy; update
109
## inventory; write out
111
## TODO: move command; check destination is a directory and will not
114
## TODO: command to show renames, one per line, as to->from
119
def cmd_status(all=False):
120
"""Display status summary.
122
For each file there is a single line giving its file state and name.
123
The name is that in the current revision unless it is deleted or
124
missing, in which case the old name is shown.
126
:todo: Don't show unchanged files unless ``--all`` is given?
128
Branch('.').show_status(show_all=all)
132
######################################################################
134
def cmd_get_revision(revision_id):
135
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
def cmd_get_file_text(text_id):
139
"""Get contents of a file by hash."""
140
sf = Branch('.').text_store[text_id]
141
pumpfile(sf, sys.stdout)
145
######################################################################
150
"""Show number of revisions on this branch"""
151
print Branch('.').revno()
155
def cmd_add(file_list, verbose=False):
156
"""Add specified files or directories.
158
In non-recursive mode, all the named items are added, regardless
159
of whether they were previously ignored. A warning is given if
160
any of the named files are already versioned.
162
In recursive mode (the default), files are treated the same way
163
but the behaviour for directories is different. Directories that
164
are already versioned do not give a warning. All directories,
165
whether already versioned or not, are searched for files or
166
subdirectories that are neither versioned or ignored, and these
167
are added. This search proceeds recursively into versioned
170
Therefore simply saying 'bzr add .' will version all files that
171
are currently unknown.
173
bzrlib.add.smart_add(file_list, verbose)
176
def cmd_relpath(filename):
177
"""Show path of file relative to root"""
178
print Branch(filename).relpath(filename)
182
def cmd_inventory(revision=None):
183
"""Show inventory of the current working copy."""
184
## TODO: Also optionally show a previous inventory
185
## TODO: Format options
188
inv = b.read_working_inventory()
190
inv = b.get_revision_inventory(b.lookup_revision(revision))
192
for path, entry in inv.iter_entries():
193
print '%-50s %s' % (entry.file_id, path)
197
# TODO: Maybe a 'mv' command that has the combined move/rename
198
# special behaviour of Unix?
200
def cmd_move(source_list, dest):
203
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
207
def cmd_rename(from_name, to_name):
208
"""Change the name of an entry.
210
usage: bzr rename FROM_NAME TO_NAME
213
bzr rename frob.c frobber.c
214
bzr rename src/frob.c lib/frob.c
216
It is an error if the destination name exists.
218
See also the 'move' command, which moves files into a different
219
directory without changing their name.
221
TODO: Some way to rename multiple files without invoking bzr for each
224
b.rename_one(b.relpath(from_name), b.relpath(to_name))
229
def cmd_renames(dir='.'):
230
"""Show list of renamed files.
232
usage: bzr renames [BRANCH]
234
TODO: Option to show renames between two historical versions.
236
TODO: Only show renames under dir, rather than in the whole branch.
239
old_inv = b.basis_tree().inventory
240
new_inv = b.read_working_inventory()
242
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
244
for old_name, new_name in renames:
245
print "%s => %s" % (old_name, new_name)
250
"""info: Show statistical information for this branch
254
info.show_info(Branch('.'))
258
def cmd_remove(file_list, verbose=False):
259
b = Branch(file_list[0])
260
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
264
def cmd_file_id(filename):
265
"""Print file_id of a particular file or directory.
267
usage: bzr file-id FILE
269
The file_id is assigned when the file is first added and remains the
270
same through all revisions where the file exists, even when it is
274
i = b.inventory.path2id(b.relpath(filename))
276
bailout("%r is not a versioned file" % filename)
281
def cmd_file_id_path(filename):
282
"""Print path of file_ids to a file or directory.
284
usage: bzr file-id-path FILE
286
This prints one line for each directory down to the target,
287
starting at the branch root."""
290
fid = inv.path2id(b.relpath(filename))
292
bailout("%r is not a versioned file" % filename)
293
for fip in inv.get_idpath(fid):
297
def cmd_revision_history():
298
for patchid in Branch('.').revision_history():
302
def cmd_directories():
303
for name, ie in Branch('.').read_working_inventory().directories():
311
for name, ie in Branch('.').working_tree().missing():
316
# TODO: Check we're not already in a working directory? At the
317
# moment you'll get an ugly error.
319
# TODO: What if we're in a subdirectory of a branch? Would like
320
# to allow that, but then the parent may need to understand that
321
# the children have disappeared, or should they be versioned in
324
# TODO: Take an argument/option for branch name.
325
Branch('.', init=True)
328
def cmd_diff(revision=None):
329
"""bzr diff: Show differences in working tree.
331
usage: bzr diff [-r REV]
334
Show changes since REV, rather than predecessor.
336
TODO: Given two revision arguments, show the difference between them.
338
TODO: Allow diff across branches.
340
TODO: Option to use external diff command; could be GNU diff, wdiff,
343
TODO: Diff selected files.
346
## TODO: Shouldn't be in the cmd function.
351
old_tree = b.basis_tree()
353
old_tree = b.revision_tree(b.lookup_revision(revision))
355
new_tree = b.working_tree()
357
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
361
DEVNULL = '/dev/null'
362
# Windows users, don't panic about this filename -- it is a
363
# special signal to GNU patch that the file should be created or
364
# deleted respectively.
366
# TODO: Generation of pseudo-diffs for added/deleted files could
367
# be usefully made into a much faster special case.
369
# TODO: Better to return them in sorted order I think.
371
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
372
# Don't show this by default; maybe do it if an option is passed
373
# idlabel = ' {%s}' % fid
376
# FIXME: Something about the diff format makes patch unhappy
377
# with newly-added files.
379
def diffit(oldlines, newlines, **kw):
380
# FIXME: difflib is wrong if there is no trailing newline.
382
# Special workaround for Python2.3, where difflib fails if
383
# both sequences are empty.
384
if oldlines or newlines:
385
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
388
if file_state in ['.', '?', 'I']:
390
elif file_state == 'A':
391
print '*** added %s %r' % (kind, new_name)
394
new_tree.get_file(fid).readlines(),
396
tofile=new_label + new_name + idlabel)
397
elif file_state == 'D':
398
assert isinstance(old_name, types.StringTypes)
399
print '*** deleted %s %r' % (kind, old_name)
401
diffit(old_tree.get_file(fid).readlines(), [],
402
fromfile=old_label + old_name + idlabel,
404
elif file_state in ['M', 'R']:
405
if file_state == 'M':
406
assert kind == 'file'
407
assert old_name == new_name
408
print '*** modified %s %r' % (kind, new_name)
409
elif file_state == 'R':
410
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
413
diffit(old_tree.get_file(fid).readlines(),
414
new_tree.get_file(fid).readlines(),
415
fromfile=old_label + old_name + idlabel,
416
tofile=new_label + new_name)
418
bailout("can't represent state %s {%s}" % (file_state, fid))
422
def cmd_deleted(show_ids=False):
423
"""List files deleted in the working tree.
425
TODO: Show files deleted since a previous revision, or between two revisions.
429
new = b.working_tree()
431
## TODO: Much more efficient way to do this: read in new
432
## directories with readdir, rather than stating each one. Same
433
## level of effort but possibly much less IO. (Or possibly not,
434
## if the directories are very large...)
436
for path, ie in old.inventory.iter_entries():
437
if not new.has_id(ie.file_id):
439
print '%-50s %s' % (path, ie.file_id)
445
def cmd_parse_inventory():
448
cElementTree.ElementTree().parse(file('.bzr/inventory'))
452
def cmd_load_inventory():
453
"""Load inventory for timing purposes"""
454
Branch('.').basis_tree().inventory
458
def cmd_dump_new_inventory():
459
import bzrlib.newinventory
460
inv = Branch('.').basis_tree().inventory
461
bzrlib.newinventory.write_inventory(inv, sys.stdout)
464
def cmd_load_new_inventory():
465
import bzrlib.newinventory
466
bzrlib.newinventory.read_new_inventory(sys.stdin)
469
def cmd_dump_slacker_inventory():
470
import bzrlib.newinventory
471
inv = Branch('.').basis_tree().inventory
472
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
476
def cmd_root(filename=None):
477
"""Print the branch root."""
478
print bzrlib.branch.find_branch_root(filename)
481
def cmd_log(timezone='original'):
482
"""Show log of this branch.
484
:todo: Options for utc; to show ids; to limit range; etc.
486
Branch('.').write_log(show_timezone=timezone)
489
def cmd_ls(revision=None, verbose=False):
490
"""List files in a tree.
492
:todo: Take a revision or remote path and list that tree instead.
496
tree = b.working_tree()
498
tree = b.revision_tree(b.lookup_revision(revision))
500
for fp, fc, kind, fid in tree.list_files():
502
if kind == 'directory':
509
print '%-8s %s%s' % (fc, fp, kindch)
516
"""List unknown files"""
517
for f in Branch('.').unknowns():
523
"""List ignored files and the patterns that matched them.
525
tree = Branch('.').working_tree()
526
for path, file_class, kind, file_id in tree.list_files():
527
if file_class != 'I':
529
## XXX: Slightly inefficient since this was already calculated
530
pat = tree.is_ignored(path)
531
print '%-50s %s' % (path, pat)
534
def cmd_lookup_revision(revno):
538
bailout("usage: lookup-revision REVNO",
539
["REVNO is a non-negative revision number for this branch"])
541
print Branch('.').lookup_revision(revno) or NONE_STRING
545
def cmd_export(revno, dest):
546
"""Export past revision to destination directory."""
548
rh = b.lookup_revision(int(revno))
549
t = b.revision_tree(rh)
552
def cmd_cat(revision, filename):
553
"""Print file to stdout."""
555
b.print_file(b.relpath(filename), int(revision))
558
######################################################################
559
# internal/test commands
563
"""Print a newly-generated UUID."""
564
print bzrlib.osutils.uuid()
568
def cmd_local_time_offset():
569
print bzrlib.osutils.local_time_offset()
573
def cmd_commit(message=None, verbose=False):
574
"""Commit changes to a new revision.
577
Description of changes in this revision; free form text.
578
It is recommended that the first line be a single-sentence
581
Show status of changed files,
583
TODO: Commit only selected files.
585
TODO: Run hooks on tree to-be-committed, and after commit.
587
TODO: Strict commit that fails if there are unknown or deleted files.
591
bailout("please specify a commit message")
592
Branch('.').commit(message, verbose=verbose)
595
def cmd_check(dir='.'):
596
"""check: Consistency check of branch history.
598
usage: bzr check [-v] [BRANCH]
601
--verbose, -v Show progress of checking.
603
This command checks various invariants about the branch storage to
604
detect data corruption or bzr bugs.
607
bzrlib.check.check(Branch(dir, find_root=False))
610
def cmd_is(pred, *rest):
611
"""Test whether PREDICATE is true."""
613
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
615
bailout("unknown predicate: %s" % quotefn(pred))
619
except BzrCheckError:
620
# by default we don't print the message so that this can
621
# be used from shell scripts without producing noise
626
print bzrlib.osutils.username()
629
def cmd_user_email():
630
print bzrlib.osutils.user_email()
633
def cmd_gen_revision_id():
634
print bzrlib.branch._gen_revision_id(time.time())
638
"""Run internal test suite"""
639
## -v, if present, is seen by doctest; the argument is just here
640
## so our parser doesn't complain
642
## TODO: --verbose option
644
failures, tests = 0, 0
646
import doctest, bzrlib.store, bzrlib.tests
647
bzrlib.trace.verbose = False
649
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
650
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
651
mf, mt = doctest.testmod(m)
654
print '%-40s %3d tests' % (m.__name__, mt),
656
print '%3d FAILED!' % mf
660
print '%-40s %3d tests' % ('total', tests),
662
print '%3d FAILED!' % failures
669
cmd_doctest = cmd_selftest
672
######################################################################
676
def cmd_help(topic=None):
681
# otherwise, maybe the name of a command?
683
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
685
bailout("no help for %r" % topic)
689
bailout("sorry, no detailed help yet for %r" % topic)
697
print "bzr (bazaar-ng) %s" % bzrlib.__version__
698
print bzrlib.__copyright__
699
print "http://bazaar-ng.org/"
702
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
703
you may use, modify and redistribute it under the terms of the GNU
704
General Public License version 2 or later."""
708
"""Statement of optimism."""
709
print "it sure does!"
713
######################################################################
717
# list of all available options; the rhs can be either None for an
718
# option that takes no argument, or a constructor function that checks
738
# List of options that apply to particular commands; commands not
743
'commit': ['message', 'verbose'],
744
'deleted': ['show-ids'],
745
'diff': ['revision'],
746
'inventory': ['revision'],
748
'ls': ['revision', 'verbose'],
749
'remove': ['verbose'],
759
'export': ['revno', 'dest'],
760
'file-id': ['filename'],
761
'file-id-path': ['filename'],
762
'get-file-text': ['text_id'],
763
'get-inventory': ['inventory_id'],
764
'get-revision': ['revision_id'],
765
'get-revision-inventory': ['revision_id'],
769
'lookup-revision': ['revno'],
770
'move': ['source$', 'dest'],
771
'relpath': ['filename'],
773
'rename': ['from_name', 'to_name'],
775
'root': ['filename?'],
780
def parse_args(argv):
781
"""Parse command line.
783
Arguments and options are parsed at this level before being passed
784
down to specific command handlers. This routine knows, from a
785
lookup table, something about the available options, what optargs
786
they take, and which commands will accept them.
788
>>> parse_args('--help'.split())
790
>>> parse_args('--version'.split())
791
([], {'version': True})
792
>>> parse_args('status --all'.split())
793
(['status'], {'all': True})
794
>>> parse_args('commit --message=biter'.split())
795
(['commit'], {'message': u'biter'})
800
# TODO: Maybe handle '--' to end options?
807
mutter(" got option %r" % a)
809
optname, optarg = a[2:].split('=', 1)
812
if optname not in OPTIONS:
813
bailout('unknown long option %r' % a)
816
if shortopt not in SHORT_OPTIONS:
817
bailout('unknown short option %r' % a)
818
optname = SHORT_OPTIONS[shortopt]
821
# XXX: Do we ever want to support this, e.g. for -r?
822
bailout('repeated option %r' % a)
824
optargfn = OPTIONS[optname]
828
bailout('option %r needs an argument' % a)
831
opts[optname] = optargfn(optarg)
834
bailout('option %r takes no argument' % optname)
843
def _match_args(cmd, args):
844
"""Check non-option arguments match required pattern.
846
>>> _match_args('status', ['asdasdsadasd'])
847
Traceback (most recent call last):
849
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
850
>>> _match_args('add', ['asdasdsadasd'])
851
{'file_list': ['asdasdsadasd']}
852
>>> _match_args('add', 'abc def gj'.split())
853
{'file_list': ['abc', 'def', 'gj']}
855
# match argument pattern
856
argform = cmd_args.get(cmd, [])
858
# TODO: Need a way to express 'cp SRC... DEST', where it matches
861
# step through args and argform, allowing appropriate 0-many matches
866
argdict[argname] = args.pop(0)
868
raise BzrError("arg form %r not implemented yet" % ap)
871
bailout("command %r needs one or more %s"
872
% (cmd, argname.upper()))
874
argdict[argname + '_list'] = args[:]
876
elif ap[-1] == '$': # all but one
878
bailout("command %r needs one or more %s"
879
% (cmd, argname.upper()))
880
argdict[argname + '_list'] = args[:-1]
886
bailout("command %r requires argument %s"
887
% (cmd, argname.upper()))
889
argdict[argname] = args.pop(0)
892
bailout("extra arguments to command %s: %r"
900
"""Execute a command.
902
This is similar to main(), but without all the trappings for
903
logging and error handling.
906
args, opts = parse_args(argv[1:])
908
# TODO: pass down other arguments in case they asked for
909
# help on a command name?
915
elif 'version' in opts:
920
log_error('usage: bzr COMMAND\n')
921
log_error(' try "bzr help"\n')
925
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
927
bailout("unknown command " + `cmd`)
930
if 'profile' in opts:
936
# check options are reasonable
937
allowed = cmd_options.get(cmd, [])
939
if oname not in allowed:
940
bailout("option %r is not allowed for command %r"
943
# TODO: give an error if there are any mandatory options which are
944
# not specified? Or maybe there shouldn't be any "mandatory
945
# options" (it is an oxymoron)
947
# mix arguments and options into one dictionary
948
cmdargs = _match_args(cmd, args)
949
for k, v in opts.items():
950
cmdargs[k.replace('-', '_')] = v
954
prof = hotshot.Profile('.bzr.profile')
955
ret = prof.runcall(cmd_handler, **cmdargs) or 0
959
stats = hotshot.stats.load('.bzr.profile')
961
stats.sort_stats('time')
962
stats.print_stats(20)
966
return cmd_handler(**cmdargs) or 0
971
## TODO: Handle command-line options; probably know what options are valid for
974
## TODO: If the arguments are wrong, give a usage message rather
975
## than just a backtrace.
977
bzrlib.trace.create_tracefile(argv)
983
log_error('bzr: error: ' + e.args[0] + '\n')
986
log_error(' ' + h + '\n')
987
traceback.print_exc(None, bzrlib.trace._tracefile)
988
log_error('(see $HOME/.bzr.log for debug information)\n')
991
log_error('bzr: exception: %s\n' % e)
992
log_error('(see $HOME/.bzr.log for debug information)\n')
993
traceback.print_exc(None, bzrlib.trace._tracefile)
994
## traceback.print_exc(None, sys.stderr)
997
# TODO: Maybe nicer handling of IOError?
1001
if __name__ == '__main__':
1002
sys.exit(main(sys.argv))
1004
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
