Merge pull request #8 from caltechads/master

Removed process_exception(). Improved docs.
Fixes #7

AUTHORS.rst

@@ -12,6 +12,7 @@ answer newbie questions, and generally made ``django-crequest`` that much better
 
 * Alireza Savand <[email protected]>
 * Richard Royal <[email protected]>
+* Robert Rollins <[email protected]>
 
 A big THANK YOU goes to:
 

crequest/__init__.py

@@ -1 +1 @@
-__version__ = (2016, 3, 16)
+__version__ = '2018.5.1'

crequest/middleware.py

@@ -1,5 +1,4 @@
 import threading
-
 try:
     from django.utils.deprecation import MiddlewareMixin
 except ImportError:
@@ -8,46 +7,43 @@
 
 class CrequestMiddleware(MiddlewareMixin):
     """
-    Always have access to the current request
+    Provides storage for the "current" request object, so that code anywhere
+    in your project can access it, without it having to be passed to that code
+    from the view.
     """
-    _request = {}
+    _requests = {}
 
     def process_request(self, request):
         """
-        Store request
+        Store the current request.
         """
         self.__class__.set_request(request)
 
     def process_response(self, request, response):
         """
-        Delete request
+        Delete the current request to avoid leaking memory.
         """
         self.__class__.del_request()
         return response
 
-    def process_exception(self, request, exception):
-        """
-        Delete request
-        """
-        self.__class__.del_request()
-
     @classmethod
     def get_request(cls, default=None):
         """
-        Retrieve request
+        Retrieve the request object for the current thread, or the optionally
+        provided default if there is no current request.
         """
-        return cls._request.get(threading.current_thread(), default)
+        return cls._requests.get(threading.current_thread(), default)
 
     @classmethod
     def set_request(cls, request):
         """
-        Store request
+        Save the given request into storage for the current thread.
         """
-        cls._request[threading.current_thread()] = request
+        cls._requests[threading.current_thread()] = request
 
     @classmethod
     def del_request(cls):
         """
-        Delete request
+        Delete the request that was stored for the current thread.
         """
-        cls._request.pop(threading.current_thread(), None)
+        cls._requests.pop(threading.current_thread(), None)

setup.py

@@ -3,8 +3,8 @@
 
 setup(
     name='django-crequest',
-    version=".".join(map(str, __import__('crequest').__version__)),
-    description='Middleware to make current request always available.',
+    version=__import__('crequest').__version__,
+    description='Middleware that makes the current request available from anywhere.',
     long_description=open('README.rst').read(),
     license=open('LICENSE', encoding='utf-8').read(),
     author='Alireza Savand',