Docs for response.stream

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

Description


        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)

Attributes


response.stream.__call__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__call__(...) <==> x(...)

response.stream.__class__	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> instancemethod(function, instance, class) Create an instance method object.

response.stream.__cmp__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__cmp__(y) <==> cmp(x,y)

response.stream.__delattr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__delattr__('name') <==> del x.name

response.stream.__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.stream.__format__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> default object formatter

response.stream.__func__	<type 'function'> belongs to class <type 'function'> 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.stream.__get__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> descr.__get__(obj[, type]) -> value

response.stream.__getattribute__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__getattribute__('name') <==> x.name

response.stream.__hash__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__hash__() <==> hash(x)

response.stream.__init__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__init__(...) initializes x; see help(type(x)) for signature

response.stream.__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.stream.__reduce__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> helper for pickle

response.stream.__reduce_ex__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> helper for pickle

response.stream.__repr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__repr__() <==> repr(x)

response.stream.__self__	<class 'gluon.globals.Response'> belongs to class <class 'gluon.globals.Response'> Defines the response object and the default values of its members response.write( ) can be used to write in the output html

response.stream.__setattr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__setattr__('name', value) <==> x.name = value

response.stream.__sizeof__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> __sizeof__() -> int size of object in memory, in bytes

response.stream.__str__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__str__() <==> str(x)

response.stream.__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.stream.im_class	<type 'type'> extends (<class 'gluon.storage.Storage'>,) belongs to class <type 'type'> Defines the response object and the default values of its members response.write( ) can be used to write in the output html

response.stream.im_func	<type 'function'> belongs to class <type 'function'> 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.stream.im_self	<class 'gluon.globals.Response'> belongs to class <class 'gluon.globals.Response'> Defines the response object and the default values of its members response.write( ) can be used to write in the output html