fix code style

Author: mariajgrimaldi

openedx_events/exceptions.py

@@ -1,24 +1,26 @@
 """
-Custom exceptions thrown by Open edX events tooling. These exceptions are raised
-there is an error initializing or sending a signal.
+Custom exceptions thrown by Open edX events tooling.
 """
 
 
 class HookEventException(Exception):
     """
     Base class for Open edX Events exceptions.
-
-    Arguments:
-        - message (str): message describing why the exception was raised.
     """
 
     def __init__(self, message=""):
+        """
+        Init method for HookEventException base class.
+
+        Arguments:
+            message (str): message describing why the exception was raised.
+        """
         super().__init__()
         self.message = message
 
     def __str__(self):
         """
-        Shows string representation of HookEventException using its message.
+        Show string representation of HookEventException using its message.
         """
         return self.message
 
@@ -30,12 +32,16 @@ class InstantiationException(HookEventException):
     This exception is raised when there's an error instantiating an Open edX
     event, it can be that a required argument for the event definition is
     missing.
-
-    Arguments:
-        - event_type (str): name of the event raising the exception.
     """
 
     def __init__(self, event_type="", message=""):
+        """
+        Init method for InstantiationException custom exception class.
+
+        Arguments:
+            event_type (str): name of the event raising the exception.
+            message (str): message describing why the exception was raised.
+        """
         super().__init__(
             message="There was an error while instantiating {event_type}: {message}".format(
                 event_type=event_type, message=message
@@ -46,12 +52,16 @@ def __init__(self, event_type="", message=""):
 class SenderValidationException(HookEventException):
     """
     Describes errors that occur while validating arguments of send methods.
-
-    Arguments:
-        - message (str): message describing why the exception was raised.
     """
 
     def __init__(self, event_type="", message=""):
+        """
+        Init method for SenderValidationException custom exception class.
+
+        Arguments:
+            event_type (str): name of the event raising the exception.
+            message (str): message describing why the exception was raised.
+        """
         super().__init__(
             message="There was an error while validating the arguments of the event: {event_type}: {message}".format(
                 event_type=event_type, message=message

openedx_events/tests/test_tooling.py

@@ -4,8 +4,9 @@
     EventsToolingTest: Test events tooling.
 """
 
+from unittest.mock import Mock
+
 from django.test import TestCase
-from mock import Mock
 
 
 class OpenEdxPublicSignalTest(TestCase):
@@ -15,7 +16,7 @@ class OpenEdxPublicSignalTest(TestCase):
 
     def test_get_signal_metadata(self):
         """
-        This methods tests getting generated metadata for an event.
+        This methods tests getting the generated metadata for an event.
 
         Expected behavior:
             Returns the metadata containing information about the event.

openedx_events/tooling.py

@@ -15,14 +15,17 @@
 class OpenEdxPublicSignal(Signal):
     """
     Custom class used to create Open edX events.
-
-    Arguments:
-        - event_type (str): name of the event.
-        - data (dict): attributes passed to the event.
-        - minor_version (str): version of the event type.
     """
 
     def __init__(self, event_type=None, data=None, minor_version="0.0"):
+        """
+        Init method for OpenEdxPublicSignal definition class.
+
+        Arguments:
+            event_type (str): name of the event.
+            data (dict): attributes passed to the event.
+            minor_version (str): version of the event type.
+        """
         if not event_type or not data:
             raise InstantiationException(
                 event_type=event_type, message="Missing required argument."
@@ -33,11 +36,14 @@ def __init__(self, event_type=None, data=None, minor_version="0.0"):
         super().__init__()
 
     def __repr__(self):
+        """
+        Represent OpenEdxPublicSignal as a string.
+        """
         return "<OpenEdxPublicSignal: {event_type}>".format(event_type=self.event_type)
 
     def get_signal_metadata(self):
         """
-        Used to set signal extra metadata when an event is sent.
+        Get signal extra metadata when an event is sent.
 
         These fields are generated on the fly and are a subset of the Event
         Message defined in the OEP-41.
@@ -47,28 +53,28 @@ def get_signal_metadata(self):
 
         def get_current_time():
             """
-            Helper function used to get timestamp when the event ocurred.
+            Getter function used to get timestamp when the event ocurred.
             """
             return str(datetime.utcnow().isoformat()) + "Z"
 
         def get_source():
             """
-            Helper function used to get logical source of an event.
+            Getter function used to get logical source of an event.
             """
             return "openedx/{service}/web".format(
                 service=getattr(settings, "SERVICE_VARIANT", "")
             )
 
         def get_source_host():
             """
-            Helper function used to get physical source of the event.
+            Getter function used to get physical source of the event.
             """
             current_request = crum.get_current_request()
             return current_request.get_host() if current_request else None
 
         def get_spec_version():
             """
-            Helper function used to get the Open edX Events version.
+            Getter function used to get the Open edX Events version.
             """
             return openedx_events.__version__
 
@@ -83,31 +89,31 @@ def get_spec_version():
 
     def send_event(self, send_robust=True, **kwargs):
         """
-        Custom method that sends events to all connected receivers.
+        Send events to all connected receivers.
 
-        Used to send events just like Django signals are sent. In addition, runs
-        validations on the arguments sent and generates relevant metadata
-        that can be used for logging or debugging purposes. Besides this
-        behavior, send_event behaves just like the send method.
+        Used to send events just like Django signals are sent. In addition,
+        some validations are run on the arguments, and then relevant metadata
+        that can be used for logging or debugging purposes is generated.
+        Besides this behavior, send_event behaves just like the send method.
 
         Example usage:
 
         Keyword arguments:
-            - send_robust (bool):
+            send_robust (bool):
 
         Returns:
-            - list: response of each receiver following the format
+            list: response of each receiver following the format
             [(receiver, response), ... ]
 
         Exceptions raised:
-            - SenderValidationException: raised when there's a mismatch between
+            SenderValidationException: raised when there's a mismatch between
             arguments passed to this method and arguments used to initialize
             the event.
         """
 
         def validate_sender():
             """
-            Helper method used to run validations over the send arguments.
+            Run validations over the send arguments.
             """
             if len(kwargs) != len(self.init_data):
                 raise SenderValidationException(