Applying Python Magic Methods in Unit Tests: __init__, setUp, tearDown, __str__, __repr__, __eq__, __lt__, __len__, __iter__, __getitem__

In Python, magic methods (also called special methods) are uniquely named methods that let you customize class behavior; while not directly used for interface automation testing, they can enhance test frameworks.

__init__ method

Practical use case: initializing the test environment.

import unittest
import requests
class TestAPI(unittest.TestCase):
    def __init__(self, methodName='runTest'):
        super().__init__(methodName)
        self.base_url = 'http://api.example.com'
    def test_get_users(self):
        response = requests.get(self.base_url + '/users')
        self.assertEqual(response.status_code, 200)

setUp method

Practical use case: preparing resources before each test method.

import unittest
import requests
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def test_get_users(self):
        response = requests.get(self.base_url + '/users', headers=self.headers)
        self.assertEqual(response.status_code, 200)

tearDown method

Practical use case: cleaning up resources after each test method.

import unittest
import requests
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def tearDown(self):
        # clean up resources
        pass
    def test_get_users(self):
        response = requests.get(self.base_url + '/users', headers=self.headers)
        self.assertEqual(response.status_code, 200)

__str__ method

Practical use case: changing the string representation of the test class for easier debugging.

import unittest
import requests
class TestAPI(unittest.TestCase):
    def __str__(self):
        return "API Test Suite"
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def test_get_users(self):
        response = requests.get(self.base_url + '/users', headers=self.headers)
        self.assertEqual(response.status_code, 200)

__repr__ method

Practical use case: altering the representation of the test class for debugging.

import unittest
import requests
class TestAPI(unittest.TestCase):
    def __repr__(self):
        return ""
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def test_get_users(self):
        response = requests.get(self.base_url + '/users', headers=self.headers)
        self.assertEqual(response.status_code, 200)

__eq__ method

Practical use case: customizing object equality comparison, useful for testing object equivalence.

import unittest
import requests
class Response:
    def __init__(self, status_code):
        self.status_code = status_code
    def __eq__(self, other):
        return self.status_code == other.status_code
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def test_get_users(self):
        response = Response(200)
        self.assertEqual(response, Response(200))

__lt__ method

Practical use case: customizing "less‑than" comparison for sorting or testing size relationships.

import unittest
import requests
class Response:
    def __init__(self, status_code):
        self.status_code = status_code
    def __lt__(self, other):
        return self.status_code < other.status_code
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def test_compare_responses(self):
        response1 = Response(200)
        response2 = Response(404)
        self.assertTrue(response1 < response2)

__len__ method

Practical use case: defining object length, useful for testing data‑structure size.

import unittest
import requests
class ResponseList:
    def __init__(self, responses):
        self.responses = responses
    def __len__(self):
        return len(self.responses)
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application/json'}
    def test_response_list_length(self):
        response_list = ResponseList([Response(200), Response(404)])
        self.assertEqual(len(response_list), 2)

__iter__ method

Practical use case: customizing iteration behavior to enable looping over object collections.

import unittest
import requests
class ResponseList:
    def __init__(self, responses):
        self.responses = responses
    def __iter__(self):
        return iter(self.responses)
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application.json'}
    def test_response_list_iteration(self):
        response_list = ResponseList([Response(200), Response(404)])
        for response in response_list:
            self.assertGreaterEqual(response.status_code, 200)

__getitem__ method

Practical use case: customizing index access behavior for object collections.

import unittest
import requests
class ResponseList:
    def __init__(self, responses):
        self.responses = responses
    def __getitem__(self, index):
        return self.responses[index]
class TestAPI(unittest.TestCase):
    def setUp(self):
        self.base_url = 'http://api.example.com'
        self.headers = {'Content-Type': 'application.json'}
    def test_response_list_index_access(self):
        response_list = ResponseList([Response(200), Response(404)])
        self.assertEqual(response_list[0].status_code, 200)