Fix CI

Author: ZachOrr

firebase_admin/messaging.py

@@ -120,13 +120,13 @@ def send_all(messages, dry_run=False, app=None):
     return _get_messaging_service(app).send_all(messages, dry_run)
 
 def send_multicast(multicast_message, dry_run=False, app=None):
-    """Sends the given mutlicast message to the mutlicast message tokens via Firebase Cloud Messaging (FCM).
+    """Sends the given mutlicast message to all tokens via Firebase Cloud Messaging (FCM).
 
     If the ``dry_run`` mode is enabled, the message will not be actually delivered to the
     recipients. Instead FCM performs all the usual validations, and emulates the send operation.
 
     Args:
-        message: An instance of ``messaging.MulticastMessage``.
+        multicast_message: An instance of ``messaging.MulticastMessage``.
         dry_run: A boolean indicating whether to run the operation in dry run mode (optional).
         app: An App instance (optional).
 
@@ -139,14 +139,14 @@ def send_multicast(multicast_message, dry_run=False, app=None):
     """
     if not isinstance(multicast_message, MulticastMessage):
         raise ValueError('Message must be an instance of messaging.MulticastMessage class.')
-    messages = map(lambda token: Message(
+    messages = [Message(
         data=multicast_message.data,
         notification=multicast_message.notification,
         android=multicast_message.android,
         webpush=multicast_message.webpush,
         apns=multicast_message.apns,
         token=token
-    ), multicast_message.tokens)
+    ) for token in multicast_message.tokens]
     return _get_messaging_service(app).send_all(messages, dry_run)
 
 def subscribe_to_topic(tokens, topic, app=None):
@@ -254,6 +254,7 @@ def __init__(self, code, message, detail=None):
 
 
 class BatchResponse(object):
+    """The response received from a batch request to the FCM API."""
 
     def __init__(self, responses):
         self._responses = responses
@@ -277,6 +278,7 @@ def failure_count(self):
 
 
 class SendResponse(object):
+    """The response received from an individual batched request to the FCM API."""
 
     def __init__(self, resp, exception):
         self._exception = exception
@@ -361,7 +363,12 @@ def send(self, message, dry_run=False):
         data = self._message_data(message, dry_run)
         try:
             resp = self._client.body(
-                'post', url=self._fcm_url, headers=self._fcm_headers, json=data, timeout=self._timeout)
+                'post',
+                url=self._fcm_url,
+                headers=self._fcm_headers,
+                json=data,
+                timeout=self._timeout
+            )
         except requests.exceptions.RequestException as error:
             if error.response is not None:
                 self._handle_fcm_error(error)
@@ -372,12 +379,13 @@ def send(self, message, dry_run=False):
             return resp['name']
 
     def send_all(self, messages, dry_run=False):
+        """Sends the given messages to FCM via the batch API."""
         if not isinstance(messages, list):
             raise ValueError('Messages must be an list of messaging.Message instances.')
 
         responses = []
 
-        def batch_callback(request_id, response, error):
+        def batch_callback(_, response, error):
             exception = None
             if error:
                 exception = self._parse_batch_error(error)
@@ -388,7 +396,13 @@ def batch_callback(request_id, response, error):
         for message in messages:
             body = json.dumps(self._message_data(message, dry_run))
             req = http.HttpRequest(
-                http=self._transport, postproc=self._postproc, uri=self._fcm_url, method='POST', body=body, headers=self._fcm_headers)
+                http=self._transport,
+                postproc=self._postproc,
+                uri=self._fcm_url,
+                method='POST',
+                body=body,
+                headers=self._fcm_headers
+            )
             batch.add(req)
 
         try:
@@ -455,7 +469,8 @@ def _handle_fcm_error(self, error):
         except ValueError:
             pass
 
-        raise _MessagingService._parse_fcm_error(data, error.response.content, error.response.status_code, error)
+        raise _MessagingService._parse_fcm_error(
+            data, error.response.content, error.response.status_code, error)
 
     def _handle_iid_error(self, error):
         """Handles errors received from the Instance ID API."""
@@ -476,6 +491,7 @@ def _handle_iid_error(self, error):
         raise ApiCallError(code, msg, error)
 
     def _parse_batch_error(self, error):
+        """Parses a googleapiclient.http.HttpError content in to an ApiCallError."""
         if error.content is None:
             msg = 'Failed to call messaging API: {0}'.format(error)
             return ApiCallError(self.INTERNAL_ERROR, msg, error)
@@ -504,6 +520,7 @@ def _parse_fcm_error(cls, data, content, status_code, error):
 
         msg = error_dict.get('message')
         if not msg:
-            msg = 'Unexpected HTTP response with status: {0}; body: {1}'.format(status_code, content.decode())
+            msg = 'Unexpected HTTP response with status: {0}; body: {1}'.format(
+                status_code, content.decode())
 
         return ApiCallError(code, msg, error)

tests/test_messaging.py

@@ -20,7 +20,6 @@
 import pytest
 import six
 
-import googleapiclient
 from googleapiclient.http import HttpMockSequence
 
 import firebase_admin
@@ -1338,7 +1337,9 @@ def test_send_fcm_error_code(self, status):
 
 class TestSendAll(object):
 
-    _PAYLOAD_FORMAT = """--boundary\r\nContent-Type: application/http\r\nContent-ID: <uuid + 1>\r\n\r\nHTTP/1.1 {} Success\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n{}\r\n\r\n--boundary--"""
+    _PAYLOAD_FORMAT = """--boundary\r\nContent-Type: application/http\r\n\
+Content-ID: <uuid + 1>\r\n\r\nHTTP/1.1 {} Success\r\n\
+Content-Type: application/json; charset=UTF-8\r\n\r\n{}\r\n\r\n--boundary--"""
     _CLIENT_VERSION = 'fire-admin-python/{0}'.format(firebase_admin.__version__)
 
     @classmethod
@@ -1386,7 +1387,8 @@ def test_invalid_send_all(self, msg):
 
     def test_send_all(self):
         payload = json.dumps({'name': 'message-id'})
-        _ = self._instrument_batch_messaging_service(payload=self._PAYLOAD_FORMAT.format('200', payload))
+        _ = self._instrument_batch_messaging_service(
+            payload=self._PAYLOAD_FORMAT.format('200', payload))
         msg = messaging.Message(topic='foo')
         batch_response = messaging.send_all([msg], dry_run=True)
         assert batch_response.success_count is 1
@@ -1488,7 +1490,7 @@ def test_send_all_batch_detailed_error(self, status):
         assert str(excinfo.value.code) == 'invalid-argument'
 
     @pytest.mark.parametrize('status', HTTP_ERRORS)
-    def test_send_all_canonical_error_code(self, status):
+    def test_send_all_batch_canonical_error_code(self, status):
         payload = json.dumps({
             'error': {
                 'status': 'NOT_FOUND',
@@ -1503,7 +1505,7 @@ def test_send_all_canonical_error_code(self, status):
         assert str(excinfo.value.code) == 'registration-token-not-registered'
 
     @pytest.mark.parametrize('status', HTTP_ERRORS)
-    def test_send_all_fcm_error_code(self, status):
+    def test_send_all_batch_fcm_error_code(self, status):
         payload = json.dumps({
             'error': {
                 'status': 'INVALID_ARGUMENT',
@@ -1526,7 +1528,9 @@ def test_send_all_fcm_error_code(self, status):
 
 class TestSendMulticast(object):
 
-    _PAYLOAD_FORMAT = """--boundary\r\nContent-Type: application/http\r\nContent-ID: <uuid + 1>\r\n\r\nHTTP/1.1 {} Success\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n{}\r\n\r\n--boundary--"""
+    _PAYLOAD_FORMAT = """--boundary\r\nContent-Type: application/http\r\n\
+Content-ID: <uuid + 1>\r\n\r\nHTTP/1.1 {} Success\r\n\
+Content-Type: application/json; charset=UTF-8\r\n\r\n{}\r\n\r\n--boundary--"""
     _CLIENT_VERSION = 'fire-admin-python/{0}'.format(firebase_admin.__version__)
 
     @classmethod
@@ -1570,7 +1574,8 @@ def test_invalid_send_multicast(self, msg):
 
     def test_send_multicast(self):
         payload = json.dumps({'name': 'message-id'})
-        _ = self._instrument_batch_messaging_service(payload=self._PAYLOAD_FORMAT.format('200', payload))
+        _ = self._instrument_batch_messaging_service(
+            payload=self._PAYLOAD_FORMAT.format('200', payload))
         msg = messaging.MulticastMessage(tokens=['foo'])
         batch_response = messaging.send_multicast(msg, dry_run=True)
         assert batch_response.success_count is 1
@@ -1672,7 +1677,7 @@ def test_send_multicast_batch_detailed_error(self, status):
         assert str(excinfo.value.code) == 'invalid-argument'
 
     @pytest.mark.parametrize('status', HTTP_ERRORS)
-    def test_send_multicast_canonical_error_code(self, status):
+    def test_send_multicast_batch_canonical_error_code(self, status):
         payload = json.dumps({
             'error': {
                 'status': 'NOT_FOUND',
@@ -1687,7 +1692,7 @@ def test_send_multicast_canonical_error_code(self, status):
         assert str(excinfo.value.code) == 'registration-token-not-registered'
 
     @pytest.mark.parametrize('status', HTTP_ERRORS)
-    def test_send_multicast_fcm_error_code(self, status):
+    def test_send_multicast_batch_fcm_error_code(self, status):
         payload = json.dumps({
             'error': {
                 'status': 'INVALID_ARGUMENT',