117
def get_cmd_object(cmd_name, plugins_override=True):
188
def get_cmd_class(cmd, plugins_override=True):
118
189
"""Return the canonical name and command class for a command.
121
If true, plugin commands can override builtins.
123
from bzrlib.externalcommand import ExternalCommand
125
cmd_name = str(cmd_name) # not unicode
191
cmd = str(cmd) # not unicode
127
193
# first look up this command under the specified name
128
194
cmds = _get_cmd_dict(plugins_override=plugins_override)
130
return cmds[cmd_name]()
196
return cmd, cmds[cmd]
134
200
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
139
cmd_obj = ExternalCommand.find_command(cmd_name)
143
raise BzrCommandError("unknown command %r" % cmd_name)
201
for cmdname, cmdclass in cmds.iteritems():
202
if cmd in cmdclass.aliases:
203
return cmdname, cmdclass
205
cmdclass = ExternalCommand.find_command(cmd)
209
raise BzrCommandError("unknown command %r" % cmd)
146
212
class Command(object):
147
213
"""Base class for commands.
149
Commands are the heart of the command-line bzr interface.
151
The command object mostly handles the mapping of command-line
152
parameters into one or more bzrlib operations, and of the results
155
Commands normally don't have any state. All their arguments are
156
passed in to the run method. (Subclasses may take a different
157
policy if the behaviour of the instance needs to depend on e.g. a
158
shell plugin and not just its Python class.)
160
215
The docstring for an actual command should give a single-line
161
216
summary, then a complete description of the command. A grammar
162
217
description will be inserted.
165
Other accepted names for this command.
168
220
List of argument forms, marked with whether they are optional,
173
['to_location', 'from_branch?', 'file*']
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
224
List of options that may be given for this command.
185
If true, this command isn't advertised. This is typically
186
for commands intended for expert users.
227
If true, this command isn't advertised.
190
232
takes_options = []
195
"""Construct an instance of this command."""
236
def __init__(self, options, arguments):
237
"""Construct and run the command.
239
Sets self.status to the return value of run()."""
240
assert isinstance(options, dict)
241
assert isinstance(arguments, dict)
242
cmdargs = options.copy()
243
cmdargs.update(arguments)
196
244
if self.__doc__ == Command.__doc__:
245
from warnings import warn
197
246
warn("No help message set for %r" % self)
200
"""Return dict of valid options for this command.
202
Maps from long option name to option object."""
204
r['help'] = Option.OPTIONS['help']
205
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
214
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
224
# mix arguments and options into one dictionary
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
227
for k, v in opts.items():
228
cmdopts[k.replace('-', '_')] = v
230
all_cmd_args = cmdargs.copy()
231
all_cmd_args.update(cmdopts)
233
return self.run(**all_cmd_args)
247
self.status = self.run(**cmdargs)
248
if self.status is None:
236
"""Actually run the command.
253
"""Override this in sub-classes.
238
255
This is invoked with the options and arguments bound to
239
256
keyword parameters.
241
Return 0 or None if the command was successful, or a non-zero
242
shell error code if not. It's OK for this method to allow
243
an exception to raise up.
258
Return 0 or None if the command was successful, or a shell
245
raise NotImplementedError()
249
"""Return help message for this class."""
250
if self.__doc__ is Command.__doc__:
255
return _unsquish_command_name(self.__class__.__name__)
264
class ExternalCommand(Command):
265
"""Class to wrap external commands.
267
We cheat a little here, when get_cmd_class() calls us we actually
268
give it back an object we construct that has the appropriate path,
269
help, options etc for the specified command.
271
When run_bzr() tries to instantiate that 'class' it gets caught by
272
the __call__ method, which we override to call the Command.__init__
273
method. That then calls our run method which is pretty straight
276
The only wrinkle is that we have to map bzr's dictionary of options
277
and arguments back into command line options and arguments for the
281
def find_command(cls, cmd):
283
bzrpath = os.environ.get('BZRPATH', '')
285
for dir in bzrpath.split(os.pathsep):
286
path = os.path.join(dir, cmd)
287
if os.path.isfile(path):
288
return ExternalCommand(path)
292
find_command = classmethod(find_command)
294
def __init__(self, path):
297
pipe = os.popen('%s --bzr-usage' % path, 'r')
298
self.takes_options = pipe.readline().split()
300
for opt in self.takes_options:
301
if not opt in OPTIONS:
302
raise BzrError("Unknown option '%s' returned by external command %s"
305
# TODO: Is there any way to check takes_args is valid here?
306
self.takes_args = pipe.readline().split()
308
if pipe.close() is not None:
309
raise BzrError("Failed funning '%s --bzr-usage'" % path)
311
pipe = os.popen('%s --bzr-help' % path, 'r')
312
self.__doc__ = pipe.read()
313
if pipe.close() is not None:
314
raise BzrError("Failed funning '%s --bzr-help'" % path)
316
def __call__(self, options, arguments):
317
Command.__init__(self, options, arguments)
320
def run(self, **kargs):
327
optname = name.replace('_','-')
329
if OPTIONS.has_key(optname):
331
opts.append('--%s' % optname)
332
if value is not None and value is not True:
333
opts.append(str(value))
335
# it's an arg, or arg list
336
if type(value) is not list:
342
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
346
class cmd_status(Command):
347
"""Display status summary.
349
This reports on versioned and unknown files, reporting them
350
grouped by state. Possible states are:
353
Versioned in the working copy but not in the previous revision.
356
Versioned in the previous revision but removed or deleted
360
Path of this file changed from the previous revision;
361
the text may also have changed. This includes files whose
362
parent directory was renamed.
365
Text has changed since the previous revision.
368
Nothing about this file has changed since the previous revision.
369
Only shown with --all.
372
Not versioned and not matching an ignore pattern.
374
To see ignored files use 'bzr ignored'. For details in the
375
changes to file texts, use 'bzr diff'.
377
If no arguments are specified, the status of the entire working
378
directory is shown. Otherwise, only the status of the specified
379
files or directories is reported. If a directory is given, status
380
is reported for everything inside that directory.
382
If a revision is specified, the changes since that revision are shown.
384
takes_args = ['file*']
385
takes_options = ['all', 'show-ids', 'revision']
386
aliases = ['st', 'stat']
388
def run(self, all=False, show_ids=False, file_list=None):
390
b = find_branch(file_list[0])
391
file_list = [b.relpath(x) for x in file_list]
392
# special case: only one path was given and it's the root
394
if file_list == ['']:
399
from bzrlib.status import show_status
400
show_status(b, show_unchanged=all, show_ids=show_ids,
401
specific_files=file_list)
404
class cmd_cat_revision(Command):
405
"""Write out metadata for a revision."""
408
takes_args = ['revision_id']
410
def run(self, revision_id):
411
from bzrlib.xml import pack_xml
412
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
415
class cmd_revno(Command):
416
"""Show current revision number.
418
This is equal to the number of revisions on this branch."""
420
print find_branch('.').revno()
422
class cmd_revision_info(Command):
423
"""Show revision number and revision id for a given revision identifier.
426
takes_args = ['revision_info*']
427
takes_options = ['revision']
428
def run(self, revision=None, revision_info_list=None):
429
from bzrlib.branch import find_branch
432
if revision is not None:
433
revs.extend(revision)
434
if revision_info_list is not None:
435
revs.extend(revision_info_list)
437
raise BzrCommandError('You must supply a revision identifier')
442
print '%4d %s' % b.get_revision_info(rev)
445
class cmd_add(Command):
446
"""Add specified files or directories.
448
In non-recursive mode, all the named items are added, regardless
449
of whether they were previously ignored. A warning is given if
450
any of the named files are already versioned.
452
In recursive mode (the default), files are treated the same way
453
but the behaviour for directories is different. Directories that
454
are already versioned do not give a warning. All directories,
455
whether already versioned or not, are searched for files or
456
subdirectories that are neither versioned or ignored, and these
457
are added. This search proceeds recursively into versioned
458
directories. If no names are given '.' is assumed.
460
Therefore simply saying 'bzr add' will version all files that
461
are currently unknown.
463
TODO: Perhaps adding a file whose directly is not versioned should
464
recursively add that parent, rather than giving an error?
466
takes_args = ['file*']
467
takes_options = ['verbose', 'no-recurse']
469
def run(self, file_list, verbose=False, no_recurse=False):
470
from bzrlib.add import smart_add
471
smart_add(file_list, verbose, not no_recurse)
475
class cmd_mkdir(Command):
476
"""Create a new versioned directory.
478
This is equivalent to creating the directory and then adding it.
480
takes_args = ['dir+']
482
def run(self, dir_list):
489
b.add([d], verbose=True)
492
class cmd_relpath(Command):
493
"""Show path of a file relative to root"""
494
takes_args = ['filename']
497
def run(self, filename):
498
print find_branch(filename).relpath(filename)
502
class cmd_inventory(Command):
503
"""Show inventory of the current working copy or a revision."""
504
takes_options = ['revision', 'show-ids']
506
def run(self, revision=None, show_ids=False):
509
inv = b.read_working_inventory()
511
if len(revision) > 1:
512
raise BzrCommandError('bzr inventory --revision takes'
513
' exactly one revision identifier')
514
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
516
for path, entry in inv.entries():
518
print '%-50s %s' % (path, entry.file_id)
523
class cmd_move(Command):
524
"""Move files to a different directory.
529
The destination must be a versioned directory in the same branch.
531
takes_args = ['source$', 'dest']
532
def run(self, source_list, dest):
535
# TODO: glob expansion on windows?
536
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
539
class cmd_rename(Command):
540
"""Change the name of an entry.
543
bzr rename frob.c frobber.c
544
bzr rename src/frob.c lib/frob.c
546
It is an error if the destination name exists.
548
See also the 'move' command, which moves files into a different
549
directory without changing their name.
551
TODO: Some way to rename multiple files without invoking bzr for each
553
takes_args = ['from_name', 'to_name']
555
def run(self, from_name, to_name):
557
b.rename_one(b.relpath(from_name), b.relpath(to_name))
561
class cmd_mv(Command):
562
"""Move or rename a file.
565
bzr mv OLDNAME NEWNAME
566
bzr mv SOURCE... DESTINATION
568
If the last argument is a versioned directory, all the other names
569
are moved into it. Otherwise, there must be exactly two arguments
570
and the file is changed to a new name, which must not already exist.
572
Files cannot be moved between branches.
574
takes_args = ['names*']
575
def run(self, names_list):
576
if len(names_list) < 2:
577
raise BzrCommandError("missing file argument")
578
b = find_branch(names_list[0])
580
rel_names = [b.relpath(x) for x in names_list]
582
if os.path.isdir(names_list[-1]):
583
# move into existing directory
584
b.move(rel_names[:-1], rel_names[-1])
586
if len(names_list) != 2:
587
raise BzrCommandError('to mv multiple files the destination '
588
'must be a versioned directory')
589
b.move(rel_names[0], rel_names[1])
594
class cmd_pull(Command):
595
"""Pull any changes from another branch into the current one.
597
If the location is omitted, the last-used location will be used.
598
Both the revision history and the working directory will be
601
This command only works on branches that have not diverged. Branches are
602
considered diverged if both branches have had commits without first
603
pulling from the other.
605
If branches have diverged, you can use 'bzr merge' to pull the text changes
606
from one into the other.
608
takes_args = ['location?']
610
def run(self, location=None):
611
from bzrlib.merge import merge
613
from shutil import rmtree
616
br_to = find_branch('.')
619
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
621
if e.errno != errno.ENOENT:
624
if stored_loc is None:
625
raise BzrCommandError("No pull location known or specified.")
627
print "Using last location: %s" % stored_loc
628
location = stored_loc
629
cache_root = tempfile.mkdtemp()
630
from bzrlib.branch import DivergedBranches
631
br_from = find_branch(location)
632
location = pull_loc(br_from)
633
old_revno = br_to.revno()
635
from branch import find_cached_branch, DivergedBranches
636
br_from = find_cached_branch(location, cache_root)
637
location = pull_loc(br_from)
638
old_revno = br_to.revno()
640
br_to.update_revisions(br_from)
641
except DivergedBranches:
642
raise BzrCommandError("These branches have diverged."
645
merge(('.', -1), ('.', old_revno), check_clean=False)
646
if location != stored_loc:
647
br_to.controlfile("x-pull", "wb").write(location + "\n")
653
class cmd_branch(Command):
654
"""Create a new copy of a branch.
656
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
657
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
659
To retrieve the branch as of a particular revision, supply the --revision
660
parameter, as in "branch foo/bar -r 5".
662
takes_args = ['from_location', 'to_location?']
663
takes_options = ['revision']
664
aliases = ['get', 'clone']
666
def run(self, from_location, to_location=None, revision=None):
668
from bzrlib.merge import merge
669
from bzrlib.branch import DivergedBranches, \
670
find_cached_branch, Branch
671
from shutil import rmtree
672
from meta_store import CachedStore
674
cache_root = tempfile.mkdtemp()
678
elif len(revision) > 1:
679
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
683
br_from = find_cached_branch(from_location, cache_root)
685
if e.errno == errno.ENOENT:
686
raise BzrCommandError('Source location "%s" does not'
687
' exist.' % to_location)
691
if to_location is None:
692
to_location = os.path.basename(from_location.rstrip("/\\"))
695
os.mkdir(to_location)
697
if e.errno == errno.EEXIST:
698
raise BzrCommandError('Target directory "%s" already'
699
' exists.' % to_location)
700
if e.errno == errno.ENOENT:
701
raise BzrCommandError('Parent of "%s" does not exist.' %
705
br_to = Branch(to_location, init=True)
707
br_to.set_root_id(br_from.get_root_id())
710
if revision[0] is None:
711
revno = br_from.revno()
713
revno, rev_id = br_from.get_revision_info(revision[0])
715
br_to.update_revisions(br_from, stop_revision=revno)
716
except bzrlib.errors.NoSuchRevision:
718
msg = "The branch %s has no revision %d." % (from_location,
720
raise BzrCommandError(msg)
722
merge((to_location, -1), (to_location, 0), this_dir=to_location,
723
check_clean=False, ignore_zero=True)
724
from_location = pull_loc(br_from)
725
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
730
def pull_loc(branch):
731
# TODO: Should perhaps just make attribute be 'base' in
732
# RemoteBranch and Branch?
733
if hasattr(branch, "baseurl"):
734
return branch.baseurl
740
class cmd_renames(Command):
741
"""Show list of renamed files.
743
TODO: Option to show renames between two historical versions.
745
TODO: Only show renames under dir, rather than in the whole branch.
747
takes_args = ['dir?']
749
def run(self, dir='.'):
751
old_inv = b.basis_tree().inventory
752
new_inv = b.read_working_inventory()
754
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
756
for old_name, new_name in renames:
757
print "%s => %s" % (old_name, new_name)
760
class cmd_info(Command):
761
"""Show statistical information about a branch."""
762
takes_args = ['branch?']
764
def run(self, branch=None):
767
b = find_branch(branch)
771
class cmd_remove(Command):
772
"""Make a file unversioned.
774
This makes bzr stop tracking changes to a versioned file. It does
775
not delete the working copy.
777
takes_args = ['file+']
778
takes_options = ['verbose']
780
def run(self, file_list, verbose=False):
781
b = find_branch(file_list[0])
782
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
785
class cmd_file_id(Command):
786
"""Print file_id of a particular file or directory.
788
The file_id is assigned when the file is first added and remains the
789
same through all revisions where the file exists, even when it is
793
takes_args = ['filename']
794
def run(self, filename):
795
b = find_branch(filename)
796
i = b.inventory.path2id(b.relpath(filename))
798
raise BzrError("%r is not a versioned file" % filename)
803
class cmd_file_path(Command):
804
"""Print path of file_ids to a file or directory.
806
This prints one line for each directory down to the target,
807
starting at the branch root."""
809
takes_args = ['filename']
810
def run(self, filename):
811
b = find_branch(filename)
813
fid = inv.path2id(b.relpath(filename))
815
raise BzrError("%r is not a versioned file" % filename)
816
for fip in inv.get_idpath(fid):
820
class cmd_revision_history(Command):
821
"""Display list of revision ids on this branch."""
824
for patchid in find_branch('.').revision_history():
828
class cmd_directories(Command):
829
"""Display list of versioned directories in this branch."""
831
for name, ie in find_branch('.').read_working_inventory().directories():
838
class cmd_init(Command):
839
"""Make a directory into a versioned branch.
841
Use this to create an empty branch, or before importing an
844
Recipe for importing a tree of files:
849
bzr commit -m 'imported project'
852
from bzrlib.branch import Branch
853
Branch('.', init=True)
856
class cmd_diff(Command):
857
"""Show differences in working tree.
859
If files are listed, only the changes in those files are listed.
860
Otherwise, all changes for the tree are listed.
862
TODO: Allow diff across branches.
864
TODO: Option to use external diff command; could be GNU diff, wdiff,
867
TODO: Python difflib is not exactly the same as unidiff; should
868
either fix it up or prefer to use an external diff.
870
TODO: If a directory is given, diff everything under that.
872
TODO: Selected-file diff is inefficient and doesn't show you
875
TODO: This probably handles non-Unix newlines poorly.
883
takes_args = ['file*']
884
takes_options = ['revision', 'diff-options']
885
aliases = ['di', 'dif']
887
def run(self, revision=None, file_list=None, diff_options=None):
888
from bzrlib.diff import show_diff
891
b = find_branch(file_list[0])
892
file_list = [b.relpath(f) for f in file_list]
893
if file_list == ['']:
894
# just pointing to top-of-tree
899
if revision is not None:
900
if len(revision) == 1:
901
show_diff(b, revision[0], specific_files=file_list,
902
external_diff_options=diff_options)
903
elif len(revision) == 2:
904
show_diff(b, revision[0], specific_files=file_list,
905
external_diff_options=diff_options,
906
revision2=revision[1])
908
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
910
show_diff(b, None, specific_files=file_list,
911
external_diff_options=diff_options)
916
class cmd_deleted(Command):
917
"""List files deleted in the working tree.
919
TODO: Show files deleted since a previous revision, or between two revisions.
921
def run(self, show_ids=False):
924
new = b.working_tree()
926
## TODO: Much more efficient way to do this: read in new
927
## directories with readdir, rather than stating each one. Same
928
## level of effort but possibly much less IO. (Or possibly not,
929
## if the directories are very large...)
931
for path, ie in old.inventory.iter_entries():
932
if not new.has_id(ie.file_id):
934
print '%-50s %s' % (path, ie.file_id)
939
class cmd_modified(Command):
940
"""List files modified in working tree."""
943
from bzrlib.delta import compare_trees
946
td = compare_trees(b.basis_tree(), b.working_tree())
948
for path, id, kind in td.modified:
953
class cmd_added(Command):
954
"""List files added in working tree."""
958
wt = b.working_tree()
959
basis_inv = b.basis_tree().inventory
962
if file_id in basis_inv:
964
path = inv.id2path(file_id)
965
if not os.access(b.abspath(path), os.F_OK):
971
class cmd_root(Command):
972
"""Show the tree root directory.
974
The root is the nearest enclosing directory with a .bzr control
976
takes_args = ['filename?']
977
def run(self, filename=None):
978
"""Print the branch root."""
979
b = find_branch(filename)
980
print getattr(b, 'base', None) or getattr(b, 'baseurl')
983
class cmd_log(Command):
984
"""Show log of this branch.
986
To request a range of logs, you can use the command -r begin:end
987
-r revision requests a specific revision, -r :end or -r begin: are
990
--message allows you to give a regular expression, which will be evaluated
991
so that only matching entries will be displayed.
993
TODO: Make --revision support uuid: and hash: [future tag:] notation.
997
takes_args = ['filename?']
998
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
999
'long', 'message', 'short',]
1001
def run(self, filename=None, timezone='original',
1009
from bzrlib.branch import find_branch
1010
from bzrlib.log import log_formatter, show_log
1013
direction = (forward and 'forward') or 'reverse'
1016
b = find_branch(filename)
1017
fp = b.relpath(filename)
1019
file_id = b.read_working_inventory().path2id(fp)
1021
file_id = None # points to branch root
1023
b = find_branch('.')
1026
if revision is None:
1029
elif len(revision) == 1:
1030
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1031
elif len(revision) == 2:
1032
rev1 = b.get_revision_info(revision[0])[0]
1033
rev2 = b.get_revision_info(revision[1])[0]
1035
raise BzrCommandError('bzr log --revision takes one or two values.')
1042
mutter('encoding log as %r' % bzrlib.user_encoding)
1044
# use 'replace' so that we don't abort if trying to write out
1045
# in e.g. the default C locale.
1046
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1051
log_format = 'short'
1052
lf = log_formatter(log_format,
1055
show_timezone=timezone)
1061
direction=direction,
1062
start_revision=rev1,
1068
class cmd_touching_revisions(Command):
1069
"""Return revision-ids which affected a particular file.
1071
A more user-friendly interface is "bzr log FILE"."""
1073
takes_args = ["filename"]
1074
def run(self, filename):
1075
b = find_branch(filename)
1076
inv = b.read_working_inventory()
1077
file_id = inv.path2id(b.relpath(filename))
1078
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1079
print "%6d %s" % (revno, what)
1082
class cmd_ls(Command):
1083
"""List files in a tree.
1085
TODO: Take a revision or remote path and list that tree instead.
1088
def run(self, revision=None, verbose=False):
1089
b = find_branch('.')
1090
if revision == None:
1091
tree = b.working_tree()
1093
tree = b.revision_tree(b.lookup_revision(revision))
1095
for fp, fc, kind, fid in tree.list_files():
1097
if kind == 'directory':
1099
elif kind == 'file':
1104
print '%-8s %s%s' % (fc, fp, kindch)
1110
class cmd_unknowns(Command):
1111
"""List unknown files."""
1113
from bzrlib.osutils import quotefn
1114
for f in find_branch('.').unknowns():
1119
class cmd_ignore(Command):
1120
"""Ignore a command or pattern.
1122
To remove patterns from the ignore list, edit the .bzrignore file.
1124
If the pattern contains a slash, it is compared to the whole path
1125
from the branch root. Otherwise, it is comapred to only the last
1126
component of the path.
1128
Ignore patterns are case-insensitive on case-insensitive systems.
1130
Note: wildcards must be quoted from the shell on Unix.
1133
bzr ignore ./Makefile
1134
bzr ignore '*.class'
1136
takes_args = ['name_pattern']
1138
def run(self, name_pattern):
1139
from bzrlib.atomicfile import AtomicFile
1142
b = find_branch('.')
1143
ifn = b.abspath('.bzrignore')
1145
if os.path.exists(ifn):
1148
igns = f.read().decode('utf-8')
1154
# TODO: If the file already uses crlf-style termination, maybe
1155
# we should use that for the newly added lines?
1157
if igns and igns[-1] != '\n':
1159
igns += name_pattern + '\n'
1162
f = AtomicFile(ifn, 'wt')
1163
f.write(igns.encode('utf-8'))
1168
inv = b.working_tree().inventory
1169
if inv.path2id('.bzrignore'):
1170
mutter('.bzrignore is already versioned')
1172
mutter('need to make new .bzrignore file versioned')
1173
b.add(['.bzrignore'])
1177
class cmd_ignored(Command):
1178
"""List ignored files and the patterns that matched them.
1180
See also: bzr ignore"""
1182
tree = find_branch('.').working_tree()
1183
for path, file_class, kind, file_id in tree.list_files():
1184
if file_class != 'I':
1186
## XXX: Slightly inefficient since this was already calculated
1187
pat = tree.is_ignored(path)
1188
print '%-50s %s' % (path, pat)
1191
class cmd_lookup_revision(Command):
1192
"""Lookup the revision-id from a revision-number
1195
bzr lookup-revision 33
1198
takes_args = ['revno']
1200
def run(self, revno):
1204
raise BzrCommandError("not a valid revision-number: %r" % revno)
1206
print find_branch('.').lookup_revision(revno)
1209
class cmd_export(Command):
1210
"""Export past revision to destination directory.
1212
If no revision is specified this exports the last committed revision.
1214
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1215
given, try to find the format with the extension. If no extension
1216
is found exports to a directory (equivalent to --format=dir).
1218
Root may be the top directory for tar, tgz and tbz2 formats. If none
1219
is given, the top directory will be the root name of the file."""
1220
# TODO: list known exporters
1221
takes_args = ['dest']
1222
takes_options = ['revision', 'format', 'root']
1223
def run(self, dest, revision=None, format=None, root=None):
1225
b = find_branch('.')
1226
if revision is None:
1227
rev_id = b.last_patch()
1229
if len(revision) != 1:
1230
raise BzrError('bzr export --revision takes exactly 1 argument')
1231
revno, rev_id = b.get_revision_info(revision[0])
1232
t = b.revision_tree(rev_id)
1233
root, ext = os.path.splitext(dest)
1235
if ext in (".tar",):
1237
elif ext in (".gz", ".tgz"):
1239
elif ext in (".bz2", ".tbz2"):
1243
t.export(dest, format, root)
1246
class cmd_cat(Command):
1247
"""Write a file's text from a previous revision."""
1249
takes_options = ['revision']
1250
takes_args = ['filename']
1252
def run(self, filename, revision=None):
1253
if revision == None:
1254
raise BzrCommandError("bzr cat requires a revision number")
1255
elif len(revision) != 1:
1256
raise BzrCommandError("bzr cat --revision takes exactly one number")
1257
b = find_branch('.')
1258
b.print_file(b.relpath(filename), revision[0])
1261
class cmd_local_time_offset(Command):
1262
"""Show the offset in seconds from GMT to local time."""
1265
print bzrlib.osutils.local_time_offset()
1269
class cmd_commit(Command):
1270
"""Commit changes into a new revision.
1272
If no arguments are given, the entire tree is committed.
1274
If selected files are specified, only changes to those files are
1275
committed. If a directory is specified then the directory and everything
1276
within it is committed.
1278
A selected-file commit may fail in some cases where the committed
1279
tree would be invalid, such as trying to commit a file in a
1280
newly-added directory that is not itself committed.
1282
TODO: Run hooks on tree to-be-committed, and after commit.
1284
TODO: Strict commit that fails if there are unknown or deleted files.
1286
takes_args = ['selected*']
1287
takes_options = ['message', 'file', 'verbose', 'unchanged']
1288
aliases = ['ci', 'checkin']
1290
# TODO: Give better message for -s, --summary, used by tla people
1292
def run(self, message=None, file=None, verbose=True, selected_list=None,
1294
from bzrlib.errors import PointlessCommit
1295
from bzrlib.osutils import get_text_message
1297
## Warning: shadows builtin file()
1298
if not message and not file:
1299
# FIXME: Ugly; change status code to send to a provided function?
1303
catcher = cStringIO.StringIO()
1304
sys.stdout = catcher
1305
cmd_status({"file_list":selected_list}, {})
1306
info = catcher.getvalue()
1308
message = get_text_message(info)
1311
raise BzrCommandError("please specify a commit message",
1312
["use either --message or --file"])
1313
elif message and file:
1314
raise BzrCommandError("please specify either --message or --file")
1318
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1320
b = find_branch('.')
1322
selected_list = [b.relpath(s) for s in selected_list]
1325
b.commit(message, verbose=verbose,
1326
specific_files=selected_list,
1327
allow_pointless=unchanged)
1328
except PointlessCommit:
1329
# FIXME: This should really happen before the file is read in;
1330
# perhaps prepare the commit; get the message; then actually commit
1331
raise BzrCommandError("no changes to commit",
1332
["use --unchanged to commit anyhow"])
1335
class cmd_check(Command):
1336
"""Validate consistency of branch history.
1338
This command checks various invariants about the branch storage to
1339
detect data corruption or bzr bugs.
1341
If given the --update flag, it will update some optional fields
1342
to help ensure data consistency.
1344
takes_args = ['dir?']
1346
def run(self, dir='.'):
1347
from bzrlib.check import check
1349
check(find_branch(dir))
1352
class cmd_scan_cache(Command):
1355
from bzrlib.hashcache import HashCache
1362
print '%6d stats' % c.stat_count
1363
print '%6d in hashcache' % len(c._cache)
1364
print '%6d files removed from cache' % c.removed_count
1365
print '%6d hashes updated' % c.update_count
1366
print '%6d files changed too recently to cache' % c.danger_count
1373
class cmd_upgrade(Command):
1374
"""Upgrade branch storage to current format.
1376
The check command or bzr developers may sometimes advise you to run
1379
takes_args = ['dir?']
1381
def run(self, dir='.'):
1382
from bzrlib.upgrade import upgrade
1383
upgrade(find_branch(dir))
1387
class cmd_whoami(Command):
1388
"""Show bzr user id."""
1389
takes_options = ['email']
1391
def run(self, email=False):
1393
b = bzrlib.branch.find_branch('.')
1398
print bzrlib.osutils.user_email(b)
1400
print bzrlib.osutils.username(b)
1403
class cmd_selftest(Command):
1404
"""Run internal test suite"""
1406
takes_options = ['verbose']
1407
def run(self, verbose=False):
1409
from bzrlib.selftest import selftest
1411
# we don't want progress meters from the tests to go to the
1412
# real output; and we don't want log messages cluttering up
1415
save_ui = bzrlib.ui.ui_factory
1416
bzrlib.trace.info('running tests...')
1418
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1419
result = selftest(verbose=verbose)
1421
bzrlib.trace.info('tests passed')
1423
bzrlib.trace.info('tests failed')
1424
return int(not result)
1426
bzrlib.ui.ui_factory = save_ui
1429
class cmd_version(Command):
1430
"""Show version of bzr."""
1435
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1436
# is bzrlib itself in a branch?
1437
bzrrev = bzrlib.get_bzr_revision()
1439
print " (bzr checkout, revision %d {%s})" % bzrrev
1440
print bzrlib.__copyright__
1441
print "http://bazaar-ng.org/"
1443
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1444
print "you may use, modify and redistribute it under the terms of the GNU"
1445
print "General Public License version 2 or later."
1448
class cmd_rocks(Command):
1449
"""Statement of optimism."""
1452
print "it sure does!"
258
1454
def parse_spec(spec):
286
1482
parsed = [spec, None]
289
def parse_args(command, argv):
1487
class cmd_find_merge_base(Command):
1488
"""Find and print a base revision for merging two branches.
1490
TODO: Options to specify revisions on either side, as if
1491
merging only part of the history.
1493
takes_args = ['branch', 'other']
1496
def run(self, branch, other):
1497
branch1 = find_branch(branch)
1498
branch2 = find_branch(other)
1500
base_revno, base_revid = branch1.common_ancestor(branch2)
1502
if base_revno is None:
1503
raise bzrlib.errors.UnrelatedBranches()
1505
print 'merge base is revision %s' % base_revid
1506
print ' r%-6d in %s' % (base_revno, branch)
1508
other_revno = branch2.revision_id_to_revno(base_revid)
1510
print ' r%-6d in %s' % (other_revno, other)
1514
class cmd_merge(Command):
1515
"""Perform a three-way merge.
1517
The branch is the branch you will merge from. By default, it will merge
1518
the latest revision. If you specify a revision, that revision will be
1519
merged. If you specify two revisions, the first will be used as a BASE,
1520
and the second one as OTHER. Revision numbers are always relative to the
1525
To merge the latest revision from bzr.dev
1526
bzr merge ../bzr.dev
1528
To merge changes up to and including revision 82 from bzr.dev
1529
bzr merge -r 82 ../bzr.dev
1531
To merge the changes introduced by 82, without previous changes:
1532
bzr merge -r 81..82 ../bzr.dev
1534
merge refuses to run if there are any uncommitted changes, unless
1537
takes_args = ['branch?']
1538
takes_options = ['revision', 'force', 'merge-type']
1540
def run(self, branch='.', revision=None, force=False,
1542
from bzrlib.merge import merge
1543
from bzrlib.merge_core import ApplyMerge3
1544
if merge_type is None:
1545
merge_type = ApplyMerge3
1547
if revision is None or len(revision) < 1:
1549
other = (branch, -1)
1551
if len(revision) == 1:
1552
other = (branch, revision[0])
1555
assert len(revision) == 2
1556
if None in revision:
1557
raise BzrCommandError(
1558
"Merge doesn't permit that revision specifier.")
1559
base = (branch, revision[0])
1560
other = (branch, revision[1])
1562
merge(other, base, check_clean=(not force), merge_type=merge_type)
1565
class cmd_revert(Command):
1566
"""Reverse all changes since the last commit.
1568
Only versioned files are affected. Specify filenames to revert only
1569
those files. By default, any files that are changed will be backed up
1570
first. Backup files have a '~' appended to their name.
1572
takes_options = ['revision', 'no-backup']
1573
takes_args = ['file*']
1574
aliases = ['merge-revert']
1576
def run(self, revision=None, no_backup=False, file_list=None):
1577
from bzrlib.merge import merge
1578
if file_list is not None:
1579
if len(file_list) == 0:
1580
raise BzrCommandError("No files specified")
1581
if revision is None:
1583
elif len(revision) != 1:
1584
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1585
merge(('.', revision[0]), parse_spec('.'),
1588
backup_files=not no_backup,
1589
file_list=file_list)
1592
class cmd_assert_fail(Command):
1593
"""Test reporting of assertion failures"""
1596
assert False, "always fails"
1599
class cmd_help(Command):
1600
"""Show help on a command or other topic.
1602
For a list of all available commands, say 'bzr help commands'."""
1603
takes_options = ['long']
1604
takes_args = ['topic?']
1607
def run(self, topic=None, long=False):
1609
if topic is None and long:
1614
class cmd_shell_complete(Command):
1615
"""Show appropriate completions for context.
1617
For a list of all available commands, say 'bzr shell-complete'."""
1618
takes_args = ['context?']
1622
def run(self, context=None):
1623
import shellcomplete
1624
shellcomplete.shellcomplete(context)
1627
class cmd_missing(Command):
1628
"""What is missing in this branch relative to other branch.
1630
takes_args = ['remote?']
1631
aliases = ['mis', 'miss']
1632
# We don't have to add quiet to the list, because
1633
# unknown options are parsed as booleans
1634
takes_options = ['verbose', 'quiet']
1636
def run(self, remote=None, verbose=False, quiet=False):
1637
from bzrlib.branch import find_branch, DivergedBranches
1638
from bzrlib.errors import BzrCommandError
1639
from bzrlib.missing import get_parent, show_missing
1641
if verbose and quiet:
1642
raise BzrCommandError('Cannot pass both quiet and verbose')
1644
b = find_branch('.')
1645
parent = get_parent(b)
1648
raise BzrCommandError("No missing location known or specified.")
1651
print "Using last location: %s" % parent
1653
elif parent is None:
1654
# We only update x-pull if it did not exist, missing should not change the parent
1655
b.controlfile('x-pull', 'wb').write(remote + '\n')
1656
br_remote = find_branch(remote)
1658
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1662
class cmd_plugins(Command):
1666
import bzrlib.plugin
1667
from inspect import getdoc
1668
from pprint import pprint
1669
for plugin in bzrlib.plugin.all_plugins:
1670
print plugin.__path__[0]
1673
print '\t', d.split('\n')[0]
1675
#pprint(bzrlib.plugin.all_plugins)
1679
# list of all available options; the rhs can be either None for an
1680
# option that takes no argument, or a constructor function that checks
1684
'diff-options': str,
1693
'revision': _parse_revision_str,
1705
'merge-type': get_merge_type,
1718
def parse_args(argv):
290
1719
"""Parse command line.
292
1721
Arguments and options are parsed at this level before being passed
293
1722
down to specific command handlers. This routine knows, from a
294
1723
lookup table, something about the available options, what optargs
295
1724
they take, and which commands will accept them.
1726
>>> parse_args('--help'.split())
1727
([], {'help': True})
1728
>>> parse_args('--version'.split())
1729
([], {'version': True})
1730
>>> parse_args('status --all'.split())
1731
(['status'], {'all': True})
1732
>>> parse_args('commit --message=biter'.split())
1733
(['commit'], {'message': u'biter'})
1734
>>> parse_args('log -r 500'.split())
1735
(['log'], {'revision': [500]})
1736
>>> parse_args('log -r500..600'.split())
1737
(['log'], {'revision': [500, 600]})
1738
>>> parse_args('log -vr500..600'.split())
1739
(['log'], {'verbose': True, 'revision': [500, 600]})
1740
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1741
(['log'], {'revision': ['v500', 600]})
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
1746
# TODO: Maybe handle '--' to end options?
309
# We've received a standalone -- No more flags
313
1751
# option names must not be unicode
317
mutter(" got option %r", a)
1755
mutter(" got option %r" % a)
319
1757
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
1760
if optname not in OPTIONS:
1761
raise BzrError('unknown long option %r' % a)
326
1763
shortopt = a[1:]
327
if shortopt in Option.SHORT_OPTIONS:
1764
if shortopt in SHORT_OPTIONS:
328
1765
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
1767
optname = SHORT_OPTIONS[shortopt]
333
1769
# Single character short options, can be chained,
334
1770
# and have their value appended to their name
335
1771
shortopt = a[1:2]
336
if shortopt not in Option.SHORT_OPTIONS:
1772
if shortopt not in SHORT_OPTIONS:
337
1773
# We didn't find the multi-character name, and we
338
1774
# didn't find the single char name
339
1775
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
1776
optname = SHORT_OPTIONS[shortopt]
343
1779
# There are extra things on this option
344
1780
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
1782
optargfn = OPTIONS[optname]
347
1783
if optargfn is None:
348
1784
# This option does not take an argument, so the
349
1785
# next entry is another short option, pack it back