plain.auth 0.20.0__py3-none-any.whl → 0.20.2__py3-none-any.whl

plain/auth/CHANGELOG.md

@@ -1,5 +1,25 @@
 # plain-auth changelog
 
+## [0.20.2](https://github.com/dropseed/plain/releases/plain-auth@0.20.2) (2025-10-06)
+
+### What's changed
+
+- Added comprehensive type annotations across the entire package for improved IDE support and type checking ([786c1db](https://github.com/dropseed/plain/commit/786c1dbdbd))
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.20.1](https://github.com/dropseed/plain/releases/plain-auth@0.20.1) (2025-10-02)
+
+### What's changed
+
+- Updated README documentation to use `get_request_user()` and `get_current_user()` instead of `request.user` ([f6278d9](https://github.com/dropseed/plain/commit/f6278d9bb4))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.20.0](https://github.com/dropseed/plain/releases/plain-auth@0.20.0) (2025-10-02)
 
 ### What's changed

plain/auth/README.md

@@ -17,8 +17,11 @@ The `plain.auth` package provides user authentication and authorization for Plai
 
 ```python
 # In a view
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -33,7 +36,7 @@ class ProfileView(AuthViewMixin, View):
     login_required = True
 
     def get(self):
-        return f"Welcome, {self.request.user.email}!"
+        return f"Welcome, {self.user.email}!"
 ```
 
 ## Authentication setup
@@ -108,23 +111,24 @@ urlpatterns = [
 
 ## Checking if a user is logged in
 
-A `request.user` will either be `None` or point to an instance of your `AUTH_USER_MODEL`.
-
-In templates:
+In templates, use the `get_current_user()` function:
 
 ```html
-{% if request.user %}
-    <p>Hello, {{ request.user.email }}!</p>
+{% if get_current_user() %}
+    <p>Hello, {{ get_current_user().email }}!</p>
 {% else %}
     <p>You are not logged in.</p>
 {% endif %}
 ```
 
-In Python code:
+In Python code, use `get_request_user()`:
 
 ```python
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -151,7 +155,7 @@ class AdminOnlyView(AuthViewMixin, View):
 class CustomPermissionView(AuthViewMixin, View):
     def check_auth(self):
         super().check_auth()
-        if not self.request.user.is_special:
+        if not self.user.is_special:
             raise PermissionDenied("You're not special!")
 ```
 

plain/auth/requests.py

@@ -1,24 +1,20 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from weakref import WeakKeyDictionary
 
 if TYPE_CHECKING:
     from plain.http import Request
 
-    from .sessions import get_user_model
+_request_users: WeakKeyDictionary[Request, Any | None] = WeakKeyDictionary()
 
-    User = get_user_model()
 
-_request_users: WeakKeyDictionary[Request, User | None] = WeakKeyDictionary()
-
-
-def set_request_user(request: Request, user: User | None) -> None:
+def set_request_user(request: Request, user: Any | None) -> None:
     """Store the authenticated user for this request."""
     _request_users[request] = user
 
 
-def get_request_user(request: Request) -> User | None:
+def get_request_user(request: Request) -> Any | None:
     """
     Get the authenticated user for this request, if any.
 

plain/auth/sessions.py

@@ -1,4 +1,8 @@
+from __future__ import annotations
+
 import hmac
+from collections.abc import Generator
+from typing import TYPE_CHECKING, Any
 
 from plain.exceptions import ImproperlyConfigured
 from plain.models import models_registry
@@ -9,18 +13,21 @@ from plain.utils.encoding import force_bytes
 
 from .requests import get_request_user, set_request_user
 
+if TYPE_CHECKING:
+    from plain.http import Request
+
 USER_ID_SESSION_KEY = "_auth_user_id"
 USER_HASH_SESSION_KEY = "_auth_user_hash"
 
 
-def get_session_auth_hash(user):
+def get_session_auth_hash(user: Any) -> str:
     """
     Return an HMAC of the password field.
     """
     return _get_session_auth_hash(user)
 
 
-def update_session_auth_hash(request, user):
+def update_session_auth_hash(request: Request, user: Any) -> None:
     """
     Updating a user's password (for example) logs out all sessions for the user.
 
@@ -36,12 +43,12 @@ def update_session_auth_hash(request, user):
         session[USER_HASH_SESSION_KEY] = get_session_auth_hash(user)
 
 
-def get_session_auth_fallback_hash(user):
+def get_session_auth_fallback_hash(user: Any) -> Generator[str, None, None]:
     for fallback_secret in settings.SECRET_KEY_FALLBACKS:
         yield _get_session_auth_hash(user, secret=fallback_secret)
 
 
-def _get_session_auth_hash(user, secret=None):
+def _get_session_auth_hash(user: Any, secret: str | None = None) -> str:
     key_salt = "plain.auth.get_session_auth_hash"
     return salted_hmac(
         key_salt,
@@ -51,7 +58,7 @@ def _get_session_auth_hash(user, secret=None):
     ).hexdigest()
 
 
-def login(request, user):
+def login(request: Request, user: Any) -> None:
     """
     Persist a user id and a backend in the request. This way a user doesn't
     have to reauthenticate on every request. Note that data set during
@@ -87,7 +94,7 @@ def login(request, user):
     set_request_user(request, user)
 
 
-def logout(request):
+def logout(request: Request) -> None:
     """
     Remove the authenticated user's ID from the request and flush their session
     data.
@@ -99,7 +106,7 @@ def logout(request):
     set_request_user(request, None)
 
 
-def get_user_model():
+def get_user_model() -> type[Any]:
     """
     Return the User model that is active in this project.
     """
@@ -115,7 +122,7 @@ def get_user_model():
         )
 
 
-def get_user(request):
+def get_user(request: Request) -> Any | None:
     """
     Return the user model instance associated with the given request session.
     If no user is retrieved, return None.

plain/auth/templates.py

@@ -1,13 +1,20 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
 from jinja2 import pass_context
 
 from plain.templates import register_template_global
 
 from .requests import get_request_user
 
+if TYPE_CHECKING:
+    from jinja2.runtime import Context
+
 
 @register_template_global
 @pass_context
-def get_current_user(context):
+def get_current_user(context: Context) -> Any | None:
     """Get the authenticated user for the current request."""
     request = context.get("request")
     assert request is not None, "No request in template context"

plain/auth/test.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from http.cookies import SimpleCookie
+from typing import TYPE_CHECKING, Any
 
 from plain.http.request import Request
 from plain.runtime import settings
@@ -8,8 +11,11 @@ from plain.sessions.requests import get_request_session, set_request_session
 from .requests import set_request_user
 from .sessions import get_user, login, logout
 
+if TYPE_CHECKING:
+    from plain.test.client import Client
+
 
-def login_client(client, user):
+def login_client(client: Client, user: Any) -> None:
     """Log a user into a test client."""
     request = Request()
     if client.session:
@@ -32,7 +38,7 @@ def login_client(client, user):
     client.cookies[session_cookie].update(cookie_data)
 
 
-def logout_client(client):
+def logout_client(client: Client) -> None:
     """Log out a user from a test client."""
     request = Request()
     if client.session:

plain/auth/utils.py

@@ -1,8 +1,12 @@
+from __future__ import annotations
+
+from typing import Any
+
 from plain.urls import NoReverseMatch, reverse
 from plain.utils.functional import Promise
 
 
-def resolve_url(to, *args, **kwargs):
+def resolve_url(to: Any, *args: Any, **kwargs: Any) -> str:
     """
     Return a URL appropriate for the arguments passed.
 

plain/auth/views.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from urllib.parse import urlparse, urlunparse
 
 from plain.exceptions import PermissionDenied
@@ -23,13 +23,9 @@ from .utils import resolve_url
 if TYPE_CHECKING:
     from plain.http import Request
 
-    from .sessions import get_user_model
-
-    User = get_user_model()
-
 
 class LoginRequired(Exception):
-    def __init__(self, login_url=None, redirect_field_name="next"):
+    def __init__(self, login_url: str | None = None, redirect_field_name: str = "next"):
         self.login_url = login_url or settings.AUTH_LOGIN_URL
         self.redirect_field_name = redirect_field_name
 
@@ -42,7 +38,7 @@ class AuthViewMixin(SessionViewMixin):
     request: Request
 
     @cached_property
-    def user(self) -> User | None:
+    def user(self) -> Any | None:
         """Get the authenticated user for this request."""
         from .requests import get_request_user
 
@@ -116,12 +112,14 @@ class AuthViewMixin(SessionViewMixin):
 
 
 class LogoutView(View):
-    def post(self):
+    def post(self) -> ResponseRedirect:
         logout(self.request)
         return ResponseRedirect("/")
 
 
-def redirect_to_login(next, login_url=None, redirect_field_name="next"):
+def redirect_to_login(
+    next: str, login_url: str | None = None, redirect_field_name: str = "next"
+) -> ResponseRedirect:
     """
     Redirect the user to the login page, passing the given 'next' page.
     """
@@ -133,4 +131,4 @@ def redirect_to_login(next, login_url=None, redirect_field_name="next"):
         querystring[redirect_field_name] = next
         login_url_parts[4] = querystring.urlencode(safe="/")
 
-    return ResponseRedirect(urlunparse(login_url_parts))
+    return ResponseRedirect(str(urlunparse(login_url_parts)))

{plain_auth-0.20.0.dist-info → plain_auth-0.20.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.auth
-Version: 0.20.0
+Version: 0.20.2
 Summary: Add users to your app and decide what they can access.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
@@ -29,8 +29,11 @@ The `plain.auth` package provides user authentication and authorization for Plai
 
 ```python
 # In a view
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -45,7 +48,7 @@ class ProfileView(AuthViewMixin, View):
     login_required = True
 
     def get(self):
-        return f"Welcome, {self.request.user.email}!"
+        return f"Welcome, {self.user.email}!"
 ```
 
 ## Authentication setup
@@ -120,23 +123,24 @@ urlpatterns = [
 
 ## Checking if a user is logged in
 
-A `request.user` will either be `None` or point to an instance of your `AUTH_USER_MODEL`.
-
-In templates:
+In templates, use the `get_current_user()` function:
 
 ```html
-{% if request.user %}
-    <p>Hello, {{ request.user.email }}!</p>
+{% if get_current_user() %}
+    <p>Hello, {{ get_current_user().email }}!</p>
 {% else %}
     <p>You are not logged in.</p>
 {% endif %}
 ```
 
-In Python code:
+In Python code, use `get_request_user()`:
 
 ```python
-if request.user:
-    print(f"Hello, {request.user.email}!")
+from plain.auth import get_request_user
+
+user = get_request_user(request)
+if user:
+    print(f"Hello, {user.email}!")
 else:
     print("You are not logged in.")
 ```
@@ -163,7 +167,7 @@ class AdminOnlyView(AuthViewMixin, View):
 class CustomPermissionView(AuthViewMixin, View):
     def check_auth(self):
         super().check_auth()
-        if not self.request.user.is_special:
+        if not self.user.is_special:
             raise PermissionDenied("You're not special!")
 ```
 

plain_auth-0.20.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+plain/auth/CHANGELOG.md,sha256=KEwd7C-ZHFlVY2Rv4G8tm_KFU6iPN-3-ZBs-W479_wA,4864
+plain/auth/README.md,sha256=I1SeOyrBnF0GAjD7T0k5OlZ2bSHz9---nElinaobewc,4030
+plain/auth/__init__.py,sha256=CrOsS74CPGN1nPTTfie13mPgdyVLRyZ1YwDPIA77uaA,179
+plain/auth/default_settings.py,sha256=65VzDn3j61OMn78Lg6Zuds4A8QKzJJ_0G9KoFqAOIRo,466
+plain/auth/requests.py,sha256=jUlMTOWFt0qfDF_uVkOqaP9rZiCLrAofsmirCwyRGEE,880
+plain/auth/sessions.py,sha256=xDp1EiB0cV5w3L5XioqO8vs77wnF8cvreExms3-e744,6015
+plain/auth/templates.py,sha256=bOMPfLrf8SSxOSWrKTkqKGaK3aNBTLxe62HJulghutU,556
+plain/auth/test.py,sha256=SHawhwarJEMVfaLkjpiuFVSWZoGIMwhzXreU_T1zvCE,1599
+plain/auth/utils.py,sha256=9kKWh1QqxA8Esct-jBvTCdjBYOHpO_Tg1YeV9WxYmxg,1362
+plain/auth/views.py,sha256=vWLMeykTrA5LtA179uE7w-BY9Kv25r1VScLHooDvZUA,4792
+plain_auth-0.20.2.dist-info/METADATA,sha256=BE1BOkDeM_Nw6Ym8w3VanuGn7uHN8wwnHkmuYhcEVBU,4390
+plain_auth-0.20.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_auth-0.20.2.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain_auth-0.20.2.dist-info/RECORD,,

plain_auth-0.20.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-plain/auth/CHANGELOG.md,sha256=IyxuPyEHvnwqEu6GKtUEOtlu1iuLg5Xux6610lrRAIU,4200
-plain/auth/README.md,sha256=Kr3pW6XDd9sp-b8DOH2uKRqCqrR8MYB98qRUxeiwn0k,3944
-plain/auth/__init__.py,sha256=CrOsS74CPGN1nPTTfie13mPgdyVLRyZ1YwDPIA77uaA,179
-plain/auth/default_settings.py,sha256=65VzDn3j61OMn78Lg6Zuds4A8QKzJJ_0G9KoFqAOIRo,466
-plain/auth/requests.py,sha256=f8QUpqHueoTYnL2ITgRXxLFYLSxra9jW3p9pjFgj0B0,949
-plain/auth/sessions.py,sha256=Pz27K2wFfij0H0nGg_2rq0WJpcgTWW22bG0YvHM-dfc,5679
-plain/auth/templates.py,sha256=MQ9vdxE2fBXN-F043g8EGm93s6HRvEMtGHrFcbAr3Fs,400
-plain/auth/test.py,sha256=bLxQEp1mM4t9b-bSSq2u9_Z07Wkl--7U_mSBb9VV7BU,1428
-plain/auth/utils.py,sha256=eEON0Mo928l-aW5tqBuoTdVke8aP4majxVtAFoLroSE,1280
-plain/auth/views.py,sha256=Gm91sB_Z47h-8SwxCMKVKl57FSjed_AM5fdeaiPmz-E,4761
-plain_auth-0.20.0.dist-info/METADATA,sha256=9LQj-14o1wKsAbKp3xTd09vmjuJTzYvcD4xjiUqGRqY,4304
-plain_auth-0.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_auth-0.20.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain_auth-0.20.0.dist-info/RECORD,,