Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to using pytest's tmp_path over legacy tmpdir #209

Closed
matthewfeickert opened this issue Nov 21, 2023 · 0 comments · Fixed by #207
Closed

Update to using pytest's tmp_path over legacy tmpdir #209

matthewfeickert opened this issue Nov 21, 2023 · 0 comments · Fixed by #207

Comments

@matthewfeickert
Copy link

Nothing breaks yet, but pytest now uses the tmp_path and tmp_path_factory fixtures over the (now "legacy") tmpdir and tmpdir_factory fixtures.

From the pytest docs (https://docs.pytest.org/en/7.4.x/how-to/tmp_path.html#the-tmpdir-and-tmpdir-factory-fixtures):

The tmpdir and tmpdir_factory fixtures are similar to tmp_path and tmp_path_factory, but use/return legacy py.path.local objects rather than standard pathlib.Path objects.

Note

These days, it is preferred to use tmp_path and tmp_path_factory.

In order to help modernize old code bases, one can run pytest with the legacypath plugin disabled:

pytest -p no:legacypath

This will trigger errors on tests using the legacy paths. It can also be permanently set as part of the addopts parameter in the config file.

While this should be a small internal change, it seems like still using tmpdir is keeping projects that use pytest-mpl form using the legacypath plugin to do validation (c.f. scikit-hep/pyhf#2384 (comment)).

@ConorMacBride ConorMacBride linked a pull request Nov 21, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant