orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #4477 from tusharsadhwani/decorator-types

Browse source 
Add better types for app decorators
This commit is contained in:
David Lord 2022-03-08 06:50:25 -08:00 • committed by GitHub
commit b655a9db30
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/flask/scaffold.py
View file

@ -369,48 +369,53 @@ class Scaffold:
return open(os.path.join(self.root_path, resource), mode) return open(os.path.join(self.root_path, resource), mode)
def _method_route(self, method: str, rule: str, options: dict) -> t.Callable: def _method_route(
self,
method: str,
rule: str,
options: dict,
) -> t.Callable[[F], F]:
if "methods" in options: if "methods" in options:
raise TypeError("Use the 'route' decorator to use the 'methods' argument.") raise TypeError("Use the 'route' decorator to use the 'methods' argument.")
return self.route(rule, methods=[method], **options) return self.route(rule, methods=[method], **options)
def get(self, rule: str, **options: t.Any) -> t.Callable: def get(self, rule: str, **options: t.Any) -> t.Callable[[F], F]:
"""Shortcut for :meth:`route` with ``methods=["GET"]``. """Shortcut for :meth:`route` with ``methods=["GET"]``.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
return self._method_route("GET", rule, options) return self._method_route("GET", rule, options)
def post(self, rule: str, **options: t.Any) -> t.Callable: def post(self, rule: str, **options: t.Any) -> t.Callable[[F], F]:
"""Shortcut for :meth:`route` with ``methods=["POST"]``. """Shortcut for :meth:`route` with ``methods=["POST"]``.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
return self._method_route("POST", rule, options) return self._method_route("POST", rule, options)
def put(self, rule: str, **options: t.Any) -> t.Callable: def put(self, rule: str, **options: t.Any) -> t.Callable[[F], F]:
"""Shortcut for :meth:`route` with ``methods=["PUT"]``. """Shortcut for :meth:`route` with ``methods=["PUT"]``.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
return self._method_route("PUT", rule, options) return self._method_route("PUT", rule, options)
def delete(self, rule: str, **options: t.Any) -> t.Callable: def delete(self, rule: str, **options: t.Any) -> t.Callable[[F], F]:
"""Shortcut for :meth:`route` with ``methods=["DELETE"]``. """Shortcut for :meth:`route` with ``methods=["DELETE"]``.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
return self._method_route("DELETE", rule, options) return self._method_route("DELETE", rule, options)
def patch(self, rule: str, **options: t.Any) -> t.Callable: def patch(self, rule: str, **options: t.Any) -> t.Callable[[F], F]:
"""Shortcut for :meth:`route` with ``methods=["PATCH"]``. """Shortcut for :meth:`route` with ``methods=["PATCH"]``.
.. versionadded:: 2.0 .. versionadded:: 2.0
""" """
return self._method_route("PATCH", rule, options) return self._method_route("PATCH", rule, options)
def route(self, rule: str, **options: t.Any) -> t.Callable: def route(self, rule: str, **options: t.Any) -> t.Callable[[F], F]:
"""Decorate a view function to register it with the given URL """Decorate a view function to register it with the given URL
rule and options. Calls :meth:`add_url_rule`, which has more rule and options. Calls :meth:`add_url_rule`, which has more
details about the implementation. details about the implementation.
@ -434,7 +439,7 @@ class Scaffold:
:class:`~werkzeug.routing.Rule` object. :class:`~werkzeug.routing.Rule` object.
""" """
def decorator(f: t.Callable) -> t.Callable: def decorator(f: F) -> F:
endpoint = options.pop("endpoint", None) endpoint = options.pop("endpoint", None)
self.add_url_rule(rule, endpoint, f, **options) self.add_url_rule(rule, endpoint, f, **options)
return f return f