How to use pytest.yield_fixture and why it be deprecated?

[aiwonderland]

Hi everyone,

How to use pytest.yield_fixture and why it be deprecated?
I see https://docs.pytest.org/en/stable/yieldfixture.html

Remember to tag me!

[aiwonderland]

sorry

[gistrec]

@aiwonderland — pytest.yield_fixture was deprecated in pytest 3.0 (August 2016). The current pytest source still ships it as a thin wrapper that just calls @pytest.fixture and emits a deprecation warning:

@pytest.yield_fixture is deprecated. Use @pytest.fixture instead;
they are the same.

It still works — but you should migrate.

Why it was deprecated: before pytest 3.0, @pytest.fixture only supported return-style fixtures; setup/teardown via yield required the separate @pytest.yield_fixture decorator. In 3.0 the regular @pytest.fixture was extended to handle yield as well, making the two decorators do exactly the same thing — so the dedicated yield_fixture became redundant.

What to use:

import pytest

@pytest.fixture
def db_connection():
    conn = create_connection()    # setup
    yield conn                    # the test runs here
    conn.close()                  # teardown

This is identical to what @pytest.yield_fixture used to do. To migrate old code, just rename the decorator — no other changes needed.

References:

• pytest fixtures: teardown via yield
• The yield_fixture doc page you linked confirms the same: it's an alias now.