add warmup context (#154)

* add warmup context

* fix mypy

* fix mypy comment

* fix mypy ignore

* fix mypy ignore

* fix mypy pass

Author: YunchuWang

azure/functions/_abc.py

@@ -47,6 +47,11 @@ def message(self) -> str:
         pass
 
 
+class WarmUpContext(abc.ABC):
+    """Warmup context object."""
+    pass
+
+
 class TraceContext(abc.ABC):
     """Trace context object."""
 
@@ -126,6 +131,12 @@ def retry_context(self) -> RetryContext:
         """Context for retries to the function."""
         pass
 
+    @property
+    @abc.abstractmethod
+    def warmup_context(self) -> WarmUpContext:
+        """Context for warmup to the function."""
+        pass
+
 
 class HttpRequest(abc.ABC):
     """HTTP request object."""

azure/functions/_eventhub.py

@@ -13,7 +13,8 @@ class EventHubEvent(func_abc.EventHubEvent):
 
     def __init__(self, *,
                  body: bytes,
-                 trigger_metadata: typing.Mapping[str, meta.Datum] = None,
+                 trigger_metadata: typing.Optional[
+                     typing.Mapping[str, meta.Datum]] = None,
                  enqueued_time: typing.Optional[datetime.datetime] = None,
                  partition_key: typing.Optional[str] = None,
                  sequence_number: typing.Optional[int] = None,

azure/functions/_http.py

@@ -66,11 +66,11 @@ class HttpResponse(_abc.HttpResponse):
     """
 
     def __init__(self,
-                 body: typing.Union[str, bytes] = None, *,
-                 status_code: int = None,
+                 body: typing.Optional[typing.Union[str, bytes]] = None, *,
+                 status_code: typing.Optional[int] = None,
                  headers: typing.Optional[typing.Mapping[str, str]] = None,
                  mimetype: typing.Optional[str] = None,
-                 charset: str = None) -> None:
+                 charset: typing.Optional[str] = None) -> None:
         if status_code is None:
             status_code = 200
         self.__status_code = status_code

azure/functions/decorators/generic.py

@@ -9,7 +9,7 @@
 class GenericInputBinding(InputBinding):
 
     @staticmethod
-    def get_binding_name() -> str:
+    def get_binding_name():
         pass
 
     def __init__(self,
@@ -23,7 +23,7 @@ def __init__(self,
 class GenericOutputBinding(OutputBinding):
 
     @staticmethod
-    def get_binding_name() -> str:
+    def get_binding_name():
         pass
 
     def __init__(self,
@@ -37,7 +37,7 @@ def __init__(self,
 class GenericTrigger(Trigger):
 
     @staticmethod
-    def get_binding_name() -> str:
+    def get_binding_name():
         pass
 
     def __init__(self,

azure/functions/decorators/servicebus.py

@@ -50,7 +50,7 @@ def __init__(self,
 
 class ServiceBusTopicTrigger(Trigger):
     @staticmethod
-    def get_binding_name():
+    def get_binding_name() -> str:
         return SERVICE_BUS_TRIGGER
 
     def __init__(self,
@@ -74,7 +74,7 @@ def __init__(self,
 
 class ServiceBusTopicOutput(OutputBinding):
     @staticmethod
-    def get_binding_name():
+    def get_binding_name() -> str:
         return SERVICE_BUS
 
     def __init__(self,

azure/functions/kafka.py

@@ -16,7 +16,8 @@ class KafkaEvent(AbstractKafkaEvent):
 
     def __init__(self, *,
                  body: bytes,
-                 trigger_metadata: typing.Mapping[str, meta.Datum] = None,
+                 trigger_metadata: typing.Optional[
+                     typing.Mapping[str, meta.Datum]] = None,
                  key: typing.Optional[str] = None,
                  offset: typing.Optional[int] = None,
                  partition: typing.Optional[int] = None,

azure/functions/servicebus.py

@@ -16,7 +16,7 @@ class ServiceBusMessage(azf_sbus.ServiceBusMessage):
     def __init__(
             self, *,
             body: bytes,
-            trigger_metadata: Mapping[str, Any] = None,
+            trigger_metadata: Optional[Mapping[str, Any]] = None,
             content_type: Optional[str] = None,
             correlation_id: Optional[str] = None,
             dead_letter_source: Optional[str] = None,

tests/test_http_asgi.py

@@ -5,7 +5,7 @@
 import unittest
 
 import azure.functions as func
-from azure.functions._abc import TraceContext, RetryContext
+from azure.functions._abc import TraceContext, RetryContext, WarmUpContext
 from azure.functions._http_asgi import (
     AsgiMiddleware
 )
@@ -114,15 +114,17 @@ def _generate_func_context(
         function_name='httptrigger',
         function_directory='/home/roger/wwwroot/httptrigger',
         trace_context=TraceContext,
-        retry_context=RetryContext
+        retry_context=RetryContext,
+        warmup_context=WarmUpContext
     ) -> func.Context:
         class MockContext(func.Context):
-            def __init__(self, ii, fn, fd, tc, rc):
+            def __init__(self, ii, fn, fd, tc, rc, wc):
                 self._invocation_id = ii
                 self._function_name = fn
                 self._function_directory = fd
                 self._trace_context = tc
                 self._retry_context = rc
+                self._warmup_context = wc
 
             @property
             def invocation_id(self):
@@ -144,8 +146,12 @@ def trace_context(self):
             def retry_context(self):
                 return self._retry_context
 
+            @property
+            def warmup_context(self):
+                return self._warmup_context
+
         return MockContext(invocation_id, function_name, function_directory,
-                           trace_context, retry_context)
+                           trace_context, retry_context, warmup_context)
 
     def test_middleware_calls_app(self):
         app = MockAsgiApplication()

tests/test_http_wsgi.py

@@ -5,7 +5,7 @@
 from io import StringIO, BytesIO
 
 import azure.functions as func
-from azure.functions._abc import TraceContext, RetryContext
+from azure.functions._abc import TraceContext, RetryContext, WarmUpContext
 from azure.functions._http import HttpResponseHeaders
 from azure.functions._http_wsgi import (
     WsgiRequest,
@@ -223,15 +223,17 @@ def _generate_func_context(
         function_name='httptrigger',
         function_directory='/home/roger/wwwroot/httptrigger',
         trace_context=TraceContext,
-        retry_context=RetryContext
+        retry_context=RetryContext,
+        warmup_context=WarmUpContext
     ) -> func.Context:
         class MockContext(func.Context):
-            def __init__(self, ii, fn, fd, tc, rc):
+            def __init__(self, ii, fn, fd, tc, rc, wc):
                 self._invocation_id = ii
                 self._function_name = fn
                 self._function_directory = fd
                 self._trace_context = tc
                 self._retry_context = rc
+                self._warmup_context = wc
 
             @property
             def invocation_id(self):
@@ -253,8 +255,12 @@ def trace_context(self):
             def retry_context(self):
                 return self._retry_context
 
+            @property
+            def warmup_context(self):
+                return self._warmup_context
+
         return MockContext(invocation_id, function_name, function_directory,
-                           trace_context, retry_context)
+                           trace_context, retry_context, warmup_context)
 
     def _generate_wsgi_app(self,
                            status='200 OK',