Skip to content

Commit 06afe9f

Browse files
committed
Document compression
1 parent 1493976 commit 06afe9f

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/web_reference.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,29 @@ first positional parameter.
140140

141141
.. versionadded:: 0.15
142142

143+
.. attribute:: compression
144+
145+
Read-only :class:`bool` property, ``True`` if compression is enabled.
146+
147+
``False`` by default.
148+
149+
.. versionadded:: 0.14
150+
151+
.. seealso:: :meth:`enable_compression`
152+
153+
.. method:: enable_compression(force=False)
154+
155+
Enable compression.
156+
157+
When *force* is ``False`` (default) compression is used only
158+
when *deflate* is in *Accept-Encoding* request's header.
159+
160+
*Accept-Encoding* is not checked if *force* is ``True``.
161+
162+
.. versionadded:: 0.14
163+
164+
.. seealso:: :attr:`compression`
165+
143166
.. attribute:: payload
144167

145168
A :class:`~aiohttp.streams.FlowControlStreamReader` instance,

0 commit comments

Comments
 (0)