Skip to content

Commit

Permalink
Deprecate Starlette and Router decorators
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kludex
Kludex committed Oct 5, 2022
1 parent 58b82b0 commit 5c14be1
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 102 deletions.
119 changes: 63 additions & 56 deletions starlette/applications.py
View file
@@ -1,4 +1,5 @@
import typing
import warnings

from starlette.datastructures import State, URLPath
from starlette.middleware import Middleware
Expand Down Expand Up @@ -126,45 +127,44 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
# The following usages are now discouraged in favour of configuration
# during Starlette.__init__(...)
def on_event(self, event_type: str) -> typing.Callable: # pragma: nocover
warnings.warn(
"The `on_event` decorator is deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/events/#registering-events for recommended approach.", # noqa: E501
DeprecationWarning,
)

return self.router.on_event(event_type)

def mount(
self, path: str, app: ASGIApp, name: typing.Optional[str] = None
) -> None: # pragma: nocover
"""
We no longer document this API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
Mount(path, ...),
...
]
app = Starlette(routes=routes)
"""
warnings.warn(
"The 'mount' method is now deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/routing/#submounting-routes for recommended approach.", # noqa: E501
DeprecationWarning,
)

self.router.mount(path, app=app, name=name)

def host(
self, host: str, app: ASGIApp, name: typing.Optional[str] = None
) -> None: # pragma: no cover
"""
We no longer document this API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
Host(path, ...),
...
]
app = Starlette(routes=routes)
"""
warnings.warn(
"The 'host' method is deprecated, and will be removed in version 1.0.0."
"Refer to https://www.starlette.io/routing/#host-based-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)

self.router.host(host, app=app, name=name)

def add_middleware(
self, middleware_class: type, **options: typing.Any
) -> None: # pragma: no cover
warnings.warn(
"The `add_middleware` method is deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/middleware/#using-middleware for recommended approach.", # noqa: E501
DeprecationWarning,
)
self.user_middleware.insert(0, Middleware(middleware_class, **options))
self.middleware_stack = self.build_middleware_stack()

Expand All @@ -173,12 +173,22 @@ def add_exception_handler(
exc_class_or_status_code: typing.Union[int, typing.Type[Exception]],
handler: typing.Callable,
) -> None: # pragma: no cover
warnings.warn(
"The `add_exception_handler` method is deprecated, and will be removed in version 1.0.0." # noqa: E501
"Refer to https://www.starlette.io/exceptions/ for the recommended approach.", # noqa: E501
DeprecationWarning,
)
self.exception_handlers[exc_class_or_status_code] = handler
self.middleware_stack = self.build_middleware_stack()

def add_event_handler(
self, event_type: str, func: typing.Callable
) -> None: # pragma: no cover
warnings.warn(
"The `add_event_handler` method is deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/events/#registering-events for recommended approach.", # noqa: E501
DeprecationWarning,
)
self.router.add_event_handler(event_type, func)

def add_route(
Expand All @@ -189,18 +199,34 @@ def add_route(
name: typing.Optional[str] = None,
include_in_schema: bool = True,
) -> None: # pragma: no cover
warnings.warn(
"The `add_route` method is deprecated, and will be removed in version 1.0.0." # noqa: E501
"Refer to https://www.starlette.io/routing/#http-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)
self.router.add_route(
path, route, methods=methods, name=name, include_in_schema=include_in_schema
)

def add_websocket_route(
self, path: str, route: typing.Callable, name: typing.Optional[str] = None
) -> None: # pragma: no cover
warnings.warn(
"The `add_websocket_route` method is deprecated, and will be removed in version 1.0.0. Refer to " # noqa: E501
"https://www.starlette.io/routing/#websocket-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)
self.router.add_websocket_route(path, route, name=name)

def exception_handler(
self, exc_class_or_status_code: typing.Union[int, typing.Type[Exception]]
) -> typing.Callable: # pragma: nocover
warnings.warn(
"The `exception_handler` decorator is deprecated, and will be removed in version 1.0.0." # noqa: E501
"Refer to https://www.starlette.io/exceptions/ for the recommended approach.", # noqa: E501
DeprecationWarning,
)

def decorator(func: typing.Callable) -> typing.Callable:
self.add_exception_handler(exc_class_or_status_code, func)
return func
Expand All @@ -214,17 +240,11 @@ def route(
name: typing.Optional[str] = None,
include_in_schema: bool = True,
) -> typing.Callable: # pragma: nocover
"""
We no longer document this decorator style API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
Route(path, endpoint=..., ...),
...
]
app = Starlette(routes=routes)
"""
warnings.warn(
"The `route` decorator is deprecated, and will be removed in version 1.0.0."
"Refer to https://www.starlette.io/routing/#http-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)

def decorator(func: typing.Callable) -> typing.Callable:
self.router.add_route(
Expand All @@ -241,17 +261,11 @@ def decorator(func: typing.Callable) -> typing.Callable:
def websocket_route(
self, path: str, name: typing.Optional[str] = None
) -> typing.Callable: # pragma: nocover
"""
We no longer document this decorator style API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
WebSocketRoute(path, endpoint=..., ...),
...
]
app = Starlette(routes=routes)
"""
warnings.warn(
"The `websocket_route` decorator is deprecated, and will be removed in version 1.0.0. Refer to " # noqa: E501
"https://www.starlette.io/routing/#websocket-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)

def decorator(func: typing.Callable) -> typing.Callable:
self.router.add_websocket_route(path, func, name=name)
Expand All @@ -260,18 +274,11 @@ def decorator(func: typing.Callable) -> typing.Callable:
return decorator

def middleware(self, middleware_type: str) -> typing.Callable: # pragma: nocover
"""
We no longer document this decorator style API, and its usage is discouraged.
Instead you should use the following approach:
middleware = [
Middleware(...),
...
]
app = Starlette(middleware=middleware)
"""

warnings.warn(
"The `middleware` decorator is deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/middleware/#using-middleware for recommended approach.", # noqa: E501
DeprecationWarning,
)
assert (
middleware_type == "http"
), 'Currently only middleware("http") is supported.'
Expand Down
87 changes: 41 additions & 46 deletions starlette/routing.py
View file
Expand Up @@ -742,36 +742,22 @@ def __eq__(self, other: typing.Any) -> bool:
def mount(
self, path: str, app: ASGIApp, name: typing.Optional[str] = None
) -> None: # pragma: nocover
"""
We no longer document this API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
Mount(path, ...),
...
]
app = Starlette(routes=routes)
"""

warnings.warn(
"The 'mount' method is now deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/routing/#submounting-routes for recommended approach.", # noqa: E501
DeprecationWarning,
)
route = Mount(path, app=app, name=name)
self.routes.append(route)

def host(
self, host: str, app: ASGIApp, name: typing.Optional[str] = None
) -> None: # pragma: no cover
"""
We no longer document this API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
Host(path, ...),
...
]
app = Starlette(routes=routes)
"""

warnings.warn(
"The 'host' method is deprecated, and will be removed in version 1.0.0."
"Refer to https://www.starlette.io/routing/#host-based-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)
route = Host(host, app=app, name=name)
self.routes.append(route)

Expand All @@ -783,6 +769,11 @@ def add_route(
name: typing.Optional[str] = None,
include_in_schema: bool = True,
) -> None: # pragma: nocover
warnings.warn(
"The `add_route` method is deprecated, and will be removed in version 1.0.0." # noqa: E501
"Refer to https://www.starlette.io/routing/#http-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)
route = Route(
path,
endpoint=endpoint,
Expand All @@ -795,6 +786,11 @@ def add_route(
def add_websocket_route(
self, path: str, endpoint: typing.Callable, name: typing.Optional[str] = None
) -> None: # pragma: no cover
warnings.warn(
"The `add_websocket_route` method is deprecated, and will be removed in version 1.0.0. Refer to " # noqa: E501
"https://www.starlette.io/routing/#websocket-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)
route = WebSocketRoute(path, endpoint=endpoint, name=name)
self.routes.append(route)

Expand All @@ -805,17 +801,11 @@ def route(
name: typing.Optional[str] = None,
include_in_schema: bool = True,
) -> typing.Callable: # pragma: nocover
"""
We no longer document this decorator style API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
Route(path, endpoint=..., ...),
...
]
app = Starlette(routes=routes)
"""
warnings.warn(
"The `route` decorator is deprecated, and will be removed in version 1.0.0."
"Refer to https://www.starlette.io/routing/#http-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)

def decorator(func: typing.Callable) -> typing.Callable:
self.add_route(
Expand All @@ -832,17 +822,11 @@ def decorator(func: typing.Callable) -> typing.Callable:
def websocket_route(
self, path: str, name: typing.Optional[str] = None
) -> typing.Callable: # pragma: nocover
"""
We no longer document this decorator style API, and its usage is discouraged.
Instead you should use the following approach:
routes = [
WebSocketRoute(path, endpoint=..., ...),
...
]
app = Starlette(routes=routes)
"""
warnings.warn(
"The `websocket_route` decorator is deprecated, and will be removed in version 1.0.0. Refer to " # noqa: E501
"https://www.starlette.io/routing/#websocket-routing for the recommended approach.", # noqa: E501
DeprecationWarning,
)

def decorator(func: typing.Callable) -> typing.Callable:
self.add_websocket_route(path, func, name=name)
Expand All @@ -853,6 +837,11 @@ def decorator(func: typing.Callable) -> typing.Callable:
def add_event_handler(
self, event_type: str, func: typing.Callable
) -> None: # pragma: no cover
warnings.warn(
"The `add_event_handler` method is deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/events/#registering-events for recommended approach.", # noqa: E501
DeprecationWarning,
)
assert event_type in ("startup", "shutdown")

if event_type == "startup":
Expand All @@ -861,6 +850,12 @@ def add_event_handler(
self.on_shutdown.append(func)

def on_event(self, event_type: str) -> typing.Callable: # pragma: nocover
warnings.warn(
"The `on_event` decorator is deprecated, and will be removed in version 1.0.0. " # noqa: E501
"Refer to https://www.starlette.io/events/#registering-events for recommended approach.", # noqa: E501
DeprecationWarning,
)

def decorator(func: typing.Callable) -> typing.Callable:
self.add_event_handler(event_type, func)
return func
Expand Down

0 comments on commit 5c14be1

Please sign in to comment.