Disable nose running setup()

Question

The nose package is often used to run doctests as well as tests in dedicated test files. It appears that even in doctest files, it attempts to run the setup and teardown fixtures.

When the module for doctesting happens to require a function named setup for some other purpose -- it may be a Sphinx extension, for example -- nosetests will call setup and fail.

To be clear, here is an example:

def my_tricky_function(arg):
    """Do something testable

    >>> my_tricky_function(1)
    2
    """
    return arg + arg


def my_extension(app):
    ...


def setup(app):
    """Establish sphinx hooks"""
    app.connect('build-finished', my_extension)

Running nosestests results in:

File ".../site-packages/nose/suite.py", line 291, in setUp
    self.setupContext(ancestor)
  File ".../site-packages/nose/suite.py", line 314, in setupContext
    try_run(context, names)
  File ".../site-packages/nose/util.py", line 468, in try_run
    return func(obj)
  File "sphinx_ext.py", line 14, in setup
    app.connect('build-finished', my_extension)
AttributeError: 'module' object has no attribute 'connect'

(Note: when setup accepts an argument, nosetest passes the scope in which setup is a name, in this case the module.)

Note that the following do not (seem to) apply:

adding an attribute __test__ = False (or using this decorator) to setup doesn't stop it being called.
there is no command-line option equivalent to --ignore-files
setting my_tricky_function.setup = None does not stop the module-level setup (h/t @alecxe)

Just a shot in the dark - does setting `my_tricky_function.setup = None` help? — alecxe, May 20 '14 at 00:33

score 1 · Answer 1 · answered Jan 21 '16 at 21:47

While joeln's own answer is nifty, it does pollute the top-level namespace of the module a bit.

I would check the arguments to setup() to distinguish a nosetests call from a normal call. In your case, if app is a module (or has no connect attribute), simply return and do nothing.

def setup(app):
    """Establish sphinx hooks"""
    if hasattr(app, 'connect'):
        app.connect('build-finished', my_extension)

I had this issue where a custom setuptools.setup(**kwargs) tripped up nose. While nosetests called it without any arguments, normal usage of setup() would always pass in some keyword arguments, which allows me to distinguish the two cases.

score 0 · Accepted Answer · answered May 20 '14 at 01:53

I have found the following somewhat hacky solution: add another function setup_module which will hide setup from nose.

...

def setup(app):
    """Establish sphinx hooks"""
    app.connect('build-finished', my_extension)

def setup_module():
    pass

Disable nose running setup()

2 Answers2