Merge pull request python-smpplib#116 from wavemm/wave/custom-error-pdu-handler

Add the ability to set a custom error pdu handler

Author: eigenein

smpplib/client.py

@@ -307,6 +307,10 @@ def set_query_resp_handler(self, func):
         """Set new function to handle query resp event"""
         self.query_resp_handler = func
 
+    def set_error_pdu_handler(self, func):
+        """Set new function to handle PDUs with an error status"""
+        self.error_pdu_handler = func
+
     def message_received_handler(self, pdu, **kwargs):
         """Custom handler to process received message. May be overridden"""
         self.logger.warning('Message received handler (Override me)')
@@ -322,8 +326,24 @@ def query_resp_handler(self, pdu, **kwargs):
         """Custom handler to process response to queries. May be overridden"""
         self.logger.warning('Query resp handler (Override me)')
 
+    def error_pdu_handler(self, pdu):
+        raise exceptions.PDUError('({}) {}: {}'.format(
+            pdu.status,
+            pdu.command,
+            consts.DESCRIPTIONS.get(pdu.status, 'Unknown status')),
+            int(pdu.status),
+        )
+
     def read_once(self, ignore_error_codes=None, auto_send_enquire_link=True):
         """Read a PDU and act"""
+
+        if ignore_error_codes is not None:
+            warnings.warn(
+                "ignore_error_codes is deprecated, use set_error_pdu_handler to "
+                "configure a custom error PDU handler instead.",
+                DeprecationWarning,
+            )
+
         try:
             try:
                 pdu = self.read_pdu()
@@ -336,12 +356,7 @@ def read_once(self, ignore_error_codes=None, auto_send_enquire_link=True):
                 return
 
             if pdu.is_error():
-                raise exceptions.PDUError('({}) {}: {}'.format(
-                    pdu.status,
-                    pdu.command,
-                    consts.DESCRIPTIONS.get(pdu.status, 'Unknown status')),
-                    int(pdu.status),
-                )
+                self.error_pdu_handler(pdu)
 
             if pdu.command == 'unbind':  # unbind_res
                 self.logger.info('Unbind command received')

tests/test_client.py

@@ -1,6 +1,11 @@
 import warnings
+import pytest
+from mock import Mock, call
 
 from smpplib.client import Client
+from smpplib.smpp import make_pdu
+from smpplib import consts
+from smpplib import exceptions
 
 
 def test_client_construction_allow_unknown_opt_params_warning():
@@ -10,3 +15,32 @@ def test_client_construction_allow_unknown_opt_params_warning():
     assert len(w) == 1
     assert "optional parameters" in str(w[0].message)
     assert not client.allow_unknown_opt_params
+
+
+def test_client_error_pdu_default():
+    client = Client("localhost", 5679)
+    error_pdu = make_pdu("submit_sm_resp")
+    error_pdu.status = consts.SMPP_ESME_RINVMSGLEN
+    client.read_pdu = Mock(return_value=error_pdu)
+
+    with pytest.raises(exceptions.PDUError) as exec_info:
+        client.read_once()
+
+    assert exec_info.value.args[1] == consts.SMPP_ESME_RINVMSGLEN
+
+    # Should not raise
+    client.read_once(ignore_error_codes=[consts.SMPP_ESME_RINVMSGLEN])
+
+
+def test_client_error_pdu_custom_handler():
+    client = Client("localhost", 5679)
+    error_pdu = make_pdu("submit_sm_resp")
+    error_pdu.status = consts.SMPP_ESME_RINVMSGLEN
+    client.read_pdu = Mock(return_value=error_pdu)
+
+    mock_error_pdu_handler = Mock()
+    client.set_error_pdu_handler(mock_error_pdu_handler)
+
+    client.read_once()
+
+    assert mock_error_pdu_handler.mock_calls == [call(error_pdu)]