pytest-dev / pytest-dev/pytest

Warn on test arguments with default values?

Open
#12,693 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: enhancement
Dominant language
Python
Stars
14.5k
Forks
3.4k
Avg merge
2d 9h
Merged PRs (30d)
35

Description

As someone pointed out in my pytest training, pytest currently silently accepts:

def test_fixt(fixt=42):
    ...

with fixt obviously being 42 in the test function no matter if such a fixture was ever defined or not.

There doesn't really seem any valid reason to do this kind of thing, yet some ideas float around how default argument like this could be used in the future with either test functions (e.g. #3834) or with fixture functions (e.g. #8109).

To avoid accidental usage and possibly allow for different usage in the future, should we maybe add a warning if default argument values are used like this?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. First determine how pytest handles test-function defaults during collection and how warnings are emitted, then clarify the intended behavior in light of the possible future uses mentioned. Done means an agreed warning policy with focused coverage for default-valued test arguments.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.