Docs for response.__class__

[ Python Tutorial ] [ Python Libraries ] [ web2py epydoc ]

Description


<type 'type'> extends (<class 'gluon.storage.Storage'>,)






Defines the response object and the default values of its members
response.write( ) can be used to write in the output html


Attributes


response.__class__.__class__ <type 'type'> extends (<type 'object'>,) belongs to class <type 'type'>
type(object) -> the object's type type(name, bases, dict) -> a new type

response.__class__.__cmp__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__cmp__(y) <==> cmp(x,y)

response.__class__.__contains__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.__contains__(k) -> True if D has a key k, else False

response.__class__.__copy__ <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.__delattr__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__delitem__(y) <==> del x[y]

response.__class__.__delitem__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__delitem__(y) <==> del x[y]

response.__class__.__dict__ <type 'dictproxy'> belongs to class <type 'dictproxy'>

response.__class__.__doc__ <type 'str'> belongs to class <type 'str'>
str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

response.__class__.__eq__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__eq__(y) <==> x==y

response.__class__.__format__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
default object formatter

response.__class__.__ge__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__ge__(y) <==> x>=y

response.__class__.__getattr__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

response.__class__.__getattribute__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__getattribute__('name') <==> x.name

response.__class__.__getitem__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

response.__class__.__getnewargs__ <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.__getstate__ <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.__gt__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__gt__(y) <==> x>y

response.__class__.__hash__ <type 'NoneType'> belongs to class <type 'NoneType'>

response.__class__.__init__ <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.__iter__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__iter__() <==> iter(x)

response.__class__.__le__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__le__(y) <==> x<=y

response.__class__.__len__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__len__() <==> len(x)

response.__class__.__lt__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__lt__(y) <==> x<y

response.__class__.__module__ <type 'str'> belongs to class <type 'str'>
str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

response.__class__.__ne__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__ne__(y) <==> x!=y

response.__class__.__new__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
T.__new__(S, ...) -> a new object with type S, a subtype of T

response.__class__.__reduce__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
helper for pickle

response.__class__.__reduce_ex__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
helper for pickle

response.__class__.__repr__ <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.__setattr__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__setitem__(i, y) <==> x[i]=y

response.__class__.__setitem__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__setitem__(i, y) <==> x[i]=y

response.__class__.__sizeof__ <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.__sizeof__() -> size of D in memory, in bytes

response.__class__.__slots__ <type 'tuple'> belongs to class <type 'tuple'>
tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

response.__class__.__str__ <type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'>
x.__str__() <==> str(x)

response.__class__.__subclasshook__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
Abstract classes can override this to customize issubclass(). This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

response.__class__.__weakref__ <type 'getset_descriptor'> belongs to class <type 'getset_descriptor'>
list of weak references to the object (if defined)

response.__class__.clear <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.clear() -> None. Remove all items from D.

response.__class__.copy <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.copy() -> a shallow copy of D

response.__class__.download <type 'instancemethod'> belongs to class <type 'instancemethod'>
Example of usage in controller:: def download(): return response.download(request, db) Downloads from http://..../download/filename

response.__class__.fromkeys <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

response.__class__.get <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

response.__class__.getfirst <type 'instancemethod'> belongs to class <type 'instancemethod'>
Returns the first value of a list or the value itself when given a `request.vars` style key. If the value is a list, its first item will be returned; otherwise, the value will be returned as-is. Example output for a query string of `?x=abc&y=abc&y=def`:: >>> request = Storage() >>> request.vars = Storage() >>> request.vars.x = 'abc' >>> request.vars.y = ['abc', 'def'] >>> request.vars.getfirst('x') 'abc' >>> request.vars.getfirst('y') 'abc' >>> request.vars.getfirst('z')

response.__class__.getlast <type 'instancemethod'> belongs to class <type 'instancemethod'>
Returns the last value of a list or value itself when given a `request.vars` style key. If the value is a list, the last item will be returned; otherwise, the value will be returned as-is. Simulated output with a query string of `?x=abc&y=abc&y=def`:: >>> request = Storage() >>> request.vars = Storage() >>> request.vars.x = 'abc' >>> request.vars.y = ['abc', 'def'] >>> request.vars.getlast('x') 'abc' >>> request.vars.getlast('y') 'def' >>> request.vars.getlast('z')

response.__class__.getlist <type 'instancemethod'> belongs to class <type 'instancemethod'>
Returns a Storage value as a list. If the value is a list it will be returned as-is. If object is None, an empty list will be returned. Otherwise, `[value]` will be returned. Example output for a query string of `?x=abc&y=abc&y=def`:: >>> request = Storage() >>> request.vars = Storage() >>> request.vars.x = 'abc' >>> request.vars.y = ['abc', 'def'] >>> request.vars.getlist('x') ['abc'] >>> request.vars.getlist('y') ['abc', 'def'] >>> request.vars.getlist('z') []

response.__class__.has_key <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.has_key(k) -> True if D has a key k, else False

response.__class__.include_files <type 'instancemethod'> belongs to class <type 'instancemethod'>
Includes files (usually in the head). Can minify and cache local files By default, caches in ram for 5 minutes. To change, response.cache_includes = (cache_method, time_expire). Example: (cache.disk, 60) # caches to disk for 1 minute.

response.__class__.include_meta <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.items <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.items() -> list of D's (key, value) pairs, as 2-tuples

response.__class__.iteritems <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.iteritems() -> an iterator over the (key, value) items of D

response.__class__.iterkeys <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.iterkeys() -> an iterator over the keys of D

response.__class__.itervalues <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.itervalues() -> an iterator over the values of D

response.__class__.json <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.keys <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.keys() -> list of D's keys

response.__class__.pop <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

response.__class__.popitem <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

response.__class__.render <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.setdefault <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

response.__class__.stream <type 'instancemethod'> belongs to class <type 'instancemethod'>
If in a controller function:: return response.stream(file, 100) the file content will be streamed at 100 bytes at the time Args: stream: filename or read()able content chunk_size(int): Buffer size request: the request object attachment(bool): prepares the correct headers to download the file as an attachment. Usually creates a pop-up download window on browsers filename(str): the name for the attachment Note: for using the stream name (filename) with attachments the option must be explicitly set as function parameter (will default to the last request argument otherwise)

response.__class__.toolbar <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.update <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

response.__class__.values <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.values() -> list of D's values

response.__class__.viewitems <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.viewitems() -> a set-like object providing a view on D's items

response.__class__.viewkeys <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.viewkeys() -> a set-like object providing a view on D's keys

response.__class__.viewvalues <type 'method_descriptor'> belongs to class <type 'method_descriptor'>
D.viewvalues() -> an object providing a view on D's values

response.__class__.write <type 'instancemethod'> belongs to class <type 'instancemethod'>

response.__class__.xmlrpc <type 'instancemethod'> belongs to class <type 'instancemethod'>
assuming:: def add(a, b): return a+b if a controller function "func":: return response.xmlrpc(request, [add]) the controller will be able to handle xmlrpc requests for the add function. Example:: import xmlrpclib connection = xmlrpclib.ServerProxy( 'http://hostname/app/contr/func') print connection.add(3, 4)