chore: pydocstyle

Author: tuan-pham

pact/broker.py

@@ -15,6 +15,27 @@ class Broker():
     """PactBroker helper functions."""
 
     def __init__(self, broker_base_url=None, broker_username=None, broker_password=None, broker_token=None):
+        """
+        Create a Broker instance.
+
+        :param broker_base_url: URL of the pact broker that pacts will be
+            published to. Can also be supplied through the PACT_BROKER_BASE_URL
+            environment variable. Defaults to None.
+        :type broker_base_url: str
+        :param broker_username: Username to use when connecting to the pact
+            broker if authentication is required. Can also be supplied through
+            the PACT_BROKER_USERNAME environment variable. Defaults to None.
+        :type broker_username: str
+        :param broker_password: Password to use when connecting to the pact
+            broker if authentication is required. Strongly recommend supplying
+            this value through the PACT_BROKER_PASSWORD environment variable
+            instead. Defaults to None.
+        :type broker_password: str
+        :param broker_token: Authentication token to use when connecting to
+            the pact broker. Strongly recommend supplying this value through
+            the PACT_BROKER_TOKEN environment variable instead.
+            Defaults to None.
+        """
         self.broker_base_url = broker_base_url
         self.broker_username = broker_username
         self.broker_password = broker_password

pact/message_pact.py

@@ -43,6 +43,7 @@ def __init__(
     ):
         """
         Create a Pact instance using messages.
+
         :param consumer: A consumer for this contract that uses messages.
         :type consumer: pact.MessageConsumer
         :param provider: The generic provider for this contract.
@@ -115,21 +116,49 @@ def given(self, provider_states):
         return self
 
     def with_metadata(self, metadata):
+        """
+        Define metadata attached to the message.
+
+        :param metadata: dictionary of metadata attached to the message.
+        :type metadata: dict or None
+        :rtype: Pact
+        """
         self._insert_message_if_complete()
         self._messages[0]['metaData'] = metadata
         return self
 
     def with_content(self, contents):
+        """
+        Define message content (event) that will be use in the message.
+
+        :param contents: dictionary of dictionary used in the message.
+        :type metadata: dict
+        :rtype: Pact
+        """
         self._insert_message_if_complete()
         self._messages[0]['contents'] = contents
         return self
 
     def expects_to_receive(self, description):
+        """
+        Define the name of this contract (Same as upon_receiving in http pact implementation).
+
+        :param scenario: A unique name for this contract.
+        :type scenario: basestring
+        :rtype: Pact
+        """
         self._insert_message_if_complete()
         self._messages[0]['description'] = description
         return self
 
     def write_to_pact_file(self):
+        """
+        Create a pact file based on provided attributes in DSL.
+
+        Return 0 if success, 1 otherwise.
+
+        :rtype: int
+        """
         command = [
             MESSAGE_PATH,
             "update",
@@ -145,6 +174,7 @@ def write_to_pact_file(self):
     def _insert_message_if_complete(self):
         """
         Insert a new message if current message is complete.
+
         An interaction is complete if it has all the mandatory fields.
         If there are no message, a new message will be added.
         :rtype: None
@@ -155,9 +185,7 @@ def _insert_message_if_complete(self):
             self._messages.insert(0, {})
 
     def __enter__(self):
-        """
-        Enter a Python context. This function is required for context manager to work.
-        """
+        """Enter a Python context. This function is required for context manager to work."""
         pass
 
     def __exit__(self, exc_type, exc_val, exc_tb):