Skip to content

Commit

Permalink
Remove request_class, response_class, ws_response_class from document…
Browse files Browse the repository at this point in the history
…ation.

These parameters are still supported but may be changed without any notification/deprecation
  • Loading branch information
asvetlov committed Aug 25, 2016
1 parent d8848dd commit 83ed397
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 33 deletions.
35 changes: 2 additions & 33 deletions docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@ The client session supports the context manager protocol for self closing.

.. class:: ClientSession(*, connector=None, loop=None, cookies=None, \
headers=None, skip_auto_headers=None, \
auth=None, request_class=ClientRequest, \
response_class=ClientResponse, \
ws_response_class=ClientWebSocketResponse, \
auth=None, \
version=aiohttp.HttpVersion11, \
cookie_jar=None)

Expand Down Expand Up @@ -88,18 +86,6 @@ The client session supports the context manager protocol for self closing.
:param aiohttp.BasicAuth auth: an object that represents HTTP Basic
Authorization (optional)

:param request_class: Request class implementation. ``ClientRequest`` by
default.

:param response_class: Response class
implementation. :class:`ClientResponse` by
default.

:param ws_response_class: WebSocketResponse class implementation.
``ClientWebSocketResponse`` by default.

.. versionadded:: 0.16

:param version: supported HTTP version, ``HTTP 1.1`` by default.

.. versionadded:: 0.21
Expand All @@ -115,12 +101,6 @@ The client session supports the context manager protocol for self closing.

.. versionadded:: 0.22

.. versionchanged:: 0.16
*request_class* default changed from ``None`` to ``ClientRequest``

.. versionchanged:: 0.16
*response_class* default changed from ``None`` to :class:`ClientResponse`

.. attribute:: closed

``True`` if the session has been closed, ``False`` otherwise.
Expand Down Expand Up @@ -440,8 +420,7 @@ certification chaining.
version=HttpVersion(major=1, minor=1), \
compress=None, chunked=None, expect100=False, \
connector=None, loop=None,\
read_until_eof=True, request_class=None,\
response_class=None)
read_until_eof=True)

Perform an asynchronous HTTP request. Return a response object
(:class:`ClientResponse` or derived from).
Expand Down Expand Up @@ -489,10 +468,6 @@ certification chaining.
does not have Content-Length header.
``True`` by default (optional).

:param request_class: Custom Request class implementation (optional)

:param response_class: Custom Response class implementation (optional)

:param loop: :ref:`event loop<asyncio-event-loop>`
used for processing HTTP requests.
If param is ``None``, :func:`asyncio.get_event_loop`
Expand Down Expand Up @@ -624,7 +599,6 @@ Usage::

.. coroutinefunction:: ws_connect(url, *, protocols=(), \
timeout=10.0, connector=None, auth=None,\
ws_response_class=ClientWebSocketResponse,\
autoclose=True, autoping=True, loop=None,\
origin=None, headers=None)

Expand All @@ -640,11 +614,6 @@ Usage::

:param obj connector: object :class:`TCPConnector`

:param ws_response_class: WebSocketResponse class implementation.
``ClientWebSocketResponse`` by default.

.. versionadded:: 0.16

:param bool autoclose: Automatically close websocket connection
on close message from server. If `autoclose` is
False them close procedure has to be handled manually
Expand Down
33 changes: 33 additions & 0 deletions docs/streams.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. module:: aiohttp.streams

.. _aiohttp-streams:

Streaming API
=============


``aiohttp`` uses streams for retrieving *BODIES*:
:attr:`aiohttp.web.Request.content` and
:attr:`aiohttp.ClientResponse.content` are streams.


StreamReader
------------

.. class:: StreamReader

.. comethod:: read(n=-1)

.. comethod:: readany()

.. comethod:: readexactly(n)

.. comethod:: readline()

.. method:: read_nowait(n=None)

.. comethod:: iter_chunked(n)
:async-for:

.. comethod:: iter_any(n)
:async-for:

0 comments on commit 83ed397

Please sign in to comment.