Add new usefulib

Author: hamdivazim-archive

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# usefulib temp data
+temp_data/

usefulib/_usefulibs.py

@@ -12,6 +12,7 @@
 import random # generate_random_string()
 import string # generate_random_string()
 import uuid # generateUUID()
+import os # external_verbose_output()
 
 """"""
 
@@ -89,6 +90,8 @@ def filter_by_condition(lst, condition: str):
     return result
 
 def generate_random_string(word_length=18):
+    """ @hamdivazim - generates a random string using ASCII chars, digits and special chars. """
+
     components = [string.ascii_letters, string.digits, "!@#$%&"]
 
     chars = []
@@ -106,6 +109,8 @@ def generate_random_string(word_length=18):
     return "".join(result)
 
 def generateUUID(version=4):
+    """ @hamdivazim - generates a UUID using version 4 by default but you can choose. """
+
     if version < 1 or version > 5:
         raise ValueError(f"{version} is not a valid UUID version number (valid values are 1-5).")
     else:
@@ -118,4 +123,14 @@ def generateUUID(version=4):
         elif version == 4:
             return uuid.uuid4()
         elif version == 5:
-            return uuid.uuid5()
+            return uuid.uuid5()
+        
+def external_verbose_output(data, path="data.log"):
+    """ @hamdivazim - if you are printing a lot of data, you can use this method to write the output to log file. """
+
+    if not os.path.exists(path):
+        open(path, "x").close()
+
+    with open(path, "w") as f:
+        f.write("# Logged by usefulibs.external_verbose_output()\n\n")
+        f.write(data)

usefulib/tests.py

@@ -47,8 +47,8 @@ def test_find_nth_root(self):
 
     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?"]
+        lst = ["I really do love apples!", "Bananas are nice!", "An apple a day keeps the doctor away!", "You want a pear?"]
+        lst2 = [1, "I really do love apples!", "Bananas are nice!", "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")
@@ -65,6 +65,14 @@ def test_generate_random_string(self):
     def test_generateUUID(self):
         """ @hamdivazim """
         self.assertNotEqual(generateUUID(), generateUUID())
+        self.assertRaises(ValueError, generateUUID, 6)
+
+    def test_external_verbose_output(self):
+        """ @hamdivazim """
+        external_verbose_output("Test Data\n1 2 3\na b c", R"usefulib\temp_data\ext_verbose_test.log")
+
+        with open(R"usefulib\temp_data\ext_verbose_test.log", "r") as f:
+            self.assertEqual(f.read(), "# Logged by usefulibs.external_verbose_output()\n\nTest Data\n1 2 3\na b c")
 
 
 if __name__ == "__main__":