Skip: mark tests as skipped — nose 1.3.7 documentation

# Skip: mark tests as skipped

This plugin installs a SKIP error class for the SkipTest exception. When SkipTest is raised, the exception will be logged in the skipped attribute of the result, ‘S’ or ‘SKIP’ (verbose) will be output, and the exception will not be counted as an error or failure. This plugin is enabled by default but may be disabled with the `--no-skip` option.

## Options

`--no-skip```

  Disable special handling of SkipTest exceptions.

## Plugin

class `nose.plugins.skip.` `Skip`

  Bases: `nose.plugins.errorclass.ErrorClassPlugin`

  Plugin that installs a SKIP error class for the SkipTest exception. When SkipTest is raised, the exception will be logged in the skipped attribute of the result, ‘S’ or ‘SKIP’ (verbose) will be output, and the exception will not be counted as an error or failure.

  `configure`(options, conf)

    Configure plugin. Skip plugin is enabled by default.

  `options`(parser, env)

    Add my options to command line.

## Source

    """
    This plugin installs a SKIP error class for the SkipTest exception.
    When SkipTest is raised, the exception will be logged in the skipped
    attribute of the result, 'S' or 'SKIP' (verbose) will be output, and
    the exception will not be counted as an error or failure. This plugin
    is enabled by default but may be disabled with the ``--no-skip`` option.
    """

    from nose.plugins.errorclass import ErrorClass, ErrorClassPlugin

    # on SkipTest:
    #  - unittest SkipTest is first preference, but it's only available
    #    for >= 2.7
    #  - unittest2 SkipTest is second preference for older pythons.  This
    #    mirrors logic for choosing SkipTest exception in testtools
    #  - if none of the above, provide custom class
    try:
        from unittest.case import SkipTest
    except ImportError:
        try:
            from unittest2.case import SkipTest
        except ImportError:
            class SkipTest(Exception):
                """Raise this exception to mark a test as skipped.
                """
                pass

    class Skip(ErrorClassPlugin):
        """
        Plugin that installs a SKIP error class for the SkipTest
        exception.  When SkipTest is raised, the exception will be logged
        in the skipped attribute of the result, 'S' or 'SKIP' (verbose)
        will be output, and the exception will not be counted as an error
        or failure.
        """
        enabled = True
        skipped = ErrorClass(SkipTest,
                             label='SKIP',
                             isfailure=False)

        def options(self, parser, env):
            """
            Add my options to command line.
            """
            env_opt = 'NOSE_WITHOUT_SKIP'
            parser.add_option('--no-skip', action='store_true',
                              dest='noSkip', default=env.get(env_opt, False),
                              help="Disable special handling of SkipTest "
                              "exceptions.")

        def configure(self, options, conf):
            """
            Configure plugin. Skip plugin is enabled by default.
            """
            if not self.can_configure:
                return
            self.conf = conf
            disable = getattr(options, 'noSkip', False)
            if disable:
                self.enabled = False