diff options
| author | markotibold | 2011-05-17 01:27:27 +0200 | 
|---|---|---|
| committer | markotibold | 2011-05-17 01:27:27 +0200 | 
| commit | 40573b2793a49d68b89ea5b6c4bff0e13470cc0c (patch) | |
| tree | 5368570fffbe9b48702f44bbde406243b36c9f04 /djangorestframework/authentication.py | |
| parent | 66b9bda9bf9492c5e1ffba162e044aacb51bbd7e (diff) | |
| download | django-rest-framework-40573b2793a49d68b89ea5b6c4bff0e13470cc0c.tar.bz2 | |
Nicely marked up source code.
Diffstat (limited to 'djangorestframework/authentication.py')
| -rw-r--r-- | djangorestframework/authentication.py | 31 | 
1 files changed, 17 insertions, 14 deletions
diff --git a/djangorestframework/authentication.py b/djangorestframework/authentication.py index b0ba41aa..e3e44ffb 100644 --- a/djangorestframework/authentication.py +++ b/djangorestframework/authentication.py @@ -1,10 +1,10 @@  """ -The ``authentication`` module provides a set of pluggable authentication classes. +The :mod:`authentication` module provides a set of pluggable authentication classes. -Authentication behavior is provided by adding the ``AuthMixin`` class to a ``View`` . +Authentication behavior is provided by mixing the :class:`mixins.AuthMixin` class into a :class:`View` class.  The set of authentication methods which are used is then specified by setting the -``authentication`` attribute on the ``View`` class, and listing a set of authentication classes. +:attr:`authentication` attribute on the :class:`View` class, and listing a set of authentication classes.  """  from django.contrib.auth import authenticate @@ -22,28 +22,31 @@ __all__ = (  class BaseAuthenticaton(object):      """      All authentication classes should extend BaseAuthentication. +     +    :param view: :class:`Authentication` classes are always passed the current view on creation.      """      def __init__(self, view):          """ -        Authentication classes are always passed the current view on creation.          """          self.view = view      def authenticate(self, request):          """ -        Authenticate the request and return a ``User`` instance or None. (*) +        :param request: Request to be authenticated +        :rtype: :obj:`User` object or None [*]_ -        This function must be overridden to be implemented. +        .. Note:: +            This function must be overridden to be implemented. -        (*) The authentication context _will_ typically be a ``User`` object, -        but it need not be.  It can be any user-like object so long as the -        permissions classes on the view can handle the object and use -        it to determine if the request has the required permissions or not.  - -        This can be an important distinction if you're implementing some token -        based authentication mechanism, where the authentication context -        may be more involved than simply mapping to a ``User``. +        .. [*] The authentication context *will* typically be a :obj:`User` object, +            but it need not be.  It can be any user-like object so long as the +            permissions classes on the view can handle the object and use +            it to determine if the request has the required permissions or not.  +     +            This can be an important distinction if you're implementing some token +            based authentication mechanism, where the authentication context +            may be more involved than simply mapping to a :obj:`User`.          """          return None  | 
