Improvements to remove_word + new method: remove_word_list

profanityfilter/profanityfilter.py

@@ -53,9 +53,30 @@ def append_words(self, word_list):
         """Define a custom list of profane words to be used in conjunction with the default list."""
         self._extra_censor_list.extend(word_list)
 
-    def remove_word(self, word):
-        """Remove given word from censor list."""
-        self._censor_list.remove(word)
+    def remove_word(self, word, anywhere=True):
+        """
+        Remove given word from censor list.
+            - anywhere (bool):
+                attempt removal from both the extra censor list and the custom/default censor list
+        """
+        if word in self._extra_censor_list and anywhere:
+            self._extra_censor_list.remove(word)
+        else:
+            if word in self._custom_censor_list:
+                self._custom_censor_list.remove(word)
+            else:
+                self._censor_list.remove(word)
+
+    def remove_words(self, word_list, anywhere=True):
+        """
+        Remove given list of words from censor list.
+            - anywhere (bool):
+                attempt removal from both the extra censor list and the custom/default censor list
+            - word_list (list):
+                the list of words to remove
+        """
+        for word in word_list:
+            self.remove_word(word, anywhere=anywhere)
 
     def set_censor(self, character):
         """Replaces the original censor character '*' with ``character``."""

tests/test_profanity.py

@@ -2,7 +2,7 @@
 import unittest
 
 pf = ProfanityFilter()
-TEST_STATEMENT = "Hey, I like unicorns, chocolate and oranges, Turd!"
+TEST_STATEMENT = "Hey, I like unicorns, chocolate and oranges, big old Turd!"
 CLEAN_STATEMENT = "Hey there, I like chocolate too mate."
 
 def update_censored(pf_instance=pf):
@@ -28,10 +28,10 @@ def test_censor(self):
             "My email is fuckyoubitch@****.com"
         )
         update_censored()
-        self.assertEqual(censored, "Hey, I like unicorns, chocolate and oranges, ****!")
+        self.assertEqual(censored, "Hey, I like unicorns, chocolate and oranges, big old ****!")
         pf.set_censor("#")
         update_censored()
-        self.assertEqual(censored, "Hey, I like unicorns, chocolate and oranges, ####!")
+        self.assertEqual(censored, "Hey, I like unicorns, chocolate and oranges, big old ####!")
 
     def test_define_words(self):
         # Testing pluralization here as well
@@ -42,18 +42,34 @@ def test_define_words(self):
         self.assertTrue("Turd" in censored)
 
     def test_append_words(self):
-        pf.append_words(["Hey", "like"])
+        pf.append_words(["Hey", "like", "old"])
         update_censored()
         self.assertTrue("oranges" in censored)
         self.assertFalse("Hey" in censored)
         self.assertFalse("like" in censored)
         self.assertFalse("Turd" in censored)
+        self.assertTrue("big" in censored)
+        self.assertFalse("old" in censored)
 
     def test_remove_word(self):
         self.assertTrue("Turd" in censored)
+        self.assertFalse("old" in censored)
         pf.remove_word("turd")
+        pf.remove_word("old")
         update_censored()
         self.assertTrue("Turd" in censored)
+        self.assertTrue("old" in censored)
+
+    def test_remove_words(self):
+        self.assertTrue("like" in censored)
+        self.assertTrue("I" in censored)
+        self.assertFalse("xxx" in censored)
+        pf.remove_words(["chocolate", "like", "xxx"])
+        update_censored()
+        self.assertTrue("there" in censored)
+        self.assertTrue("like" in censored)
+        self.assertTrue("xxx" in censored)
+        self.assertFalse("unicorn" in censored)
 
     def test_restore_words(self):
         pf.define_words(["cupcakes"])