Package wsgitools :: Module filters :: Class GzipWSGIFilter
[hide private]
[frames] | no frames]

Class GzipWSGIFilter

source code


Compresses content using gzip.

Instance Methods [hide private]
 
__init__(self, flush=True)
This constructor does nothing and can safely be overwritten.
source code
{str: str}
filter_environ(self, environ)
BaseWSGIFilter interface
source code
(str, str) or None
filter_header(self, headername, headervalue)
BaseWSGIFilter interface
source code
[(str, str)]
filter_headers(self, headers)
BaseWSGIFilter interface
source code
str
filter_data(self, data)
BaseWSGIFilter interface
source code
[str]
append_data(self)
BaseWSGIFilter interface
source code

Inherited from BaseWSGIFilter: filter_exc_info, filter_status, handle_close

Class Methods [hide private]
 
creator(cls, flush=True)
Returns a function creating GzipWSGIFilters.
source code
Method Details [hide private]

creator(cls, flush=True)
Class Method

source code 

Returns a function creating GzipWSGIFilters.

Parameters:
  • flush (bool) - whether or not the filter should always flush the buffer

__init__(self, flush=True)
(Constructor)

source code 

This constructor does nothing and can safely be overwritten. It is only listed here to document that it must be callable without additional parameters.

Parameters:
  • flush (bool) - when true does not pump data necessarily immediately but accumulate to get a better compression ratio
Overrides: BaseWSGIFilter.__init__

filter_environ(self, environ)

source code 

BaseWSGIFilter interface

Parameters:
  • environ ({str: str})
Returns: {str: str}
Overrides: BaseWSGIFilter.filter_environ

filter_header(self, headername, headervalue)

source code 

BaseWSGIFilter interface

Parameters:
  • headername (str)
  • headervalue (str)
Returns: (str, str) or None
Overrides: BaseWSGIFilter.filter_header

filter_headers(self, headers)

source code 

BaseWSGIFilter interface

Parameters:
  • headers ([(str, str)])
Returns: [(str, str)]
Overrides: BaseWSGIFilter.filter_headers

filter_data(self, data)

source code 

BaseWSGIFilter interface

Parameters:
  • data (str)
Returns: str
Overrides: BaseWSGIFilter.filter_data

append_data(self)

source code 

BaseWSGIFilter interface

Returns: [str]
Overrides: BaseWSGIFilter.append_data