Code-font class names and other PR fixes

lahirumaramba · lahirumaramba · commit 04a9d508cc3c · 2019-11-12T12:21:29.000-05:00
diff --git a/firebase_admin/_messaging_encoder.py b/firebase_admin/_messaging_encoder.py
@@ -91,7 +91,7 @@ def __init__(self, tokens, data=None, notification=None, android=None, webpush=N
 class _Validators(object):
     """A collection of data validation utilities.
 
-    Methods provided in this class raise ValueErrors if any validations fail.
+    Methods provided in this class raise ``ValueErrors`` if any validations fail.
     """
 
     @classmethod
@@ -174,15 +174,15 @@ def check_datetime(cls, label, value):
 
 
 class MessageEncoder(json.JSONEncoder):
-    """A custom JSONEncoder implementation for serializing Message instances into JSON."""
+    """A custom ``JSONEncoder`` implementation for serializing Message instances into JSON."""
 
     @classmethod
     def remove_null_values(cls, dict_value):
         return {k: v for k, v in dict_value.items() if v not in [None, [], {}]}
 
     @classmethod
     def encode_android(cls, android):
-        """Encodes an AndroidConfig instance into JSON."""
+        """Encodes an ``AndroidConfig`` instance into JSON."""
         if android is None:
             return None
         if not isinstance(android, _messaging_utils.AndroidConfig):
@@ -208,7 +208,7 @@ def encode_android(cls, android):
 
     @classmethod
     def encode_android_fcm_options(cls, fcm_options):
-        """Encodes an AndroidFCMOptions instance into a json."""
+        """Encodes an ``AndroidFCMOptions`` instance into JSON."""
         if fcm_options is None:
             return None
         if not isinstance(fcm_options, _messaging_utils.AndroidFCMOptions):
@@ -223,7 +223,7 @@ def encode_android_fcm_options(cls, fcm_options):
 
     @classmethod
     def encode_ttl(cls, ttl):
-        """Encodes a AndroidConfig TTL duration into a string."""
+        """Encodes an ``AndroidConfig`` ``TTL`` duration into a string."""
         if ttl is None:
             return None
         if isinstance(ttl, numbers.Number):
@@ -268,7 +268,7 @@ def encode_boolean(cls, value):
 
     @classmethod
     def encode_android_notification(cls, notification):
-        """Encodes an AndroidNotification instance into JSON."""
+        """Encodes an ``AndroidNotification`` instance into JSON."""
         if notification is None:
             return None
         if not isinstance(notification, _messaging_utils.AndroidNotification):
@@ -362,7 +362,7 @@ def encode_android_notification(cls, notification):
 
     @classmethod
     def encode_light_settings(cls, light_settings):
-        """Encodes a LightSettings instance into JSON."""
+        """Encodes a ``LightSettings`` instance into JSON."""
         if light_settings is None:
             return None
         if not isinstance(light_settings, _messaging_utils.LightSettings):
@@ -403,7 +403,7 @@ def encode_light_settings(cls, light_settings):
 
     @classmethod
     def encode_webpush(cls, webpush):
-        """Encodes a WebpushConfig instance into JSON."""
+        """Encodes a ``WebpushConfig`` instance into JSON."""
         if webpush is None:
             return None
         if not isinstance(webpush, _messaging_utils.WebpushConfig):
@@ -420,7 +420,7 @@ def encode_webpush(cls, webpush):
 
     @classmethod
     def encode_webpush_notification(cls, notification):
-        """Encodes a WebpushNotification instance into JSON."""
+        """Encodes a ``WebpushNotification`` instance into JSON."""
         if notification is None:
             return None
         if not isinstance(notification, _messaging_utils.WebpushNotification):
@@ -467,7 +467,7 @@ def encode_webpush_notification(cls, notification):
 
     @classmethod
     def encode_webpush_notification_actions(cls, actions):
-        """Encodes a list of WebpushNotificationActions into JSON."""
+        """Encodes a list of ``WebpushNotificationActions`` into JSON."""
         if actions is None:
             return None
         if not isinstance(actions, list):
@@ -491,7 +491,7 @@ def encode_webpush_notification_actions(cls, actions):
 
     @classmethod
     def encode_webpush_fcm_options(cls, options):
-        """Encodes a WebpushFCMOptions instance into JSON."""
+        """Encodes a ``WebpushFCMOptions`` instance into JSON."""
         if options is None:
             return None
         result = {
@@ -505,7 +505,7 @@ def encode_webpush_fcm_options(cls, options):
 
     @classmethod
     def encode_apns(cls, apns):
-        """Encodes an APNSConfig instance into JSON."""
+        """Encodes an ``APNSConfig`` instance into JSON."""
         if apns is None:
             return None
         if not isinstance(apns, _messaging_utils.APNSConfig):
@@ -520,7 +520,7 @@ def encode_apns(cls, apns):
 
     @classmethod
     def encode_apns_payload(cls, payload):
-        """Encodes an APNSPayload instance into JSON."""
+        """Encodes an ``APNSPayload`` instance into JSON."""
         if payload is None:
             return None
         if not isinstance(payload, _messaging_utils.APNSPayload):
@@ -534,7 +534,7 @@ def encode_apns_payload(cls, payload):
 
     @classmethod
     def encode_apns_fcm_options(cls, fcm_options):
-        """Encodes an APNSFCMOptions instance into JSON."""
+        """Encodes an ``APNSFCMOptions`` instance into JSON."""
         if fcm_options is None:
             return None
         if not isinstance(fcm_options, _messaging_utils.APNSFCMOptions):
@@ -549,7 +549,7 @@ def encode_apns_fcm_options(cls, fcm_options):
 
     @classmethod
     def encode_aps(cls, aps):
-        """Encodes an Aps instance into JSON."""
+        """Encodes an ``Aps`` instance into JSON."""
         if not isinstance(aps, _messaging_utils.Aps):
             raise ValueError('APNSPayload.aps must be an instance of Aps class.')
         result = {
@@ -598,7 +598,7 @@ def encode_aps_sound(cls, sound):
 
     @classmethod
     def encode_aps_alert(cls, alert):
-        """Encodes an ApsAlert instance into JSON."""
+        """Encodes an ``ApsAlert`` instance into JSON."""
         if alert is None:
             return None
         if isinstance(alert, six.string_types):
@@ -640,7 +640,7 @@ def encode_aps_alert(cls, alert):
 
     @classmethod
     def encode_notification(cls, notification):
-        """Encodes an Notification instance into JSON."""
+        """Encodes a ``Notification`` instance into JSON."""
         if notification is None:
             return None
         if not isinstance(notification, _messaging_utils.Notification):
@@ -688,7 +688,7 @@ def default(self, obj): # pylint: disable=method-hidden
 
     @classmethod
     def encode_fcm_options(cls, fcm_options):
-        """Encodes an FCMOptions instance into JSON."""
+        """Encodes an ``FCMOptions`` instance into JSON."""
         if fcm_options is None:
             return None
         if not isinstance(fcm_options, _messaging_utils.FCMOptions):
diff --git a/firebase_admin/_messaging_utils.py b/firebase_admin/_messaging_utils.py
@@ -100,13 +100,13 @@ class AndroidNotification(object):
             reference, sets the time that the event in the notification occurred as a
             ``datetime.datetime`` instance. Notifications in the panel are sorted by this time
             (optional).
-        local_only: Set whether or not this notification is relevant only to the current device.
+        local_only: Sets whether or not this notification is relevant only to the current device.
             Some notifications can be bridged to other devices for remote display, such as a Wear OS
             watch. This hint can be set to recommend this notification not be bridged (optional).
             See Wear OS guides:
             https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging
-        priority: Set the relative priority for this notification. Low-priority notifications may be
-            hidden from the user in certain situations. Note this priority differs from
+        priority: Sets the relative priority for this notification. Low-priority notifications may
+            be hidden from the user in certain situations. Note this priority differs from
             ``AndroidMessagePriority``. This priority is processed by the client after the message
             has been delivered. Whereas ``AndroidMessagePriority`` is an FCM concept that controls
             when the message is delivered (optional). Must be one of ``default``, ``min``, ``low``,
@@ -132,7 +132,7 @@ class AndroidNotification(object):
             https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml.
             If ``default_light_settings`` is set to ``True`` and ``light_settings`` is also set, the
             user-specified ``light_settings`` is used instead of the default value.
-        visibility: Set the visibility of the notification. Must be either ``private``, ``public``,
+        visibility: Sets the visibility of the notification. Must be either ``private``, ``public``,
             or ``secret``. If unspecified, default to ``private``.
         notification_count: Sets the number of items this notification represents. May be displayed
             as a badge count for Launchers that support badging. See ``NotificationBadge``
@@ -183,10 +183,10 @@ class LightSettings(object):
     ``messaging.AndroidNotification``.
 
     Args:
-        color: Set color of the LED in ``#rrggbb`` or ``#rrggbbaa`` format.
-        light_on_duration_millis: Along with ``light_off_duration``, define the blink rate of LED
+        color: Sets the color of the LED in ``#rrggbb`` or ``#rrggbbaa`` format.
+        light_on_duration_millis: Along with ``light_off_duration``, defines the blink rate of LED
             flashes.
-        light_off_duration_millis: Along with ``light_on_duration``, define the blink rate of LED
+        light_off_duration_millis: Along with ``light_on_duration``, defines the blink rate of LED
             flashes.
     """
     def __init__(self, color, light_on_duration_millis,
diff --git a/tests/test_messaging.py b/tests/test_messaging.py
@@ -32,7 +32,7 @@
 NON_DICT_ARGS = ['', list(), tuple(), True, False, 1, 0, {1: 'foo'}, {'foo': 1}]
 NON_OBJECT_ARGS = [list(), tuple(), dict(), 'foo', 0, 1, True, False]
 NON_LIST_ARGS = ['', tuple(), dict(), True, False, 1, 0, [1], ['foo', 1]]
-NON_UNUM_ARGS = ['1.23s', list(), tuple(), dict(), -1.23]
+NON_UINT_ARGS = ['1.23s', list(), tuple(), dict(), -1.23]
 HTTP_ERROR_CODES = {
     400: exceptions.InvalidArgumentError,
     403: exceptions.PermissionDeniedError,
@@ -293,7 +293,7 @@ def test_invalid_priority(self, data):
         else:
             assert str(excinfo.value) == 'AndroidConfig.priority must be a non-empty string.'
 
-    @pytest.mark.parametrize('data', NON_UNUM_ARGS)
+    @pytest.mark.parametrize('data', NON_UINT_ARGS)
     def test_invalid_ttl(self, data):
         with pytest.raises(ValueError) as excinfo:
             check_encoding(messaging.Message(
@@ -501,7 +501,7 @@ def test_invalid_priority(self, priority):
             expected = 'AndroidNotification.priority must be a non-empty string.'
         assert str(excinfo.value) == expected
 
-    @pytest.mark.parametrize('visibility', NON_STRING_ARGS + ['', 'topic', 'priority', 'foo'])
+    @pytest.mark.parametrize('visibility', NON_STRING_ARGS + ['foo'])
     def test_invalid_visibility(self, visibility):
         notification = messaging.AndroidNotification(visibility=visibility)
         excinfo = self._check_notification(notification)
@@ -646,7 +646,7 @@ def test_no_light_off_duration_millis(self):
         expected = 'LightSettings.light_off_duration_millis is required.'
         assert str(excinfo.value) == expected
 
-    @pytest.mark.parametrize('data', NON_UNUM_ARGS)
+    @pytest.mark.parametrize('data', NON_UINT_ARGS)
     def test_invalid_light_off_duration_millis(self, data):
         light_settings = messaging.LightSettings(color='#aabbcc',
                                                  light_on_duration_millis=200,
@@ -660,7 +660,7 @@ def test_invalid_light_off_duration_millis(self, data):
                                           'duration in milliseconds or '
                                           'an instance of datetime.timedelta.')
 
-    @pytest.mark.parametrize('data', NON_UNUM_ARGS)
+    @pytest.mark.parametrize('data', NON_UINT_ARGS)
     def test_invalid_light_on_duration_millis(self, data):
         light_settings = messaging.LightSettings(color='#aabbcc',
                                                  light_on_duration_millis=data,
