provide examples of extra fields in route decorator, refactor is_http_trigger method

Author: peterstone2017

azure/functions/decorators/core.py

@@ -1,9 +1,9 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 from abc import ABC, abstractmethod
-from typing import Dict, Optional
+from typing import Dict, Optional, Type
 
-from azure.functions.decorators.utils import to_camel_case, \
+from .utils import to_camel_case, \
     ABCBuildDictMeta, StringifyEnum
 
 SCRIPT_FILE_NAME = "function_app.py"
@@ -145,3 +145,8 @@ class OutputBinding(Binding, ABC, metaclass=ABCBuildDictMeta):
     def __init__(self, name, data_type) -> None:
         super().__init__(direction=BindingDirection.OUT,
                          name=name, data_type=data_type)
+
+
+def is_supported_trigger_type(trigger: Trigger, trigger_type: Type[Trigger]):
+    return isinstance(trigger, trigger_type) or \
+        trigger.get_binding_name() == trigger_type.get_binding_name()

azure/functions/decorators/function_app.py

@@ -6,12 +6,13 @@
 
 from azure.functions.decorators.blob import BlobTrigger, BlobInput, BlobOutput
 from azure.functions.decorators.core import Binding, Trigger, DataType, \
-    AuthLevel, SCRIPT_FILE_NAME, Cardinality, AccessRights
+    AuthLevel, SCRIPT_FILE_NAME, Cardinality, AccessRights, \
+    is_supported_trigger_type
 from azure.functions.decorators.cosmosdb import CosmosDBTrigger, \
     CosmosDBOutput, CosmosDBInput
 from azure.functions.decorators.eventhub import EventHubTrigger, EventHubOutput
 from azure.functions.decorators.http import HttpTrigger, HttpOutput, \
-    HttpMethod, is_http_trigger
+    HttpMethod
 from azure.functions.decorators.queue import QueueTrigger, QueueOutput
 from azure.functions.decorators.servicebus import ServiceBusQueueTrigger, \
     ServiceBusQueueOutput, ServiceBusTopicTrigger, \
@@ -178,8 +179,9 @@ def _validate_function(self) -> None:
                 f"Function {function_name} trigger {trigger} not present"
                 f" in bindings {bindings}")
 
-        if is_http_trigger(trigger) and getattr(trigger, 'route',
-                                                None) is None:
+        # Set route to function name if unspecified in the http trigger
+        if is_supported_trigger_type(trigger, HttpTrigger) \
+                and getattr(trigger, 'route', None) is None:
             setattr(trigger, 'route', self._function.get_function_name())
 
     def build(self) -> Function:
@@ -369,9 +371,11 @@ def route(self,
         on the request in order to invoke the function.
         :return: Decorator function.
         :param trigger_extra_fields: Additional fields to include in trigger
-        json.
+        json. For example,
+        >>> data_type='STRING' # 'dataType': 'STRING' in trigger json
         :param binding_extra_fields: Additional fields to include in binding
-        json.
+        json. For example,
+        >>> data_type='STRING' # 'dataType': 'STRING' in binding json
         """
 
         @self._configure_function_builder

azure/functions/decorators/http.py

@@ -46,8 +46,3 @@ def __init__(self,
                  data_type: Optional[DataType] = None,
                  **kwargs) -> None:
         super().__init__(name=name, data_type=data_type)
-
-
-def is_http_trigger(trigger):
-    return isinstance(trigger, HttpTrigger) or \
-        trigger.get_binding_name() == HTTP_TRIGGER

tests/decorators/test_http.py

@@ -5,9 +5,8 @@
 from azure.functions.decorators.constants import HTTP_TRIGGER, HTTP_OUTPUT
 from azure.functions.decorators.core import BindingDirection, DataType, \
     AuthLevel
-from azure.functions.decorators.custom import CustomTrigger
 from azure.functions.decorators.http import HttpTrigger, HttpOutput, \
-    HttpMethod, is_http_trigger
+    HttpMethod
 
 
 class TestHttp(unittest.TestCase):
@@ -49,14 +48,3 @@ def test_http_output_valid_creation(self):
             "name": "req",
             "dataType": DataType.UNDEFINED,
         })
-
-    def test_is_http_trigger_binding_name(self):
-        self.assertTrue(
-            is_http_trigger(CustomTrigger(name='req', type=HTTP_TRIGGER)))
-
-    def test_is_http_trigger_instance(self):
-        self.assertTrue(is_http_trigger(HttpTrigger(name='req')))
-
-    def test_is_not_http_trigger(self):
-        self.assertFalse(
-            is_http_trigger(CustomTrigger(name='req', type="dummy")))

tests/decorators/test_utils.py

@@ -4,7 +4,10 @@
 
 from azure.functions import HttpMethod
 from azure.functions.decorators import utils
-from azure.functions.decorators.core import DataType
+from azure.functions.decorators.constants import HTTP_TRIGGER
+from azure.functions.decorators.core import DataType, is_supported_trigger_type
+from azure.functions.decorators.custom import CustomTrigger
+from azure.functions.decorators.http import HttpTrigger
 from azure.functions.decorators.utils import to_camel_case, BuildDictMeta, \
     is_snake_case, is_word
 
@@ -152,7 +155,7 @@ def test_clean_nones_nested(self):
             {
                 "hello2": ["dummy1", "dummy2", ["dummy3"], {}],
                 "hello4": {"dummy5": "pass1"}
-            } # NoQA
+            }  # NoQA
         )
 
     def test_add_to_dict_no_args(self):
@@ -200,3 +203,17 @@ def get_dict_repr(self):
         self.assertCountEqual(getattr(test_obj, 'init_params'),
                               {'self', 'arg1', 'arg2'})
         self.assertEqual(test_obj.get_dict_repr(), {"world": ["dummy"]})
+
+    def test_is_supported_trigger_binding_name(self):
+        self.assertTrue(
+            is_supported_trigger_type(
+                CustomTrigger(name='req', type=HTTP_TRIGGER), HttpTrigger))
+
+    def test_is_supported_trigger_instance(self):
+        self.assertTrue(
+            is_supported_trigger_type(HttpTrigger(name='req'), HttpTrigger))
+
+    def test_is_not_supported_trigger_type(self):
+        self.assertFalse(
+            is_supported_trigger_type(CustomTrigger(name='req', type="dummy"),
+                                      HttpTrigger))