Merge pull request #36 from MIT-Emerging-Talent/positive-number-function

Add Positive number function to the main

solutions/is_positive.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Created on XX XX XX
+
+A module for checking if an integer is positive.
+
+@author: Luyando .E. Chitindi
+"""
+
+
+def is_positive(number: int) -> bool:
+    """
+    This checks if an integer is positive.
+
+    Parameters:
+    number: int, the number to check
+
+    Returns -> bool:
+        True if the number is positive, false otherwise.
+
+    Raises:
+        AssertionError: if the input is not an integer
+
+    Example:
+    >>> is_positive(4)
+    True
+    >>> is_positive(-3)
+    False
+    >>> is_positive(0)
+    False
+    >>> is_positive("hello")
+    Traceback (most recent call last):
+        ...
+    AssertionError: Input must be an integer.
+    """
+    assert isinstance(number, int), "Input must be an integer"
+    return number > 0

solutions/tests/test_is_positive.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Unit tests for the is_positive function.
+
+@author: Luyando .E. Chitindi
+"""
+
+import unittest
+from solutions.is_positive import is_positive
+
+
+class TestIsPositive(unittest.TestCase):
+    """Test the is_positive function"""
+
+    def test_positive_number(self):
+        """It should evaluate 4 to True"""
+        actual = is_positive(4)
+        expected = True
+        self.assertEqual(actual, expected)
+
+    def test_negative_number(self):
+        """It should evaluate -3 to False"""
+        actual = is_positive(-3)
+        expected = False
+        self.assertEqual(actual, expected)
+
+    def test_zero(self):
+        """It should evaluate 0 to False"""
+        actual = is_positive(0)
+        expected = False
+        self.assertEqual(actual, expected)
+
+    def test_non_integer_input(self):
+        """It should raise an assertion error if the argument is not an integer"""
+        with self.assertRaises(AssertionError):
+            is_positive(3.5)
+
+        with self.assertRaises(AssertionError):
+            is_positive("string")
+
+
+if __name__ == "__main__":
+    unittest.main()