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)
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
189
inv = b.read_working_inventory()
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
200
info.show_info(Branch('.'))
204
def cmd_remove(file_list, verbose=False):
205
b = Branch(file_list[0])
206
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
def cmd_file_id(filename):
212
i = b.inventory.path2id(b.relpath(filename))
214
bailout("%s is not a versioned file" % filename)
219
def cmd_find_filename(fileid):
220
n = find_filename(fileid)
222
bailout("%s is not a live file id" % fileid)
227
def cmd_revision_history():
228
for patchid in Branch('.').revision_history():
234
# TODO: Check we're not already in a working directory? At the
235
# moment you'll get an ugly error.
237
# TODO: What if we're in a subdirectory of a branch? Would like
238
# to allow that, but then the parent may need to understand that
239
# the children have disappeared, or should they be versioned in
242
# TODO: Take an argument/option for branch name.
243
Branch('.', init=True)
246
def cmd_diff(revision=None):
247
"""Show diff from basis to working copy.
249
:todo: Take one or two revision arguments, look up those trees,
252
:todo: Allow diff across branches.
254
:todo: Mangle filenames in diff to be more relevant.
256
:todo: Shouldn't be in the cmd function.
258
TODO: Option to use external diff command; could be GNU diff,
259
wdiff, or a graphical diff.
265
old_tree = b.basis_tree()
267
old_tree = b.revision_tree(b.lookup_revision(revision))
269
new_tree = b.working_tree()
270
old_inv = old_tree.inventory
271
new_inv = new_tree.inventory
273
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
277
DEVNULL = '/dev/null'
278
# Windows users, don't panic about this filename -- it is a
279
# special signal to GNU patch that the file should be created or
280
# deleted respectively.
282
# TODO: Generation of pseudo-diffs for added/deleted files could
283
# be usefully made into a much faster special case.
285
# TODO: Better to return them in sorted order I think.
287
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
290
# Don't show this by default; maybe do it if an option is passed
291
# idlabel = ' {%s}' % fid
294
# FIXME: Something about the diff format makes patch unhappy
295
# with newly-added files.
297
def diffit(*a, **kw):
298
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
301
if file_state in ['.', '?', 'I']:
303
elif file_state == 'A':
304
print '*** added %s %r' % (kind, new_name)
307
new_tree.get_file(fid).readlines(),
309
tofile=new_label + new_name + idlabel)
310
elif file_state == 'D':
311
assert isinstance(old_name, types.StringTypes)
312
print '*** deleted %s %r' % (kind, old_name)
314
diffit(old_tree.get_file(fid).readlines(), [],
315
fromfile=old_label + old_name + idlabel,
317
elif file_state in ['M', 'R']:
318
if file_state == 'M':
319
assert kind == 'file'
320
assert old_name == new_name
321
print '*** modified %s %r' % (kind, new_name)
322
elif file_state == 'R':
323
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
326
diffit(old_tree.get_file(fid).readlines(),
327
new_tree.get_file(fid).readlines(),
328
fromfile=old_label + old_name + idlabel,
329
tofile=new_label + new_name)
331
bailout("can't represent state %s {%s}" % (file_state, fid))
335
def cmd_root(filename=None):
336
"""Print the branch root."""
337
print bzrlib.branch.find_branch_root(filename)
340
def cmd_log(timezone='original'):
341
"""Show log of this branch.
343
:todo: Options for utc; to show ids; to limit range; etc.
345
Branch('.').write_log(show_timezone=timezone)
348
def cmd_ls(revision=None, verbose=False):
349
"""List files in a tree.
351
:todo: Take a revision or remote path and list that tree instead.
355
tree = b.working_tree()
357
tree = b.revision_tree(b.lookup_revision(revision))
359
for fp, fc, kind, fid in tree.list_files():
361
if kind == 'directory':
368
print '%-8s %s%s' % (fc, fp, kindch)
375
"""List unknown files"""
376
for f in Branch('.').unknowns():
380
def cmd_lookup_revision(revno):
384
bailout("usage: lookup-revision REVNO",
385
["REVNO is a non-negative revision number for this branch"])
387
print Branch('.').lookup_revision(revno) or NONE_STRING
391
def cmd_export(revno, dest):
392
"""Export past revision to destination directory."""
394
rh = b.lookup_revision(int(revno))
395
t = b.revision_tree(rh)
400
######################################################################
401
# internal/test commands
405
"""Print a newly-generated UUID."""
406
print bzrlib.osutils.uuid()
410
def cmd_local_time_offset():
411
print bzrlib.osutils.local_time_offset()
415
def cmd_commit(message=None, verbose=False):
417
bailout("please specify a commit message")
418
Branch('.').commit(message, verbose=verbose)
422
"""Check consistency of the branch."""
426
def cmd_is(pred, *rest):
427
"""Test whether PREDICATE is true."""
429
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
431
bailout("unknown predicate: %s" % quotefn(pred))
435
except BzrCheckError:
436
# by default we don't print the message so that this can
437
# be used from shell scripts without producing noise
442
print bzrlib.osutils.username()
445
def cmd_user_email():
446
print bzrlib.osutils.user_email()
449
def cmd_gen_revision_id():
451
print bzrlib.branch._gen_revision_id(time.time())
454
def cmd_selftest(verbose=False):
455
"""Run internal test suite"""
456
## -v, if present, is seen by doctest; the argument is just here
457
## so our parser doesn't complain
459
## TODO: --verbose option
461
failures, tests = 0, 0
463
import doctest, bzrlib.store, bzrlib.tests
464
bzrlib.trace.verbose = False
466
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
467
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
468
mf, mt = doctest.testmod(m)
471
print '%-40s %3d tests' % (m.__name__, mt),
473
print '%3d FAILED!' % mf
477
print '%-40s %3d tests' % ('total', tests),
479
print '%3d FAILED!' % failures
486
cmd_doctest = cmd_selftest
489
######################################################################
493
def cmd_help(topic=None):
498
# otherwise, maybe the name of a command?
500
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
502
bailout("no help for %r" % topic)
506
bailout("sorry, no detailed help yet for %r" % topic)
514
print "bzr (bazaar-ng) %s" % bzrlib.__version__
515
print bzrlib.__copyright__
516
print "http://bazaar-ng.org/"
519
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
520
you may use, modify and redistribute it under the terms of the GNU
521
General Public License version 2 or later."""
525
"""Statement of optimism."""
526
print "it sure does!"
530
######################################################################
534
# list of all available options; the rhs can be either None for an
535
# option that takes no argument, or a constructor function that checks
554
# List of options that apply to particular commands; commands not
558
'commit': ['message', 'verbose'],
559
'diff': ['revision'],
560
'inventory': ['revision'],
561
'log': ['show-ids', 'timezone'],
562
'ls': ['revision', 'verbose'],
563
'remove': ['verbose'],
572
'export': ['revno', 'dest'],
573
'file-id': ['filename'],
574
'get-file-text': ['text_id'],
575
'get-inventory': ['inventory_id'],
576
'get-revision': ['revision_id'],
577
'get-revision-inventory': ['revision_id'],
581
'lookup-revision': ['revno'],
582
'relpath': ['filename'],
584
'root': ['filename?'],
589
def parse_args(argv):
590
"""Parse command line.
592
Arguments and options are parsed at this level before being passed
593
down to specific command handlers. This routine knows, from a
594
lookup table, something about the available options, what optargs
595
they take, and which commands will accept them.
597
>>> parse_args('--help'.split())
599
>>> parse_args('--version'.split())
600
([], {'version': True})
601
>>> parse_args('status --all'.split())
602
(['status'], {'all': True})
603
>>> parse_args('commit --message=biter'.split())
604
(['commit'], {'message': u'biter'})
609
# TODO: Maybe handle '--' to end options?
616
mutter(" got option %r" % a)
618
optname, optarg = a[2:].split('=', 1)
621
if optname not in OPTIONS:
622
bailout('unknown long option %r' % a)
625
if shortopt not in SHORT_OPTIONS:
626
bailout('unknown short option %r' % a)
627
optname = SHORT_OPTIONS[shortopt]
630
# XXX: Do we ever want to support this, e.g. for -r?
631
bailout('repeated option %r' % a)
633
optargfn = OPTIONS[optname]
637
bailout('option %r needs an argument' % a)
640
opts[optname] = optargfn(optarg)
641
mutter(" option argument %r" % opts[optname])
644
bailout('option %r takes no argument' % optname)
653
def _match_args(cmd, args):
654
"""Check non-option arguments match required pattern.
656
>>> _match_args('status', ['asdasdsadasd'])
657
Traceback (most recent call last):
659
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
660
>>> _match_args('add', ['asdasdsadasd'])
661
{'file_list': ['asdasdsadasd']}
662
>>> _match_args('add', 'abc def gj'.split())
663
{'file_list': ['abc', 'def', 'gj']}
665
# match argument pattern
666
argform = cmd_args.get(cmd, [])
668
# TODO: Need a way to express 'cp SRC... DEST', where it matches
671
# step through args and argform, allowing appropriate 0-many matches
676
argdict[argname] = args.pop(0)
681
bailout("command %r needs one or more %s"
682
% (cmd, argname.upper()))
684
argdict[argname + '_list'] = args[:]
690
bailout("command %r requires argument %s"
691
% (cmd, argname.upper()))
693
argdict[argname] = args.pop(0)
696
bailout("extra arguments to command %s: %r"
704
"""Execute a command.
706
This is similar to main(), but without all the trappings for
707
logging and error handling.
710
args, opts = parse_args(argv[1:])
712
# TODO: pass down other arguments in case they asked for
713
# help on a command name?
716
elif 'version' in opts:
721
log_error('usage: bzr COMMAND\n')
722
log_error(' try "bzr help"\n')
726
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
728
bailout("unknown command " + `cmd`)
730
# TODO: special --profile option to turn on the Python profiler
732
# check options are reasonable
733
allowed = cmd_options.get(cmd, [])
735
if oname not in allowed:
736
bailout("option %r is not allowed for command %r"
739
cmdargs = _match_args(cmd, args)
742
ret = cmd_handler(**cmdargs) or 0
747
## TODO: Handle command-line options; probably know what options are valid for
750
## TODO: If the arguments are wrong, give a usage message rather
751
## than just a backtrace.
753
bzrlib.trace.create_tracefile(argv)
759
log_error('bzr: error: ' + e.args[0] + '\n')
762
log_error(' ' + h + '\n')
765
log_error('bzr: exception: %s\n' % e)
766
log_error(' see .bzr.log for details\n')
767
traceback.print_exc(None, bzrlib.trace._tracefile)
768
traceback.print_exc(None, sys.stderr)
771
# TODO: Maybe nicer handling of IOError?
775
if __name__ == '__main__':
776
sys.exit(main(sys.argv))
778
##profile.run('main(sys.argv)')
added
removed
bzrlib/commands.py
