Checking membership (in, not in) in PyTest - Framework Patterns

Framework Mode - Checking membership (in, not in)

Folder Structure

project-root/
├── tests/
│   ├── test_membership.py
│   └── __init__.py
├── src/
│   └── membership_utils.py
├── conftest.py
├── pytest.ini
└── requirements.txt
    

Test Framework Layers

• Source Code Layer (src/): Contains the main code to check membership logic, e.g., functions that verify if an item is in a collection.
• Test Layer (tests/): Contains pytest test files that use assertions with in and not in to verify membership behavior.
• Configuration Layer (conftest.py, pytest.ini): Holds pytest configurations and fixtures for setup or reusable test data.
• Utilities Layer: Could include helper functions or test data generators if needed (not shown here for simplicity).

Configuration Patterns

Use pytest.ini to configure pytest options like test paths and markers.

Use conftest.py to define fixtures that provide test data or setup, for example, a fixture that returns a sample list or dictionary to test membership.

Environment variables or command line options can be added for different test scenarios if needed, but for membership tests, simple fixtures suffice.

Test Reporting and CI/CD Integration

Pytest outputs clear pass/fail results in the console.

Use plugins like pytest-html to generate HTML reports for better visualization.

Integrate pytest runs into CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests automatically on code changes.

Failing tests with in or not in assertions will cause the pipeline to fail, alerting developers immediately.

Best Practices

• Use clear, simple test names that describe the membership check, e.g., test_item_in_list.
• Use pytest's assert statements directly with in and not in for readability.
• Keep test data small and focused to isolate membership logic.
• Use fixtures to avoid repeating test data setup.
• Write both positive (item is in collection) and negative (item is not in collection) tests to cover both cases.

Self Check

Where in this folder structure would you add a new test file to check membership of keys in a dictionary?

Key Result

Organize pytest tests in a tests/ folder with fixtures in conftest.py, use clear assertions with 'in' and 'not in' for membership checks.

Practice

1. Which of the following statements correctly checks if the string 'apple' is in the list fruits = ['apple', 'banana', 'cherry'] using pytest assertions?

easy

A. assert fruits in 'apple'

B. assert 'apple' not in fruits

C. assert 'apple' in fruits

D. assert 'apple' == fruits

Solution

1. Step 1: Understand the membership check

   The in keyword checks if an item exists inside a collection like a list.

2. Step 2: Apply the correct assertion

   To confirm 'apple' is in the list, use assert 'apple' in fruits. This passes if 'apple' is found.

3. Final Answer:

   assert 'apple' in fruits -> Option C

4. Quick Check:

   Use in to check presence [OK]

Hint: Use 'in' to check presence, 'not in' for absence [OK]

Common Mistakes:

• Using 'not in' instead of 'in' when checking presence
• Reversing the order like 'fruits in apple'
• Using equality instead of membership check

2. Which of the following is the correct syntax to assert that the number 5 is NOT in the list numbers = [1, 2, 3, 4] using pytest?

easy

A. assert 5 in numbers

B. assert numbers not in 5

C. assert 5 not numbers

D. assert 5 not in numbers

Solution

1. Step 1: Identify the correct membership operator

   To check that 5 is not in the list, use not in keyword.

2. Step 2: Write the correct assertion syntax

   The correct syntax is assert 5 not in numbers. This passes if 5 is absent.

3. Final Answer:

   assert 5 not in numbers -> Option D

4. Quick Check:

   Use 'not in' to check absence [OK]

Hint: Remember 'not in' checks absence, syntax: assert x not in y [OK]

Common Mistakes:

• Misplacing 'not' like 'assert 5 not numbers' (SyntaxError)
• Swapping operands like 'numbers not in 5' which is invalid
• Using 'in' instead of 'not in' for absence check

3. What will be the result of this pytest assertion?

items = ['pen', 'pencil', 'eraser']
assert 'marker' not in items

medium

A. Test passes because 'marker' is not in the list

B. Test fails because 'marker' is in the list

C. SyntaxError due to wrong assertion

D. Test passes because 'marker' is in the list

Solution

1. Step 1: Check if 'marker' is in the list

   The list contains 'pen', 'pencil', and 'eraser'. 'marker' is not present.

2. Step 2: Evaluate the assertion

   The assertion checks that 'marker' is not in items, which is true, so the test passes.

3. Final Answer:

   Test passes because 'marker' is not in the list -> Option A

4. Quick Check:

   Not in list means assertion passes [OK]

Hint: If item absent and 'not in' used, test passes [OK]

Common Mistakes:

• Assuming test fails if item is missing
• Confusing 'in' and 'not in' logic
• Thinking syntax error occurs with 'not in'

4. Identify the error in this pytest assertion and select the correct fix:

colors = ['red', 'green', 'blue']
assert 'yellow' in colors not

medium

A. Use 'assert not 'yellow' in colors' instead

B. SyntaxError: 'not' should come before 'in' as 'not in'

C. Replace 'in' with 'not in' and remove 'not' at the end

D. No error, assertion is correct

Solution

1. Step 1: Analyze the assertion syntax

   The expression ends with 'colors not' which is invalid syntax in Python.

2. Step 2: Correct the membership operator usage

   The correct operator for checking absence is 'not in', written together, not separated.

3. Final Answer:

   SyntaxError: 'not' should come before 'in' as 'not in' -> Option B

4. Quick Check:

   Use 'not in' together, no trailing 'not' [OK]

Hint: Write 'not in' together, never split or reorder [OK]

Common Mistakes:

• Writing 'in colors not' instead of 'not in colors'
• Using 'assert colors not in 'yellow'' which reverses order
• Omitting 'not' or placing it incorrectly

5. You want to write a pytest test to confirm that none of the forbidden words ['spam', 'scam', 'fraud'] appear in the user input string text. Which assertion correctly checks this?

hard

A. assert all(word not in text for word in ['spam', 'scam', 'fraud'])

B. assert any(word in text for word in ['spam', 'scam', 'fraud'])

C. assert 'spam' not in text and 'scam' not in text or 'fraud' not in text

D. assert 'spam' in text or 'scam' in text or 'fraud' in text

Solution

1. Step 1: Understand the requirement

   We want to ensure none of the forbidden words appear in the text, so all must be absent.

2. Step 2: Use a generator with 'all' and 'not in'

   The expression all(word not in text for word in forbidden_words) returns True only if every word is not in text.

3. Step 3: Evaluate other options

   assert any(word in text for word in ['spam', 'scam', 'fraud']) checks if any forbidden word is present (opposite). assert 'spam' not in text and 'scam' not in text or 'fraud' not in text has incorrect logic mixing 'and' and 'or'. assert 'spam' in text or 'scam' in text or 'fraud' in text checks presence, not absence.

4. Final Answer:

   assert all(word not in text for word in ['spam', 'scam', 'fraud']) -> Option A

5. Quick Check:

   Use all() with 'not in' for absence of all items [OK]

Hint: Use all() with 'not in' to confirm all items absent [OK]

Common Mistakes:

• Using any() instead of all() for absence check
• Mixing 'and' and 'or' incorrectly in conditions
• Checking only one forbidden word instead of all