Mercurial > kallithea
changeset 5253:ad89cd5a6e1a
AuthUser: update docstring
author | Søren Løvborg <kwi@kwi.dk> |
---|---|
date | Tue, 14 Jul 2015 13:59:59 +0200 |
parents | 815bf70a88ce |
children | d052078e0a16 |
files | kallithea/lib/auth.py |
diffstat | 1 files changed, 14 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/kallithea/lib/auth.py Tue Jul 14 13:59:59 2015 +0200 +++ b/kallithea/lib/auth.py Tue Jul 14 13:59:59 2015 +0200 @@ -474,11 +474,21 @@ class AuthUser(object): """ - A simple object that handles all attributes of user in Kallithea + Represents a Kallithea user, including various authentication and + authorization information. Typically used to store the current user, + but is also used as a generic user information data structure in + parts of the code, e.g. user management. - It does lookup based on API key,given user, or user present in session - Then it fills all required information for such user. It also checks if - anonymous access is enabled and if so, it returns default user as logged in + Constructed from user ID, username, API key or cookie dict, it looks + up the matching database `User` and copies all attributes to itself, + adding various non-persistent data. If lookup fails but anonymous + access to Kallithea is enabled, the default user is loaded instead. + + `AuthUser` does not by itself authenticate users and the constructor + sets the `is_authenticated` field to False, except when falling back + to the default anonymous user (if enabled). It's up to other parts + of the code to check e.g. if a supplied password is correct, and if + so, set `is_authenticated` to True. """ def __init__(self, user_id=None, api_key=None, username=None):