Merge pull request #27 from MagicStack/httpr

Implement HttpResponse support (see issue #4)

Author: 1st1

azure/functions/__init__.py

@@ -1 +1,2 @@
-from .abc import Context, Out, HttpRequest, HttpResponse # NoQA
+from ._abc import Context, Out # NoQA
+from ._http import HttpRequest, HttpResponse # NoQA

azure/functions/abc.py renamed to azure/functions/_abc.py

@@ -76,5 +76,6 @@ def status_code(self):
  def headers(self):
  pass
 
- def set_body(self, body: TypedData):
+ @abc.abstractmethod
+ def get_body(self) -> bytes:
  pass

azure/functions/_http.py

@@ -0,0 +1,129 @@
+import collections.abc
+import types
+import typing
+
+from . import _abc
+
+
+class BaseHeaders(collections.abc.Mapping):
+
+ def __init__(self, source=None):
+ if source is None:
+ self.__http_headers__ = {}
+ else:
+ self.__http_headers__ = {k.lower(): v for k, v in source.items()}
+
+ def __getitem__(self, key: str) -> str:
+ return self.__http_headers__[key.lower()]
+
+ def __len__(self):
+ return len(self.__http_headers__)
+
+ def __contains__(self, key: str):
+ return key.lower() in self.__http_headers__
+
+ def __iter__(self):
+ return iter(self.__http_headers__)
+
+
+class RequestHeaders(BaseHeaders):
+ pass
+
+
+class ResponseHeaders(BaseHeaders, collections.abc.MutableMapping):
+
+ def __setitem__(self, key: str, value: str):
+ self.__http_headers__[key.lower()] = value
+
+ def __delitem__(self, key: str):
+ del self.__http_headers__[key.lower()]
+
+
+class HttpRequest(_abc.HttpRequest):
+ """An HTTP request object."""
+
+ def __init__(self, method: str, url: str,
+ headers: typing.Mapping[str, str],
+ params: typing.Mapping[str, str],
+ body):
+ self.__method = method
+ self.__url = url
+ self.__headers = RequestHeaders(headers)
+ self.__params = types.MappingProxyType(params)
+ self.__body = body
+
+ @property
+ def url(self):
+ return self.__url
+
+ @property
+ def method(self):
+ return self.__method.upper()
+
+ @property
+ def headers(self):
+ return self.__headers
+
+ @property
+ def params(self):
+ return self.__params
+
+ def get_body(self):
+ return self.__body
+
+
+class HttpResponse(_abc.HttpResponse):
+ """An HTTP response object."""
+
+ def __init__(self, body=None, *,
+ status_code=None, headers=None, mimetype=None, charset=None):
+ if status_code is None:
+ status_code = 200
+ self.__status_code = status_code
+
+ if mimetype is None:
+ mimetype = 'text/plain'
+ self.__mimetype = mimetype
+
+ if charset is None:
+ charset = 'utf-8'
+ self.__charset = charset
+
+ if headers is None:
+ headers = {}
+ self.__headers = ResponseHeaders(headers)
+
+ if body is not None:
+ self.__set_body(body)
+ else:
+ self.__body = None
+
+ @property
+ def mimetype(self):
+ return self.__mimetype
+
+ @property
+ def charset(self):
+ return self.__charset
+
+ @property
+ def headers(self):
+ return self.__headers
+
+ @property
+ def status_code(self):
+ return self.__status_code
+
+ def __set_body(self, body):
+ if isinstance(body, str):
+ body = body.encode(self.__charset)
+
+ if not isinstance(body, (bytes, bytearray)):
+ raise TypeError(
+ f'reponse is expected to be either of '
+ f'str, bytes, or bytearray, got {type(body).__name__}')
+
+ self.__body = body
+
+ def get_body(self):
+ return self.__body

azure/worker/rpc_types.py

@@ -5,7 +5,6 @@
 """
 
 
-import types
 import typing
 
 import azure.functions as azf
@@ -44,41 +43,6 @@ def function_directory(self) -> str:
  return self.__func_dir
 
 
-class HttpRequest(azf.HttpRequest):
- """An HTTP request object."""
-
- __slots__ = ('_method', '_url', '_headers', '_params', '_body')
-
- def __init__(self, method: str, url: str,
- headers: typing.Mapping[str, str],
- params: typing.Mapping[str, str],
- body):
- self._method = method
- self._url = url
- self._headers = types.MappingProxyType(headers)
- self._params = types.MappingProxyType(params)
- self._body = body
-
- @property
- def url(self):
- return self._url
-
- @property
- def method(self):
- return self._method.upper()
-
- @property
- def headers(self):
- return self._headers
-
- @property
- def params(self):
- return self._params
-
- def get_body(self):
- return self._body
-
-
 def from_incoming_proto(o: protos.TypedData):
  dt = o.WhichOneof('data')
 
@@ -89,7 +53,7 @@ def from_incoming_proto(o: protos.TypedData):
  return getattr(o, dt)
 
  if dt == 'http':
- return HttpRequest(
+ return azf.HttpRequest(
  method=o.http.method,
  url=o.http.url,
  headers=o.http.headers,
@@ -114,6 +78,28 @@ def to_outgoing_proto(o: typing.Any):
  if isinstance(o, bytes):
  return protos.TypedData(bytes=o)
 
+ if isinstance(o, azf.HttpResponse):
+ status = o.status_code
+ headers = dict(o.headers)
+ if 'content-type' not in headers:
+ if o.mimetype.startswith('text/'):
+ headers['content-type'] = f'{o.mimetype}; charset={o.charset}'
+ else:
+ headers['content-type'] = f'{o.mimetype}'
+
+ body = o.get_body()
+ if body is not None:
+ body = protos.TypedData(bytes=body)
+ else:
+ body = protos.TypedData(bytes=b'')
+
+ return protos.TypedData(
+ http=protos.RpcHttp(
+ status_code=str(status),
+ headers=headers,
+ is_raw=True,
+ body=body))
+
  raise TypeError(
  f'unable to encode outgoing TypedData: '
  f'unsupported Python type: {type(o)}')

azure/worker/tests/functions/return_http/function.json

@@ -0,0 +1,17 @@
+{
+ "scriptFile": "main.py",
+ "disabled": false,
+ "bindings": [
+ {
+ "authLevel": "anonymous",
+ "type": "httpTrigger",
+ "direction": "in",
+ "name": "req"
+ },
+ {
+ "type": "http",
+ "direction": "out",
+ "name": "$return"
+ }
+ ]
+}

azure/worker/tests/functions/return_http/main.py

@@ -0,0 +1,6 @@
+import azure.functions as azf
+
+
+def main(req: azf.HttpRequest):
+ return azf.HttpResponse('<h1>Hello World™</h1>',
+ mimetype='text/html')

azure/worker/tests/functions/return_http_404/function.json

@@ -0,0 +1,17 @@
+{
+ "scriptFile": "main.py",
+ "disabled": false,
+ "bindings": [
+ {
+ "authLevel": "anonymous",
+ "type": "httpTrigger",
+ "direction": "in",
+ "name": "req"
+ },
+ {
+ "type": "http",
+ "direction": "out",
+ "name": "$return"
+ }
+ ]
+}

azure/worker/tests/functions/return_http_404/main.py

@@ -0,0 +1,5 @@
+import azure.functions as azf
+
+
+def main(req: azf.HttpRequest):
+ return azf.HttpResponse('bye', status_code=404)

azure/worker/tests/functions/return_http_redirect/function.json

@@ -0,0 +1,17 @@
+{
+ "scriptFile": "main.py",
+ "disabled": false,
+ "bindings": [
+ {
+ "authLevel": "anonymous",
+ "type": "httpTrigger",
+ "direction": "in",
+ "name": "req"
+ },
+ {
+ "type": "http",
+ "direction": "out",
+ "name": "$return"
+ }
+ ]
+}

azure/worker/tests/functions/return_http_redirect/main.py

@@ -0,0 +1,7 @@
+import azure.functions as azf
+
+
+def main(req: azf.HttpRequest):
+ return azf.HttpResponse(
+ status_code=302,
+ headers={'location': 'return_http'})