pytest fixtures Redefining name from outer scope [pylint]

Question

I'm learning pytest and I lint my code with pylint. But pylint still complaints about:
W0621: Redefining name %r from outer scope (line %s)

for the following example from pytest:

# test_wallet.py

@pytest.fixture
def my_wallet():
    '''Returns a Wallet instance with a zero balance'''
    return Wallet()

@pytest.mark.parametrize("earned,spent,expected", [
    (30, 10, 20),
    (20, 2, 18),
])
def test_transactions(my_wallet, earned, spent, expected):
    my_wallet.add_cash(earned)
    my_wallet.spend_cash(spent)
    assert my_wallet.balance == expected

Redefining name my_wallet from outer scope.

I found workaround to add _ prefix to the fixture name: _my_wallet.

What would be the best practice if I want to keep fixtures in same file as functions?

Prepend all fixtures with _?
Disable this pylint check for tests?
Better suggestion?

aruku7230 · Accepted Answer · 2021-06-21 00:01:00Z

227

The pytest docs for @pytest.fixture say this:

If a fixture is used in the same module in which it is defined, the function name of the fixture will be shadowed by the function arg that requests the fixture; one way to resolve this is to name the decorated function fixture_<fixturename> and then use @pytest.fixture(name='<fixturename>').

So this solution is similar to your option 1, except that the pytest author suggests a slightly more descriptive name for the fixture function. So replace these two lines

@pytest.fixture
def my_wallet():

with:

@pytest.fixture(name="my_wallet")
def fixture_my_wallet():

The description in the docs also hints at another solution which is to move the fixtures into conftest.py so they are not in the same module as the test code using the fixtures. This location is also useful for sharing fixtures among test modules.

edited Jun 21, 2021 at 0:01

aruku7230

1,03112 silver badges24 bronze badges

answered Jul 13, 2019 at 0:35

hallidave

10.5k6 gold badges34 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

ademoverflow Over a year ago

This should be the valid answer.

benwshul Over a year ago

Here's an updated link to the relevant pytest docs

Lqueryvg Over a year ago

This works. But you still get pylint errors if you are using mocker. For example: from pytest_mock import mocker followed by def test_my_thing(mocker): gives you a pylint error. I think this is why so many people voted for the other answer which suggests disabling this pylint rule for the WHOLE file. This is BAD imo. It seems to me that pylint stomps all over good linting rules.

dVeza Over a year ago

funny thing, now I get "unused argument 'name'"

Garrett Bates · Accepted Answer · 2019-01-04 20:39:20Z

52

I just disabled that rule in my test files:

# pylint: disable=redefined-outer-name
# ^^^ this
import pytest

@pytest.fixture
def my_wallet():
    '''Returns a Wallet instance with a zero balance'''
    return Wallet()

@pytest.mark.parametrize("earned,spent,expected", [
    (30, 10, 20),
    (20, 2, 18),
])
def test_transactions(my_wallet, earned, spent, expected):
    my_wallet.add_cash(earned)
    my_wallet.spend_cash(spent)
    assert my_wallet.balance == expected

answered Jan 4, 2019 at 20:39

Garrett Bates

9371 gold badge11 silver badges16 bronze badges

2 Comments

Lqueryvg Over a year ago

This is sad. The lint rule is there for a good reason. I blame pylint for this.

Or b Over a year ago

@Lqueryvg I am a Pylint contributor, I opened a bug issue regarding this False Positive message. github.com/PyCQA/pylint/issues/6531

gore · Accepted Answer · 2020-12-26 13:20:59Z

10

Add name parameter for fixture and fixture_ prefix in def.

@pytest.fixture(name="my_wallet")
def fixture_wallet():
    '''Returns a Wallet instance with a zero balance.'''
    return Wallet()

@pytest.mark.parametrize("earned, spent, expected", [
    (30, 10, 20),
    (20, 2, 18),
])
def test_transactions(my_wallet, earned, spent, expected):
    my_wallet.add_cash(earned)
    my_wallet.spend_cash(spent)
    assert my_wallet.balance == expected

edited Dec 26, 2020 at 13:20

gore

5712 silver badges20 bronze badges

answered Oct 14, 2020 at 5:45

CSRedRat

1,0268 silver badges8 bronze badges

Comments

phd · Accepted Answer · 2020-05-06 14:02:37Z

5

It's usually disabled (1, 2).

There is a pylint-pytest plugin that tried to fix some problems, but the error W0621 is not fixed yet.

edited May 6, 2020 at 14:02

user3064538

answered Sep 8, 2017 at 19:16

phd

97.8k14 gold badges168 silver badges225 bronze badges

3 Comments

sqd Over a year ago

Doesn't this plugin error out during pytest on pylint warnings, instead of suppressing pylint warnings in tests code?

RasmusWL Over a year ago

yes, the pluging @insysion is linking to runs pylint as part pytest, and has nothing to do with fixing pylint error messages on common pytest fixture usage.

Cody Django Over a year ago

this plugin doesn't seem to work properly when using the "enable" pytest configuration. Any flag that is "enabled" takes precedence over what pylint-pytest is trying to do.

Collectives™ on Stack Overflow

pytest fixtures Redefining name from outer scope [pylint]

4 Answers 4

4 Comments

2 Comments

Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

4 Comments

2 Comments

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related