{"id":435,"date":"2024-01-29T11:19:39","date_gmt":"2024-01-29T11:19:39","guid":{"rendered":"https:\/\/learnpython.elegantwallp.com\/?p=435"},"modified":"2024-01-29T11:19:41","modified_gmt":"2024-01-29T11:19:41","slug":"python-stubs","status":"publish","type":"post","link":"https:\/\/learnpython.elegantwallp.com\/2024\/01\/29\/python-stubs\/","title":{"rendered":"Python Stubs"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you\u2019ll learn how to use Python stubs to isolate parts of your program from each other for unit testing.<\/p>\n\n\n\n

Introduction to the Python stubs<\/h2>\n\n\n\n

Stubs are test doubles that return hard-coded values. The primary purpose of stubs is to prepare a specific state of the system under test.<\/p>\n\n\n\n

Stubs are beneficial because they return consistent results, making the test easier to write. Also, you can run tests even if the components that stubs are present are not working yet.<\/p>\n\n\n\n

Suppose you need to develop an alarm system that monitors the temperature of a room like a server room.<\/p>\n\n\n\n

To do that you need to set up a temperature sensor device and use the data from that sensor to alert if the temperature is below or above a specific temperature.<\/p>\n\n\n\n

First, define a\u00a0Sensor<\/code>\u00a0class in the\u00a0sensor.py<\/code>\u00a0module:<\/p>\n\n\n\n

import random class Sensor: @property def temperature(self): return random.randint(10, 45)<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
The Sensor<\/code> class has a temperature property that returns a random temperature between 10 and 45. In the real world, the Sensor<\/code> class needs to connect to the sensor device to get the actual temperature.<\/p>\n\n\n\n
Second, define the\u00a0Alarm<\/code>\u00a0class that uses a\u00a0Sensor<\/code>\u00a0object:<\/p>\n\n\n\n
from sensor import Sensor class Alarm: def __init__(self, sensor=None) -> None: self._low = 18 self._high = 24 self._sensor = sensor or Sensor() self._is_on = False def check(self): temperature = self._sensor.temperature if temperature < self._low or temperature > self._high: self._is_on = True @property def is_on(self): return self._is_on<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
By default, the is_on<\/code> property of the Alarm<\/code> is off (False<\/code>). The check()<\/code> method turns the alarm on if the temperature is lower than 18 or higher than 42.<\/p>\n\n\n\n
Once the is_on<\/code> property of an Alarm<\/code> object is on, you can send it to the alarm device to alert accordingly.<\/p>\n\n\n\n
Because the temperature()<\/code> method of the Sensor<\/code> returns a random temperature, it\u2019ll be difficult to test various scenarios to ensure the Alarm<\/code> class works properly.<\/p>\n\n\n\n
To resolve it, you can define a stub for the Sensor<\/code> class called TestSensor<\/code>. The TestSensor<\/code> has the temperature<\/code> property that returns a value provided when its object is initialized.<\/p>\n\n\n\n
Third, define the\u00a0TestSensor<\/code>\u00a0in\u00a0test_sensor.py<\/code>\u00a0module:<\/p>\n\n\n\n
class TestSensor: def __init__(self, temperature) -> None: self._temperature = temperature @property def temperature(self): return self._temperature<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
The TestSensor<\/code> class is like the Sensor<\/code> class except that the temperature<\/code> property returns a value specified in the constructor.<\/p>\n\n\n\n
Fourth, define a\u00a0TestAlarm<\/code>\u00a0class in the\u00a0test_alarm.py<\/code>\u00a0test module and import the\u00a0Alarm<\/code>\u00a0and\u00a0TestSensor<\/code>\u00a0from the\u00a0alarm.py<\/code>\u00a0and\u00a0sensor.py<\/code>\u00a0modules:<\/p>\n\n\n\n
import unittest from alarm import Alarm from test_sensor import TestSensor class TestAlarm(unittest.TestCase): pass<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
Fifth, test if the alarm is off by default:<\/p>\n\n\n\n
import unittest from alarm import Alarm from test_sensor import TestSensor class TestAlarm(unittest.TestCase): def test_is_alarm_off_by_default(self): alarm = Alarm() self.assertFalse(alarm.is_on) <\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
In the test_is_alarm_off_by_default<\/code> we create a new alarm instance and use the assertFalse()<\/code> method to check if the is_on<\/code> property of the alarm object is False<\/code>.<\/p>\n\n\n\n
Run the test:<\/p>\n\n\n\n
python -m unittest -v<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
Output:<\/p>\n\n\n\n
test_is_alarm_off_by_default (test_alarm.TestAlarm) ... ok ---------------------------------------------------------------------- Ran 1 test in 0.000s OK<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
Sixth, test the\u00a0check()<\/code>\u00a0method of the\u00a0Alarm<\/code>\u00a0class in case the temperature is too high:<\/p>\n\n\n\n
import unittest from alarm import Alarm from test_sensor import TestSensor class TestAlarm(unittest.TestCase): def test_is_alarm_off_by_default(self): alarm = Alarm() self.assertFalse(alarm.is_on) def test_check_temperature_too_high(self): alarm = Alarm(TestSensor(25)) alarm.check() self.assertTrue(alarm.is_on)<\/code>Code language: Python (python)<\/small><\/code><\/pre>\n\n\n\n
In the test_check_temperature_too_high()<\/code> test method:<\/p>\n\n\n\n