Miles to kilometers

solutions/README.md

@@ -30,6 +30,7 @@ while corresponding test files are maintained in the `tests` folder.
 | `kronecker_product.py` | Computes the Kronecker ⊗ product of 2 matrices | Fahed|
 | `feet_to_meters.py` | Converting feet to meters| Obay |
 | `volts_to_amperes.py` | Converting volts to amperes| Obay |
+| `miles_to_kilometers.py` | Converting miles to kilometers| Obay |
 | `greatest_number.py` | Finding greatest number in a list| Razan |
 
 ---

solutions/miles_to_kilometers.py

@@ -0,0 +1,42 @@
+"""
+miles_to_kilometers.py
+
+This module provides a function to convert miles to kilometers.
+
+Author: Obay Salih
+Date: Fri 10/1/2025
+Group: ET6-foundations-group-16 (Matrix)
+
+Functions:
+- miles_to_kilometers(miles): Converts miles to kilometers and returns the result.
+"""
+
+
+def miles_to_kilometers(miles: float) -> float:
+    """
+    Convert miles to kilometers.
+
+    Parameters:
+    - miles (int or float): The distance in miles to be converted.
+
+    Returns:
+    - float: The converted distance in kilometers.
+
+    Example:
+    >>> miles_to_kilometers(1)
+    1.609344
+    >>> miles_to_kilometers(10)
+    16.09344
+    """
+    if not isinstance(miles, (int, float)):
+        raise ValueError("Input must be a number.")
+    if miles < 0:
+        raise ValueError("Distance cannot be negative.")
+
+    # Conversion factor from miles to kilometers
+    return miles * 1.609344
+
+
+if __name__ == "__main__":
+    # Example usage
+    print("Example: miles_to_kilometers(5) =", miles_to_kilometers(5))

solutions/tests/test_miles_to_kilometers.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+"""
+Test module for the miles_to_kilometers function.
+
+Test categories:
+    - Standard cases: Positive numbers and zero.
+    - Defensive tests: Non-numeric inputs and negative values.
+"""
+
+import unittest
+from ..miles_to_kilometers import miles_to_kilometers
+
+
+class TestMilesToKilometers(unittest.TestCase):
+    """Test suite for the miles_to_kilometers function."""
+
+    # Standard test cases
+    def test_positive_miles(self):
+        """Test case for positive miles."""
+        self.assertEqual(miles_to_kilometers(1), 1.609344)
+
+    def test_zero_miles(self):
+        """Test case for zero miles."""
+        self.assertEqual(miles_to_kilometers(0), 0.0)
+
+    def test_large_miles(self):
+        """Test case for a large value of miles."""
+        self.assertEqual(miles_to_kilometers(100), 160.9344)
+
+    # Defensive tests
+    def test_negative_miles(self):
+        """Test case for negative miles."""
+        with self.assertRaises(ValueError):
+            miles_to_kilometers(-5)
+
+    def test_non_numeric_input(self):
+        """Test case for non-numeric input."""
+        with self.assertRaises(ValueError):
+            miles_to_kilometers("ten")
+
+
+if __name__ == "__main__":
+    unittest.main()