~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-07-04 12:26:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050704122602-69901910521e62c3
- check command checks that all inventory-ids are the same as in the revision.

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
# TODO: Split the command framework away from the actual commands.
19
 
 
20
 
# TODO: probably should say which arguments are candidates for glob
21
 
# expansion on windows and do that at the command level.
22
 
 
23
 
import sys
24
 
import os
 
18
 
 
19
import sys, os
25
20
 
26
21
import bzrlib
27
 
from bzrlib.trace import mutter, note, log_error, warning
 
22
from bzrlib.trace import mutter, note, log_error
28
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
24
from bzrlib.branch import find_branch
30
25
from bzrlib import BZRDIR
56
51
    assert cmd.startswith("cmd_")
57
52
    return cmd[4:].replace('_','-')
58
53
 
59
 
 
60
54
def _parse_revision_str(revstr):
61
 
    """This handles a revision string -> revno.
62
 
 
63
 
    This always returns a list.  The list will have one element for 
64
 
 
65
 
    It supports integers directly, but everything else it
66
 
    defers for passing to Branch.get_revision_info()
67
 
 
68
 
    >>> _parse_revision_str('234')
69
 
    [234]
70
 
    >>> _parse_revision_str('234..567')
71
 
    [234, 567]
72
 
    >>> _parse_revision_str('..')
73
 
    [None, None]
74
 
    >>> _parse_revision_str('..234')
75
 
    [None, 234]
76
 
    >>> _parse_revision_str('234..')
77
 
    [234, None]
78
 
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
79
 
    [234, 456, 789]
80
 
    >>> _parse_revision_str('234....789') # Error?
81
 
    [234, None, 789]
82
 
    >>> _parse_revision_str('revid:test@other.com-234234')
83
 
    ['revid:test@other.com-234234']
84
 
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
 
    ['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
 
    >>> _parse_revision_str('revid:test@other.com-234234..23')
87
 
    ['revid:test@other.com-234234', 23]
88
 
    >>> _parse_revision_str('date:2005-04-12')
89
 
    ['date:2005-04-12']
90
 
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
91
 
    ['date:2005-04-12 12:24:33']
92
 
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
93
 
    ['date:2005-04-12T12:24:33']
94
 
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
95
 
    ['date:2005-04-12,12:24:33']
96
 
    >>> _parse_revision_str('-5..23')
97
 
    [-5, 23]
98
 
    >>> _parse_revision_str('-5')
99
 
    [-5]
100
 
    >>> _parse_revision_str('123a')
101
 
    ['123a']
102
 
    >>> _parse_revision_str('abc')
103
 
    ['abc']
 
55
    """This handles a revision string -> revno. 
 
56
 
 
57
    There are several possibilities:
 
58
 
 
59
        '234'       -> 234
 
60
        '234:345'   -> [234, 345]
 
61
        ':234'      -> [None, 234]
 
62
        '234:'      -> [234, None]
 
63
 
 
64
    In the future we will also support:
 
65
        'uuid:blah-blah-blah'   -> ?
 
66
        'hash:blahblahblah'     -> ?
 
67
        potentially:
 
68
        'tag:mytag'             -> ?
104
69
    """
105
 
    import re
106
 
    old_format_re = re.compile('\d*:\d*')
107
 
    m = old_format_re.match(revstr)
108
 
    if m:
109
 
        warning('Colon separator for revision numbers is deprecated.'
110
 
                ' Use .. instead')
111
 
        revs = []
112
 
        for rev in revstr.split(':'):
113
 
            if rev:
114
 
                revs.append(int(rev))
115
 
            else:
116
 
                revs.append(None)
117
 
        return revs
118
 
    revs = []
119
 
    for x in revstr.split('..'):
120
 
        if not x:
121
 
            revs.append(None)
122
 
        else:
123
 
            try:
124
 
                revs.append(int(x))
125
 
            except ValueError:
126
 
                revs.append(x)
 
70
    if revstr.find(':') != -1:
 
71
        revs = revstr.split(':')
 
72
        if len(revs) > 2:
 
73
            raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
 
74
 
 
75
        if not revs[0]:
 
76
            revs[0] = None
 
77
        else:
 
78
            revs[0] = int(revs[0])
 
79
 
 
80
        if not revs[1]:
 
81
            revs[1] = None
 
82
        else:
 
83
            revs[1] = int(revs[1])
 
84
    else:
 
85
        revs = int(revstr)
127
86
    return revs
128
87
 
129
88
 
130
 
def get_merge_type(typestring):
131
 
    """Attempt to find the merge class/factory associated with a string."""
132
 
    from merge import merge_types
133
 
    try:
134
 
        return merge_types[typestring][0]
135
 
    except KeyError:
136
 
        templ = '%s%%7s: %%s' % (' '*12)
137
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
 
        type_list = '\n'.join(lines)
139
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
140
 
            (typestring, type_list)
141
 
        raise BzrCommandError(msg)
142
 
    
143
 
 
144
 
def get_merge_type(typestring):
145
 
    """Attempt to find the merge class/factory associated with a string."""
146
 
    from merge import merge_types
147
 
    try:
148
 
        return merge_types[typestring][0]
149
 
    except KeyError:
150
 
        templ = '%s%%7s: %%s' % (' '*12)
151
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
 
        type_list = '\n'.join(lines)
153
 
        msg = "No known merge type %s. Supported types are:\n%s" %\
154
 
            (typestring, type_list)
155
 
        raise BzrCommandError(msg)
156
 
    
157
 
 
158
89
 
159
90
def _get_cmd_dict(plugins_override=True):
160
91
    d = {}
233
164
        assert isinstance(arguments, dict)
234
165
        cmdargs = options.copy()
235
166
        cmdargs.update(arguments)
236
 
        if self.__doc__ == Command.__doc__:
237
 
            from warnings import warn
238
 
            warn("No help message set for %r" % self)
 
167
        assert self.__doc__ != Command.__doc__, \
 
168
               ("No help message set for %r" % self)
239
169
        self.status = self.run(**cmdargs)
240
 
        if self.status is None:
241
 
            self.status = 0
242
170
 
243
171
    
244
172
    def run(self):
256
184
class ExternalCommand(Command):
257
185
    """Class to wrap external commands.
258
186
 
259
 
    We cheat a little here, when get_cmd_class() calls us we actually
260
 
    give it back an object we construct that has the appropriate path,
261
 
    help, options etc for the specified command.
262
 
 
263
 
    When run_bzr() tries to instantiate that 'class' it gets caught by
264
 
    the __call__ method, which we override to call the Command.__init__
265
 
    method. That then calls our run method which is pretty straight
266
 
    forward.
267
 
 
268
 
    The only wrinkle is that we have to map bzr's dictionary of options
269
 
    and arguments back into command line options and arguments for the
270
 
    script.
 
187
    We cheat a little here, when get_cmd_class() calls us we actually give it back
 
188
    an object we construct that has the appropriate path, help, options etc for the
 
189
    specified command.
 
190
 
 
191
    When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
 
192
    method, which we override to call the Command.__init__ method. That then calls
 
193
    our run method which is pretty straight forward.
 
194
 
 
195
    The only wrinkle is that we have to map bzr's dictionary of options and arguments
 
196
    back into command line options and arguments for the script.
271
197
    """
272
198
 
273
199
    def find_command(cls, cmd):
370
296
    directory is shown.  Otherwise, only the status of the specified
371
297
    files or directories is reported.  If a directory is given, status
372
298
    is reported for everything inside that directory.
373
 
 
374
 
    If a revision is specified, the changes since that revision are shown.
375
299
    """
376
300
    takes_args = ['file*']
377
 
    takes_options = ['all', 'show-ids', 'revision']
 
301
    takes_options = ['all', 'show-ids']
378
302
    aliases = ['st', 'stat']
379
303
    
380
304
    def run(self, all=False, show_ids=False, file_list=None):
387
311
                file_list = None
388
312
        else:
389
313
            b = find_branch('.')
390
 
            
391
 
        from bzrlib.status import show_status
392
 
        show_status(b, show_unchanged=all, show_ids=show_ids,
393
 
                    specific_files=file_list)
 
314
        import status
 
315
        status.show_status(b, show_unchanged=all, show_ids=show_ids,
 
316
                           specific_files=file_list)
394
317
 
395
318
 
396
319
class cmd_cat_revision(Command):
411
334
    def run(self):
412
335
        print find_branch('.').revno()
413
336
 
414
 
class cmd_revision_info(Command):
415
 
    """Show revision number and revision id for a given revision identifier.
416
 
    """
417
 
    hidden = True
418
 
    takes_args = ['revision_info*']
419
 
    takes_options = ['revision']
420
 
    def run(self, revision=None, revision_info_list=None):
421
 
        from bzrlib.branch import find_branch
422
 
 
423
 
        revs = []
424
 
        if revision is not None:
425
 
            revs.extend(revision)
426
 
        if revision_info_list is not None:
427
 
            revs.extend(revision_info_list)
428
 
        if len(revs) == 0:
429
 
            raise BzrCommandError('You must supply a revision identifier')
430
 
 
431
 
        b = find_branch('.')
432
 
 
433
 
        for rev in revs:
434
 
            print '%4d %s' % b.get_revision_info(rev)
435
 
 
436
337
    
437
338
class cmd_add(Command):
438
339
    """Add specified files or directories.
447
348
    whether already versioned or not, are searched for files or
448
349
    subdirectories that are neither versioned or ignored, and these
449
350
    are added.  This search proceeds recursively into versioned
450
 
    directories.  If no names are given '.' is assumed.
 
351
    directories.
451
352
 
452
 
    Therefore simply saying 'bzr add' will version all files that
 
353
    Therefore simply saying 'bzr add .' will version all files that
453
354
    are currently unknown.
454
355
 
455
356
    TODO: Perhaps adding a file whose directly is not versioned should
456
357
    recursively add that parent, rather than giving an error?
457
358
    """
458
 
    takes_args = ['file*']
 
359
    takes_args = ['file+']
459
360
    takes_options = ['verbose', 'no-recurse']
460
361
    
461
362
    def run(self, file_list, verbose=False, no_recurse=False):
500
401
        if revision == None:
501
402
            inv = b.read_working_inventory()
502
403
        else:
503
 
            if len(revision) > 1:
504
 
                raise BzrCommandError('bzr inventory --revision takes'
505
 
                    ' exactly one revision identifier')
506
 
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
 
404
            inv = b.get_revision_inventory(b.lookup_revision(revision))
507
405
 
508
406
        for path, entry in inv.entries():
509
407
            if show_ids:
524
422
    def run(self, source_list, dest):
525
423
        b = find_branch('.')
526
424
 
527
 
        # TODO: glob expansion on windows?
528
425
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
529
426
 
530
427
 
550
447
 
551
448
 
552
449
 
553
 
class cmd_mv(Command):
554
 
    """Move or rename a file.
555
 
 
556
 
    usage:
557
 
        bzr mv OLDNAME NEWNAME
558
 
        bzr mv SOURCE... DESTINATION
559
 
 
560
 
    If the last argument is a versioned directory, all the other names
561
 
    are moved into it.  Otherwise, there must be exactly two arguments
562
 
    and the file is changed to a new name, which must not already exist.
563
 
 
564
 
    Files cannot be moved between branches.
565
 
    """
566
 
    takes_args = ['names*']
567
 
    def run(self, names_list):
568
 
        if len(names_list) < 2:
569
 
            raise BzrCommandError("missing file argument")
570
 
        b = find_branch(names_list[0])
571
 
 
572
 
        rel_names = [b.relpath(x) for x in names_list]
573
 
        
574
 
        if os.path.isdir(names_list[-1]):
575
 
            # move into existing directory
576
 
            b.move(rel_names[:-1], rel_names[-1])
577
 
        else:
578
 
            if len(names_list) != 2:
579
 
                raise BzrCommandError('to mv multiple files the destination '
580
 
                                      'must be a versioned directory')
581
 
            b.move(rel_names[0], rel_names[1])
582
 
            
583
 
    
584
450
 
585
451
 
586
452
class cmd_pull(Command):
653
519
    """
654
520
    takes_args = ['from_location', 'to_location?']
655
521
    takes_options = ['revision']
656
 
    aliases = ['get', 'clone']
657
522
 
658
523
    def run(self, from_location, to_location=None, revision=None):
659
524
        import errno
660
525
        from bzrlib.merge import merge
661
 
        from bzrlib.branch import DivergedBranches, \
 
526
        from bzrlib.branch import DivergedBranches, NoSuchRevision, \
662
527
             find_cached_branch, Branch
663
528
        from shutil import rmtree
664
529
        from meta_store import CachedStore
665
530
        import tempfile
666
531
        cache_root = tempfile.mkdtemp()
667
 
 
668
 
        if revision is None:
669
 
            revision = [None]
670
 
        elif len(revision) > 1:
671
 
            raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
672
 
 
673
532
        try:
674
533
            try:
675
534
                br_from = find_cached_branch(from_location, cache_root)
696
555
                    raise
697
556
            br_to = Branch(to_location, init=True)
698
557
 
699
 
            br_to.set_root_id(br_from.get_root_id())
700
 
 
701
 
            if revision:
702
 
                if revision[0] is None:
703
 
                    revno = br_from.revno()
704
 
                else:
705
 
                    revno, rev_id = br_from.get_revision_info(revision[0])
706
 
                try:
707
 
                    br_to.update_revisions(br_from, stop_revision=revno)
708
 
                except bzrlib.errors.NoSuchRevision:
709
 
                    rmtree(to_location)
710
 
                    msg = "The branch %s has no revision %d." % (from_location,
711
 
                                                                 revno)
712
 
                    raise BzrCommandError(msg)
713
 
            
 
558
            try:
 
559
                br_to.update_revisions(br_from, stop_revision=revision)
 
560
            except NoSuchRevision:
 
561
                rmtree(to_location)
 
562
                msg = "The branch %s has no revision %d." % (from_location,
 
563
                                                             revision)
 
564
                raise BzrCommandError(msg)
714
565
            merge((to_location, -1), (to_location, 0), this_dir=to_location,
715
566
                  check_clean=False, ignore_zero=True)
716
567
            from_location = pull_loc(br_from)
851
702
    If files are listed, only the changes in those files are listed.
852
703
    Otherwise, all changes for the tree are listed.
853
704
 
 
705
    TODO: Given two revision arguments, show the difference between them.
 
706
 
854
707
    TODO: Allow diff across branches.
855
708
 
856
709
    TODO: Option to use external diff command; could be GNU diff, wdiff,
865
718
          deleted files.
866
719
 
867
720
    TODO: This probably handles non-Unix newlines poorly.
868
 
 
869
 
    examples:
870
 
        bzr diff
871
 
        bzr diff -r1
872
 
        bzr diff -r1:2
873
721
    """
874
722
    
875
723
    takes_args = ['file*']
887
735
                file_list = None
888
736
        else:
889
737
            b = find_branch('.')
 
738
    
 
739
        show_diff(b, revision, specific_files=file_list,
 
740
                  external_diff_options=diff_options)
890
741
 
891
 
        if revision is not None:
892
 
            if len(revision) == 1:
893
 
                show_diff(b, revision[0], specific_files=file_list,
894
 
                          external_diff_options=diff_options)
895
 
            elif len(revision) == 2:
896
 
                show_diff(b, revision[0], specific_files=file_list,
897
 
                          external_diff_options=diff_options,
898
 
                          revision2=revision[1])
899
 
            else:
900
 
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
901
 
        else:
902
 
            show_diff(b, None, specific_files=file_list,
903
 
                      external_diff_options=diff_options)
904
742
 
905
743
        
906
744
 
932
770
    """List files modified in working tree."""
933
771
    hidden = True
934
772
    def run(self):
935
 
        from bzrlib.delta import compare_trees
936
 
 
 
773
        import statcache
937
774
        b = find_branch('.')
938
 
        td = compare_trees(b.basis_tree(), b.working_tree())
 
775
        inv = b.read_working_inventory()
 
776
        sc = statcache.update_cache(b, inv)
 
777
        basis = b.basis_tree()
 
778
        basis_inv = basis.inventory
 
779
        
 
780
        # We used to do this through iter_entries(), but that's slow
 
781
        # when most of the files are unmodified, as is usually the
 
782
        # case.  So instead we iterate by inventory entry, and only
 
783
        # calculate paths as necessary.
939
784
 
940
 
        for path, id, kind in td.modified:
941
 
            print path
 
785
        for file_id in basis_inv:
 
786
            cacheentry = sc.get(file_id)
 
787
            if not cacheentry:                 # deleted
 
788
                continue
 
789
            ie = basis_inv[file_id]
 
790
            if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
 
791
                path = inv.id2path(file_id)
 
792
                print path
942
793
 
943
794
 
944
795
 
979
830
    -r revision requests a specific revision, -r :end or -r begin: are
980
831
    also valid.
981
832
 
982
 
    --message allows you to give a regular expression, which will be evaluated
983
 
    so that only matching entries will be displayed.
984
 
 
985
833
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
986
834
  
987
835
    """
988
836
 
989
837
    takes_args = ['filename?']
990
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
991
 
                     'long', 'message', 'short',]
 
838
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
992
839
    
993
840
    def run(self, filename=None, timezone='original',
994
841
            verbose=False,
995
842
            show_ids=False,
996
843
            forward=False,
997
844
            revision=None,
998
 
            message=None,
999
 
            long=False,
1000
 
            short=False):
 
845
            long=False):
1001
846
        from bzrlib.branch import find_branch
1002
847
        from bzrlib.log import log_formatter, show_log
1003
848
        import codecs
1015
860
            b = find_branch('.')
1016
861
            file_id = None
1017
862
 
1018
 
        if revision is None:
1019
 
            rev1 = None
1020
 
            rev2 = None
1021
 
        elif len(revision) == 1:
1022
 
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
1023
 
        elif len(revision) == 2:
1024
 
            rev1 = b.get_revision_info(revision[0])[0]
1025
 
            rev2 = b.get_revision_info(revision[1])[0]
 
863
        if revision == None:
 
864
            revision = [None, None]
 
865
        elif isinstance(revision, int):
 
866
            revision = [revision, revision]
1026
867
        else:
1027
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
1028
 
 
1029
 
        if rev1 == 0:
1030
 
            rev1 = None
1031
 
        if rev2 == 0:
1032
 
            rev2 = None
 
868
            # pair of revisions?
 
869
            pass
 
870
            
 
871
        assert len(revision) == 2
1033
872
 
1034
873
        mutter('encoding log as %r' % bzrlib.user_encoding)
1035
874
 
1037
876
        # in e.g. the default C locale.
1038
877
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1039
878
 
1040
 
        if not short:
 
879
        if long:
1041
880
            log_format = 'long'
1042
881
        else:
1043
882
            log_format = 'short'
1051
890
                 file_id,
1052
891
                 verbose=verbose,
1053
892
                 direction=direction,
1054
 
                 start_revision=rev1,
1055
 
                 end_revision=rev2,
1056
 
                 search=message)
 
893
                 start_revision=revision[0],
 
894
                 end_revision=revision[1])
1057
895
 
1058
896
 
1059
897
 
1204
1042
    If no revision is specified this exports the last committed revision.
1205
1043
 
1206
1044
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
1207
 
    given, try to find the format with the extension. If no extension
1208
 
    is found exports to a directory (equivalent to --format=dir).
1209
 
 
1210
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1211
 
    is given, the top directory will be the root name of the file."""
 
1045
    given, exports to a directory (equivalent to --format=dir)."""
1212
1046
    # TODO: list known exporters
1213
1047
    takes_args = ['dest']
1214
 
    takes_options = ['revision', 'format', 'root']
1215
 
    def run(self, dest, revision=None, format=None, root=None):
1216
 
        import os.path
 
1048
    takes_options = ['revision', 'format']
 
1049
    def run(self, dest, revision=None, format='dir'):
1217
1050
        b = find_branch('.')
1218
 
        if revision is None:
1219
 
            rev_id = b.last_patch()
 
1051
        if revision == None:
 
1052
            rh = b.revision_history()[-1]
1220
1053
        else:
1221
 
            if len(revision) != 1:
1222
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1223
 
            revno, rev_id = b.get_revision_info(revision[0])
1224
 
        t = b.revision_tree(rev_id)
1225
 
        root, ext = os.path.splitext(dest)
1226
 
        if not format:
1227
 
            if ext in (".tar",):
1228
 
                format = "tar"
1229
 
            elif ext in (".gz", ".tgz"):
1230
 
                format = "tgz"
1231
 
            elif ext in (".bz2", ".tbz2"):
1232
 
                format = "tbz2"
1233
 
            else:
1234
 
                format = "dir"
1235
 
        t.export(dest, format, root)
 
1054
            rh = b.lookup_revision(int(revision))
 
1055
        t = b.revision_tree(rh)
 
1056
        t.export(dest, format)
1236
1057
 
1237
1058
 
1238
1059
class cmd_cat(Command):
1244
1065
    def run(self, filename, revision=None):
1245
1066
        if revision == None:
1246
1067
            raise BzrCommandError("bzr cat requires a revision number")
1247
 
        elif len(revision) != 1:
1248
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1249
1068
        b = find_branch('.')
1250
 
        b.print_file(b.relpath(filename), revision[0])
 
1069
        b.print_file(b.relpath(filename), int(revision))
1251
1070
 
1252
1071
 
1253
1072
class cmd_local_time_offset(Command):
1260
1079
 
1261
1080
class cmd_commit(Command):
1262
1081
    """Commit changes into a new revision.
1263
 
    
1264
 
    If no arguments are given, the entire tree is committed.
1265
1082
 
1266
1083
    If selected files are specified, only changes to those files are
1267
 
    committed.  If a directory is specified then the directory and everything 
1268
 
    within it is committed.
 
1084
    committed.  If a directory is specified then its contents are also
 
1085
    committed.
1269
1086
 
1270
1087
    A selected-file commit may fail in some cases where the committed
1271
1088
    tree would be invalid, such as trying to commit a file in a
1276
1093
    TODO: Strict commit that fails if there are unknown or deleted files.
1277
1094
    """
1278
1095
    takes_args = ['selected*']
1279
 
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
1096
    takes_options = ['message', 'file', 'verbose']
1280
1097
    aliases = ['ci', 'checkin']
1281
1098
 
1282
 
    # TODO: Give better message for -s, --summary, used by tla people
1283
 
    
1284
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1285
 
            unchanged=False):
1286
 
        from bzrlib.errors import PointlessCommit
 
1099
    def run(self, message=None, file=None, verbose=True, selected_list=None):
 
1100
        from bzrlib.commit import commit
1287
1101
        from bzrlib.osutils import get_text_message
1288
1102
 
1289
1103
        ## Warning: shadows builtin file()
1290
1104
        if not message and not file:
1291
 
            # FIXME: Ugly; change status code to send to a provided function?
1292
 
            
1293
1105
            import cStringIO
1294
1106
            stdout = sys.stdout
1295
1107
            catcher = cStringIO.StringIO()
1310
1122
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1311
1123
 
1312
1124
        b = find_branch('.')
1313
 
        if selected_list:
1314
 
            selected_list = [b.relpath(s) for s in selected_list]
1315
 
            
1316
 
        try:
1317
 
            b.commit(message, verbose=verbose,
1318
 
                     specific_files=selected_list,
1319
 
                     allow_pointless=unchanged)
1320
 
        except PointlessCommit:
1321
 
            # FIXME: This should really happen before the file is read in;
1322
 
            # perhaps prepare the commit; get the message; then actually commit
1323
 
            raise BzrCommandError("no changes to commit",
1324
 
                                  ["use --unchanged to commit anyhow"])
 
1125
        commit(b, message, verbose=verbose, specific_files=selected_list)
1325
1126
 
1326
1127
 
1327
1128
class cmd_check(Command):
1341
1142
 
1342
1143
 
1343
1144
 
1344
 
class cmd_scan_cache(Command):
1345
 
    hidden = True
1346
 
    def run(self):
1347
 
        from bzrlib.hashcache import HashCache
1348
 
        import os
1349
 
 
1350
 
        c = HashCache('.')
1351
 
        c.read()
1352
 
        c.scan()
1353
 
            
1354
 
        print '%6d stats' % c.stat_count
1355
 
        print '%6d in hashcache' % len(c._cache)
1356
 
        print '%6d files removed from cache' % c.removed_count
1357
 
        print '%6d hashes updated' % c.update_count
1358
 
        print '%6d files changed too recently to cache' % c.danger_count
1359
 
 
1360
 
        if c.needs_write:
1361
 
            c.write()
1362
 
            
1363
 
 
1364
 
 
1365
1145
class cmd_upgrade(Command):
1366
1146
    """Upgrade branch storage to current format.
1367
1147
 
1390
1170
class cmd_selftest(Command):
1391
1171
    """Run internal test suite"""
1392
1172
    hidden = True
1393
 
    takes_options = ['verbose']
1394
 
    def run(self, verbose=False):
 
1173
    def run(self):
1395
1174
        from bzrlib.selftest import selftest
1396
 
        return int(not selftest(verbose=verbose))
 
1175
        return int(not selftest())
1397
1176
 
1398
1177
 
1399
1178
class cmd_version(Command):
1431
1210
    ['..', -1]
1432
1211
    >>> parse_spec("../f/@35")
1433
1212
    ['../f', 35]
1434
 
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1435
 
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1436
1213
    """
1437
1214
    if spec is None:
1438
1215
        return [None, None]
1442
1219
        if parsed[1] == "":
1443
1220
            parsed[1] = -1
1444
1221
        else:
1445
 
            try:
1446
 
                parsed[1] = int(parsed[1])
1447
 
            except ValueError:
1448
 
                pass # We can allow stuff like ./@revid:blahblahblah
1449
 
            else:
1450
 
                assert parsed[1] >=0
 
1222
            parsed[1] = int(parsed[1])
 
1223
            assert parsed[1] >=0
1451
1224
    else:
1452
1225
        parsed = [spec, None]
1453
1226
    return parsed
1455
1228
 
1456
1229
 
1457
1230
class cmd_merge(Command):
1458
 
    """Perform a three-way merge.
1459
 
    
1460
 
    The branch is the branch you will merge from.  By default, it will merge
1461
 
    the latest revision.  If you specify a revision, that revision will be
1462
 
    merged.  If you specify two revisions, the first will be used as a BASE, 
1463
 
    and the second one as OTHER.  Revision numbers are always relative to the
1464
 
    specified branch.
1465
 
    
1466
 
    Examples:
1467
 
 
1468
 
    To merge the latest revision from bzr.dev
1469
 
    bzr merge ../bzr.dev
1470
 
 
1471
 
    To merge changes up to and including revision 82 from bzr.dev
1472
 
    bzr merge -r 82 ../bzr.dev
1473
 
 
1474
 
    To merge the changes introduced by 82, without previous changes:
1475
 
    bzr merge -r 81..82 ../bzr.dev
1476
 
    
 
1231
    """Perform a three-way merge of trees.
 
1232
    
 
1233
    The SPEC parameters are working tree or revision specifiers.  Working trees
 
1234
    are specified using standard paths or urls.  No component of a directory
 
1235
    path may begin with '@'.
 
1236
    
 
1237
    Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
 
1238
 
 
1239
    Revisions are specified using a dirname/@revno pair, where dirname is the
 
1240
    branch directory and revno is the revision within that branch.  If no revno
 
1241
    is specified, the latest revision is used.
 
1242
 
 
1243
    Revision examples: './@127', 'foo/@', '../@1'
 
1244
 
 
1245
    The OTHER_SPEC parameter is required.  If the BASE_SPEC parameter is
 
1246
    not supplied, the common ancestor of OTHER_SPEC the current branch is used
 
1247
    as the BASE.
 
1248
 
1477
1249
    merge refuses to run if there are any uncommitted changes, unless
1478
1250
    --force is given.
1479
1251
    """
1480
 
    takes_args = ['branch?']
1481
 
    takes_options = ['revision', 'force', 'merge-type']
 
1252
    takes_args = ['other_spec', 'base_spec?']
 
1253
    takes_options = ['force']
1482
1254
 
1483
 
    def run(self, branch='.', revision=None, force=False, 
1484
 
            merge_type=None):
 
1255
    def run(self, other_spec, base_spec=None, force=False):
1485
1256
        from bzrlib.merge import merge
1486
 
        from bzrlib.merge_core import ApplyMerge3
1487
 
        if merge_type is None:
1488
 
            merge_type = ApplyMerge3
 
1257
        merge(parse_spec(other_spec), parse_spec(base_spec),
 
1258
              check_clean=(not force))
1489
1259
 
1490
 
        if revision is None or len(revision) < 1:
1491
 
            base = (None, None)
1492
 
            other = (branch, -1)
1493
 
        else:
1494
 
            if len(revision) == 1:
1495
 
                other = (branch, revision[0])
1496
 
                base = (None, None)
1497
 
            else:
1498
 
                assert len(revision) == 2
1499
 
                if None in revision:
1500
 
                    raise BzrCommandError(
1501
 
                        "Merge doesn't permit that revision specifier.")
1502
 
                base = (branch, revision[0])
1503
 
                other = (branch, revision[1])
1504
 
            
1505
 
        merge(other, base, check_clean=(not force), merge_type=merge_type)
1506
1260
 
1507
1261
 
1508
1262
class cmd_revert(Command):
 
1263
    """Restore selected files from a previous revision.
 
1264
    """
 
1265
    takes_args = ['file+']
 
1266
    def run(self, file_list):
 
1267
        from bzrlib.branch import find_branch
 
1268
        
 
1269
        if not file_list:
 
1270
            file_list = ['.']
 
1271
            
 
1272
        b = find_branch(file_list[0])
 
1273
 
 
1274
        b.revert([b.relpath(f) for f in file_list])
 
1275
 
 
1276
 
 
1277
class cmd_merge_revert(Command):
1509
1278
    """Reverse all changes since the last commit.
1510
1279
 
1511
 
    Only versioned files are affected.  Specify filenames to revert only 
1512
 
    those files.  By default, any files that are changed will be backed up
1513
 
    first.  Backup files have a '~' appended to their name.
 
1280
    Only versioned files are affected.
 
1281
 
 
1282
    TODO: Store backups of any files that will be reverted, so
 
1283
          that the revert can be undone.          
1514
1284
    """
1515
 
    takes_options = ['revision', 'no-backup']
1516
 
    takes_args = ['file*']
1517
 
    aliases = ['merge-revert']
 
1285
    takes_options = ['revision']
1518
1286
 
1519
 
    def run(self, revision=None, no_backup=False, file_list=None):
 
1287
    def run(self, revision=-1):
1520
1288
        from bzrlib.merge import merge
1521
 
        if file_list is not None:
1522
 
            if len(file_list) == 0:
1523
 
                raise BzrCommandError("No files specified")
1524
 
        if revision is None:
1525
 
            revision = [-1]
1526
 
        elif len(revision) != 1:
1527
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1528
 
        merge(('.', revision[0]), parse_spec('.'),
 
1289
        merge(('.', revision), parse_spec('.'),
1529
1290
              check_clean=False,
1530
 
              ignore_zero=True,
1531
 
              backup_files=not no_backup,
1532
 
              file_list=file_list)
 
1291
              ignore_zero=True)
1533
1292
 
1534
1293
 
1535
1294
class cmd_assert_fail(Command):
1551
1310
        help.help(topic)
1552
1311
 
1553
1312
 
1554
 
 
1555
 
 
1556
 
class cmd_missing(Command):
1557
 
    """What is missing in this branch relative to other branch.
1558
 
    """
1559
 
    takes_args = ['remote?']
1560
 
    aliases = ['mis', 'miss']
1561
 
    # We don't have to add quiet to the list, because 
1562
 
    # unknown options are parsed as booleans
1563
 
    takes_options = ['verbose', 'quiet']
1564
 
 
1565
 
    def run(self, remote=None, verbose=False, quiet=False):
1566
 
        from bzrlib.branch import find_branch, DivergedBranches
1567
 
        from bzrlib.errors import BzrCommandError
1568
 
        from bzrlib.missing import get_parent, show_missing
1569
 
 
1570
 
        if verbose and quiet:
1571
 
            raise BzrCommandError('Cannot pass both quiet and verbose')
1572
 
 
 
1313
class cmd_update_stat_cache(Command):
 
1314
    """Update stat-cache mapping inodes to SHA-1 hashes.
 
1315
 
 
1316
    For testing only."""
 
1317
    hidden = True
 
1318
    def run(self):
 
1319
        import statcache
1573
1320
        b = find_branch('.')
1574
 
        parent = get_parent(b)
1575
 
        if remote is None:
1576
 
            if parent is None:
1577
 
                raise BzrCommandError("No missing location known or specified.")
1578
 
            else:
1579
 
                if not quiet:
1580
 
                    print "Using last location: %s" % parent
1581
 
                remote = parent
1582
 
        elif parent is None:
1583
 
            # We only update x-pull if it did not exist, missing should not change the parent
1584
 
            b.controlfile('x-pull', 'wb').write(remote + '\n')
1585
 
        br_remote = find_branch(remote)
 
1321
        statcache.update_cache(b.base, b.read_working_inventory())
1586
1322
 
1587
 
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1588
1323
 
1589
1324
 
1590
1325
class cmd_plugins(Command):
1592
1327
    hidden = True
1593
1328
    def run(self):
1594
1329
        import bzrlib.plugin
1595
 
        from inspect import getdoc
1596
1330
        from pprint import pprint
1597
 
        for plugin in bzrlib.plugin.all_plugins:
1598
 
            print plugin.__path__[0]
1599
 
            d = getdoc(plugin)
1600
 
            if d:
1601
 
                print '\t', d.split('\n')[0]
1602
 
 
1603
 
        #pprint(bzrlib.plugin.all_plugins)
 
1331
        pprint(bzrlib.plugin.all_plugins)
1604
1332
 
1605
1333
 
1606
1334
 
1619
1347
    'no-recurse':             None,
1620
1348
    'profile':                None,
1621
1349
    'revision':               _parse_revision_str,
1622
 
    'short':                  None,
1623
1350
    'show-ids':               None,
1624
1351
    'timezone':               str,
1625
1352
    'verbose':                None,
1626
1353
    'version':                None,
1627
1354
    'email':                  None,
1628
 
    'unchanged':              None,
1629
1355
    'update':                 None,
1630
1356
    'long':                   None,
1631
 
    'root':                   str,
1632
 
    'no-backup':              None,
1633
 
    'merge-type':             get_merge_type,
1634
1357
    }
1635
1358
 
1636
1359
SHORT_OPTIONS = {
1660
1383
    >>> parse_args('commit --message=biter'.split())
1661
1384
    (['commit'], {'message': u'biter'})
1662
1385
    >>> parse_args('log -r 500'.split())
1663
 
    (['log'], {'revision': [500]})
1664
 
    >>> parse_args('log -r500..600'.split())
 
1386
    (['log'], {'revision': 500})
 
1387
    >>> parse_args('log -r500:600'.split())
1665
1388
    (['log'], {'revision': [500, 600]})
1666
 
    >>> parse_args('log -vr500..600'.split())
 
1389
    >>> parse_args('log -vr500:600'.split())
1667
1390
    (['log'], {'verbose': True, 'revision': [500, 600]})
1668
 
    >>> parse_args('log -rv500..600'.split()) #the r takes an argument
1669
 
    (['log'], {'revision': ['v500', 600]})
 
1391
    >>> parse_args('log -rv500:600'.split()) #the r takes an argument
 
1392
    Traceback (most recent call last):
 
1393
    ...
 
1394
    ValueError: invalid literal for int(): v500
1670
1395
    """
1671
1396
    args = []
1672
1397
    opts = {}
1786
1511
    return argdict
1787
1512
 
1788
1513
 
 
1514
def _parse_master_args(argv):
 
1515
    """Parse the arguments that always go with the original command.
 
1516
    These are things like bzr --no-plugins, etc.
 
1517
 
 
1518
    There are now 2 types of option flags. Ones that come *before* the command,
 
1519
    and ones that come *after* the command.
 
1520
    Ones coming *before* the command are applied against all possible commands.
 
1521
    And are generally applied before plugins are loaded.
 
1522
 
 
1523
    The current list are:
 
1524
        --builtin   Allow plugins to load, but don't let them override builtin commands,
 
1525
                    they will still be allowed if they do not override a builtin.
 
1526
        --no-plugins    Don't load any plugins. This lets you get back to official source
 
1527
                        behavior.
 
1528
        --profile   Enable the hotspot profile before running the command.
 
1529
                    For backwards compatibility, this is also a non-master option.
 
1530
        --version   Spit out the version of bzr that is running and exit.
 
1531
                    This is also a non-master option.
 
1532
        --help      Run help and exit, also a non-master option (I think that should stay, though)
 
1533
 
 
1534
    >>> argv, opts = _parse_master_args(['bzr', '--test'])
 
1535
    Traceback (most recent call last):
 
1536
    ...
 
1537
    BzrCommandError: Invalid master option: 'test'
 
1538
    >>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
 
1539
    >>> print argv
 
1540
    ['command']
 
1541
    >>> print opts['version']
 
1542
    True
 
1543
    >>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
 
1544
    >>> print argv
 
1545
    ['command', '--more-options']
 
1546
    >>> print opts['profile']
 
1547
    True
 
1548
    >>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
 
1549
    >>> print argv
 
1550
    ['command']
 
1551
    >>> print opts['no-plugins']
 
1552
    True
 
1553
    >>> print opts['profile']
 
1554
    False
 
1555
    >>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
 
1556
    >>> print argv
 
1557
    ['command', '--profile']
 
1558
    >>> print opts['profile']
 
1559
    False
 
1560
    """
 
1561
    master_opts = {'builtin':False,
 
1562
        'no-plugins':False,
 
1563
        'version':False,
 
1564
        'profile':False,
 
1565
        'help':False
 
1566
    }
 
1567
 
 
1568
    # This is the point where we could hook into argv[0] to determine
 
1569
    # what front-end is supposed to be run
 
1570
    # For now, we are just ignoring it.
 
1571
    cmd_name = argv.pop(0)
 
1572
    for arg in argv[:]:
 
1573
        if arg[:2] != '--': # at the first non-option, we return the rest
 
1574
            break
 
1575
        arg = arg[2:] # Remove '--'
 
1576
        if arg not in master_opts:
 
1577
            # We could say that this is not an error, that we should
 
1578
            # just let it be handled by the main section instead
 
1579
            raise BzrCommandError('Invalid master option: %r' % arg)
 
1580
        argv.pop(0) # We are consuming this entry
 
1581
        master_opts[arg] = True
 
1582
    return argv, master_opts
 
1583
 
 
1584
 
1789
1585
 
1790
1586
def run_bzr(argv):
1791
1587
    """Execute a command.
1792
1588
 
1793
1589
    This is similar to main(), but without all the trappings for
1794
1590
    logging and error handling.  
1795
 
    
1796
 
    argv
1797
 
       The command-line arguments, without the program name from argv[0]
1798
 
    
1799
 
    Returns a command status or raises an exception.
1800
 
 
1801
 
    Special master options: these must come before the command because
1802
 
    they control how the command is interpreted.
1803
 
 
1804
 
    --no-plugins
1805
 
        Do not load plugin modules at all
1806
 
 
1807
 
    --builtin
1808
 
        Only use builtin commands.  (Plugins are still allowed to change
1809
 
        other behaviour.)
1810
 
 
1811
 
    --profile
1812
 
        Run under the Python profiler.
1813
1591
    """
1814
 
    
1815
1592
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
1816
 
 
1817
 
    opt_profile = opt_no_plugins = opt_builtin = False
1818
 
 
1819
 
    # --no-plugins is handled specially at a very early stage. We need
1820
 
    # to load plugins before doing other command parsing so that they
1821
 
    # can override commands, but this needs to happen first.
1822
 
 
1823
 
    for a in argv[:]:
1824
 
        if a == '--profile':
1825
 
            opt_profile = True
1826
 
        elif a == '--no-plugins':
1827
 
            opt_no_plugins = True
1828
 
        elif a == '--builtin':
1829
 
            opt_builtin = True
1830
 
        else:
1831
 
            break
1832
 
        argv.remove(a)
1833
 
 
1834
 
    if not opt_no_plugins:
1835
 
        from bzrlib.plugin import load_plugins
1836
 
        load_plugins()
1837
 
 
1838
 
    args, opts = parse_args(argv)
1839
 
 
1840
 
    if 'help' in opts:
1841
 
        from bzrlib.help import help
1842
 
        if args:
1843
 
            help(args[0])
1844
 
        else:
1845
 
            help()
1846
 
        return 0            
1847
 
        
1848
 
    if 'version' in opts:
1849
 
        show_version()
1850
 
        return 0
1851
1593
    
1852
 
    if not args:
1853
 
        print >>sys.stderr, "please try 'bzr help' for help"
 
1594
    try:
 
1595
        # some options like --builtin and --no-plugins have special effects
 
1596
        argv, master_opts = _parse_master_args(argv)
 
1597
        if not master_opts['no-plugins']:
 
1598
            from bzrlib.plugin import load_plugins
 
1599
            load_plugins()
 
1600
 
 
1601
        args, opts = parse_args(argv)
 
1602
 
 
1603
        if master_opts['help']:
 
1604
            from bzrlib.help import help
 
1605
            if argv:
 
1606
                help(argv[0])
 
1607
            else:
 
1608
                help()
 
1609
            return 0            
 
1610
            
 
1611
        if 'help' in opts:
 
1612
            from bzrlib.help import help
 
1613
            if args:
 
1614
                help(args[0])
 
1615
            else:
 
1616
                help()
 
1617
            return 0
 
1618
        elif 'version' in opts:
 
1619
            show_version()
 
1620
            return 0
 
1621
        elif args and args[0] == 'builtin':
 
1622
            include_plugins=False
 
1623
            args = args[1:]
 
1624
        cmd = str(args.pop(0))
 
1625
    except IndexError:
 
1626
        import help
 
1627
        help.help()
1854
1628
        return 1
1855
 
    
1856
 
    cmd = str(args.pop(0))
1857
 
 
1858
 
    canonical_cmd, cmd_class = \
1859
 
                   get_cmd_class(cmd, plugins_override=not opt_builtin)
 
1629
          
 
1630
 
 
1631
    plugins_override = not (master_opts['builtin'])
 
1632
    canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
 
1633
 
 
1634
    profile = master_opts['profile']
 
1635
    # For backwards compatibility, I would rather stick with --profile being a
 
1636
    # master/global option
 
1637
    if 'profile' in opts:
 
1638
        profile = True
 
1639
        del opts['profile']
1860
1640
 
1861
1641
    # check options are reasonable
1862
1642
    allowed = cmd_class.takes_options
1871
1651
    for k, v in opts.items():
1872
1652
        cmdopts[k.replace('-', '_')] = v
1873
1653
 
1874
 
    if opt_profile:
 
1654
    if profile:
1875
1655
        import hotshot, tempfile
1876
1656
        pffileno, pfname = tempfile.mkstemp()
1877
1657
        try:
1898
1678
 
1899
1679
def _report_exception(summary, quiet=False):
1900
1680
    import traceback
1901
 
    
1902
1681
    log_error('bzr: ' + summary)
1903
1682
    bzrlib.trace.log_exception()
1904
1683
 
1905
 
    if os.environ.get('BZR_DEBUG'):
1906
 
        traceback.print_exc()
1907
 
 
1908
1684
    if not quiet:
1909
 
        sys.stderr.write('\n')
1910
1685
        tb = sys.exc_info()[2]
1911
1686
        exinfo = traceback.extract_tb(tb)
1912
1687
        if exinfo:
1922
1697
    try:
1923
1698
        try:
1924
1699
            try:
1925
 
                return run_bzr(argv[1:])
 
1700
                return run_bzr(argv)
1926
1701
            finally:
1927
1702
                # do this here inside the exception wrappers to catch EPIPE
1928
1703
                sys.stdout.flush()
1929
1704
        except BzrError, e:
1930
1705
            quiet = isinstance(e, (BzrCommandError))
1931
 
            _report_exception('error: ' + str(e), quiet=quiet)
 
1706
            _report_exception('error: ' + e.args[0], quiet=quiet)
1932
1707
            if len(e.args) > 1:
1933
1708
                for h in e.args[1]:
1934
1709
                    # some explanation or hints