Merge pull request #80 from MIT-Emerging-Talent/is_prime

Is prime

solutions/IsPrime.py → solutions/is_prime.py

@@ -1,36 +1,36 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """
-A module for finding if an integer is prime.
+Module for finding if an integer is prime.
 
 Module contents:
-    - IsPrime: finds if an integer is prime.
+    - is_prime: finds if an integer is prime.
 
 Created on XX XX XX
 @author: Mohammed Elfadil
 """
 
 
-def IsPrime(a: int) -> str:
+def is_prime(a: int) -> str:
     """Checks if an integer is prime.
     Parameter:
         a: int
     Return -> str: whether a is prime or not
     Raises:
         AssertionError: if the argument is not an integer
-    >>> IsPrime(0)
+    >>> is_prime(0)
     not prime
-    >>> IsPrime(1)
+    >>> is_prime(1)
     not prime
-    >>> IsPrime(2)
+    >>> is_prime(2)
     prime
-    >>> IsPrime(4)
+    >>> is_prime(4)
     not prime
-    >>> IsPrime(7)
+    >>> is_prime(7)
     prime
-    >>> IsPrime(2.5)
+    >>> is_prime(2.5)
     invalid input
-    >>> IsPrime(-1)
+    >>> is_prime(-1)
     not prime
     """
     if not isinstance(a, int):

solutions/tests/test_IsPrime.py → solutions/tests/test_is_prime.py

@@ -1,67 +1,67 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 import unittest
-from solutions.IsPrime import IsPrime
+from solutions.is_prime import is_prime
 
 
 class TestIsPrime(unittest.TestCase):
-    """test the IsPrime function"""
+    """test the is_prime function"""
 
     def test_0(self):
         """It should evaluate not prime"""
-        actual = IsPrime(0)
+        actual = is_prime(0)
         expected = "not prime"
         self.assertEqual(actual, expected)
 
     def test_1(self):
         """It should evaluate not prime"""
-        actual = IsPrime(1)
+        actual = is_prime(1)
         expected = "not prime"
         self.assertEqual(actual, expected)
 
     def test_2(self):
-        actual = IsPrime(2)
+        actual = is_prime(2)
         expected = "prime"
         self.assertEqual(actual, expected)
 
     def test_4(self):
         """its should evaluate not prime"""
-        actual = IsPrime(4)
+        actual = is_prime(4)
         expected = "not prime"
         self.assertEqual(actual, expected)
 
     def test_7(self):
         """It should evaluate prime"""
-        actual = IsPrime(7)
+        actual = is_prime(7)
         expected = "prime"
         self.assertEqual(actual, expected)
 
     def test_9(self):
         """It should evaluate not prime"""
-        actual = IsPrime(9)
+        actual = is_prime(9)
         expected = "not prime"
         self.assertEqual(actual, expected)
 
     def test_11(self):
         """It should evaluate prime"""
-        actual = IsPrime(11)
+        actual = is_prime(11)
         expected = "prime"
         self.assertEqual(actual, expected)
 
     def test_13(self):
         """It should evaluate prime"""
-        actual = IsPrime(13)
+        actual = is_prime(13)
         expected = "prime"
         self.assertEqual(actual, expected)
 
     def test_negative(self):
         """It should evaluate not prime"""
-        actual = IsPrime(-1)
+        actual = is_prime(-1)
         expected = "not prime"
         self.assertEqual(actual, expected)
 
     def test_not_integer(self):
         """It should evaluate not prime"""
-        actual = IsPrime(1.5)
+        actual = is_prime(1.5)
         expected = "invalid input"
         self.assertEqual(actual, expected)