Recommend to use the name argument in the pytest.fixture decorator

[weiiwang01]

Add a tip about using the name argument in the pytest.fixture decorator to avoid naming conflicts.

[jdkandersson]

Thanks for putting this together!

[yanksyoon]

LGTM!

[gregory-schiano]

Can you add a description to the PR, I know the title is self explaining, but let's be consistent in adding descriptions

[gregory-schiano]

I have the filling that this convention could be wider, or more generic.
Something like "always set the name argument" and convention towards fixture function naming "always _fixture suffix" and eventually a "scope" prefix

What will happen if we have the following:
conftest.py

@pytest.fixture
def app():
  yield "app"

test_charm.py

@pytest.fixture(name="app")
def app_fixture(ops_test):
   yield ops_test.model.app

def test_charm(app): None
 ...

[weiiwang01]

Can you add a description to the PR, I know the title is self explaining, but let's be consistent in adding descriptions

Added, thanks!

[arturo-seijas]

LGTM

[weiiwang01]

I have the filling that this convention could be wider, or more generic. Something like "always set the name argument" and convention towards fixture function naming "always _fixture suffix" and eventually a "scope" prefix

What will happen if we have the following: conftest.py

@pytest.fixture
def app():
  yield "app"

test_charm.py

@pytest.fixture(name="app")
def app_fixture(ops_test):
   yield ops_test.model.app

def test_charm(app): None
 ...

I actually view this PR as a recommendation or tip, the original form of fixture still have its benefit of being short and easy to write.

In terms of two fixtures have the same name, pytest will choice one without raising an error. This is a known issue in pytest. pytest-dev/pytest#3966

[jdkandersson]

I have the filling that this convention could be wider, or more generic. Something like "always set the name argument" and convention towards fixture function naming "always _fixture suffix" and eventually a "scope" prefix
What will happen if we have the following: conftest.py

@pytest.fixture
def app():
  yield "app"

test_charm.py

@pytest.fixture(name="app")
def app_fixture(ops_test):
   yield ops_test.model.app

def test_charm(app): None
 ...

I actually view this PR as a recommendation or tip, the original form of fixture still have its benefit of being short and easy to write.

In terms of two fixtures have the same name, pytest will choice one without raising an error. This is a known issue in pytest. pytest-dev/pytest#3966

I'm with Weii here, this standard is more to prevent needing to have clashing names with function and arguments which is a bit messy in Python. When there is no clash, name="app" shouldn't be used since it has the drawback of being longer

[gregory-schiano]

I have the filling that this convention could be wider, or more generic. Something like "always set the name argument" and convention towards fixture function naming "always _fixture suffix" and eventually a "scope" prefix
What will happen if we have the following: conftest.py

@pytest.fixture
def app():
  yield "app"

test_charm.py

@pytest.fixture(name="app")
def app_fixture(ops_test):
   yield ops_test.model.app

def test_charm(app): None
 ...

I actually view this PR as a recommendation or tip, the original form of fixture still have its benefit of being short and easy to write.
In terms of two fixtures have the same name, pytest will choice one without raising an error. This is a known issue in pytest. pytest-dev/pytest#3966

I'm with Weii here, this standard is more to prevent needing to have clashing names with function and arguments which is a bit messy in Python. When there is no clash, name="app" shouldn't be used since it has the drawback of being longer

Ok 👌

[gregory-schiano]

LGTM