Code cleanup, add new setup script and tests

Author: hamdivazim-archive

usefulib/_usefulibs.py

@@ -7,12 +7,13 @@
 Add your useful method here if you are contributing. Remember to add unit tests in tests.py :)
 """
 
-if __name__ == "__main__":
-    import setup_script
-else:
-    from . import setup_script
+""" Setup - add any setup scripts here remembering to put the function(s) they are for. """
 
-setup_script.SETUP() # If you need any setup scripts, write them in setup_script.py. 
+import random # generate_random_string()
+import string # generate_random_string()
+import uuid # generateUUID()
+
+""""""
 
 def reverse_string(string):
     """ @hamdivazim - Reverses a string. """
@@ -37,7 +38,7 @@ def loop_dict(dictionary):
     i = 0
 
     for key in dictionary.keys():
-        result += (key, dictionary[key], i)
+        result.append((key, dictionary[key], i))
 
         i += 1
 
@@ -46,24 +47,23 @@ def loop_dict(dictionary):
 def find_nth_root(num, n):
     """ @hamdivazim - Returns the nth root of a number you provide. """
 
+    if num < 0:
+        raise ValueError("Cannot get root of a negative number.")
+
     return num ** (1 / n)
 
-def filter_by_string(lst, string):
+def filter_by_string(lst, stri):
     """ 
     @hamdivazim - Filters a list based on whether elements contain a specific string.
     Probably best used when filtering by a search query.
     """
 
-    result = []
+    try:
+        result = [x for x in lst if stri in x]
 
-    for element in lst:
-        try:
-            if string in element:
-                result += element
-        except TypeError:
-            raise TypeError("A non-string value was found while using the usefulib.filter_by_string method. Maybe try using filter_by_condition?")
-        
-    return result
+        return result
+    except TypeError:
+        raise TypeError("A non-string value was found while filtering. Maybe try using filter_by_condition()?")
 
 def filter_by_condition(lst, condition: str):
     """
@@ -84,11 +84,11 @@ def filter_by_condition(lst, condition: str):
     result = []
 
     for i in lst:
-        exec(f"if({condition}):result+=i")
+        exec(f"if({condition}):result.append(i)")
 
     return result
 
-def generate_random_string(word_length):
+def generate_random_string(word_length=18):
     components = [string.ascii_letters, string.digits, "!@#$%&"]
 
     chars = []

usefulib/setup_script.py

@@ -6,4 +6,66 @@
 
 
 This is where you should write unit tests for your useful method. If you can't do so for any reason, mention so in your PR so I can help.
-"""
+"""
+
+import unittest
+from _usefulibs import *
+
+class TestUsefulibs(unittest.TestCase):
+
+    def setUp(self):
+        # For now, there are no setup scripts for tests. If you need to add one, remove this comment and add it.
+        pass
+
+    def test_reverse_string(self):
+        """ @hamdivazim """
+
+        self.assertEqual(reverse_string("abc"), "cba")
+        self.assertEqual(reverse_string("123abcdef456"), "654fedcba321")
+
+    def test_loop_dict(self):
+        """ @hamdivazim """
+        test_dict = {"a": 1, "b": 2, "c": 3, "d": 4, "e": 5}
+
+        self.assertEqual(loop_dict(test_dict), [("a", 1, 0),("b", 2, 1),("c", 3, 2),("d", 4, 3),("e", 5, 4),])
+
+        index = 0
+        for key, val, i in loop_dict(test_dict):
+            if index == 1:
+                self.assertEqual(key, "b")
+                self.assertEqual(val, 2)
+                self.assertEqual(i, 1)
+            
+            index += 1
+
+    def test_find_nth_root(self):
+        """ @hamdivazim """
+        self.assertEqual(find_nth_root(8, 3), 2)
+        self.assertEqual(find_nth_root(729, 6), 3)
+        self.assertEqual(find_nth_root(4, -2), 0.5)
+        self.assertRaises(ValueError, find_nth_root, -4, -2)
+
+    def test_filter_by_string(self):
+        """ @hamdivazim """
+        lst = ["I really do love apples!", "Bananas are disgusting!", "An apple a day keeps the doctor away!", "You want a pear?"]
+        lst2 = [1, "I really do love apples!", "Bananas are disgusting!", "An apple a day keeps the doctor away!", "You want a pear?"]
+
+        self.assertEqual(filter_by_string(lst, "apple")[1], "An apple a day keeps the doctor away!")
+        self.assertRaises(TypeError, filter_by_string, lst2, "apple")
+
+    def test_filter_by_condition(self):
+        """ @hamdivazim """
+        self.assertEqual(filter_by_condition([0,1,2,3,4,5,6,7,8,9,10], "i % 2 == 0"), [0, 2, 4, 6, 8, 10])
+        self.assertEqual(filter_by_condition(["123abc", "456def", "123456"], '"123" in i'), ["123abc", "123456"])
+
+    def test_generate_random_string(self):
+        """ @hamdivazim """
+        self.assertNotEqual(generate_random_string(18), generate_random_string(18))
+
+    def test_generateUUID(self):
+        """ @hamdivazim """
+        self.assertNotEqual(generateUUID(), generateUUID())
+
+
+if __name__ == "__main__":
+    unittest.main()