Opened 3 weeks ago
Last modified 3 weeks ago
#36898 closed Cleanup/optimization
Document `Session.is_empty` — at Initial Version
| Reported by: | Jake Howard | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 4.2 |
| Severity: | Normal | Keywords: | |
| Cc: | jaffar Khan | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
It's often useful to check whether the user has a session, for example to avoid creating one unnecessarily. Since request.session is always populated when SessionMiddleware is used, it's better to check whether the session is empty. BaseSession has a is_empty method, but it's undocumented.
It should be documented.
Additionally, perhaps BaseSession.__bool__ should exist, so if request.session works as expected? The downside being if getattr(request, "session", None) would be False when sessions are being used, but the session is empty (arguably hasattr would be better there anyway).
Note:
See TracTickets
for help on using tickets.