Skip to content
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.

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

supporting Enum as event name #15

Merged
merged 3 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions fastapi_events/dispatcher.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import os
from distutils.util import strtobool
from typing import Deque, Any, Optional
from enum import Enum
from typing import Deque, Any, Optional, Union

from fastapi_events import event_store
from fastapi_events.typing import Event


def dispatch(event_name: str, payload: Optional[Any] = None) -> None:
def dispatch(event_name: Union[str, Enum], payload: Optional[Any] = None) -> None:
DISABLE_DISPATCH_GLOBALLY = strtobool(os.environ.get("FASTAPI_EVENTS_DISABLE_DISPATCH", "0"))

if DISABLE_DISPATCH_GLOBALLY:
Expand Down
6 changes: 6 additions & 0 deletions fastapi_events/handlers/local.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,18 @@ async def handle(self, event: Event) -> None:
await loop.run_in_executor(None, functools.partial(handler, event))

def _register_handler(self, event_name, func):
if not isinstance(event_name, str):
event_name = str(event_name)

if event_name not in self._registry:
self._registry[event_name] = []

self._registry[event_name].append(func)

def _get_handlers_for_event(self, event_name):
if not isinstance(event_name, str):
event_name = str(event_name)

# TODO consider adding a cache
handlers = []
for event_name_pattern, registered_handlers in self._registry.items():
Expand Down
5 changes: 3 additions & 2 deletions fastapi_events/typing.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from typing import Tuple, Any
from enum import Enum
from typing import Tuple, Any, Union

Event = Tuple[str, Any]
Event = Tuple[Union[str, Enum], Any]
31 changes: 31 additions & 0 deletions tests/handlers/test_local_handler.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from enum import Enum

from starlette.applications import Starlette
from starlette.middleware import Middleware
from starlette.requests import Request
Expand Down Expand Up @@ -66,3 +68,32 @@ async def root(request: Request) -> JSONResponse:
("dance", 1)
):
assert len(events_handled[event_category]) == expected_count


def test_local_handler_with_enum():
"""
Test local_handler with Enum as event name
"""

class Events(Enum):
CREATED = "CREATED"

events_handled = []

@local_handler.register(event_name=Events.CREATED)
async def handle_all_created_events(event: Event):
events_handled.append(event)

app = Starlette(middleware=[
Middleware(EventHandlerASGIMiddleware,
handlers=[local_handler])])

@app.route("/")
async def root(request: Request) -> JSONResponse:
dispatch(Events.CREATED)
return JSONResponse()

client = TestClient(app)
client.get("/")

assert events_handled[0][0] == Events.CREATED