Setting Up and Mastering Testing in Python with Pytest

Introduction to Testing Environment Setup

Welcome to our next step in mastering Test Driven Development (TDD) with Python, where we will focus on setting up a robust testing environment using pytest . As you might recall, the TDD process involves the Red-Green-Refactor cycle — starting with a failing test, writing the minimum code needed to pass it, and then refining the implementation. In this lesson, we will set up the tools necessary for testing with pytest, guiding you on how to create an efficient testing environment that complements the TDD cycle. pytest is a popular Python testing framework known for its ease of use and scalability across projects. This lesson will offer a systematic guide to setting up your environment for efficient testing using pytest .

Creating the pytest Environment

Unlike some testing tools that require extensive configuration, pytest is simple to set up. Start by installing pytest using pip: Shell pip install pytest For projects that require mocking capabilities, consider installing pytest-mock as well: Shell pip install pytest-mock Once installed, running tests is straightforward. Navigate to your project's root directory and execute the following command to discover and run tests: Shell pytest . This command will search for test files in the current directory, represented by the ., and its subdirectories, running all functions prefixed with test_or suffixed with_test . By keeping configurations simple and using command-line options, you can focus on writing and running tests, maintaining emphasis on the TDD process: Red-Green-Refactor.

Running Tests in Watch Mode

For continuous feedback during development, you can use tools like pytest-watcher . Install it via: Shell pip install pytest-watcher Then use the following command to continuously watch for changes and rerun tests: Shell ptw --now . This watch mode enhances productivity by automatically re-running tests upon file changes, aligning with the TDD philosophy: quick feedback and iterative improvements.

Examples of Patterns with pytest

With the environment ready, let's look at a test suite. We’ll utilize a User class example:

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Putting It All Together with Classes

Python

import pytest
from solution import User, fetch_user


@pytest.fixture
def user():
    return User('Jane Doe', 'jane@example.com')


class TestUser: 
    def test_create_users(self, user):
        assert user.get_name() == 'Jane Doe'
        assert user.get_email() == 'jane@example.com'
        assert isinstance(user, User)
        
    def test_invalid_email_throws_error(self):
        with pytest.raises(Exception, match='Invalid email'):
            User('Invalid', 'invalid-email')
            
    @pytest.mark.asyncio
    async def test_fetch_user(self):
        user = await fetch_user()
        assert user.get_name() == 'John Doe'
        assert user.get_email() == 'john@example.com'
        
    class TestUserEmail:
        def test_get_email_returns_correct_email(self, user):
            assert user.get_email() == 'jane@example.com'
            
        def test_email_contains_at_symbol(self, user):
            assert '@' in user.get_email()

import pytest
from solution import User, fetch_user


@pytest.fixture
def user():
    return User('Jane Doe', 'jane@example.com')


class TestUser: 
    def test_create_users(self, user):
        assert user.get_name() == 'Jane Doe'
        assert user.get_email() == 'jane@example.com'
        assert isinstance(user, User)
        
    def test_invalid_email_throws_error(self):
        with pytest.raises(Exception, match='Invalid email'):
            User('Invalid', 'invalid-email')
            
    @pytest.mark.asyncio
    async def test_fetch_user(self):
        user = await fetch_user()
        assert user.get_name() == 'John Doe'
        assert user.get_email() == 'john@example.com'
        
    class TestUserEmail:
        def test_get_email_returns_correct_email(self, user):
            assert user.get_email() == 'jane@example.com'
            
        def test_email_contains_at_symbol(self, user):
            assert '@' in user.get_email()

In this setup:

TestUser class groups tests related to the User class.
Subclass TestUserEmail further organize tests based on their functionality.
test_invalid_email_throws_error handles tests which expect to throw an exception
test_fetch_user class handles async tests separately for clear organization.

Introduction to Testing Environment Setup

Creating the pytest Environment

Running Tests in Watch Mode

Examples of Patterns with pytest

Join the 1M+ learners on CodeSignal

Assertions with `assert`, `is`, `==`, `in`, `isinstance`

Using Classes for Nesting and Grouping

Using Fixtures for Setup

Handling Exceptions

Testing Asynchronous Code

Putting It All Together with Classes

Summary and Next Steps