~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-18 09:13:28 UTC
  • mfrom: (5096.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100318091328-8fo347hq4at1usky
(vila) Get better feedback about why
        TestGetFileMTime.test_get_file_mtime is failing

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
38
39
from warnings import warn
39
40
 
40
41
import bzrlib
41
42
from bzrlib import (
 
43
    cleanup,
 
44
    cmdline,
42
45
    debug,
43
46
    errors,
44
47
    option,
45
48
    osutils,
46
 
    registry,
47
49
    trace,
 
50
    ui,
48
51
    win32utils,
49
52
    )
50
53
""")
51
54
 
 
55
from bzrlib.hooks import HookPoint, Hooks
 
56
# Compatibility - Option used to be in commands.
 
57
from bzrlib.option import Option
 
58
from bzrlib.plugin import disable_plugins, load_plugins
 
59
from bzrlib import registry
52
60
from bzrlib.symbol_versioning import (
53
61
    deprecated_function,
 
62
    deprecated_in,
54
63
    deprecated_method,
55
64
    )
56
 
# Compatibility
57
 
from bzrlib.option import Option
58
 
 
59
 
 
60
 
plugin_cmds = {}
 
65
 
 
66
 
 
67
class CommandInfo(object):
 
68
    """Information about a command."""
 
69
 
 
70
    def __init__(self, aliases):
 
71
        """The list of aliases for the command."""
 
72
        self.aliases = aliases
 
73
 
 
74
    @classmethod
 
75
    def from_command(klass, command):
 
76
        """Factory to construct a CommandInfo from a command."""
 
77
        return klass(command.aliases)
 
78
 
 
79
 
 
80
class CommandRegistry(registry.Registry):
 
81
 
 
82
    @staticmethod
 
83
    def _get_name(command_name):
 
84
        if command_name.startswith("cmd_"):
 
85
            return _unsquish_command_name(command_name)
 
86
        else:
 
87
            return command_name
 
88
 
 
89
    def register(self, cmd, decorate=False):
 
90
        """Utility function to help register a command
 
91
 
 
92
        :param cmd: Command subclass to register
 
93
        :param decorate: If true, allow overriding an existing command
 
94
            of the same name; the old command is returned by this function.
 
95
            Otherwise it is an error to try to override an existing command.
 
96
        """
 
97
        k = cmd.__name__
 
98
        k_unsquished = self._get_name(k)
 
99
        try:
 
100
            previous = self.get(k_unsquished)
 
101
        except KeyError:
 
102
            previous = _builtin_commands().get(k_unsquished)
 
103
        info = CommandInfo.from_command(cmd)
 
104
        try:
 
105
            registry.Registry.register(self, k_unsquished, cmd,
 
106
                                       override_existing=decorate, info=info)
 
107
        except KeyError:
 
108
            trace.warning('Two plugins defined the same command: %r' % k)
 
109
            trace.warning('Not loading the one in %r' %
 
110
                sys.modules[cmd.__module__])
 
111
            trace.warning('Previously this command was registered from %r' %
 
112
                sys.modules[previous.__module__])
 
113
        return previous
 
114
 
 
115
    def register_lazy(self, command_name, aliases, module_name):
 
116
        """Register a command without loading its module.
 
117
 
 
118
        :param command_name: The primary name of the command.
 
119
        :param aliases: A list of aliases for the command.
 
120
        :module_name: The module that the command lives in.
 
121
        """
 
122
        key = self._get_name(command_name)
 
123
        registry.Registry.register_lazy(self, key, module_name, command_name,
 
124
                                        info=CommandInfo(aliases))
 
125
 
 
126
 
 
127
plugin_cmds = CommandRegistry()
61
128
 
62
129
 
63
130
def register_command(cmd, decorate=False):
64
 
    """Utility function to help register a command
65
 
 
66
 
    :param cmd: Command subclass to register
67
 
    :param decorate: If true, allow overriding an existing command
68
 
        of the same name; the old command is returned by this function.
69
 
        Otherwise it is an error to try to override an existing command.
70
 
    """
71
131
    global plugin_cmds
72
 
    k = cmd.__name__
73
 
    if k.startswith("cmd_"):
74
 
        k_unsquished = _unsquish_command_name(k)
75
 
    else:
76
 
        k_unsquished = k
77
 
    if k_unsquished not in plugin_cmds:
78
 
        plugin_cmds[k_unsquished] = cmd
79
 
        ## trace.mutter('registered plugin command %s', k_unsquished)
80
 
        if decorate and k_unsquished in builtin_command_names():
81
 
            return _builtin_commands()[k_unsquished]
82
 
    elif decorate:
83
 
        result = plugin_cmds[k_unsquished]
84
 
        plugin_cmds[k_unsquished] = cmd
85
 
        return result
86
 
    else:
87
 
        trace.log_error('Two plugins defined the same command: %r' % k)
88
 
        trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
89
 
        trace.log_error('Previously this command was registered from %r' %
90
 
                        sys.modules[plugin_cmds[k_unsquished].__module__])
 
132
    return plugin_cmds.register(cmd, decorate)
91
133
 
92
134
 
93
135
def _squish_command_name(cmd):
100
142
 
101
143
def _builtin_commands():
102
144
    import bzrlib.builtins
 
145
    return _scan_module_for_commands(bzrlib.builtins)
 
146
 
 
147
 
 
148
def _scan_module_for_commands(module):
103
149
    r = {}
104
 
    builtins = bzrlib.builtins.__dict__
105
 
    for name in builtins:
 
150
    for name, obj in module.__dict__.iteritems():
106
151
        if name.startswith("cmd_"):
107
152
            real_name = _unsquish_command_name(name)
108
 
            r[real_name] = builtins[name]
 
153
            r[real_name] = obj
109
154
    return r
110
 
            
 
155
 
 
156
 
 
157
def _list_bzr_commands(names):
 
158
    """Find commands from bzr's core and plugins."""
 
159
    # to eliminate duplicates
 
160
    names.update(builtin_command_names())
 
161
    names.update(plugin_command_names())
 
162
    return names
 
163
 
 
164
 
 
165
def all_command_names():
 
166
    """Return a set of all command names."""
 
167
    names = set()
 
168
    for hook in Command.hooks['list_commands']:
 
169
        names = hook(names)
 
170
        if names is None:
 
171
            raise AssertionError(
 
172
                'hook %s returned None' % Command.hooks.get_hook_name(hook))
 
173
    return names
 
174
 
111
175
 
112
176
def builtin_command_names():
113
 
    """Return list of builtin command names."""
 
177
    """Return list of builtin command names.
 
178
    
 
179
    Use of all_command_names() is encouraged rather than builtin_command_names
 
180
    and/or plugin_command_names.
 
181
    """
114
182
    return _builtin_commands().keys()
115
 
    
 
183
 
116
184
 
117
185
def plugin_command_names():
 
186
    """Returns command names from commands registered by plugins."""
118
187
    return plugin_cmds.keys()
119
188
 
120
189
 
121
 
def _get_cmd_dict(plugins_override=True):
122
 
    """Return name->class mapping for all commands."""
123
 
    d = _builtin_commands()
124
 
    if plugins_override:
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():
132
 
        yield k,v
133
 
 
134
 
 
135
190
def get_cmd_object(cmd_name, plugins_override=True):
136
 
    """Return the canonical name and command class for a command.
 
191
    """Return the command object for a command.
137
192
 
138
193
    plugins_override
139
194
        If true, plugin commands can override builtins.
144
199
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
145
200
 
146
201
 
147
 
def _get_cmd_object(cmd_name, plugins_override=True):
148
 
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
 
    from bzrlib.externalcommand import ExternalCommand
 
202
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
 
203
    """Get a command object.
150
204
 
 
205
    :param cmd_name: The name of the command.
 
206
    :param plugins_override: Allow plugins to override builtins.
 
207
    :param check_missing: Look up commands not found in the regular index via
 
208
        the get_missing_command hook.
 
209
    :return: A Command object instance
 
210
    :raises KeyError: If no command is found.
 
211
    """
151
212
    # We want only 'ascii' command names, but the user may have typed
152
213
    # in a Unicode name. In that case, they should just get a
153
214
    # 'command not found' error later.
154
215
    # In the future, we may actually support Unicode command names.
155
 
 
156
 
    # first look up this command under the specified name
157
 
    cmds = _get_cmd_dict(plugins_override=plugins_override)
 
216
    cmd = None
 
217
    # Get a command
 
218
    for hook in Command.hooks['get_command']:
 
219
        cmd = hook(cmd, cmd_name)
 
220
        if cmd is not None and not plugins_override and not cmd.plugin_name():
 
221
            # We've found a non-plugin command, don't permit it to be
 
222
            # overridden.
 
223
            break
 
224
    if cmd is None and check_missing:
 
225
        for hook in Command.hooks['get_missing_command']:
 
226
            cmd = hook(cmd_name)
 
227
            if cmd is not None:
 
228
                break
 
229
    if cmd is None:
 
230
        # No command found.
 
231
        raise KeyError
 
232
    # Allow plugins to extend commands
 
233
    for hook in Command.hooks['extend_command']:
 
234
        hook(cmd)
 
235
    return cmd
 
236
 
 
237
 
 
238
def _try_plugin_provider(cmd_name):
 
239
    """Probe for a plugin provider having cmd_name."""
 
240
    try:
 
241
        plugin_metadata, provider = probe_for_provider(cmd_name)
 
242
        raise errors.CommandAvailableInPlugin(cmd_name,
 
243
            plugin_metadata, provider)
 
244
    except errors.NoPluginAvailable:
 
245
        pass
 
246
 
 
247
 
 
248
def probe_for_provider(cmd_name):
 
249
    """Look for a provider for cmd_name.
 
250
 
 
251
    :param cmd_name: The command name.
 
252
    :return: plugin_metadata, provider for getting cmd_name.
 
253
    :raises NoPluginAvailable: When no provider can supply the plugin.
 
254
    """
 
255
    # look for providers that provide this command but aren't installed
 
256
    for provider in command_providers_registry:
 
257
        try:
 
258
            return provider.plugin_for_command(cmd_name), provider
 
259
        except errors.NoPluginAvailable:
 
260
            pass
 
261
    raise errors.NoPluginAvailable(cmd_name)
 
262
 
 
263
 
 
264
def _get_bzr_command(cmd_or_None, cmd_name):
 
265
    """Get a command from bzr's core."""
 
266
    cmds = _builtin_commands()
158
267
    try:
159
268
        return cmds[cmd_name]()
160
269
    except KeyError:
161
270
        pass
162
 
 
163
271
    # look for any command which claims this as an alias
164
272
    for real_cmd_name, cmd_class in cmds.iteritems():
165
273
        if cmd_name in cmd_class.aliases:
166
274
            return cmd_class()
167
 
 
 
275
    return cmd_or_None
 
276
 
 
277
 
 
278
def _get_external_command(cmd_or_None, cmd_name):
 
279
    """Lookup a command that is a shell script."""
 
280
    # Only do external command lookups when no command is found so far.
 
281
    if cmd_or_None is not None:
 
282
        return cmd_or_None
 
283
    from bzrlib.externalcommand import ExternalCommand
168
284
    cmd_obj = ExternalCommand.find_command(cmd_name)
169
285
    if cmd_obj:
170
286
        return cmd_obj
171
287
 
172
 
    # look for plugins that provide this command but aren't installed
173
 
    for provider in command_providers_registry:
174
 
        try:
175
 
            plugin_metadata = provider.plugin_for_command(cmd_name)
176
 
        except errors.NoPluginAvailable:
177
 
            pass
178
 
        else:
179
 
            raise errors.CommandAvailableInPlugin(cmd_name, 
180
 
                                                  plugin_metadata, provider)
181
288
 
182
 
    raise KeyError
 
289
def _get_plugin_command(cmd_or_None, cmd_name):
 
290
    """Get a command from bzr's plugins."""
 
291
    try:
 
292
        return plugin_cmds.get(cmd_name)()
 
293
    except KeyError:
 
294
        pass
 
295
    for key in plugin_cmds.keys():
 
296
        info = plugin_cmds.get_info(key)
 
297
        if cmd_name in info.aliases:
 
298
            return plugin_cmds.get(key)()
 
299
    return cmd_or_None
183
300
 
184
301
 
185
302
class Command(object):
239
356
            sys.stdout is forced to be a binary stream, and line-endings
240
357
            will not mangled.
241
358
 
 
359
    :cvar hooks: An instance of CommandHooks.
242
360
    """
243
361
    aliases = []
244
362
    takes_args = []
246
364
    encoding_type = 'strict'
247
365
 
248
366
    hidden = False
249
 
    
 
367
 
250
368
    def __init__(self):
251
369
        """Construct an instance of this command."""
252
370
        if self.__doc__ == Command.__doc__:
253
371
            warn("No help message set for %r" % self)
254
372
        # List of standard options directly supported
255
373
        self.supported_std_options = []
256
 
 
 
374
        self._operation = cleanup.OperationWithCleanups(self.run)
 
375
 
 
376
    def add_cleanup(self, cleanup_func, *args, **kwargs):
 
377
        """Register a function to call after self.run returns or raises.
 
378
 
 
379
        Functions will be called in LIFO order.
 
380
        """
 
381
        self._operation.add_cleanup(cleanup_func, *args, **kwargs)
 
382
 
 
383
    def cleanup_now(self):
 
384
        """Execute and empty pending cleanup functions immediately.
 
385
 
 
386
        After cleanup_now all registered cleanups are forgotten.  add_cleanup
 
387
        may be called again after cleanup_now; these cleanups will be called
 
388
        after self.run returns or raises (or when cleanup_now is next called).
 
389
 
 
390
        This is useful for releasing expensive or contentious resources (such
 
391
        as write locks) before doing further work that does not require those
 
392
        resources (such as writing results to self.outf).
 
393
        """
 
394
        self._operation.cleanup_now()
 
395
 
 
396
    @deprecated_method(deprecated_in((2, 1, 0)))
257
397
    def _maybe_expand_globs(self, file_list):
258
398
        """Glob expand file_list if the platform does not do that itself.
259
 
        
 
399
 
 
400
        Not used anymore, now that the bzr command-line parser globs on
 
401
        Windows.
 
402
 
260
403
        :return: A possibly empty list of unicode paths.
261
404
 
262
405
        Introduced in bzrlib 0.18.
263
406
        """
264
 
        if not file_list:
265
 
            file_list = []
266
 
        if sys.platform == 'win32':
267
 
            file_list = win32utils.glob_expand(file_list)
268
 
        return list(file_list)
 
407
        return file_list
269
408
 
270
409
    def _usage(self):
271
410
        """Return single-line grammar for this command.
286
425
        return s
287
426
 
288
427
    def get_help_text(self, additional_see_also=None, plain=True,
289
 
                      see_also_as_links=False):
 
428
                      see_also_as_links=False, verbose=True):
290
429
        """Return a text string with help for this command.
291
 
        
 
430
 
292
431
        :param additional_see_also: Additional help topics to be
293
432
            cross-referenced.
294
433
        :param plain: if False, raw help (reStructuredText) is
295
434
            returned instead of plain text.
296
435
        :param see_also_as_links: if True, convert items in 'See also'
297
436
            list to internal links (used by bzr_man rstx generator)
 
437
        :param verbose: if True, display the full help, otherwise
 
438
            leave out the descriptive sections and just display
 
439
            usage help (e.g. Purpose, Usage, Options) with a
 
440
            message explaining how to obtain full help.
298
441
        """
299
442
        doc = self.help()
300
443
        if doc is None:
301
444
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
302
445
 
303
446
        # Extract the summary (purpose) and sections out from the text
304
 
        purpose,sections = self._get_help_parts(doc)
 
447
        purpose,sections,order = self._get_help_parts(doc)
305
448
 
306
449
        # If a custom usage section was provided, use it
307
450
        if sections.has_key('Usage'):
319
462
        result += '\n'
320
463
 
321
464
        # Add the options
 
465
        #
 
466
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
 
467
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
 
468
        # 20090319
322
469
        options = option.get_optparser(self.options()).format_option_help()
 
470
        # XXX: According to the spec, ReST option lists actually don't support 
 
471
        # options like --1.9 so that causes syntax errors (in Sphinx at least).
 
472
        # As that pattern always appears in the commands that break, we trap
 
473
        # on that and then format that block of 'format' options as a literal
 
474
        # block.
 
475
        if not plain and options.find('  --1.9  ') != -1:
 
476
            options = options.replace(' format:\n', ' format::\n\n', 1)
323
477
        if options.startswith('Options:'):
324
478
            result += ':' + options
325
479
        elif options.startswith('options:'):
329
483
            result += options
330
484
        result += '\n'
331
485
 
332
 
        # Add the description, indenting it 2 spaces
333
 
        # to match the indentation of the options
334
 
        if sections.has_key(None):
335
 
            text = sections.pop(None)
336
 
            text = '\n  '.join(text.splitlines())
337
 
            result += ':%s:\n  %s\n\n' % ('Description',text)
 
486
        if verbose:
 
487
            # Add the description, indenting it 2 spaces
 
488
            # to match the indentation of the options
 
489
            if sections.has_key(None):
 
490
                text = sections.pop(None)
 
491
                text = '\n  '.join(text.splitlines())
 
492
                result += ':%s:\n  %s\n\n' % ('Description',text)
338
493
 
339
 
        # Add the custom sections (e.g. Examples). Note that there's no need
340
 
        # to indent these as they must be indented already in the source.
341
 
        if sections:
342
 
            labels = sorted(sections.keys())
343
 
            for label in labels:
344
 
                result += ':%s:\n%s\n\n' % (label,sections[label])
 
494
            # Add the custom sections (e.g. Examples). Note that there's no need
 
495
            # to indent these as they must be indented already in the source.
 
496
            if sections:
 
497
                for label in order:
 
498
                    if sections.has_key(label):
 
499
                        result += ':%s:\n%s\n' % (label,sections[label])
 
500
                result += '\n'
 
501
        else:
 
502
            result += ("See bzr help %s for more details and examples.\n\n"
 
503
                % self.name())
345
504
 
346
505
        # Add the aliases, source (plug-in) and see also links, if any
347
506
        if self.aliases:
360
519
                        # so don't create a real link
361
520
                        see_also_links.append(item)
362
521
                    else:
363
 
                        # Use a reST link for this entry
364
 
                        see_also_links.append("`%s`_" % (item,))
 
522
                        # Use a Sphinx link for this entry
 
523
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
 
524
                        see_also_links.append(link_text)
365
525
                see_also = see_also_links
366
526
            result += ':See also: '
367
527
            result += ', '.join(see_also) + '\n'
376
536
    def _get_help_parts(text):
377
537
        """Split help text into a summary and named sections.
378
538
 
379
 
        :return: (summary,sections) where summary is the top line and
 
539
        :return: (summary,sections,order) where summary is the top line and
380
540
            sections is a dictionary of the rest indexed by section name.
 
541
            order is the order the section appear in the text.
381
542
            A section starts with a heading line of the form ":xxx:".
382
543
            Indented text on following lines is the section value.
383
544
            All text found outside a named section is assigned to the
384
545
            default section which is given the key of None.
385
546
        """
386
 
        def save_section(sections, label, section):
 
547
        def save_section(sections, order, label, section):
387
548
            if len(section) > 0:
388
549
                if sections.has_key(label):
389
550
                    sections[label] += '\n' + section
390
551
                else:
 
552
                    order.append(label)
391
553
                    sections[label] = section
392
554
 
393
555
        lines = text.rstrip().splitlines()
394
556
        summary = lines.pop(0)
395
557
        sections = {}
 
558
        order = []
396
559
        label,section = None,''
397
560
        for line in lines:
398
561
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
399
 
                save_section(sections, label, section)
 
562
                save_section(sections, order, label, section)
400
563
                label,section = line[1:-1],''
401
564
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
402
 
                save_section(sections, label, section)
 
565
                save_section(sections, order, label, section)
403
566
                label,section = None,line
404
567
            else:
405
568
                if len(section) > 0:
406
569
                    section += '\n' + line
407
570
                else:
408
571
                    section = line
409
 
        save_section(sections, label, section)
410
 
        return summary, sections
 
572
        save_section(sections, order, label, section)
 
573
        return summary, sections, order
411
574
 
412
575
    def get_help_topic(self):
413
576
        """Return the commands help topic - its name."""
415
578
 
416
579
    def get_see_also(self, additional_terms=None):
417
580
        """Return a list of help topics that are related to this command.
418
 
        
 
581
 
419
582
        The list is derived from the content of the _see_also attribute. Any
420
583
        duplicates are removed and the result is in lexical order.
421
584
        :param additional_terms: Additional help topics to cross-reference.
442
605
 
443
606
    def _setup_outf(self):
444
607
        """Return a file linked to stdout, which has proper encoding."""
445
 
        # Originally I was using self.stdout, but that looks
446
 
        # *way* too much like sys.stdout
447
 
        if self.encoding_type == 'exact':
448
 
            # force sys.stdout to be binary stream on win32
449
 
            if sys.platform == 'win32':
450
 
                fileno = getattr(sys.stdout, 'fileno', None)
451
 
                if fileno:
452
 
                    import msvcrt
453
 
                    msvcrt.setmode(fileno(), os.O_BINARY)
454
 
            self.outf = sys.stdout
455
 
            return
456
 
 
457
 
        output_encoding = osutils.get_terminal_encoding()
458
 
 
459
 
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
460
 
                        errors=self.encoding_type)
461
 
        # For whatever reason codecs.getwriter() does not advertise its encoding
462
 
        # it just returns the encoding of the wrapped file, which is completely
463
 
        # bogus. So set the attribute, so we can find the correct encoding later.
464
 
        self.outf.encoding = output_encoding
 
608
        self.outf = ui.ui_factory.make_output_stream(
 
609
            encoding_type=self.encoding_type)
465
610
 
466
611
    def run_argv_aliases(self, argv, alias_argv=None):
467
612
        """Parse the command line and run with extra aliases in alias_argv."""
468
 
        if argv is None:
469
 
            warn("Passing None for [] is deprecated from bzrlib 0.10",
470
 
                 DeprecationWarning, stacklevel=2)
471
 
            argv = []
472
613
        args, opts = parse_args(self, argv, alias_argv)
473
614
 
474
615
        # Process the standard options
475
616
        if 'help' in opts:  # e.g. bzr add --help
476
617
            sys.stdout.write(self.get_help_text())
477
618
            return 0
 
619
        if 'usage' in opts:  # e.g. bzr add --usage
 
620
            sys.stdout.write(self.get_help_text(verbose=False))
 
621
            return 0
478
622
        trace.set_verbosity_level(option._verbosity_level)
479
623
        if 'verbose' in self.supported_std_options:
480
624
            opts['verbose'] = trace.is_verbose()
496
640
 
497
641
        self._setup_outf()
498
642
 
499
 
        return self.run(**all_cmd_args)
 
643
        return self.run_direct(**all_cmd_args)
 
644
 
 
645
    def run_direct(self, *args, **kwargs):
 
646
        """Call run directly with objects (without parsing an argv list)."""
 
647
        return self._operation.run_simple(*args, **kwargs)
500
648
 
501
649
    def run(self):
502
650
        """Actually run the command.
533
681
            return None
534
682
 
535
683
 
 
684
class CommandHooks(Hooks):
 
685
    """Hooks related to Command object creation/enumeration."""
 
686
 
 
687
    def __init__(self):
 
688
        """Create the default hooks.
 
689
 
 
690
        These are all empty initially, because by default nothing should get
 
691
        notified.
 
692
        """
 
693
        Hooks.__init__(self)
 
694
        self.create_hook(HookPoint('extend_command',
 
695
            "Called after creating a command object to allow modifications "
 
696
            "such as adding or removing options, docs etc. Called with the "
 
697
            "new bzrlib.commands.Command object.", (1, 13), None))
 
698
        self.create_hook(HookPoint('get_command',
 
699
            "Called when creating a single command. Called with "
 
700
            "(cmd_or_None, command_name). get_command should either return "
 
701
            "the cmd_or_None parameter, or a replacement Command object that "
 
702
            "should be used for the command. Note that the Command.hooks "
 
703
            "hooks are core infrastructure. Many users will prefer to use "
 
704
            "bzrlib.commands.register_command or plugin_cmds.register_lazy.",
 
705
            (1, 17), None))
 
706
        self.create_hook(HookPoint('get_missing_command',
 
707
            "Called when creating a single command if no command could be "
 
708
            "found. Called with (command_name). get_missing_command should "
 
709
            "either return None, or a Command object to be used for the "
 
710
            "command.", (1, 17), None))
 
711
        self.create_hook(HookPoint('list_commands',
 
712
            "Called when enumerating commands. Called with a set of "
 
713
            "cmd_name strings for all the commands found so far. This set "
 
714
            " is safe to mutate - e.g. to remove a command. "
 
715
            "list_commands should return the updated set of command names.",
 
716
            (1, 17), None))
 
717
 
 
718
Command.hooks = CommandHooks()
 
719
 
 
720
 
536
721
def parse_args(command, argv, alias_argv=None):
537
722
    """Parse command line.
538
 
    
 
723
 
539
724
    Arguments and options are parsed at this level before being passed
540
725
    down to specific command handlers.  This routine knows, from a
541
726
    lookup table, something about the available options, what optargs
590
775
                               % (cmd, argname.upper()))
591
776
            else:
592
777
                argdict[argname] = args.pop(0)
593
 
            
 
778
 
594
779
    if args:
595
780
        raise errors.BzrCommandError("extra argument to command %s: %s"
596
781
                                     % (cmd, args[0]))
604
789
 
605
790
    tracer = trace.Trace(count=1, trace=0)
606
791
    sys.settrace(tracer.globaltrace)
607
 
 
608
 
    ret = the_callable(*args, **kwargs)
609
 
 
610
 
    sys.settrace(None)
611
 
    results = tracer.results()
612
 
    results.write_results(show_missing=1, summary=False,
613
 
                          coverdir=dirname)
 
792
    threading.settrace(tracer.globaltrace)
 
793
 
 
794
    try:
 
795
        return exception_to_return_code(the_callable, *args, **kwargs)
 
796
    finally:
 
797
        sys.settrace(None)
 
798
        results = tracer.results()
 
799
        results.write_results(show_missing=1, summary=False,
 
800
                              coverdir=dirname)
614
801
 
615
802
 
616
803
def apply_profiled(the_callable, *args, **kwargs):
621
808
    try:
622
809
        prof = hotshot.Profile(pfname)
623
810
        try:
624
 
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
 
811
            ret = prof.runcall(exception_to_return_code, the_callable, *args,
 
812
                **kwargs) or 0
625
813
        finally:
626
814
            prof.close()
627
815
        stats = hotshot.stats.load(pfname)
636
824
        os.remove(pfname)
637
825
 
638
826
 
 
827
def exception_to_return_code(the_callable, *args, **kwargs):
 
828
    """UI level helper for profiling and coverage.
 
829
 
 
830
    This transforms exceptions into a return value of 3. As such its only
 
831
    relevant to the UI layer, and should never be called where catching
 
832
    exceptions may be desirable.
 
833
    """
 
834
    try:
 
835
        return the_callable(*args, **kwargs)
 
836
    except (KeyboardInterrupt, Exception), e:
 
837
        # used to handle AssertionError and KeyboardInterrupt
 
838
        # specially here, but hopefully they're handled ok by the logger now
 
839
        exc_info = sys.exc_info()
 
840
        exitcode = trace.report_exception(exc_info, sys.stderr)
 
841
        if os.environ.get('BZR_PDB'):
 
842
            print '**** entering debugger'
 
843
            tb = exc_info[2]
 
844
            import pdb
 
845
            if sys.version_info[:2] < (2, 6):
 
846
                # XXX: we want to do
 
847
                #    pdb.post_mortem(tb)
 
848
                # but because pdb.post_mortem gives bad results for tracebacks
 
849
                # from inside generators, we do it manually.
 
850
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
 
851
 
 
852
                # Setup pdb on the traceback
 
853
                p = pdb.Pdb()
 
854
                p.reset()
 
855
                p.setup(tb.tb_frame, tb)
 
856
                # Point the debugger at the deepest frame of the stack
 
857
                p.curindex = len(p.stack) - 1
 
858
                p.curframe = p.stack[p.curindex][0]
 
859
                # Start the pdb prompt.
 
860
                p.print_stack_entry(p.stack[p.curindex])
 
861
                p.execRcLines()
 
862
                p.cmdloop()
 
863
            else:
 
864
                pdb.post_mortem(tb)
 
865
        return exitcode
 
866
 
 
867
 
639
868
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
640
869
    from bzrlib.lsprof import profile
641
 
    ret, stats = profile(the_callable, *args, **kwargs)
 
870
    ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
642
871
    stats.sort()
643
872
    if filename is None:
644
873
        stats.pprint()
648
877
    return ret
649
878
 
650
879
 
 
880
@deprecated_function(deprecated_in((2, 2, 0)))
651
881
def shlex_split_unicode(unsplit):
652
 
    import shlex
653
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
882
    return cmdline.split(unsplit)
654
883
 
655
884
 
656
885
def get_alias(cmd, config=None):
668
897
        config = bzrlib.config.GlobalConfig()
669
898
    alias = config.get_alias(cmd)
670
899
    if (alias):
671
 
        return shlex_split_unicode(alias)
 
900
        return cmdline.split(alias)
672
901
    return None
673
902
 
674
903
 
675
 
def run_bzr(argv):
 
904
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
676
905
    """Execute a command.
677
906
 
678
 
    This is similar to main(), but without all the trappings for
679
 
    logging and error handling.  
680
 
    
681
 
    argv
682
 
       The command-line arguments, without the program name from argv[0]
683
 
       These should already be decoded. All library/test code calling
684
 
       run_bzr should be passing valid strings (don't need decoding).
685
 
    
686
 
    Returns a command status or raises an exception.
 
907
    :param argv: The command-line arguments, without the program name from
 
908
        argv[0] These should already be decoded. All library/test code calling
 
909
        run_bzr should be passing valid strings (don't need decoding).
 
910
    :param load_plugins: What function to call when triggering plugin loading.
 
911
        This function should take no arguments and cause all plugins to be
 
912
        loaded.
 
913
    :param disable_plugins: What function to call when disabling plugin
 
914
        loading. This function should take no arguments and cause all plugin
 
915
        loading to be prohibited (so that code paths in your application that
 
916
        know about some plugins possibly being present will fail to import
 
917
        those plugins even if they are installed.)
 
918
    :return: Returns a command exit code or raises an exception.
687
919
 
688
920
    Special master options: these must come before the command because
689
921
    they control how the command is interpreted.
706
938
 
707
939
    --coverage
708
940
        Generate line coverage report in the specified directory.
 
941
 
 
942
    --concurrency
 
943
        Specify the number of processes that can be run concurrently (selftest).
709
944
    """
 
945
    trace.mutter("bazaar version: " + bzrlib.__version__)
710
946
    argv = list(argv)
711
947
    trace.mutter("bzr arguments: %r", argv)
712
948
 
736
972
            opt_no_aliases = True
737
973
        elif a == '--builtin':
738
974
            opt_builtin = True
 
975
        elif a == '--concurrency':
 
976
            os.environ['BZR_CONCURRENCY'] = argv[i + 1]
 
977
            i += 1
739
978
        elif a == '--coverage':
740
979
            opt_coverage_dir = argv[i + 1]
741
980
            i += 1
745
984
            argv_copy.append(a)
746
985
        i += 1
747
986
 
 
987
    debug.set_debug_flags_from_config()
 
988
 
 
989
    if not opt_no_plugins:
 
990
        load_plugins()
 
991
    else:
 
992
        disable_plugins()
 
993
 
748
994
    argv = argv_copy
749
995
    if (not argv):
750
 
        from bzrlib.builtins import cmd_help
751
 
        cmd_help().run_argv_aliases([])
 
996
        get_cmd_object('help').run_argv_aliases([])
752
997
        return 0
753
998
 
754
999
    if argv[0] == '--version':
755
 
        from bzrlib.builtins import cmd_version
756
 
        cmd_version().run_argv_aliases([])
 
1000
        get_cmd_object('version').run_argv_aliases([])
757
1001
        return 0
758
 
        
759
 
    if not opt_no_plugins:
760
 
        from bzrlib.plugin import load_plugins
761
 
        load_plugins()
762
 
    else:
763
 
        from bzrlib.plugin import disable_plugins
764
 
        disable_plugins()
765
1002
 
766
1003
    alias_argv = None
767
1004
 
768
1005
    if not opt_no_aliases:
769
1006
        alias_argv = get_alias(argv[0])
770
1007
        if alias_argv:
771
 
            alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
 
1008
            user_encoding = osutils.get_user_encoding()
 
1009
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
772
1010
            argv[0] = alias_argv.pop(0)
773
1011
 
774
1012
    cmd = argv.pop(0)
781
1019
    run_argv = [argv, alias_argv]
782
1020
 
783
1021
    try:
 
1022
        # We can be called recursively (tests for example), but we don't want
 
1023
        # the verbosity level to propagate.
 
1024
        saved_verbosity_level = option._verbosity_level
 
1025
        option._verbosity_level = 0
784
1026
        if opt_lsprof:
785
1027
            if opt_coverage_dir:
786
1028
                trace.warning(
795
1037
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
796
1038
        else:
797
1039
            ret = run(*run_argv)
 
1040
        return ret or 0
 
1041
    finally:
 
1042
        # reset, in case we may do other commands later within the same
 
1043
        # process. Commands that want to execute sub-commands must propagate
 
1044
        # --verbose in their own way.
798
1045
        if 'memory' in debug.debug_flags:
799
 
            try:
800
 
                status_file = file('/proc/%s/status' % os.getpid(), 'rb')
801
 
            except IOError:
802
 
                pass
803
 
            else:
804
 
                status = status_file.read()
805
 
                status_file.close()
806
 
                trace.note("Process status after command:")
807
 
                for line in status.splitlines():
808
 
                    trace.note(line)
809
 
        return ret or 0
810
 
    finally:
811
 
        # reset, in case we may do other commands later within the same process
812
 
        option._verbosity_level = 0
 
1046
            trace.debug_memory('Process status after command:', short=False)
 
1047
        option._verbosity_level = saved_verbosity_level
 
1048
 
813
1049
 
814
1050
def display_command(func):
815
1051
    """Decorator that suppresses pipe/interrupt errors."""
831
1067
    return ignore_pipe
832
1068
 
833
1069
 
834
 
def main(argv):
835
 
    import bzrlib.ui
836
 
    from bzrlib.ui.text import TextUIFactory
837
 
    bzrlib.ui.ui_factory = TextUIFactory()
838
 
     
839
 
    # Is this a final release version? If so, we should suppress warnings
840
 
    if bzrlib.version_info[3] == 'final':
841
 
        from bzrlib import symbol_versioning
842
 
        symbol_versioning.suppress_deprecation_warnings(override=False)
843
 
    try:
844
 
        argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
845
 
    except UnicodeDecodeError:
846
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
847
 
                                                            "encoding." % a))
 
1070
def install_bzr_command_hooks():
 
1071
    """Install the hooks to supply bzr's own commands."""
 
1072
    if _list_bzr_commands in Command.hooks["list_commands"]:
 
1073
        return
 
1074
    Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
 
1075
        "bzr commands")
 
1076
    Command.hooks.install_named_hook("get_command", _get_bzr_command,
 
1077
        "bzr commands")
 
1078
    Command.hooks.install_named_hook("get_command", _get_plugin_command,
 
1079
        "bzr plugin commands")
 
1080
    Command.hooks.install_named_hook("get_command", _get_external_command,
 
1081
        "bzr external command lookup")
 
1082
    Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
 
1083
        "bzr plugin-provider-db check")
 
1084
 
 
1085
 
 
1086
 
 
1087
def _specified_or_unicode_argv(argv):
 
1088
    # For internal or testing use, argv can be passed.  Otherwise, get it from
 
1089
    # the process arguments in a unicode-safe way.
 
1090
    if argv is None:
 
1091
        return osutils.get_unicode_argv()
 
1092
    else:
 
1093
        new_argv = []
 
1094
        try:
 
1095
            # ensure all arguments are unicode strings
 
1096
            for a in argv[1:]:
 
1097
                if isinstance(a, unicode):
 
1098
                    new_argv.append(a)
 
1099
                else:
 
1100
                    new_argv.append(a.decode('ascii'))
 
1101
        except UnicodeDecodeError:
 
1102
            raise errors.BzrError("argv should be list of unicode strings.")
 
1103
        return new_argv
 
1104
 
 
1105
 
 
1106
def main(argv=None):
 
1107
    """Main entry point of command-line interface.
 
1108
 
 
1109
    Typically `bzrlib.initialize` should be called first.
 
1110
 
 
1111
    :param argv: list of unicode command-line arguments similar to sys.argv.
 
1112
        argv[0] is script name usually, it will be ignored.
 
1113
        Don't pass here sys.argv because this list contains plain strings
 
1114
        and not unicode; pass None instead.
 
1115
 
 
1116
    :return: exit code of bzr command.
 
1117
    """
 
1118
    argv = _specified_or_unicode_argv(argv)
848
1119
    ret = run_bzr_catch_errors(argv)
 
1120
    bzrlib.ui.ui_factory.log_transport_activity(
 
1121
        display=('bytes' in debug.debug_flags))
849
1122
    trace.mutter("return code %d", ret)
850
1123
    return ret
851
1124
 
852
1125
 
853
1126
def run_bzr_catch_errors(argv):
854
 
    # Note: The except clause logic below should be kept in sync with the
855
 
    # profile() routine in lsprof.py.
856
 
    try:
857
 
        return run_bzr(argv)
858
 
    except (KeyboardInterrupt, Exception), e:
859
 
        # used to handle AssertionError and KeyboardInterrupt
860
 
        # specially here, but hopefully they're handled ok by the logger now
861
 
        exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
862
 
        if os.environ.get('BZR_PDB'):
863
 
            print '**** entering debugger'
864
 
            import pdb
865
 
            pdb.post_mortem(sys.exc_traceback)
866
 
        return exitcode
 
1127
    """Run a bzr command with parameters as described by argv.
 
1128
 
 
1129
    This function assumed that that UI layer is setup, that symbol deprecations
 
1130
    are already applied, and that unicode decoding has already been performed on argv.
 
1131
    """
 
1132
    # done here so that they're covered for every test run
 
1133
    install_bzr_command_hooks()
 
1134
    return exception_to_return_code(run_bzr, argv)
867
1135
 
868
1136
 
869
1137
def run_bzr_catch_user_errors(argv):
872
1140
    This is used for the test suite, and might be useful for other programs
873
1141
    that want to wrap the commandline interface.
874
1142
    """
 
1143
    # done here so that they're covered for every test run
 
1144
    install_bzr_command_hooks()
875
1145
    try:
876
1146
        return run_bzr(argv)
877
1147
    except Exception, e:
899
1169
        if topic and topic.startswith(self.prefix):
900
1170
            topic = topic[len(self.prefix):]
901
1171
        try:
902
 
            cmd = _get_cmd_object(topic)
 
1172
            cmd = _get_cmd_object(topic, check_missing=False)
903
1173
        except KeyError:
904
1174
            return []
905
1175
        else:
911
1181
 
912
1182
    def plugin_for_command(self, cmd_name):
913
1183
        '''Takes a command and returns the information for that plugin
914
 
        
915
 
        :return: A dictionary with all the available information 
 
1184
 
 
1185
        :return: A dictionary with all the available information
916
1186
        for the requested plugin
917
1187
        '''
918
1188
        raise NotImplementedError
926
1196
            yield provider
927
1197
 
928
1198
command_providers_registry = ProvidersRegistry()
929
 
 
930
 
 
931
 
if __name__ == '__main__':
932
 
    sys.exit(main(sys.argv))