Merge pull request #2224 from sopel-irc/db-delete-channels-and-plugins

db: add `forget_channel()` and `forget_plugin()` methods

Author: dgw

sopel/db.py

@@ -12,7 +12,7 @@
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import scoped_session, sessionmaker
 
-from sopel.tools import Identifier
+from sopel.tools import deprecated, Identifier
 
 
 LOGGER = logging.getLogger(__name__)
@@ -273,7 +273,7 @@ def get_nick_id(self, nick, create=True):
 
             Alias/group management functions: :meth:`alias_nick`,
             :meth:`unalias_nick`, :meth:`merge_nick_groups`, and
-            :meth:`delete_nick_group`.
+            :meth:`forget_nick_group`.
 
         """
         session = self.ssession()
@@ -476,7 +476,7 @@ def unalias_nick(self, alias):
 
         .. seealso::
 
-            To delete an entire group, use :meth:`delete_nick_group`.
+            To delete an entire group, use :meth:`forget_nick_group`.
 
             To *add* an alias for a nick, use :meth:`alias_nick`.
 
@@ -498,7 +498,7 @@ def unalias_nick(self, alias):
         finally:
             self.ssession.remove()
 
-    def delete_nick_group(self, nick):
+    def forget_nick_group(self, nick):
         """Remove a nickname, all of its aliases, and all of its stored values.
 
         :param str nick: one of the nicknames in the group to be deleted
@@ -523,6 +523,14 @@ def delete_nick_group(self, nick):
         finally:
             self.ssession.remove()
 
+    @deprecated(
+        version='8.0',
+        removed_in='9.0',
+        reason="Renamed to `forget_nick_group`",
+    )
+    def delete_nick_group(self, nick):  # pragma: nocover
+        self.forget_nick_group(nick)
+
     def merge_nick_groups(self, first_nick, second_nick):
         """Merge two nick groups.
 
@@ -724,6 +732,28 @@ def get_channel_value(self, channel, key, default=None):
         finally:
             self.ssession.remove()
 
+    def forget_channel(self, channel):
+        """Remove all of a channel's stored values.
+
+        :param str channel: the name of the channel for which to delete values
+        :raise ~sqlalchemy.exc.SQLAlchemyError: if there is a database error
+
+        .. important::
+
+            This is a Nuclear Option. Be *very* sure that you want to do it.
+
+        """
+        channel = self.get_channel_slug(channel)
+        session = self.ssession()
+        try:
+            session.query(ChannelValues).filter(ChannelValues.channel == channel).delete()
+            session.commit()
+        except SQLAlchemyError:
+            session.rollback()
+            raise
+        finally:
+            self.ssession.remove()
+
     # PLUGIN FUNCTIONS
 
     def set_plugin_value(self, plugin, key, value):
@@ -842,6 +872,28 @@ def get_plugin_value(self, plugin, key, default=None):
         finally:
             self.ssession.remove()
 
+    def forget_plugin(self, plugin):
+        """Remove all of a plugin's stored values.
+
+        :param str plugin: the name of the plugin for which to delete values
+        :raise ~sqlalchemy.exc.SQLAlchemyError: if there is a database error
+
+        .. important::
+
+            This is a Nuclear Option. Be *very* sure that you want to do it.
+
+        """
+        plugin = plugin.lower()
+        session = self.ssession()
+        try:
+            session.query(PluginValues).filter(PluginValues.plugin == plugin).delete()
+            session.commit()
+        except SQLAlchemyError:
+            session.rollback()
+            raise
+        finally:
+            self.ssession.remove()
+
     # NICK AND CHANNEL FUNCTIONS
 
     def get_nick_or_channel_value(self, name, key, default=None):

test/test_db.py

@@ -183,7 +183,7 @@ def test_unalias_nick(db):
     session.close()
 
 
-def test_delete_nick_group(db):
+def test_forget_nick_group(db):
     session = db.ssession()
     aliases = ['Embolalia', 'Embo']
     nick_id = 42
@@ -195,7 +195,7 @@ def test_delete_nick_group(db):
     db.set_nick_value(aliases[0], 'foo', 'bar')
     db.set_nick_value(aliases[1], 'spam', 'eggs')
 
-    db.delete_nick_group(aliases[0])
+    db.forget_nick_group(aliases[0])
 
     # Nothing else has created values, so we know the tables are empty
     nicks = session.query(Nicknames).all()
@@ -266,6 +266,16 @@ def test_get_channel_value(db):
     session.close()
 
 
+def test_forget_channel(db):
+    db.set_channel_value('#testchan', 'wasd', 'uldr')
+    db.set_channel_value('#testchan', 'asdf', 'hjkl')
+    assert db.get_channel_value('#testchan', 'wasd') == 'uldr'
+    assert db.get_channel_value('#testchan', 'asdf') == 'hjkl'
+    db.forget_channel('#testchan')
+    assert db.get_channel_value('#testchan', 'wasd') is None
+    assert db.get_channel_value('#testchan', 'asdf') is None
+
+
 def test_get_channel_value_default(db):
     assert db.get_channel_value("TestChan", "DoesntExist") is None
     assert db.get_channel_value("TestChan", "DoesntExist", "MyDefault") == "MyDefault"
@@ -325,3 +335,13 @@ def test_delete_plugin_value(db):
     assert db.get_plugin_value('plugin', 'wasd') == 'uldr'
     db.delete_plugin_value('plugin', 'wasd')
     assert db.get_plugin_value('plugin', 'wasd') is None
+
+
+def test_forget_plugin(db):
+    db.set_plugin_value('plugin', 'wasd', 'uldr')
+    db.set_plugin_value('plugin', 'asdf', 'hjkl')
+    assert db.get_plugin_value('plugin', 'wasd') == 'uldr'
+    assert db.get_plugin_value('plugin', 'asdf') == 'hjkl'
+    db.forget_plugin('plugin')
+    assert db.get_plugin_value('plugin', 'wasd') is None
+    assert db.get_plugin_value('plugin', 'asdf') is None