1 #!/usr/bin/python2.5

     2 #

     3 # Copyright 2008 the Melange authors.

     4 #

     5 # Licensed under the Apache License, Version 2.0 (the "License");

     6 # you may not use this file except in compliance with the License.

     7 # You may obtain a copy of the License at

     8 #

     9 #   http://www.apache.org/licenses/LICENSE-2.0

    10 #

    11 # Unless required by applicable law or agreed to in writing, software

    12 # distributed under the License is distributed on an "AS IS" BASIS,

    13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    14 # See the License for the specific language governing permissions and

    15 # limitations under the License.

    16 

    17 """Out-of-band responses to render instead of the usual HTTP response.

    18 """

    19 

    20 __authors__ = [

    21   '"Todd Larsen" <tlarsen@google.com>',

    22   ]

    23 

    24 

    25 class OutOfBandResponse(Exception):

    26   """Base exception for out-of-band responses raised by controller logic.

    27   """

    28   pass

    29 

    30 

    31 class ErrorResponse(OutOfBandResponse):

    32   """Out-of-band response when controller logic needs a special error page.

    33   """

    34 

    35   def __init__(self, message, **response_args):

    36     """Constructor used to set error message and HTTP response arguments.

    37   

    38     Args:

    39       message: error message to display on the error page

    40       **response_args: keyword arguments that are supplied directly to

    41         django.http.HttpResponse; the most commonly used is 'status' to

    42         set the HTTP status code for the response

    43     """

    44     self.message = message

    45     self.response_args = response_args

    46