Improve handling around helpers.

Author: funilrys

PyFunceble/helpers/command.py

@@ -212,7 +212,7 @@ def run(self, rstrip: bool = True) -> Generator[str, None, None]:
             is that :func:`~PyFunceble.helpers.Command.execute` wait for the
             process to end in order to return its output while this method
             return each line one by one
-            - as they are outputed.
+            - as they are outputted.
 
         :param bool rstrip:
             Deactivates the rstrip of the output.

PyFunceble/helpers/dict.py

@@ -66,7 +66,7 @@ class DictHelper:
     Simplify some :code:`dict` manipulation.
 
     :param dict main: The main :code:`dict` to work with.
-    :raise TypeError: When :code:`main` is not a dict nor a list (tolarated).
+    :raise TypeError: When :code:`main` is not a dict nor a list (tolerated).
     """
 
     _subject: Optional[Union[Any, dict]] = None
@@ -349,7 +349,7 @@ def to_yaml(
         :param bool default_flow_style: Uses the default flow style.
         :param int indent: The indentation to apply.
         :param bool allow_unicode: Allows the decoding of unicode chars.
-        :param bool sort_keys: Sors the keys.
+        :param bool sort_keys: Sorts the keys.
 
         :rtype: dict|list
         """
@@ -371,7 +371,7 @@ def flatten(
         data: Optional[Any] = None,
     ) -> dict:
         """
-        Flatten the current dictionnary.
+        Flatten the current dictionary.
 
         :param separator:
             The separator to apply.
@@ -405,7 +405,7 @@ def flatten(
 
     def unflatten(self, *, separator: str = ".", data: Optional[Any] = None):
         """
-        Unflatten a previously flatten dictionnary.
+        Unflatten a previously flatten dictionary.
 
         :param separator:
             The separator to split.

PyFunceble/helpers/file.py

@@ -183,7 +183,7 @@ def read(self, *, encoding: str = "utf-8") -> Optional[str]:
 
     def read_bytes(self) -> Optional[bytes]:
         """
-        Read the given file ath and returns it's bytes contetn.
+        Read the given file ath and returns it's bytes content.
         """
 
         data = None
@@ -203,7 +203,7 @@ def open(self, *args, **kwargs) -> "open":
 
     def copy(self, destination: str, *, create_parent: bool = False) -> "FileHelper":
         """
-        Copy the globaly given file path to the given destination.
+        Copy the globally given file path to the given destination.
 
         :param str destination: The destination of the copy.
         :param bool create_parent: Tell us if we have to create the parent directory.

PyFunceble/helpers/list.py

@@ -115,18 +115,21 @@ def remove_empty(self) -> "ListHelper":
 
         return self
 
-    def remove_duplicates(self) -> "ListHelper":
+    def remove_duplicates(self, *, efficient: bool = True) -> "ListHelper":
         """
         Removes the duplicates of the current list.
         """
 
-        result = []
+        if efficient:
+            self.subject = list(set(self.subject))
+        else:
+            result = []
 
-        for element in self.subject:
-            if element not in result:
-                result.append(element)
+            for element in self.subject:
+                if element not in result:
+                    result.append(element)
 
-        self.subject = result
+            self.subject = result
 
         return self
 
@@ -147,7 +150,7 @@ def custom_sort(self, key_method: Any, *, reverse: bool = False) -> "ListHelper"
 
         :param key_method:
             A function or method to use to format the
-            readed element before sorting.
+            read element before sorting.
         :type key_method: function|method
 
         :param bool reverse: Tell us if we have to reverse the list.

PyFunceble/helpers/merge.py

@@ -1,5 +1,5 @@
 """
-The tool to check the availability or syntax of dosubject, IP or URL.
+The tool to check the availability or syntax of domain, IP or URL.
 
 ::
 
@@ -164,7 +164,7 @@ def __dict(self, origin: Any, strict: bool = True) -> dict:
 
     def into(self, origin: Any, strict: bool = True) -> Any:
         """
-        Process the mergin.
+        Process the merging.
 
         :param origin: The original data.
         :param strict:

PyFunceble/helpers/regex.py

@@ -63,6 +63,7 @@ class RegexHelper:
     """
 
     _regex: Optional[str] = None
+    _compiled: Optional[re.Pattern] = None
     escape_regex: bool = False
 
     def __init__(self, regex: Optional[str] = None, escape_regex: bool = False):
@@ -99,6 +100,8 @@ def regex(self, value: str) -> None:
         else:
             self._regex = re.escape(value)
 
+        self._compiled = re.compile(self._regex)
+
     def set_regex(self, value: str) -> "RegexHelper":
         """
         Sets the regex to work with.
@@ -120,19 +123,15 @@ def get_not_matching_list(self, data: List[str]) -> List[str]:
         in the given data.
         """
 
-        pre_result = re.compile(self.regex)
-
-        return [x for x in data if not pre_result.search(str(x))]
+        return [x for x in data if not self._compiled.search(str(x))]
 
     def get_matching_list(self, data: List[str]) -> List[str]:
         """
         Returns the strings which does the match the regex
         in the given data.
         """
 
-        pre_result = re.compile(self.regex)
-
-        return [x for x in data if pre_result.search(str(x))]
+        return [x for x in data if self._compiled.search(str(x))]
 
     def match(
         self,
@@ -157,12 +156,11 @@ def match(
         """
 
         result = []
-        to_match = re.compile(self.regex)
 
         if rematch:
-            pre_result = to_match.findall(data)
+            pre_result = self._compiled.findall(data)
         else:
-            pre_result = to_match.search(data)
+            pre_result = self._compiled.search(data)
 
         if return_match and pre_result:
             if rematch:
@@ -209,7 +207,7 @@ def replace_match(
                 self.regex,
                 replacement,
                 data,
-                occurences,
+                count=occurences,
                 flags=re.MULTILINE if multiline else 0,
             )
         return data
@@ -222,4 +220,4 @@ def split(self, data: str) -> List[str]:
         :rtype: list
         """
 
-        return re.split(self.regex, data)
+        return self._compiled.split(data)

tests/helpers/test_list.py

@@ -195,10 +195,29 @@ def test_remove_duplicates(self) -> None:
         given = copy.deepcopy(self.str_test_subject)
 
         expected = ["hello", "world", "", "!", " ", "world!", "Hello"]
-        actual = self.helper.set_subject(given).remove_duplicates().subject
+        actual = (
+            self.helper.set_subject(given).remove_duplicates(efficient=False).subject
+        )
 
         self.assertEqual(expected, actual)
 
+    def test_remove_duplicates_efficient(self) -> None:
+        """
+        Tests the method which let us remove the duplicates from a given list
+        for the case that we want the best possible performance.
+        """
+
+        given = copy.deepcopy(self.str_test_subject)
+
+        expected = ["", "hello", "world!", "world", "!", " ", "Hello"]
+        actual = (
+            self.helper.set_subject(given).remove_duplicates(efficient=True).subject
+        )
+
+        self.assertTrue(isinstance(actual, list))
+        self.assertTrue(len(actual) == len(expected))
+        self.assertTrue(all(x in actual for x in expected))
+
     def test_sort(self) -> None:
         """
         Tests the method which let us sort a given list.