cherrypy._cprequest

150 """An HTTP request. 151 152 This object represents the metadata of an HTTP request message; 153 that is, it contains attributes which describe the environment 154 in which the request URL, headers, and body were sent (if you 155 want tools to interpret the headers and body, those are elsewhere, 156 mostly in Tools). This 'metadata' consists of socket data, 157 transport characteristics, and the Request-Line. This object 158 also contains data regarding the configuration in effect for 159 the given URL, and the execution plan for generating a response. 160 """ 161 162 __metaclass__ = cherrypy._AttributeDocstrings 163 164 prev = None 165 prev__doc = """ 166 The previous Request object (if any). This should be None 167 unless we are processing an InternalRedirect.""" 168 169 # Conversation/connection attributes 170 local = http.Host("localhost", 80) 171 local__doc = \ 172 "An http.Host(ip, port, hostname) object for the server socket." 173 174 remote = http.Host("localhost", 1111) 175 remote__doc = \ 176 "An http.Host(ip, port, hostname) object for the client socket." 177 178 scheme = "http" 179 scheme__doc = """ 180 The protocol used between client and server. In most cases, 181 this will be either 'http' or 'https'.""" 182 183 server_protocol = "HTTP/1.1" 184 server_protocol__doc = """ 185 The HTTP version for which the HTTP server is at least 186 conditionally compliant.""" 187 188 base = "" 189 base__doc = """The (scheme://host) portion of the requested URL.""" 190 191 # Request-Line attributes 192 request_line = "" 193 request_line__doc = """ 194 The complete Request-Line received from the client. This is a 195 single string consisting of the request method, URI, and protocol 196 version (joined by spaces). Any final CRLF is removed.""" 197 198 method = "GET" 199 method__doc = """ 200 Indicates the HTTP method to be performed on the resource identified 201 by the Request-URI. Common methods include GET, HEAD, POST, PUT, and 202 DELETE. CherryPy allows any extension method; however, various HTTP 203 servers and gateways may restrict the set of allowable methods. 204 CherryPy applications SHOULD restrict the set (on a per-URI basis).""" 205 206 query_string = "" 207 query_string__doc = """ 208 The query component of the Request-URI, a string of information to be 209 interpreted by the resource. The query portion of a URI follows the 210 path component, and is separated by a '?'. For example, the URI 211 'http://www.cherrypy.org/wiki?a=3&b=4' has the query component, 212 'a=3&b=4'.""" 213 214 protocol = (1, 1) 215 protocol__doc = """The HTTP protocol version corresponding to the set 216 of features which should be allowed in the response. If BOTH 217 the client's request message AND the server's level of HTTP 218 compliance is HTTP/1.1, this attribute will be the tuple (1, 1). 219 If either is 1.0, this attribute will be the tuple (1, 0). 220 Lower HTTP protocol versions are not explicitly supported.""" 221 222 params = {} 223 params__doc = """ 224 A dict which combines query string (GET) and request entity (POST) 225 variables. This is populated in two stages: GET params are added 226 before the 'on_start_resource' hook, and POST params are added 227 between the 'before_request_body' and 'before_handler' hooks.""" 228 229 # Message attributes 230 header_list = [] 231 header_list__doc = """ 232 A list of the HTTP request headers as (name, value) tuples. 233 In general, you should use request.headers (a dict) instead.""" 234 235 headers = http.HeaderMap() 236 headers__doc = """ 237 A dict-like object containing the request headers. Keys are header 238 names (in Title-Case format); however, you may get and set them in 239 a case-insensitive manner. That is, headers['Content-Type'] and 240 headers['content-type'] refer to the same value. Values are header 241 values (decoded according to RFC 2047 if necessary). See also: 242 http.HeaderMap, http.HeaderElement.""" 243 244 cookie = Cookie.SimpleCookie() 245 cookie__doc = """See help(Cookie).""" 246 247 rfile = None 248 rfile__doc = """ 249 If the request included an entity (body), it will be available 250 as a stream in this attribute. However, the rfile will normally 251 be read for you between the 'before_request_body' hook and the 252 'before_handler' hook, and the resulting string is placed into 253 either request.params or the request.body attribute. 254 255 You may disable the automatic consumption of the rfile by setting 256 request.process_request_body to False, either in config for the desired 257 path, or in an 'on_start_resource' or 'before_request_body' hook. 258 259 WARNING: In almost every case, you should not attempt to read from the 260 rfile stream after CherryPy's automatic mechanism has read it. If you 261 turn off the automatic parsing of rfile, you should read exactly the 262 number of bytes specified in request.headers['Content-Length']. 263 Ignoring either of these warnings may result in a hung request thread 264 or in corruption of the next (pipelined) request. 265 """ 266 267 process_request_body = True 268 process_request_body__doc = """ 269 If True, the rfile (if any) is automatically read and parsed, 270 and the result placed into request.params or request.body.""" 271 272 methods_with_bodies = ("POST", "PUT") 273 methods_with_bodies__doc = """ 274 A sequence of HTTP methods for which CherryPy will automatically 275 attempt to read a body from the rfile.""" 276 277 body = None 278 body__doc = """ 279 If the request Content-Type is 'application/x-www-form-urlencoded' 280 or multipart, this will be None. Otherwise, this will contain the 281 request entity body as a string; this value is set between the 282 'before_request_body' and 'before_handler' hooks (assuming that 283 process_request_body is True).""" 284 285 # Dispatch attributes 286 dispatch = cherrypy.dispatch.Dispatcher() 287 dispatch__doc = """ 288 The object which looks up the 'page handler' callable and collects 289 config for the current request based on the path_info, other 290 request attributes, and the application architecture. The core 291 calls the dispatcher as early as possible, passing it a 'path_info' 292 argument. 293 294 The default dispatcher discovers the page handler by matching path_info 295 to a hierarchical arrangement of objects, starting at request.app.root. 296 See help(cherrypy.dispatch) for more information.""" 297 298 script_name = "" 299 script_name__doc = """ 300 The 'mount point' of the application which is handling this request.""" 301 302 path_info = "/" 303 path_info__doc = """ 304 The 'relative path' portion of the Request-URI. This is relative 305 to the script_name ('mount point') of the application which is 306 handling this request.""" 307 308 login = None 309 login__doc = """ 310 When authentication is used during the request processing this is 311 set to 'False' if it failed and to the 'username' value if it succeeded. 312 The default 'None' implies that no authentication happened.""" 313 314 app = None 315 app__doc = \ 316 """The cherrypy.Application object which is handling this request.""" 317 318 handler = None 319 handler__doc = """ 320 The function, method, or other callable which CherryPy will call to 321 produce the response. The discovery of the handler and the arguments 322 it will receive are determined by the request.dispatch object. 323 By default, the handler is discovered by walking a tree of objects 324 starting at request.app.root, and is then passed all HTTP params 325 (from the query string and POST body) as keyword arguments.""" 326 327 toolmaps = {} 328 toolmaps__doc = """ 329 A nested dict of all Toolboxes and Tools in effect for this request, 330 of the form: {Toolbox.namespace: {Tool.name: config dict}}.""" 331 332 config = None 333 config__doc = """ 334 A flat dict of all configuration entries which apply to the 335 current request. These entries are collected from global config, 336 application config (based on request.path_info), and from handler 337 config (exactly how is governed by the request.dispatch object in 338 effect for this request; by default, handler config can be attached 339 anywhere in the tree between request.app.root and the final handler, 340 and inherits downward).""" 341 342 is_index = None 343 is_index__doc = """ 344 This will be True if the current request is mapped to an 'index' 345 resource handler (also, a 'default' handler if path_info ends with 346 a slash). The value may be used to automatically redirect the 347 user-agent to a 'more canonical' URL which either adds or removes 348 the trailing slash. See cherrypy.tools.trailing_slash.""" 349 350 hooks = HookMap(hookpoints) 351 hooks__doc = """ 352 A HookMap (dict-like object) of the form: {hookpoint: [hook, ...]}. 353 Each key is a str naming the hook point, and each value is a list 354 of hooks which will be called at that hook point during this request. 355 The list of hooks is generally populated as early as possible (mostly 356 from Tools specified in config), but may be extended at any time. 357 See also: _cprequest.Hook, _cprequest.HookMap, and cherrypy.tools.""" 358 359 error_response = cherrypy.HTTPError(500).set_response 360 error_response__doc = """ 361 The no-arg callable which will handle unexpected, untrapped errors 362 during request processing. This is not used for expected exceptions 363 (like NotFound, HTTPError, or HTTPRedirect) which are raised in 364 response to expected conditions (those should be customized either 365 via request.error_page or by overriding HTTPError.set_response). 366 By default, error_response uses HTTPError(500) to return a generic 367 error response to the user-agent.""" 368 369 error_page = {} 370 error_page__doc = """ 371 A dict of {error code: response filename} pairs. The named response 372 files should be Python string-formatting templates, and can expect by 373 default to receive the format values with the mapping keys 'status', 374 'message', 'traceback', and 'version'. The set of format mappings 375 can be extended by overriding HTTPError.set_response.""" 376 377 show_tracebacks = True 378 show_tracebacks__doc = """ 379 If True, unexpected errors encountered during request processing will 380 include a traceback in the response body.""" 381 382 throws = (KeyboardInterrupt, SystemExit, cherrypy.InternalRedirect) 383 throws__doc = \ 384 """The sequence of exceptions which Request.run does not trap.""" 385 386 throw_errors = False 387 throw_errors__doc = """ 388 If True, Request.run will not trap any errors (except HTTPRedirect and 389 HTTPError, which are more properly called 'exceptions', not errors).""" 390 391 namespaces = _cpconfig.NamespaceSet( 392 **{"hooks": hooks_namespace, 393 "request": request_namespace, 394 "response": response_namespace, 395 "error_page": error_page_namespace, 396 # "tools": See _cptools.Toolbox 397 }) 398

399 - def __init__(self, local_host, remote_host, scheme="http", 400 server_protocol="HTTP/1.1"):

401 """Populate a new Request object. 402 403 local_host should be an http.Host object with the server info. 404 remote_host should be an http.Host object with the client info. 405 scheme should be a string, either "http" or "https". 406 """ 407 self.local = local_host 408 self.remote = remote_host 409 self.scheme = scheme 410 self.server_protocol = server_protocol 411 412 self.closed = False 413 414 # Put a *copy* of the class error_page into self. 415 self.error_page = self.error_page.copy() 416 417 # Put a *copy* of the class namespaces into self. 418 self.namespaces = self.namespaces.copy()

419

420 - def close(self):

421 """Run cleanup code and remove self from globals. (Core)""" 422 if not self.closed:

Source Code for Module cherrypy._cprequest