Skip to content

fix: preserve user function type through http and cloud_event decorators #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
64johnlee wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −5
Open

fix: preserve user function type through http and cloud_event decorators #426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions src/functions_framework/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import types

from inspect import signature
from typing import Callable, Type
from typing import Callable, Type, TypeVar

import cloudevents.exceptions as cloud_exceptions
import flask
Expand Down Expand Up @@ -56,6 +56,11 @@
CloudEventFunction = Callable[[CloudEvent], None]
HTTPFunction = Callable[[flask.Request], flask.typing.ResponseReturnValue]

# TypeVars used by decorators to preserve the user function's exact type, so
# that type checkers (mypy, pyright) can still verify call sites after decoration.
_CloudEventFunctionT = TypeVar("_CloudEventFunctionT", bound=CloudEventFunction)
_HTTPFunctionT = TypeVar("_HTTPFunctionT", bound=HTTPFunction)


class _LoggingHandler(io.TextIOWrapper):
"""Logging replacement for stdout and stderr in GCF Python 3.7."""
Expand All @@ -70,7 +75,7 @@ def write(self, out):
return self.stderr.write(json.dumps(payload) + "\n")


def cloud_event(func: CloudEventFunction) -> CloudEventFunction:
def cloud_event(func: _CloudEventFunctionT) -> _CloudEventFunctionT:
"""Decorator that registers cloudevent as user function signature type."""
_function_registry.REGISTRY_MAP[func.__name__] = (
_function_registry.CLOUDEVENT_SIGNATURE_TYPE
Expand All @@ -80,7 +85,7 @@ def cloud_event(func: CloudEventFunction) -> CloudEventFunction:
def wrapper(*args, **kwargs):
return func(*args, **kwargs)

return wrapper
return wrapper # type: ignore[return-value]


def typed(*args):
Expand Down Expand Up @@ -110,7 +115,7 @@ def wrapper(*args, **kwargs):
return _typed


def http(func: HTTPFunction) -> HTTPFunction:
def http(func: _HTTPFunctionT) -> _HTTPFunctionT:
"""Decorator that registers http as user function signature type."""
_function_registry.REGISTRY_MAP[func.__name__] = (
_function_registry.HTTP_SIGNATURE_TYPE
Expand All @@ -120,7 +125,7 @@ def http(func: HTTPFunction) -> HTTPFunction:
def wrapper(*args, **kwargs):
return func(*args, **kwargs)

return wrapper
return wrapper # type: ignore[return-value]


def setup_logging():
Expand Down