~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Alexander Belchenko
  • Date: 2007-10-26 21:49:15 UTC
  • mto: (2947.4.2 0.92)
  • mto: This revision was merged to the branch mainline in revision 2971.
  • Revision ID: bialix@ukr.net-20071026214915-5eacqh9k2ps6jagj
windows python-based installer: shortcut for uninstall action

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
# TODO: probably should say which arguments are candidates for glob
35
35
lazy_import(globals(), """
36
36
import codecs
37
37
import errno
38
 
import threading
39
38
from warnings import warn
40
39
 
41
40
import bzrlib
42
41
from bzrlib import (
43
 
    cleanup,
44
42
    debug,
45
43
    errors,
46
44
    option,
47
45
    osutils,
48
46
    trace,
49
 
    ui,
50
47
    win32utils,
51
48
    )
52
49
""")
53
50
 
54
 
from bzrlib.hooks import HookPoint, Hooks
55
 
# Compatibility - Option used to be in commands.
56
 
from bzrlib.option import Option
57
 
from bzrlib import registry
58
51
from bzrlib.symbol_versioning import (
59
52
    deprecated_function,
60
 
    deprecated_in,
61
53
    deprecated_method,
62
 
    suppress_deprecation_warnings,
63
54
    )
64
 
 
65
 
 
66
 
class CommandInfo(object):
67
 
    """Information about a command."""
68
 
 
69
 
    def __init__(self, aliases):
70
 
        """The list of aliases for the command."""
71
 
        self.aliases = aliases
72
 
 
73
 
    @classmethod
74
 
    def from_command(klass, command):
75
 
        """Factory to construct a CommandInfo from a command."""
76
 
        return klass(command.aliases)
77
 
 
78
 
 
79
 
class CommandRegistry(registry.Registry):
80
 
 
81
 
    @staticmethod
82
 
    def _get_name(command_name):
83
 
        if command_name.startswith("cmd_"):
84
 
            return _unsquish_command_name(command_name)
85
 
        else:
86
 
            return command_name
87
 
 
88
 
    def register(self, cmd, decorate=False):
89
 
        """Utility function to help register a command
90
 
 
91
 
        :param cmd: Command subclass to register
92
 
        :param decorate: If true, allow overriding an existing command
93
 
            of the same name; the old command is returned by this function.
94
 
            Otherwise it is an error to try to override an existing command.
95
 
        """
96
 
        k = cmd.__name__
97
 
        k_unsquished = self._get_name(k)
98
 
        try:
99
 
            previous = self.get(k_unsquished)
100
 
        except KeyError:
101
 
            previous = _builtin_commands().get(k_unsquished)
102
 
        info = CommandInfo.from_command(cmd)
103
 
        try:
104
 
            registry.Registry.register(self, k_unsquished, cmd,
105
 
                                       override_existing=decorate, info=info)
106
 
        except KeyError:
107
 
            trace.warning('Two plugins defined the same command: %r' % k)
108
 
            trace.warning('Not loading the one in %r' %
109
 
                sys.modules[cmd.__module__])
110
 
            trace.warning('Previously this command was registered from %r' %
111
 
                sys.modules[previous.__module__])
112
 
        return previous
113
 
 
114
 
    def register_lazy(self, command_name, aliases, module_name):
115
 
        """Register a command without loading its module.
116
 
 
117
 
        :param command_name: The primary name of the command.
118
 
        :param aliases: A list of aliases for the command.
119
 
        :module_name: The module that the command lives in.
120
 
        """
121
 
        key = self._get_name(command_name)
122
 
        registry.Registry.register_lazy(self, key, module_name, command_name,
123
 
                                        info=CommandInfo(aliases))
124
 
 
125
 
 
126
 
plugin_cmds = CommandRegistry()
 
55
# Compatibility
 
56
from bzrlib.option import Option
 
57
 
 
58
 
 
59
plugin_cmds = {}
127
60
 
128
61
 
129
62
def register_command(cmd, decorate=False):
 
63
    """Utility function to help register a command
 
64
 
 
65
    :param cmd: Command subclass to register
 
66
    :param decorate: If true, allow overriding an existing command
 
67
        of the same name; the old command is returned by this function.
 
68
        Otherwise it is an error to try to override an existing command.
 
69
    """
130
70
    global plugin_cmds
131
 
    return plugin_cmds.register(cmd, decorate)
 
71
    k = cmd.__name__
 
72
    if k.startswith("cmd_"):
 
73
        k_unsquished = _unsquish_command_name(k)
 
74
    else:
 
75
        k_unsquished = k
 
76
    if k_unsquished not in plugin_cmds:
 
77
        plugin_cmds[k_unsquished] = cmd
 
78
        ## trace.mutter('registered plugin command %s', k_unsquished)
 
79
        if decorate and k_unsquished in builtin_command_names():
 
80
            return _builtin_commands()[k_unsquished]
 
81
    elif decorate:
 
82
        result = plugin_cmds[k_unsquished]
 
83
        plugin_cmds[k_unsquished] = cmd
 
84
        return result
 
85
    else:
 
86
        trace.log_error('Two plugins defined the same command: %r' % k)
 
87
        trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
88
        trace.log_error('Previously this command was registered from %r' %
 
89
                        sys.modules[plugin_cmds[k_unsquished].__module__])
132
90
 
133
91
 
134
92
def _squish_command_name(cmd):
136
94
 
137
95
 
138
96
def _unsquish_command_name(cmd):
 
97
    assert cmd.startswith("cmd_")
139
98
    return cmd[4:].replace('_','-')
140
99
 
141
100
 
142
101
def _builtin_commands():
143
102
    import bzrlib.builtins
144
 
    return _scan_module_for_commands(bzrlib.builtins)
145
 
 
146
 
 
147
 
def _scan_module_for_commands(module):
148
103
    r = {}
149
 
    for name, obj in module.__dict__.iteritems():
 
104
    builtins = bzrlib.builtins.__dict__
 
105
    for name in builtins:
150
106
        if name.startswith("cmd_"):
151
107
            real_name = _unsquish_command_name(name)
152
 
            r[real_name] = obj
 
108
            r[real_name] = builtins[name]
153
109
    return r
154
 
 
155
 
 
156
 
def _list_bzr_commands(names):
157
 
    """Find commands from bzr's core and plugins."""
158
 
    # to eliminate duplicates
159
 
    names.update(builtin_command_names())
160
 
    names.update(plugin_command_names())
161
 
    return names
162
 
 
163
 
 
164
 
def all_command_names():
165
 
    """Return a set of all command names."""
166
 
    names = set()
167
 
    for hook in Command.hooks['list_commands']:
168
 
        names = hook(names)
169
 
        if names is None:
170
 
            raise AssertionError(
171
 
                'hook %s returned None' % Command.hooks.get_hook_name(hook))
172
 
    return names
173
 
 
 
110
            
174
111
 
175
112
def builtin_command_names():
176
 
    """Return list of builtin command names.
177
 
    
178
 
    Use of all_command_names() is encouraged rather than builtin_command_names
179
 
    and/or plugin_command_names.
180
 
    """
 
113
    """Return list of builtin command names."""
181
114
    return _builtin_commands().keys()
182
 
 
 
115
    
183
116
 
184
117
def plugin_command_names():
185
 
    """Returns command names from commands registered by plugins."""
186
118
    return plugin_cmds.keys()
187
119
 
188
120
 
189
 
@deprecated_function(deprecated_in((1, 17, 0)))
190
 
def get_all_cmds(plugins_override=False):
191
 
    """Return canonical name and class for most commands.
192
 
    
193
 
    NB: This does not return all commands since the introduction of
194
 
    command hooks, and returning the class is not sufficient to 
195
 
    get correctly setup commands, which is why it is deprecated.
196
 
 
197
 
    Use 'all_command_names' + 'get_cmd_object' instead.
198
 
    """
 
121
def _get_cmd_dict(plugins_override=True):
 
122
    """Return name->class mapping for all commands."""
199
123
    d = _builtin_commands()
200
124
    if plugins_override:
201
 
        d.update(plugin_cmds.iteritems())
202
 
    for k, v in d.iteritems():
 
125
        d.update(plugin_cmds)
 
126
    return d
 
127
 
 
128
    
 
129
def get_all_cmds(plugins_override=True):
 
130
    """Return canonical name and class for all registered commands."""
 
131
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
203
132
        yield k,v
204
133
 
205
134
 
206
135
def get_cmd_object(cmd_name, plugins_override=True):
207
 
    """Return the command object for a command.
 
136
    """Return the canonical name and command class for a command.
208
137
 
209
138
    plugins_override
210
139
        If true, plugin commands can override builtins.
216
145
 
217
146
 
218
147
def _get_cmd_object(cmd_name, plugins_override=True):
219
 
    """Get a command object.
 
148
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
 
149
    from bzrlib.externalcommand import ExternalCommand
220
150
 
221
 
    :param cmd_name: The name of the command.
222
 
    :param plugins_override: Allow plugins to override builtins.
223
 
    :return: A Command object instance
224
 
    :raises KeyError: If no command is found.
225
 
    """
226
151
    # We want only 'ascii' command names, but the user may have typed
227
152
    # in a Unicode name. In that case, they should just get a
228
153
    # 'command not found' error later.
229
154
    # In the future, we may actually support Unicode command names.
230
 
    cmd = None
231
 
    # Get a command
232
 
    for hook in Command.hooks['get_command']:
233
 
        cmd = hook(cmd, cmd_name)
234
 
        if cmd is not None and not plugins_override and not cmd.plugin_name():
235
 
            # We've found a non-plugin command, don't permit it to be
236
 
            # overridden.
237
 
            break
238
 
    if cmd is None:
239
 
        for hook in Command.hooks['get_missing_command']:
240
 
            cmd = hook(cmd_name)
241
 
            if cmd is not None:
242
 
                break
243
 
    if cmd is None:
244
 
        # No command found.
245
 
        raise KeyError
246
 
    # Allow plugins to extend commands
247
 
    for hook in Command.hooks['extend_command']:
248
 
        hook(cmd)
249
 
    return cmd
250
 
 
251
 
 
252
 
def _try_plugin_provider(cmd_name):
253
 
    """Probe for a plugin provider having cmd_name."""
254
 
    try:
255
 
        plugin_metadata, provider = probe_for_provider(cmd_name)
256
 
        raise errors.CommandAvailableInPlugin(cmd_name,
257
 
            plugin_metadata, provider)
258
 
    except errors.NoPluginAvailable:
259
 
        pass
260
 
 
261
 
 
262
 
def probe_for_provider(cmd_name):
263
 
    """Look for a provider for cmd_name.
264
 
 
265
 
    :param cmd_name: The command name.
266
 
    :return: plugin_metadata, provider for getting cmd_name.
267
 
    :raises NoPluginAvailable: When no provider can supply the plugin.
268
 
    """
269
 
    # look for providers that provide this command but aren't installed
270
 
    for provider in command_providers_registry:
271
 
        try:
272
 
            return provider.plugin_for_command(cmd_name), provider
273
 
        except errors.NoPluginAvailable:
274
 
            pass
275
 
    raise errors.NoPluginAvailable(cmd_name)
276
 
 
277
 
 
278
 
def _get_bzr_command(cmd_or_None, cmd_name):
279
 
    """Get a command from bzr's core."""
280
 
    cmds = _builtin_commands()
 
155
 
 
156
    # first look up this command under the specified name
 
157
    cmds = _get_cmd_dict(plugins_override=plugins_override)
281
158
    try:
282
159
        return cmds[cmd_name]()
283
160
    except KeyError:
284
161
        pass
 
162
 
285
163
    # look for any command which claims this as an alias
286
164
    for real_cmd_name, cmd_class in cmds.iteritems():
287
165
        if cmd_name in cmd_class.aliases:
288
166
            return cmd_class()
289
 
    return cmd_or_None
290
 
 
291
 
 
292
 
def _get_external_command(cmd_or_None, cmd_name):
293
 
    """Lookup a command that is a shell script."""
294
 
    # Only do external command lookups when no command is found so far.
295
 
    if cmd_or_None is not None:
296
 
        return cmd_or_None
297
 
    from bzrlib.externalcommand import ExternalCommand
 
167
 
298
168
    cmd_obj = ExternalCommand.find_command(cmd_name)
299
169
    if cmd_obj:
300
170
        return cmd_obj
301
 
 
302
 
 
303
 
def _get_plugin_command(cmd_or_None, cmd_name):
304
 
    """Get a command from bzr's plugins."""
305
 
    try:
306
 
        return plugin_cmds.get(cmd_name)()
307
 
    except KeyError:
308
 
        pass
309
 
    for key in plugin_cmds.keys():
310
 
        info = plugin_cmds.get_info(key)
311
 
        if cmd_name in info.aliases:
312
 
            return plugin_cmds.get(key)()
313
 
    return cmd_or_None
 
171
    raise KeyError
314
172
 
315
173
 
316
174
class Command(object):
370
228
            sys.stdout is forced to be a binary stream, and line-endings
371
229
            will not mangled.
372
230
 
373
 
    :cvar hooks: An instance of CommandHooks.
374
231
    """
375
232
    aliases = []
376
233
    takes_args = []
378
235
    encoding_type = 'strict'
379
236
 
380
237
    hidden = False
381
 
 
 
238
    
382
239
    def __init__(self):
383
240
        """Construct an instance of this command."""
384
241
        if self.__doc__ == Command.__doc__:
385
242
            warn("No help message set for %r" % self)
386
243
        # List of standard options directly supported
387
244
        self.supported_std_options = []
388
 
        self._operation = cleanup.OperationWithCleanups(self.run)
389
 
    
390
 
    def add_cleanup(self, cleanup_func, *args, **kwargs):
391
 
        """Register a function to call after self.run returns or raises.
392
 
 
393
 
        Functions will be called in LIFO order.
394
 
        """
395
 
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
396
 
 
397
 
    def cleanup_now(self):
398
 
        """Execute and empty pending cleanup functions immediately.
399
 
 
400
 
        After cleanup_now all registered cleanups are forgotten.  add_cleanup
401
 
        may be called again after cleanup_now; these cleanups will be called
402
 
        after self.run returns or raises (or when cleanup_now is next called).
403
 
 
404
 
        This is useful for releasing expensive or contentious resources (such
405
 
        as write locks) before doing further work that does not require those
406
 
        resources (such as writing results to self.outf).
407
 
        """
408
 
        self._operation.cleanup_now()
409
 
        
410
 
    @deprecated_method(deprecated_in((2, 1, 0)))
 
245
 
411
246
    def _maybe_expand_globs(self, file_list):
412
247
        """Glob expand file_list if the platform does not do that itself.
413
 
 
414
 
        Not used anymore, now that the bzr command-line parser globs on
415
 
        Windows.
416
 
 
 
248
        
417
249
        :return: A possibly empty list of unicode paths.
418
250
 
419
251
        Introduced in bzrlib 0.18.
420
252
        """
421
 
        return file_list
 
253
        if not file_list:
 
254
            file_list = []
 
255
        if sys.platform == 'win32':
 
256
            file_list = win32utils.glob_expand(file_list)
 
257
        return list(file_list)
422
258
 
423
259
    def _usage(self):
424
260
        """Return single-line grammar for this command.
435
271
            elif aname[-1] == '*':
436
272
                aname = '[' + aname[:-1] + '...]'
437
273
            s += aname + ' '
438
 
        s = s[:-1]      # remove last space
 
274
                
 
275
        assert s[-1] == ' '
 
276
        s = s[:-1]
439
277
        return s
440
278
 
441
279
    def get_help_text(self, additional_see_also=None, plain=True,
442
 
                      see_also_as_links=False, verbose=True):
 
280
                      see_also_as_links=False):
443
281
        """Return a text string with help for this command.
444
 
 
 
282
        
445
283
        :param additional_see_also: Additional help topics to be
446
284
            cross-referenced.
447
285
        :param plain: if False, raw help (reStructuredText) is
448
286
            returned instead of plain text.
449
287
        :param see_also_as_links: if True, convert items in 'See also'
450
288
            list to internal links (used by bzr_man rstx generator)
451
 
        :param verbose: if True, display the full help, otherwise
452
 
            leave out the descriptive sections and just display
453
 
            usage help (e.g. Purpose, Usage, Options) with a
454
 
            message explaining how to obtain full help.
455
289
        """
456
290
        doc = self.help()
457
291
        if doc is None:
458
292
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
459
293
 
460
294
        # Extract the summary (purpose) and sections out from the text
461
 
        purpose,sections,order = self._get_help_parts(doc)
 
295
        purpose,sections = self._get_help_parts(doc)
462
296
 
463
297
        # If a custom usage section was provided, use it
464
298
        if sections.has_key('Usage'):
476
310
        result += '\n'
477
311
 
478
312
        # Add the options
479
 
        #
480
 
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
481
 
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
482
 
        # 20090319
483
313
        options = option.get_optparser(self.options()).format_option_help()
484
 
        # XXX: According to the spec, ReST option lists actually don't support 
485
 
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
486
 
        # As that pattern always appears in the commands that break, we trap
487
 
        # on that and then format that block of 'format' options as a literal
488
 
        # block.
489
 
        if not plain and options.find('  --1.9  ') != -1:
490
 
            options = options.replace(' format:\n', ' format::\n\n', 1)
491
314
        if options.startswith('Options:'):
492
315
            result += ':' + options
493
316
        elif options.startswith('options:'):
497
320
            result += options
498
321
        result += '\n'
499
322
 
500
 
        if verbose:
501
 
            # Add the description, indenting it 2 spaces
502
 
            # to match the indentation of the options
503
 
            if sections.has_key(None):
504
 
                text = sections.pop(None)
505
 
                text = '\n  '.join(text.splitlines())
506
 
                result += ':%s:\n  %s\n\n' % ('Description',text)
 
323
        # Add the description, indenting it 2 spaces
 
324
        # to match the indentation of the options
 
325
        if sections.has_key(None):
 
326
            text = sections.pop(None)
 
327
            text = '\n  '.join(text.splitlines())
 
328
            result += ':%s:\n  %s\n\n' % ('Description',text)
507
329
 
508
 
            # Add the custom sections (e.g. Examples). Note that there's no need
509
 
            # to indent these as they must be indented already in the source.
510
 
            if sections:
511
 
                for label in order:
512
 
                    if sections.has_key(label):
513
 
                        result += ':%s:\n%s\n' % (label,sections[label])
514
 
                result += '\n'
515
 
        else:
516
 
            result += ("See bzr help %s for more details and examples.\n\n"
517
 
                % self.name())
 
330
        # Add the custom sections (e.g. Examples). Note that there's no need
 
331
        # to indent these as they must be indented already in the source.
 
332
        if sections:
 
333
            labels = sorted(sections.keys())
 
334
            for label in labels:
 
335
                result += ':%s:\n%s\n\n' % (label,sections[label])
518
336
 
519
337
        # Add the aliases, source (plug-in) and see also links, if any
520
338
        if self.aliases:
533
351
                        # so don't create a real link
534
352
                        see_also_links.append(item)
535
353
                    else:
536
 
                        # Use a Sphinx link for this entry
537
 
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
538
 
                        see_also_links.append(link_text)
 
354
                        # Use a reST link for this entry
 
355
                        see_also_links.append("`%s`_" % (item,))
539
356
                see_also = see_also_links
540
357
            result += ':See also: '
541
358
            result += ', '.join(see_also) + '\n'
542
359
 
543
 
        # If this will be rendered as plain text, convert it
 
360
        # If this will be rendered as plan text, convert it
544
361
        if plain:
545
362
            import bzrlib.help_topics
546
363
            result = bzrlib.help_topics.help_as_plain_text(result)
550
367
    def _get_help_parts(text):
551
368
        """Split help text into a summary and named sections.
552
369
 
553
 
        :return: (summary,sections,order) where summary is the top line and
 
370
        :return: (summary,sections) where summary is the top line and
554
371
            sections is a dictionary of the rest indexed by section name.
555
 
            order is the order the section appear in the text.
556
372
            A section starts with a heading line of the form ":xxx:".
557
373
            Indented text on following lines is the section value.
558
374
            All text found outside a named section is assigned to the
559
375
            default section which is given the key of None.
560
376
        """
561
 
        def save_section(sections, order, label, section):
 
377
        def save_section(sections, label, section):
562
378
            if len(section) > 0:
563
379
                if sections.has_key(label):
564
380
                    sections[label] += '\n' + section
565
381
                else:
566
 
                    order.append(label)
567
382
                    sections[label] = section
568
 
 
 
383
            
569
384
        lines = text.rstrip().splitlines()
570
385
        summary = lines.pop(0)
571
386
        sections = {}
572
 
        order = []
573
387
        label,section = None,''
574
388
        for line in lines:
575
389
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
576
 
                save_section(sections, order, label, section)
 
390
                save_section(sections, label, section)
577
391
                label,section = line[1:-1],''
578
 
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
579
 
                save_section(sections, order, label, section)
 
392
            elif label != None and len(line) > 1 and not line[0].isspace():
 
393
                save_section(sections, label, section)
580
394
                label,section = None,line
581
395
            else:
582
396
                if len(section) > 0:
583
397
                    section += '\n' + line
584
398
                else:
585
399
                    section = line
586
 
        save_section(sections, order, label, section)
587
 
        return summary, sections, order
 
400
        save_section(sections, label, section)
 
401
        return summary, sections
588
402
 
589
403
    def get_help_topic(self):
590
404
        """Return the commands help topic - its name."""
592
406
 
593
407
    def get_see_also(self, additional_terms=None):
594
408
        """Return a list of help topics that are related to this command.
595
 
 
 
409
        
596
410
        The list is derived from the content of the _see_also attribute. Any
597
411
        duplicates are removed and the result is in lexical order.
598
412
        :param additional_terms: Additional help topics to cross-reference.
619
433
 
620
434
    def _setup_outf(self):
621
435
        """Return a file linked to stdout, which has proper encoding."""
622
 
        self.outf = ui.ui_factory.make_output_stream(
623
 
            encoding_type=self.encoding_type)
 
436
        assert self.encoding_type in ['strict', 'exact', 'replace']
 
437
 
 
438
        # Originally I was using self.stdout, but that looks
 
439
        # *way* too much like sys.stdout
 
440
        if self.encoding_type == 'exact':
 
441
            # force sys.stdout to be binary stream on win32
 
442
            if sys.platform == 'win32':
 
443
                fileno = getattr(sys.stdout, 'fileno', None)
 
444
                if fileno:
 
445
                    import msvcrt
 
446
                    msvcrt.setmode(fileno(), os.O_BINARY)
 
447
            self.outf = sys.stdout
 
448
            return
 
449
 
 
450
        output_encoding = osutils.get_terminal_encoding()
 
451
 
 
452
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
 
453
                        errors=self.encoding_type)
 
454
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
455
        # it just returns the encoding of the wrapped file, which is completely
 
456
        # bogus. So set the attribute, so we can find the correct encoding later.
 
457
        self.outf.encoding = output_encoding
624
458
 
625
459
    def run_argv_aliases(self, argv, alias_argv=None):
626
460
        """Parse the command line and run with extra aliases in alias_argv."""
634
468
        if 'help' in opts:  # e.g. bzr add --help
635
469
            sys.stdout.write(self.get_help_text())
636
470
            return 0
637
 
        if 'usage' in opts:  # e.g. bzr add --usage
638
 
            sys.stdout.write(self.get_help_text(verbose=False))
639
 
            return 0
640
471
        trace.set_verbosity_level(option._verbosity_level)
641
472
        if 'verbose' in self.supported_std_options:
642
473
            opts['verbose'] = trace.is_verbose()
658
489
 
659
490
        self._setup_outf()
660
491
 
661
 
        return self.run_direct(**all_cmd_args)
662
 
 
663
 
    def run_direct(self, *args, **kwargs):
664
 
        """Call run directly with objects (without parsing an argv list)."""
665
 
        return self._operation.run_simple(*args, **kwargs)
666
 
 
 
492
        return self.run(**all_cmd_args)
 
493
    
667
494
    def run(self):
668
495
        """Actually run the command.
669
496
 
699
526
            return None
700
527
 
701
528
 
702
 
class CommandHooks(Hooks):
703
 
    """Hooks related to Command object creation/enumeration."""
704
 
 
705
 
    def __init__(self):
706
 
        """Create the default hooks.
707
 
 
708
 
        These are all empty initially, because by default nothing should get
709
 
        notified.
710
 
        """
711
 
        Hooks.__init__(self)
712
 
        self.create_hook(HookPoint('extend_command',
713
 
            "Called after creating a command object to allow modifications "
714
 
            "such as adding or removing options, docs etc. Called with the "
715
 
            "new bzrlib.commands.Command object.", (1, 13), None))
716
 
        self.create_hook(HookPoint('get_command',
717
 
            "Called when creating a single command. Called with "
718
 
            "(cmd_or_None, command_name). get_command should either return "
719
 
            "the cmd_or_None parameter, or a replacement Command object that "
720
 
            "should be used for the command. Note that the Command.hooks "
721
 
            "hooks are core infrastructure. Many users will prefer to use "
722
 
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
723
 
            (1, 17), None))
724
 
        self.create_hook(HookPoint('get_missing_command',
725
 
            "Called when creating a single command if no command could be "
726
 
            "found. Called with (command_name). get_missing_command should "
727
 
            "either return None, or a Command object to be used for the "
728
 
            "command.", (1, 17), None))
729
 
        self.create_hook(HookPoint('list_commands',
730
 
            "Called when enumerating commands. Called with a set of "
731
 
            "cmd_name strings for all the commands found so far. This set "
732
 
            " is safe to mutate - e.g. to remove a command. "
733
 
            "list_commands should return the updated set of command names.",
734
 
            (1, 17), None))
735
 
 
736
 
Command.hooks = CommandHooks()
737
 
 
738
 
 
739
529
def parse_args(command, argv, alias_argv=None):
740
530
    """Parse command line.
741
 
 
 
531
    
742
532
    Arguments and options are parsed at this level before being passed
743
533
    down to specific command handlers.  This routine knows, from a
744
534
    lookup table, something about the available options, what optargs
793
583
                               % (cmd, argname.upper()))
794
584
            else:
795
585
                argdict[argname] = args.pop(0)
796
 
 
 
586
            
797
587
    if args:
798
588
        raise errors.BzrCommandError("extra argument to command %s: %s"
799
589
                                     % (cmd, args[0]))
800
590
 
801
591
    return argdict
802
592
 
803
 
def apply_coveraged(dirname, the_callable, *args, **kwargs):
804
 
    # Cannot use "import trace", as that would import bzrlib.trace instead of
805
 
    # the standard library's trace.
806
 
    trace = __import__('trace')
807
 
 
808
 
    tracer = trace.Trace(count=1, trace=0)
809
 
    sys.settrace(tracer.globaltrace)
810
 
    threading.settrace(tracer.globaltrace)
811
 
 
812
 
    try:
813
 
        return exception_to_return_code(the_callable, *args, **kwargs)
814
 
    finally:
815
 
        sys.settrace(None)
816
 
        results = tracer.results()
817
 
        results.write_results(show_missing=1, summary=False,
818
 
                              coverdir=dirname)
819
593
 
820
594
 
821
595
def apply_profiled(the_callable, *args, **kwargs):
826
600
    try:
827
601
        prof = hotshot.Profile(pfname)
828
602
        try:
829
 
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
830
 
                **kwargs) or 0
 
603
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
831
604
        finally:
832
605
            prof.close()
833
606
        stats = hotshot.stats.load(pfname)
842
615
        os.remove(pfname)
843
616
 
844
617
 
845
 
def exception_to_return_code(the_callable, *args, **kwargs):
846
 
    """UI level helper for profiling and coverage.
847
 
 
848
 
    This transforms exceptions into a return value of 3. As such its only
849
 
    relevant to the UI layer, and should never be called where catching
850
 
    exceptions may be desirable.
851
 
    """
852
 
    try:
853
 
        return the_callable(*args, **kwargs)
854
 
    except (KeyboardInterrupt, Exception), e:
855
 
        # used to handle AssertionError and KeyboardInterrupt
856
 
        # specially here, but hopefully they're handled ok by the logger now
857
 
        exc_info = sys.exc_info()
858
 
        exitcode = trace.report_exception(exc_info, sys.stderr)
859
 
        if os.environ.get('BZR_PDB'):
860
 
            print '**** entering debugger'
861
 
            tb = exc_info[2]
862
 
            import pdb
863
 
            if sys.version_info[:2] < (2, 6):
864
 
                # XXX: we want to do
865
 
                #    pdb.post_mortem(tb)
866
 
                # but because pdb.post_mortem gives bad results for tracebacks
867
 
                # from inside generators, we do it manually.
868
 
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
869
 
 
870
 
                # Setup pdb on the traceback
871
 
                p = pdb.Pdb()
872
 
                p.reset()
873
 
                p.setup(tb.tb_frame, tb)
874
 
                # Point the debugger at the deepest frame of the stack
875
 
                p.curindex = len(p.stack) - 1
876
 
                p.curframe = p.stack[p.curindex][0]
877
 
                # Start the pdb prompt.
878
 
                p.print_stack_entry(p.stack[p.curindex])
879
 
                p.execRcLines()
880
 
                p.cmdloop()
881
 
            else:
882
 
                pdb.post_mortem(tb)
883
 
        return exitcode
884
 
 
885
 
 
886
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
887
619
    from bzrlib.lsprof import profile
888
 
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
 
620
    ret, stats = profile(the_callable, *args, **kwargs)
889
621
    stats.sort()
890
622
    if filename is None:
891
623
        stats.pprint()
895
627
    return ret
896
628
 
897
629
 
898
 
def shlex_split_unicode(unsplit):
899
 
    import shlex
900
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
901
 
 
902
 
 
903
630
def get_alias(cmd, config=None):
904
631
    """Return an expanded alias, or None if no alias exists.
905
632
 
915
642
        config = bzrlib.config.GlobalConfig()
916
643
    alias = config.get_alias(cmd)
917
644
    if (alias):
918
 
        return shlex_split_unicode(alias)
 
645
        import shlex
 
646
        return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
919
647
    return None
920
648
 
921
649
 
922
650
def run_bzr(argv):
923
651
    """Execute a command.
924
652
 
 
653
    This is similar to main(), but without all the trappings for
 
654
    logging and error handling.  
 
655
    
925
656
    argv
926
657
       The command-line arguments, without the program name from argv[0]
927
658
       These should already be decoded. All library/test code calling
928
659
       run_bzr should be passing valid strings (don't need decoding).
929
 
 
 
660
    
930
661
    Returns a command status or raises an exception.
931
662
 
932
663
    Special master options: these must come before the command because
947
678
 
948
679
    --lsprof
949
680
        Run under the Python lsprof profiler.
950
 
 
951
 
    --coverage
952
 
        Generate line coverage report in the specified directory.
953
 
 
954
 
    --concurrency
955
 
        Specify the number of processes that can be run concurrently (selftest).
956
681
    """
957
 
    trace.mutter("bazaar version: " + bzrlib.__version__)
958
682
    argv = list(argv)
959
683
    trace.mutter("bzr arguments: %r", argv)
960
684
 
961
685
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
962
686
                opt_no_aliases = False
963
 
    opt_lsprof_file = opt_coverage_dir = None
 
687
    opt_lsprof_file = None
964
688
 
965
689
    # --no-plugins is handled specially at a very early stage. We need
966
690
    # to load plugins before doing other command parsing so that they
984
708
            opt_no_aliases = True
985
709
        elif a == '--builtin':
986
710
            opt_builtin = True
987
 
        elif a == '--concurrency':
988
 
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
989
 
            i += 1
990
 
        elif a == '--coverage':
991
 
            opt_coverage_dir = argv[i + 1]
992
 
            i += 1
993
711
        elif a.startswith('-D'):
994
712
            debug.debug_flags.add(a[2:])
995
713
        else:
996
714
            argv_copy.append(a)
997
715
        i += 1
998
716
 
999
 
    debug.set_debug_flags_from_config()
1000
 
 
1001
717
    argv = argv_copy
1002
718
    if (not argv):
1003
719
        from bzrlib.builtins import cmd_help
1008
724
        from bzrlib.builtins import cmd_version
1009
725
        cmd_version().run_argv_aliases([])
1010
726
        return 0
1011
 
 
 
727
        
1012
728
    if not opt_no_plugins:
1013
729
        from bzrlib.plugin import load_plugins
1014
730
        load_plugins()
1021
737
    if not opt_no_aliases:
1022
738
        alias_argv = get_alias(argv[0])
1023
739
        if alias_argv:
1024
 
            user_encoding = osutils.get_user_encoding()
1025
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
 
740
            alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1026
741
            argv[0] = alias_argv.pop(0)
1027
742
 
1028
743
    cmd = argv.pop(0)
1035
750
    run_argv = [argv, alias_argv]
1036
751
 
1037
752
    try:
1038
 
        # We can be called recursively (tests for example), but we don't want
1039
 
        # the verbosity level to propagate.
1040
 
        saved_verbosity_level = option._verbosity_level
1041
 
        option._verbosity_level = 0
1042
753
        if opt_lsprof:
1043
 
            if opt_coverage_dir:
1044
 
                trace.warning(
1045
 
                    '--coverage ignored, because --lsprof is in use.')
1046
754
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1047
755
        elif opt_profile:
1048
 
            if opt_coverage_dir:
1049
 
                trace.warning(
1050
 
                    '--coverage ignored, because --profile is in use.')
1051
756
            ret = apply_profiled(run, *run_argv)
1052
 
        elif opt_coverage_dir:
1053
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1054
757
        else:
1055
758
            ret = run(*run_argv)
1056
759
        return ret or 0
1057
760
    finally:
1058
 
        # reset, in case we may do other commands later within the same
1059
 
        # process. Commands that want to execute sub-commands must propagate
1060
 
        # --verbose in their own way.
1061
 
        if 'memory' in debug.debug_flags:
1062
 
            trace.debug_memory('Process status after command:', short=False)
1063
 
        option._verbosity_level = saved_verbosity_level
1064
 
 
 
761
        # reset, in case we may do other commands later within the same process
 
762
        option._verbosity_level = 0
1065
763
 
1066
764
def display_command(func):
1067
765
    """Decorator that suppresses pipe/interrupt errors."""
1083
781
    return ignore_pipe
1084
782
 
1085
783
 
1086
 
def install_bzr_command_hooks():
1087
 
    """Install the hooks to supply bzr's own commands."""
1088
 
    if _list_bzr_commands in Command.hooks["list_commands"]:
1089
 
        return
1090
 
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1091
 
        "bzr commands")
1092
 
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
1093
 
        "bzr commands")
1094
 
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
1095
 
        "bzr plugin commands")
1096
 
    Command.hooks.install_named_hook("get_command", _get_external_command,
1097
 
        "bzr external command lookup")
1098
 
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
 
        "bzr plugin-provider-db check")
1100
 
 
1101
 
 
1102
 
def main(argv=None):
1103
 
    """Main entry point of command-line interface.
1104
 
 
1105
 
    :param argv: list of unicode command-line arguments similar to sys.argv.
1106
 
        argv[0] is script name usually, it will be ignored.
1107
 
        Don't pass here sys.argv because this list contains plain strings
1108
 
        and not unicode; pass None instead.
1109
 
 
1110
 
    :return: exit code of bzr command.
1111
 
    """
 
784
def main(argv):
1112
785
    import bzrlib.ui
1113
 
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
 
        sys.stdin, sys.stdout, sys.stderr)
1115
 
 
1116
 
    # Is this a final release version? If so, we should suppress warnings
1117
 
    if bzrlib.version_info[3] == 'final':
1118
 
        suppress_deprecation_warnings(override=True)
1119
 
    if argv is None:
1120
 
        argv = osutils.get_unicode_argv()
1121
 
    else:
1122
 
        new_argv = []
1123
 
        try:
1124
 
            # ensure all arguments are unicode strings
1125
 
            for a in argv[1:]:
1126
 
                if isinstance(a, unicode):
1127
 
                    new_argv.append(a)
1128
 
                else:
1129
 
                    new_argv.append(a.decode('ascii'))
1130
 
        except UnicodeDecodeError:
1131
 
            raise errors.BzrError("argv should be list of unicode strings.")
1132
 
        argv = new_argv
 
786
    from bzrlib.ui.text import TextUIFactory
 
787
    bzrlib.ui.ui_factory = TextUIFactory()
 
788
    try:
 
789
        argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
 
790
    except UnicodeDecodeError:
 
791
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
792
                                                            "encoding." % a))
1133
793
    ret = run_bzr_catch_errors(argv)
1134
 
    bzrlib.ui.ui_factory.log_transport_activity(
1135
 
        display=('bytes' in debug.debug_flags))
1136
794
    trace.mutter("return code %d", ret)
1137
 
    osutils.report_extension_load_failures()
1138
795
    return ret
1139
796
 
1140
797
 
1141
798
def run_bzr_catch_errors(argv):
1142
 
    """Run a bzr command with parameters as described by argv.
1143
 
 
1144
 
    This function assumed that that UI layer is setup, that symbol deprecations
1145
 
    are already applied, and that unicode decoding has already been performed on argv.
1146
 
    """
1147
 
    install_bzr_command_hooks()
1148
 
    return exception_to_return_code(run_bzr, argv)
 
799
    # Note: The except clause logic below should be kept in sync with the
 
800
    # profile() routine in lsprof.py.
 
801
    try:
 
802
        return run_bzr(argv)
 
803
    except (KeyboardInterrupt, Exception), e:
 
804
        # used to handle AssertionError and KeyboardInterrupt
 
805
        # specially here, but hopefully they're handled ok by the logger now
 
806
        exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
 
807
        if os.environ.get('BZR_PDB'):
 
808
            print '**** entering debugger'
 
809
            import pdb
 
810
            pdb.post_mortem(sys.exc_traceback)
 
811
        return exitcode
1149
812
 
1150
813
 
1151
814
def run_bzr_catch_user_errors(argv):
1154
817
    This is used for the test suite, and might be useful for other programs
1155
818
    that want to wrap the commandline interface.
1156
819
    """
1157
 
    install_bzr_command_hooks()
1158
820
    try:
1159
821
        return run_bzr(argv)
1160
822
    except Exception, e:
1189
851
            return [cmd]
1190
852
 
1191
853
 
1192
 
class Provider(object):
1193
 
    '''Generic class to be overriden by plugins'''
1194
 
 
1195
 
    def plugin_for_command(self, cmd_name):
1196
 
        '''Takes a command and returns the information for that plugin
1197
 
 
1198
 
        :return: A dictionary with all the available information
1199
 
        for the requested plugin
1200
 
        '''
1201
 
        raise NotImplementedError
1202
 
 
1203
 
 
1204
 
class ProvidersRegistry(registry.Registry):
1205
 
    '''This registry exists to allow other providers to exist'''
1206
 
 
1207
 
    def __iter__(self):
1208
 
        for key, provider in self.iteritems():
1209
 
            yield provider
1210
 
 
1211
 
command_providers_registry = ProvidersRegistry()
1212
 
 
1213
 
 
1214
854
if __name__ == '__main__':
1215
855
    sys.exit(main(sys.argv))