Skip to content

Commit

Permalink
Merge pull request #126 from MIT-Emerging-Talent/common-elements
Browse files Browse the repository at this point in the history
Solution for (common elements) challenge
Bikaze authored Jan 11, 2025
2 parents 86f96cf + 20fe30c commit 9d930ff
Showing 3 changed files with 214 additions and 0 deletions.
3 changes: 3 additions & 0 deletions solutions/README.md
Original file line number Diff line number Diff line change
@@ -35,6 +35,9 @@ while corresponding test files are maintained in the `tests` folder.
| `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 |
| `common_elements.py` | finding common elements in two lists | Mohamed|
| `simple_calculator.py` | performs simple operations on two integers | Mohamed|
| `reverse_string.py` | reverses contents of an input string | Mohamed|
| `check_prime_number.py` | Given a positive int if it is a prime number| Özgür |
| `password_strength.py` | Checks the strength of a password| Anas |
| `decimal_to_binary.py` | Converts decimal to its equivalent binary| Anas |
59 changes: 59 additions & 0 deletions solutions/common_elements.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
A module for finding the common elements between two input lists.
Created on 11/1/2025
@author: Mohamed Altayeb
Group: ET foundations group 16 (Matrix)
Module functions:
- common_elements: finds the common elements between two lists.
"""


def common_elements(list1: list, list2: list) -> list:
"""
Compares two input lists and returns a list that contains
all the common elements between the two input lists without repeating
the common elements if they are duplicated in the input lists:
Arguments:
list1 (list): the first list we want to compare.
list2 (list): the second list we want to compare.
Returns-> list: A list containing all common elements between two input lists,
the returned list will have the common elements of the first input list
followed by the common elements of the second input list.
Raises:
AssertionError: if inputs are not lists.
>>> common_elements([1,2,3,4,5,6] , [4,5,6,7])
[4, 5, 6]
>>> common_elements(["c", "a", "r"] , ["c", "a", "t"])
['c', 'a']
>>> common_elements([[1,2] , [2,3,4], ["mohamed"]] , [["mohamed"], [1,2,3], [2,3,4], [4,5,6]])
[[2, 3, 4], ['mohamed']]
"""
# Ensure both inputs are lists
if not isinstance(list1, list) or not isinstance(list2, list):
raise AssertionError("Both inputs must be lists")

common_list_no_duplicates = []

# Iterate through elements of the first list
for element1 in list1:
# Iterate through elements of second list comparing
# each element in the second list to the element in the first list
for element2 in list2:
if element1 == element2 and element1 not in common_list_no_duplicates:
# Add the element to the resultant list
common_list_no_duplicates.append(element1)

# Return the resultant list with common elements with no duplicated elements
return common_list_no_duplicates
152 changes: 152 additions & 0 deletions solutions/tests/test_common_elements.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Test module for common_elements function
Test categories:
-Standard cases: typical inputs
-Edge cases: extreme inputs and boundaries
-Defensive tests: wrong input types, assertions
Created on 11/1/2025
@author: Mohamed Altayeb
Group: ET foundations group 16 (Matrix)
"""

import unittest

from ..common_elements import common_elements


class TestCommonElements(unittest.TestCase):
"""Test suite for the common_elements function"""

# Standard cases
def test_lists_with_integers(self):
"""it should return a list with the common integers between the two input lists"""
self.assertEqual(common_elements([1, 2, 3], [2, 3]), [2, 3])

def test_lists_with_string_elements(self):
"""it should return a list with the common string elements between the two input lists"""
self.assertEqual(common_elements(["a", "b", "c"], ["b", "c"]), ["b", "c"])

def test_lists_with_duplicated_elements(self):
"""it should return a list with the common elements between the two input lists
without duplicating the elements in the output list"""
self.assertEqual(common_elements(["a", "b", "b"], ["b", "b", "c"]), ["b"])

def test_lists_with_mixed_string_and_integer_elements(self):
"""it should return a list with the common string elements between the two input lists"""
self.assertEqual(
common_elements(["a", "b", 2, 56, "abc"], ["abc", 56, 999]), [56, "abc"]
)

def test_lists_within_lists(self):
"""it should return a list with the common elements between the two input lists
even if the elements are lists as well"""
self.assertEqual(
common_elements(
[[1, 2], [2, 3, 4], ["mohamed"]],
[["mohamed"], [1, 2, 3], [2, 3, 4], [4, 5, 6]],
),
[[2, 3, 4], ["mohamed"]],
)

def test_order_of_elements_in_output_list(self):
"""the function should prioritize the order of the elements in the first input list"""
self.assertEqual(common_elements([1, 2, 3], [3, 2, 1]), [1, 2, 3])

# Edge cases
def test_long_lists(self):
"""it should return a list with the common elements between the two input lists
regardless of the length of the input lists"""
self.assertEqual(
common_elements(
[
1,
2,
3,
4,
5,
6,
7,
8,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
],
[
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
9,
],
),
[9],
)

def test_one_of_the_lists_is_empty(self):
"""it should return an empty list"""
self.assertEqual(common_elements(["Mohamed", "cat", "1,2,3"], []), [])

def test_both_of_the_lists_are_empty(self):
"""it should return an empty list"""
self.assertEqual(common_elements([], []), [])

# Defensive tests
def test_input1_is_not_a_list(self):
"""It should raise AssertionError if first input is not a list"""
with self.assertRaises(AssertionError):
common_elements("mohamed", [1, 2, 3, 4, 5, 6])

def test_input2_is_not_a_list(self):
"""It should raise AssertionError if second input is not a list"""
with self.assertRaises(AssertionError):
common_elements([1, 2, 3, 4, 5, 6], "numbers")

0 comments on commit 9d930ff

Please sign in to comment.