python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Write the docs for new current_user dependency

Browse Source
This commit is contained in:
François Voron
2021-02-06 13:55:41 +01:00
parent 3146a1ffe6
commit 4776117f10
3 changed files with 83 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
fastapi_users/authentication/__init__.py
View File

@@ -97,15 +97,16 @@ class Authenticator:
"""
Return a dependency callable to retrieve currently authenticated user.
:param optional: If `true`, `None` is returned if there is no
authenticated user or if it doesn't pass the other requirements.
Otherwise, an exception is raised. Defaults to `false`.
:param active: If `true`, raise an exception if
the authenticated user is inactive. Defaults to `false`.
:param verified: If `true`, raise an exception if
the authenticated user is not verified. Defaults to `false`.
:param superuser: If `true`, raise an exception if
the authenticated user is not a superuser. Defaults to `false`.
:param optional: If `True`, `None` is returned if there is no authenticated user
or if it doesn't pass the other requirements.
Otherwise, throw `401 Unauthorized`. Defaults to `False`.
Otherwise, an exception is raised. Defaults to `False`.
:param active: If `True`, throw `401 Unauthorized` if
the authenticated user is inactive. Defaults to `False`.
:param verified: If `True`, throw `401 Unauthorized` if
the authenticated user is not verified. Defaults to `False`.
:param superuser: If `True`, throw `403 Forbidden` if
the authenticated user is not a superuser. Defaults to `False`.
"""
# Here comes some blood magic 🧙‍♂️
# Thank to "makefun", we are able to generate callable