Merge pull request #2652 from fetchai/fix/protocols_darglint

protocols and protocol generator fixes to pass darglint checks. darglint check enabled for protocols

Makefile

@@ -46,7 +46,7 @@ lint:
 	isort aea benchmark examples packages plugins scripts tests
 	flake8 aea benchmark examples packages plugins scripts tests
 	vulture aea scripts/whitelist.py --exclude "*_pb2.py"
-	darglint aea benchmark examples libs packages/fetchai/connections packages/fetchai/contracts packages/fetchai/skills plugins scripts
+	darglint aea benchmark examples libs packages plugins scripts
 
 .PHONY: pylint
 pylint:

aea/protocols/generator/base.py

@@ -746,6 +746,7 @@ def _message_class_str(self) -> str:
         cls_str += self.indent + ":param dialogue_reference: the dialogue reference.\n"
         cls_str += self.indent + ":param target: the message target.\n"
         cls_str += self.indent + ":param performative: the message performative.\n"
+        cls_str += self.indent + ":param **kwargs: extra options.\n"
         cls_str += self.indent + '"""\n'
 
         cls_str += self.indent + "super().__init__(\n"
@@ -1156,7 +1157,7 @@ def _dialogue_class_str(self) -> str:
             self.indent
             + ":param role: the role of the agent this dialogue is maintained for\n"
         )
-        cls_str += self.indent + ":return: None\n"
+        cls_str += self.indent + ":param message_class: the message class used\n"
         cls_str += self.indent + '"""\n'
         cls_str += self.indent + "Dialogue.__init__(\n"
         cls_str += self.indent + "self,\n"
@@ -1219,7 +1220,11 @@ def _dialogue_class_str(self) -> str:
             self.indent
             + ":param self_address: the address of the entity for whom dialogues are maintained\n"
         )
-        cls_str += self.indent + ":return: None\n"
+        cls_str += self.indent + ":param dialogue_class: the dialogue class used\n"
+        cls_str += (
+            self.indent
+            + ":param role_from_first_message: the callable determining role from first message\n"
+        )
         cls_str += self.indent + '"""\n'
         cls_str += self.indent + "Dialogues.__init__(\n"
         self._change_indent(1)
@@ -1306,7 +1311,6 @@ def _custom_types_module_str(self) -> str:
                     _camel_case_to_snake_case(custom_type)
                 )
             )
-            cls_str += self.indent + ":return: None\n"
             cls_str += self.indent + '"""\n'
             cls_str += self.indent + "raise NotImplementedError\n\n"
             self._change_indent(-1)

packages/fetchai/protocols/acn/custom_types.py

@@ -101,7 +101,6 @@ def encode(
 
         :param agent_record_protobuf_object: the protocol buffer object whose type corresponds with this class.
         :param agent_record_object: an instance of this class to be encoded in the protocol buffer object.
-        :return: None
         """
         agent_record_protobuf_object.address = agent_record_object.address
         agent_record_protobuf_object.public_key = agent_record_object.public_key
@@ -196,7 +195,6 @@ def encode(
 
         :param status_body_protobuf_object: the protocol buffer object whose type corresponds with this class.
         :param status_body_object: an instance of this class to be encoded in the protocol buffer object.
-        :return: None
         """
         status_body_protobuf_object.code = int(status_body_object.status_code)
         status_body_protobuf_object.msgs.extend(status_body_object.msgs)

packages/fetchai/protocols/acn/dialogues.py

@@ -83,7 +83,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -113,7 +113,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/acn/message.py

@@ -95,6 +95,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/acn/protocol.yaml

@@ -11,9 +11,9 @@ fingerprint:
   __init__.py: QmX9Hmq51Tt6gkVrjNehcw3yCZGTzFr2UBVZq7Mgiq8EKv
   acn.proto: QmVWvXETUNe7QZTvBgzwpofNP3suFthwyxbTVUqSx8mdnE
   acn_pb2.py: Qmc2Pb1WERRBm1mw5Q4iGret621bjXYKR3KwaMXVQCiAT4
-  custom_types.py: QmX6XWjUc8YAWRZz5RwPP7FEpZZR9srWqRQMbfa1BbYQFD
-  dialogues.py: QmVV9PvqWZ2a6qZFty3wPZmm2KfxfHLLixusw2qgWZ6nLC
-  message.py: QmVJWhpvdW6PpNAC6PMizzAnhejKXBBa21TTSPay47Mnqe
+  custom_types.py: QmS9xN5EPy8pZRbwpUdewH7TocNGCx7xv3GwupxSQRRVgM
+  dialogues.py: QmcfUKuz4yTs4kxohhQD1dJV8yb3xxFA5EQ3v5inKter7U
+  message.py: QmdGN9AqAiSTkdG3W1KB4ZG28mn9f65oSmZuUWp5cdJgE1
   serialization.py: QmaYfCTqKwbYrUkgnouxzd41QwnStDGhoXdvwovQXD6xr1
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/aggregation/dialogues.py

@@ -78,7 +78,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -108,7 +108,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/aggregation/message.py

@@ -82,6 +82,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/aggregation/protocol.yaml

@@ -11,8 +11,8 @@ fingerprint:
   __init__.py: QmX2nGncvSdS5Py1LED3HEKZE11wtC2TZrmcgJtALGFo55
   aggregation.proto: QmPMqf6ysCcSS6j27zQRisD3YqbkiDaNF7AvHHi9vMYV1n
   aggregation_pb2.py: QmXKXPDctMS3amwzqDS6kTw2DZ4KpFTVNcyZJpPphsPLXw
-  dialogues.py: QmbJX6bN2mQ4jYvLvcPdqhU4YaSqY3nmMXHo8FaHZrvDRZ
-  message.py: QmSxMzPCRwciRp21TEwBJMgmnddh8hjzQUvCjisQfZHCqs
+  dialogues.py: Qma9v3XvzNrMcU7Apvre4D5UWSym3wczfK5taWTEijxcBG
+  message.py: QmdmEaTbtxXCVcrxWVE2QVrpS48wopEANZkCKZWMeANcQU
   serialization.py: QmfUH3z7yg4efdnWtJQAPL8Tihz9m64JY6bkXd2tg8bZ1h
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/contract_api/custom_types.py

@@ -68,7 +68,6 @@ def encode(kwargs_protobuf_object: Any, kwargs_object: "Kwargs") -> None:
 
         :param kwargs_protobuf_object: the protocol buffer object whose type corresponds with this class.
         :param kwargs_object: an instance of this class to be encoded in the protocol buffer object.
-        :return: None
         """
         kwargs_protobuf_object.kwargs = DictProtobufStructSerializer.encode(
             kwargs_object.body

packages/fetchai/protocols/contract_api/dialogues.py

@@ -109,7 +109,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -139,7 +139,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/contract_api/message.py

@@ -120,6 +120,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/contract_api/protocol.yaml

@@ -11,9 +11,9 @@ fingerprint:
   __init__.py: QmWaYLeSNYEhvgqhsjjLgND3wvTd9VBntNfmYgrFV8RCcL
   contract_api.proto: QmVezvQ3vgN19nzJD1CfgvjHxjdaP4yLUSwaQDMQq85vUZ
   contract_api_pb2.py: QmYux5XHsY3u1e81gE33wHpMUN5u3VZy5wq9xSsPMbC7yf
-  custom_types.py: QmcGGXMEDGXaXsvzx9J97xy56RZfXQsFNfBPrTzvZzUBSL
-  dialogues.py: Qmc3NfLQqG3cn3JVxu6NHvb9Ntovj9ttdJGXBwkPWkgVPX
-  message.py: QmeXHzgifc44KPZiYnLVx4jkhSo59yMN3CyWHP1xbrHDi6
+  custom_types.py: QmW9Ju9GnYc8A7sbG8RvR8NnTCf5sVfycYqotN6WZb76LG
+  dialogues.py: QmVJGTD7HhEKZPFDTqNcrkMZjveG7gaECZRXW4rDMRYWBE
+  message.py: QmTTdSiv9MWUa2KtcZ6xhDNM9Lonf3CzdrNBSnu6XNApbq
   serialization.py: QmNyo7sVC92QbjEfVHCpUixTfMjtaARYUedxiCQE6QzQ2p
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/cosm_trade/dialogues.py

@@ -84,7 +84,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -114,7 +114,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/cosm_trade/message.py

@@ -89,6 +89,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/cosm_trade/protocol.yaml

@@ -13,8 +13,8 @@ fingerprint:
   cosm_trade.proto: QmX1hcA9m6QM2bni9g6SG11ieWaYGvCrFi2qfT7TCG1s3j
   cosm_trade_pb2.py: QmVZWhxWmqr3WKPx2HQWPENavv8754BmiLuh6hTukuWRxX
   custom_types.py: QmUweZKxravsiJNVzUypN8fiF7XWYbuN2rVURw18EHQrss
-  dialogues.py: QmPZE5iezybfDHcNRUvCT8Mn66nUGnwwG2vMjWeRrigXTJ
-  message.py: QmUNjmXAjc5FDrm86DgyjSwh8p5sdwXycCgBvUu59LyAv2
+  dialogues.py: QmQMbaNba3HCZbubgBi1t9cyNPv7zKhm7odfQt31BJ1bK4
+  message.py: QmXAP7uckdGW4T5Gb8xMuyaWQ73cGhCspa4AHCcq65j8uR
   serialization.py: QmTsEjoduW6mgWSGF1hFLobUmajPXVVVWZ7Bs4FmLWaRW8
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/default/custom_types.py

@@ -41,7 +41,6 @@ def encode(error_code_protobuf_object: Any, error_code_object: "ErrorCode") -> N
 
         :param error_code_protobuf_object: the protocol buffer object whose type corresponds with this class.
         :param error_code_object: an instance of this class to be encoded in the protocol buffer object.
-        :return: None
         """
         error_code_protobuf_object.error_code = error_code_object.value
 

packages/fetchai/protocols/default/dialogues.py

@@ -79,7 +79,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -109,7 +109,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/default/message.py

@@ -84,6 +84,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/default/protocol.yaml

@@ -9,11 +9,11 @@ aea_version: '>=1.0.0, <2.0.0'
 fingerprint:
   README.md: QmNN1eJSSeAGs4uny1tqWkeQwyr6SVV2QgKAoPz18W5jnV
   __init__.py: QmU9514mYQYGtTDVmf5QEmaiw5RvuAPwELwYe6WAVFwHoC
-  custom_types.py: QmbAu5CYv5VtKKbEtzCbGQGE5cPZezDjubLNbiTPycXrHv
+  custom_types.py: QmVbmxfpiHM8xDvsRvytPr4jmjD5Ktc5171fweYGBkXvBd
   default.proto: QmWYzTSHVbz7FBS84iKFMhGSXPxay2mss29vY7ufz2BFJ8
   default_pb2.py: QmYxGuF1rY2Ru52kX4DVqaAHV1dk65jcU636LHa4WvY9hk
-  dialogues.py: Qmecfdc7tCNSY19Z5kDBpKrq8dBQtxPYH2rX2n7uym6bFK
-  message.py: QmYbyUsAc7UhSDMcL8erqYzQFdEkNPfBLeXea9WtRoBXkb
+  dialogues.py: QmYAWjUwBvCrMaoNtFxbcNF8Mcr1C7R4LY9Nd6QfBrd38N
+  message.py: QmYF4eGCBZXqejmtNgGHhbWL7Pk55FphTG7hSDWnf1kJDP
   serialization.py: QmXB5GkFRkSGrez6YJiuiM26scXLfSvFvNfvECv7nuxupD
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/fipa/dialogues.py

@@ -109,7 +109,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -144,7 +144,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/fipa/message.py

@@ -104,6 +104,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/fipa/protocol.yaml

@@ -10,10 +10,10 @@ fingerprint:
   README.md: QmfZxjMzApLKdff7s77G6RKqsmXLdc18yLoMLpDsoV2C8c
   __init__.py: Qmbqt24D3vwQYL6kkdFw1B6VwzHFBgabgSk6LvPJ8mbEth
   custom_types.py: Qmf72KRbkNsxxAHwMtkmJc5TRL23fU7AuzJAdSTftckwJQ
-  dialogues.py: QmRwGzQtdTtg9t1AaBbhTu7BnT3Sv54aS1PwU593bEdgno
+  dialogues.py: QmZ721KxFmyBzpnPHT7UFxZDsWsZFLYUAVVfikPUo4cs7b
   fipa.proto: QmS7aXZ2JoG3oyMHWiPYoP9RJ7iChsoTC9KQLsj6vi3ejR
   fipa_pb2.py: QmPNJfKCA5dHA8Uh5wNN6fYKsGyc5FcWevEqyqa6eTjKH4
-  message.py: Qmep6hLp3yzvQigAwFw7ww5kkBqBWEGjg8hEfd2PMckFVS
+  message.py: QmXZPGXLtPcxQuGD2q5c4RYUYaeVYt69fWzr3G6uAHWpah
   serialization.py: Qmamy2aSw5HEVvArTumXqkxvCR7ePgxnVaJVPic8uniZVU
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/gym/custom_types.py

@@ -41,7 +41,6 @@ def encode(any_object_protobuf_object: Any, any_object_object: "AnyObject") -> N
 
         :param any_object_protobuf_object: the protocol buffer object whose type corresponds with this class.
         :param any_object_object: an instance of this class to be encoded in the protocol buffer object.
-        :return: None
         """
         any_object_protobuf_object.any = pickle.dumps(any_object_object)  # nosec
 

packages/fetchai/protocols/gym/dialogues.py

@@ -87,7 +87,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -115,7 +115,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/gym/message.py

@@ -89,6 +89,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,

packages/fetchai/protocols/gym/protocol.yaml

@@ -9,11 +9,11 @@ aea_version: '>=1.0.0, <2.0.0'
 fingerprint:
   README.md: QmSrL3oujtXaSgrbxQzYD12oHjb5d55kNSFiZ4SA3jSNj1
   __init__.py: QmPE862VDVyhz2DLx1HNzc8fDXrRgFDCTDSHJNEcJ2cz9W
-  custom_types.py: QmbLYSBTMMshVBvcCNRBPXCNngFVssVLBh9V6xGkquX64N
-  dialogues.py: QmWJHeqAcshN7Hz9nRLRT74BfWdgddey4xkTphyze29dVe
+  custom_types.py: QmTQSizkRh6awSk4J2cPGjidMcZ356bTyYxNG2HSgfkj9B
+  dialogues.py: QmbeoxWVZAoQt83k3JKom3mjHg23m9CDviWXcgW9ijPGkN
   gym.proto: QmSYD1qtmNwKnfuTUtPGzbfW3kww4viJ714aRTPupLdV62
   gym_pb2.py: Qme3KgpxmLJihio9opNK9NHJtacdrkivafAZKvpQ2HGaqE
-  message.py: QmcVxLCNJ6JJBxZBNAkSTn4L78EZ7pumJ7NnU3igdv4SYo
+  message.py: Qmds3cP2ku2B8e7kuDng2q7xQFXaypa4knnomDVknmWEek
   serialization.py: QmVouHyTqWNbtaTMW1s1MEPUrhKdLgYN5mNBAMMkPoKddX
 fingerprint_ignore_patterns: []
 dependencies:

packages/fetchai/protocols/http/dialogues.py

@@ -74,7 +74,7 @@ def __init__(
         :param dialogue_label: the identifier of the dialogue
         :param self_address: the address of the entity for whom this dialogue is maintained
         :param role: the role of the agent this dialogue is maintained for
-        :return: None
+        :param message_class: the message class used
         """
         Dialogue.__init__(
             self,
@@ -102,7 +102,8 @@ def __init__(
         Initialize dialogues.
 
         :param self_address: the address of the entity for whom dialogues are maintained
-        :return: None
+        :param dialogue_class: the dialogue class used
+        :param role_from_first_message: the callable determining role from first message
         """
         Dialogues.__init__(
             self,

packages/fetchai/protocols/http/message.py

@@ -82,6 +82,7 @@ def __init__(
         :param dialogue_reference: the dialogue reference.
         :param target: the message target.
         :param performative: the message performative.
+        :param **kwargs: extra options.
         """
         super().__init__(
             dialogue_reference=dialogue_reference,