[ Pobierz całość w formacie PDF ]
.A closing iterator is not needed if the application uses response objects and fin-ishes the processing if the response is started:try:return response(environ, start_response)finally:cleanup_session()cleanup_locals()classwerkzeug.wsgi.FileWrapper(file, buffer_size=8192)This class can be used to convert afile-like object into an iterable.It yieldsbuffer_size blocks until the file is fully read.You should not use this class directly but rather use thewrap_file()functionthat uses the WSGI server s file wrapper support if it s available.New in version0.5.If you re using this object together with aBaseResponseyou have to use thedirect_passthrough mode.89 Parameters" file afile-like object with aread()method." buffer_size number of bytes for one iteration.classwerkzeug.wsgi.LimitedStream(stream, limit)Wraps a stream so that it doesn t read more than n bytes.If the stream is ex-hausted and the caller tries to get more bytes from iton_exhausted()is calledwhich by default returns an empty string.The return value of that function isforwarded to the reader function.So if it returns an empty stringread()willreturn an empty string as well.The limit however must never be higher than what the stream can output.Oth-erwisereadlines()will try to read past the limit.Note on WSGI compliancecalls toreadline()andreadlines()are not WSGI compliant because it passes asize argument to the readline methods.Unfortunately the WSGI PEP is not safelyimplementable without a size argument toreadline()because there is no EOFmarker in the stream.As a result of that the use ofreadline()is discouraged.For the same reason iterating over theLimitedStreamis not portable.It internallycallsreadline().We strongly suggest usingread()only or using themake_line_iter()whichsafely iterates line-based over a WSGI input stream.Parameters" stream the stream to wrap." limit the limit for the stream, must not be longer than whatthe string can provide if the stream does not end with EOF (likewsgi.input)exhaust(chunk_size=65536)Exhaust the stream.This consumes all the data left until the limit is reached.Parameters chunk_size the size for a chunk.It will read thechunk until the stream is exhausted and throw away the results.is_exhaustedIf the stream is exhausted this attribute is True.on_disconnect()What should happen if a disconnect is detected? The return value of thisfunction is returned from read functions in case the client went away.Bydefault aClientDisconnectedexception is raised.on_exhausted()This is called when the stream tries to read past the limit.The return value90 of this function is returned from the reading function.read(size=None)Read size bytes or if size is not provided everything is read.Parameters size the number of bytes read.readline(size=None)Reads one line from the stream.readlines(size=None)Reads a file into a list of strings.It callsreadline()until the file is readto the end.It does support the optional size argument if the underlayingstream supports it for readline.tell()Returns the position of the stream.New in version 0.9.werkzeug.wsgi.make_line_iter(stream, limit=None, buffer_size=10240)Safely iterates line-based over an input stream.If the input stream is not aLimitedStreamthe limit parameter is mandatory.This uses the stream sread()method internally as opposite to thereadline()method that is unsafe and can only be used in violation of the WSGI specification.The same problem applies to the __iter__ function of the input stream which callsreadline()without arguments.If you need line-by-line processing it s strongly recommended to iterate over theinput stream using this helper function.Changed in version 0.8: This functionnow ensures that the limit was reached.New in version 0.9: added support foriterators as input stream.Parameters" stream the stream or iterate to iterate over." limit the limit in bytes for the stream.(Usually contentlength.Not necessary if the stream is aLimitedStream." buffer_size The optional buffer size.werkzeug.wsgi.make_chunk_iter(stream, separator, limit=None,buffer_size=10240)Works likemake_line_iter()but accepts a separator which divides chunks.Ifyou want newline based processing you should usemake_line_iter()insteadas it supports arbitrary newline markers.New in version 0.8.New in version 0.9:added support for iterators as input stream.Parameters" stream the stream or iterate to iterate over." separator the separator that divides chunks." limit the limit in bytes for the stream.(Usually contentlength.Not necessary if the stream is otherwise already lim-ited).91 " buffer_size The optional buffer size.werkzeug.wsgi.wrap_file(environ, file, buffer_size=8192)Wraps a file.This uses the WSGI server s file wrapper if available or otherwisethe genericFileWrapper.New in version 0.5.If the file wrapper from the WSGIserver is used it s important to not iterate over it from inside the application butto pass it through unchanged.If you want to pass out a file wrapper inside aresponse object you have to setdirect_passthroughto True.More information about file wrappers are available in PEP 333.Parameters" file afile-like object with aread()method
[ Pobierz całość w formacie PDF ]