Changeset 682

Timestamp:

09/27/05 02:54:29

Author:

fumanchu

Message:

Fix for ticket #317? More importantly, some error-handling and other cleanups:

1. _cphttptools.checkStatus moved to lib.cptools.validStatus. Illegal status codes now raise HTTPError(500) with custom messages.
2. _cputil.responseCodes moved into cptools.
3. _cpOnError logic *all* moved into HTTPError.set_response.
4. _cputil.getErrorStatusAndPage changed to getErrorPage.
5. Made _cputil._HTTPErrorTemplate into a string instead of a function, which the new getErrorPage interpolates with its own **kwargs.
6. HTTPError now properly takes a "message" arg instead of a "body" arg. Specify alternate body via errorPage.4xx config entry (overriding _HTTPErrorTemplate).
7. HTTPError now allows str statuses, to allow arbitrary reason-phrases.
8. assertErrorPage in helper.py updated to match core changes.

Files:

• trunk/cherrypy/_cperror.py (modified) (2 diffs)
• trunk/cherrypy/_cphttptools.py (modified) (5 diffs)
• trunk/cherrypy/_cputil.py (modified) (3 diffs)
• trunk/cherrypy/lib/cptools.py (modified) (3 diffs)
• trunk/cherrypy/test/helper.py (modified) (1 diff)
• trunk/cherrypy/test/test_core.py (modified) (6 diffs)
• trunk/cherrypy/test/test_gzip_filter.py (modified) (1 diff)

trunk/cherrypy/_cperror.py

@@ -172 +172 @@
-
-
-_missing = object()
-
-class HTTPError(Error):
-    """ Exception used to return an HTTP error code to the client.
-        This exception will automatically set the response status and body.
-        
-body can be pased to the init method in place of the
-standard error page
+message (a long description to display in the browser)
+can be provided in place of the default
-    """
-    
-body=_missing
+message=None
-        self.status = status = int(status)
-        if status < 400 or status > 599:
-            raise ValueError("status must be between 400 and 599.")
-
-
+
-    
-    def set_response(self):
-        import cherrypy
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    
-    def __str__(self):
-        import cherrypy
-
+
+
-
-class NotFound(HTTPError):
@@ -227 +217 @@
-    def __init__(self, path):
-        self.args = (path,)
-
-
-
-
+

trunk/cherrypy/_cphttptools.py

@@ -276 +276 @@
-                except cherrypy.RequestHandled:
-                    pass
-
-
-
+
+
+
+
-                    inst.set_response()
-                    applyFilters('beforeFinalize')
-                    finalize()
-                except cherrypy.HTTPError, inst:
-                    # This includes NotFound
-                    inst.set_response()
-                    applyFilters('beforeFinalize')
-                    finalize()
-
-            finally:
-                applyFilters('onEndResource')
-        except:
-            # This includes HTTPError and NotFound
-            handleError(sys.exc_info())
-    
@@ -425 +419 @@
-
-def handleError(exc):
-
+unanticipated 
-    try:
-        applyFilters('beforeErrorResponse')
@@ -437 +431 @@
-        applyFilters('afterErrorResponse')
-        return
-cherrypy.HTTPRedirect
+(cherrypy.HTTPRedirect, cherrypy.HTTPError)
-        try:
-            inst.set_response()
@@ -520 +514 @@
-    return body
-
-def checkStatus():
-    """Test/set cherrypy.response.status. Provide Reason-phrase if missing."""
-    if not cherrypy.response.status:
-        cherrypy.response.status = "200 OK"
-    else:
-        status = str(cherrypy.response.status)
-        parts = status.split(" ", 1)
-        if len(parts) == 1:
-            # No reason supplied.
-            code, = parts
-            reason = None
-        else:
-            code, reason = parts
-            reason = reason.strip()
-        
-        try:
-            code = int(code)
-            assert code >= 100 and code < 600
-        except (ValueError, AssertionError):
-            code = 500
-            reason = None
-        
-        if reason is None:
-            try:
-                reason = _cputil.responseCodes[code][0]
-            except (KeyError, IndexError):
-                reason = ""
-        
-        cherrypy.response.status = "%s %s" % (code, reason)
-    return cherrypy.response.status
-
-
-general_header_fields = ["Cache-Control", "Connection", "Date", "Pragma",
@@ -580 +543 @@
-    """Transform headerMap (and cookies) into cherrypy.response.headers."""
-    
-    checkStatus()
-    
-    response = cherrypy.response
+    
+    code, reason, _ = cptools.validStatus(response.status)
+    response.status = "%s %s" % (code, reason)
+    
-    if response.body is None:
-        response.body = []

trunk/cherrypy/_cputil.py

@@ -34 +34 @@
-import traceback
-import time
-#import os.path
-
-from BaseHTTPServer import BaseHTTPRequestHandler
-responseCodes = BaseHTTPRequestHandler.responses
-
-import cherrypy
+from cherrypy.lib import cptools
+
-
-class EmptyClass:
@@ -153 +151 @@
-        f.close()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-def formatExc(exc=None):
-
+ if None
-    if exc is None:
-        exc = sys.exc_info()
-
+
-    if exc == (None, None, None):
-        return ""
@@ -211 +216 @@
-def _cpOnError():
-    """ Default _cpOnError method """
-
-
-
-
-
-
-
-
-
-
-
+
-
-_cpFilterList = []

trunk/cherrypy/lib/cptools.py

@@ -28 +28 @@
-
-"""
-
+
-"""
+
+from BaseHTTPServer import BaseHTTPRequestHandler
+responseCodes = BaseHTTPRequestHandler.responses
-
-import inspect
@@ -41 +44 @@
-import sys
-import time
+
+
-import cherrypy
-
@@ -327 +332 @@
-        chunk = input.read(chunkSize)
-    input.close()
+
+def validStatus(status):
+    """Return legal HTTP status Code, Reason-phrase and Message.
+    
+    The status arg must be an int, or a str that begins with an int.
+    
+    If status is an int, or a str and  no reason-phrase is supplied,
+    a default reason-phrase will be provided.
+    """
+    
+    if not status:
+        status = 200
+    
+    status = str(status)
+    parts = status.split(" ", 1)
+    if len(parts) == 1:
+        # No reason supplied.
+        code, = parts
+        reason = None
+    else:
+        code, reason = parts
+        reason = reason.strip()
+    
+    try:
+        code = int(code)
+    except ValueError:
+        raise cherrypy.HTTPError(500, "Illegal response status from server (non-numeric).")
+    
+    if code < 100 or code > 599:
+        raise cherrypy.HTTPError(500, "Illegal response status from server (out of range).")
+    
+    if code not in responseCodes:
+        # code is unknown but not illegal
+        defaultReason, message = "", ""
+    else:
+        defaultReason, message = responseCodes[code]
+    
+    if reason is None:
+        reason = defaultReason
+    
+    return code, reason, message

trunk/cherrypy/test/helper.py

@@ -150 +150 @@
-        else:
-            webtest.WebCase.getPage(self, url, headers, method, body)
-
-errorCode, pattern = 
+   
+status, message=None, pattern=
-        """ Compare the response body with a built in error page.
-            The function will optionally look for the regexp pattern, 
-            within the exception embedded in the error page.
-        """
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        else:
-
-
-
+
+
+
+
-
-CPTestLoader = webtest.ReloadingTestLoader()

trunk/cherrypy/test/test_core.py

@@ -295 +295 @@
-    '/error/page_streamed': {
-        'streamResponse': True,
+    },
+    '/error/cause_err_in_finalize': {
+        'server.showTracebacks': False,
-    },
-})
@@ -364 +367 @@
-        
-        self.getPage("/status/illegal")
-        self.assertBody('oops' + (" " * 509))
-        self.assertStatus('500 Internal error')
+        msg = "Illegal response status from server (out of range)."
+        self.assertErrorPage(500, msg)
-        
-        self.getPage("/status/unknown")
@@ -372 +376 @@
-        
-        self.getPage("/status/bad")
-        self.assertBody('hello' + (" " * 508))
-        self.assertStatus('500 Internal error')
+        msg = "Illegal response status from server (non-numeric)."
+        self.assertErrorPage(500, msg)
-    
-    def testLogging(self):
@@ -499 +504 @@
-        self.getPage("/error/missing")
-        self.assertStatus("404 Not Found")
-
+, "The path '/error/missing' was not found."
-        
-        ignore = helper.webtest.ignored_exceptions
@@ -506 +511 @@
-            valerr = r'\n    raise ValueError\(\)\nValueError\n'
-            self.getPage("/error/page_method")
-
+pattern=
-            
-            self.getPage("/error/page_yield")
-
+pattern=
-            
-            import cherrypy
@@ -523 +528 @@
-                self.assertBody("helloUnrecoverable error in the server.")
-            
+            # No traceback should be present
-            self.getPage("/error/cause_err_in_finalize")
-# We're in 'production' mode, so body should be empty
-Body(""
+msg = "Illegal response status from server (non-numeric)."
+ErrorPage(500, msg, None
-        finally:
-            ignore.pop()

trunk/cherrypy/test/test_gzip_filter.py

@@ -81 +81 @@
-            self.assertNoHeader('Content-Encoding')
-            self.assertStatus('500 Internal error')
-
+pattern=
-            
-            # In this case, there's nothing we can do to deliver a