Merge pull request #2138 from Exirel/class-py3-style

sopel: use python3 style class and abc.ABC

Author: dgw

sopel/bot.py

@@ -45,7 +45,7 @@
 
 class Sopel(irc.AbstractBot):
     def __init__(self, config, daemon=False):
-        super(Sopel, self).__init__(config)
+        super().__init__(config)
         self._daemon = daemon  # Used for iPython. TODO something saner here
         self.wantsrestart = False
         self._running_triggers = []
@@ -1199,7 +1199,7 @@ def restart(self, message):
         self.quit(message)
 
 
-class SopelWrapper(object):
+class SopelWrapper:
     """Wrapper around a Sopel instance and a Trigger.
 
     :param sopel: Sopel instance

sopel/config/__init__.py

@@ -86,15 +86,15 @@ class ConfigurationNotFound(ConfigurationError):
     :param str filename: file path that could not be found
     """
     def __init__(self, filename):
-        super(ConfigurationNotFound, self).__init__(None)
+        super().__init__(None)
         self.filename = filename
         """Path to the configuration file that could not be found."""
 
     def __str__(self):
         return 'Unable to find the configuration file %s' % self.filename
 
 
-class Config(object):
+class Config:
     """The bot's configuration.
 
     :param str filename: the configuration file to load and use to populate this
@@ -279,7 +279,7 @@ def define_section(self, name, cls_, validate=True):
             )
         setattr(self, name, cls_(self, name, validate=validate))
 
-    class ConfigSection(object):
+    class ConfigSection:
         """Represents a section of the config file.
 
         :param str name: name of this section

sopel/config/types.py

@@ -25,18 +25,19 @@
 
 from __future__ import generator_stop
 
+import abc
 import getpass
 import os.path
 import re
 
 from sopel.tools import deprecated, get_input
 
 
-class NO_DEFAULT(object):
+class NO_DEFAULT:
     """A special value to indicate that there should be no default."""
 
 
-class StaticSection(object):
+class StaticSection:
     """A configuration section with parsed and validated settings.
 
     This class is intended to be subclassed and customized with added
@@ -113,10 +114,7 @@ def configure_setting(self, name, prompt, default=NO_DEFAULT):
         setattr(self, name, value)
 
 
-# TODO: Make this a proper abstract class when dropping Python 2 support.
-# Abstract classes are much simpler to deal with once we only need to worry
-# about Python 3.4 or newer. (https://stackoverflow.com/a/13646263/5991)
-class BaseValidated(object):
+class BaseValidated(abc.ABC):
     """The base type for a setting descriptor in a :class:`StaticSection`.
 
     :param str name: the attribute name to use in the config file
@@ -196,18 +194,13 @@ def configure(self, prompt, default, parent, section_name):
 
         return self._parse(value, parent, section)
 
+    @abc.abstractmethod
     def serialize(self, value, *args, **kwargs):
-        """Take some object, and return the string to be saved to the file.
-
-        Must be implemented in subclasses.
-        """
-        raise NotImplementedError("Serialize method must be implemented in subclass")
+        """Take some object, and return the string to be saved to the file."""
 
+    @abc.abstractmethod
     def parse(self, value, *args, **kwargs):
-        """Take a string from the file, and return the appropriate object.
-
-        Must be implemented in subclasses."""
-        raise NotImplementedError("Parse method must be implemented in subclass")
+        """Take a string from the file, and return the appropriate object."""
 
     def __get__(self, instance, owner=None):
         if instance is None:
@@ -305,8 +298,7 @@ def __init__(self,
                  serialize=None,
                  default=None,
                  is_secret=False):
-        super(ValidatedAttribute, self).__init__(
-            name, default=default, is_secret=is_secret)
+        super().__init__(name, default=default, is_secret=is_secret)
 
         if parse == bool:
             parse, serialize = _deprecated_special_bool_handling(serialize)
@@ -334,7 +326,7 @@ def configure(self, prompt, default, parent, section_name):
         if self.parse == _parse_boolean:
             prompt += ' (y/n)'
             default = 'y' if default else 'n'
-        return super(ValidatedAttribute, self).configure(prompt, default, parent, section_name)
+        return super().configure(prompt, default, parent, section_name)
 
 
 class BooleanAttribute(BaseValidated):
@@ -347,8 +339,7 @@ class BooleanAttribute(BaseValidated):
     If the ``default`` value is not specified, it will be ``False``.
     """
     def __init__(self, name, default=False):
-        super(BooleanAttribute, self).__init__(
-            name, default=default, is_secret=False)
+        super().__init__(name, default=default, is_secret=False)
 
     def configure(self, prompt, default, parent, section_name):
         """Parse and return a value from user's input.
@@ -417,7 +408,7 @@ class SecretAttribute(ValidatedAttribute):
     otherwise behaves like other any option.
     """
     def __init__(self, name, parse=None, serialize=None, default=None):
-        super(SecretAttribute, self).__init__(
+        super().__init__(
             name,
             parse=parse,
             serialize=serialize,
@@ -498,7 +489,7 @@ class SpamSection(StaticSection):
 
     def __init__(self, name, strip=True, default=None):
         default = default or []
-        super(ListAttribute, self).__init__(name, default=default)
+        super().__init__(name, default=default)
         self.strip = strip
 
     def parse(self, value):
@@ -621,7 +612,7 @@ class ChoiceAttribute(BaseValidated):
     :type default: str
     """
     def __init__(self, name, choices, default=None):
-        super(ChoiceAttribute, self).__init__(name, default=default)
+        super().__init__(name, default=default)
         self.choices = choices
 
     def parse(self, value):
@@ -668,7 +659,7 @@ class FilenameAttribute(BaseValidated):
     :type default: str
     """
     def __init__(self, name, relative=True, directory=False, default=None):
-        super(FilenameAttribute, self).__init__(name, default=default)
+        super().__init__(name, default=default)
         self.relative = relative
         self.directory = directory
 

sopel/db.py

@@ -81,7 +81,7 @@ class PluginValues(BASE):
     value = Column(String(255))
 
 
-class SopelDB(object):
+class SopelDB:
     """Database object class.
 
     :param config: Sopel's configuration settings

sopel/irc/abstract_backends.py

@@ -3,10 +3,12 @@
 # Licensed under the Eiffel Forum License 2.
 from __future__ import generator_stop
 
+import abc
+
 from .utils import safe
 
 
-class AbstractIRCBackend(object):
+class AbstractIRCBackend(abc.ABC):
     """Abstract class defining the interface and basic logic of an IRC backend.
 
     :param bot: a Sopel instance
@@ -18,13 +20,14 @@ class AbstractIRCBackend(object):
     def __init__(self, bot):
         self.bot = bot
 
+    @abc.abstractmethod
     def is_connected(self):
         """Tell if the backend is connected or not.
 
         :rtype: bool
         """
-        raise NotImplementedError
 
+    @abc.abstractmethod
     def on_irc_error(self, pretrigger):
         """Action to perform when the server sends an error event.
 
@@ -34,14 +37,13 @@ def on_irc_error(self, pretrigger):
         On IRC error, if ``bot.hasquit`` is set, the backend should close the
         connection so the bot can quit or reconnect as required.
         """
-        raise NotImplementedError
 
+    @abc.abstractmethod
     def irc_send(self, data):
         """Send an IRC line as raw ``data``.
 
         :param bytes data: raw line to send
         """
-        raise NotImplementedError
 
     def send_command(self, *args, **kwargs):
         """Send a command through the IRC connection.

sopel/irc/isupport.py

@@ -143,7 +143,7 @@ def parse_parameter(arg):
     return (key, parser(value))
 
 
-class ISupport(object):
+class ISupport:
     """Storage class for IRC's ``ISUPPORT`` feature.
 
     An instance of ``ISupport`` can be used as a read-only dict, to store
@@ -196,7 +196,7 @@ def __setattr__(self, name, value):
         # make sure you can't set the value of any ISUPPORT attribute yourself
         if name == '_ISupport__isupport':
             # allow to set self.__isupport inside of the class
-            super(ISupport, self).__setattr__(name, value)
+            super().__setattr__(name, value)
         elif name in self.__isupport:
             # reject any modification of __isupport
             raise AttributeError("Can't set value for %r" % name)

sopel/irc/utils.py

@@ -59,7 +59,7 @@ def safe(string):
     return string
 
 
-class CapReq(object):
+class CapReq:
     """Represents a pending CAP REQ request.
 
     :param str prefix: either ``=`` (must be enabled),

sopel/logger.py

@@ -18,7 +18,7 @@ class IrcLoggingHandler(logging.Handler):
     Implementation of a :class:`logging.Handler`.
     """
     def __init__(self, bot, level):
-        super(IrcLoggingHandler, self).__init__(level)
+        super().__init__(level)
         self._bot = bot
         self._channel = bot.settings.core.logging_channel
 
@@ -52,7 +52,7 @@ class ChannelOutputFormatter(logging.Formatter):
     Implementation of a :class:`logging.Formatter`.
     """
     def __init__(self, fmt='[%(filename)s] %(message)s', datefmt=None):
-        super(ChannelOutputFormatter, self).__init__(fmt=fmt, datefmt=datefmt)
+        super().__init__(fmt=fmt, datefmt=datefmt)
 
     def formatException(self, exc_info):
         """Format the exception info as a string for output.

sopel/modules/admin.py

@@ -55,13 +55,13 @@ def setup(bot):
 
 class InvalidSection(Exception):
     def __init__(self, section):
-        super(InvalidSection, self).__init__(self, 'Section [{}] does not exist.'.format(section))
+        super().__init__(self, 'Section [{}] does not exist.'.format(section))
         self.section = section
 
 
 class InvalidSectionOption(Exception):
     def __init__(self, section, option):
-        super(InvalidSectionOption, self).__init__(self, 'Section [{}] does not have option \'{}\'.'.format(section, option))
+        super().__init__(self, 'Section [{}] does not have option \'{}\'.'.format(section, option))
         self.section = section
         self.option = option
 

sopel/modules/currency.py

@@ -86,13 +86,13 @@ def setup(bot):
 class FixerError(Exception):
     """A Fixer.io API Error Exception"""
     def __init__(self, status):
-        super(FixerError, self).__init__("FixerError: {}".format(status))
+        super().__init__("FixerError: {}".format(status))
 
 
 class UnsupportedCurrencyError(Exception):
     """A currency is currently not supported by the API"""
     def __init__(self, currency):
-        super(UnsupportedCurrencyError, self).__init__(currency)
+        super().__init__(currency)
 
 
 def build_reply(amount, base, target, out_string):