]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
add `[chunk_size]` for `a?iter_.*` methods (#2281)
authorDaniel Holth <dholth@anaconda.com>
Fri, 24 Jun 2022 13:36:45 +0000 (09:36 -0400)
committerGitHub <noreply@github.com>
Fri, 24 Jun 2022 13:36:45 +0000 (14:36 +0100)
```
    def iter_bytes(
        self, chunk_size: typing.Optional[int] = None
    ) -> typing.Iterator[bytes]:
```

docs/api.md

index c644f8a3116e8e001f793f1847eaf74d8da096c8..3f806b6f296bbe469b429757a3f5ee45afa948d1 100644 (file)
 * `def .raise_for_status()` - **None**
 * `def .json()` - **Any**
 * `def .read()` - **bytes**
-* `def .iter_raw()` - **bytes iterator**
-* `def .iter_bytes()` - **bytes iterator**
-* `def .iter_text()` - **text iterator**
-* `def .iter_lines()` - **text iterator**
+* `def .iter_raw([chunk_size])` - **bytes iterator**
+* `def .iter_bytes([chunk_size])` - **bytes iterator**
+* `def .iter_text([chunk_size])` - **text iterator**
+* `def .iter_lines([chunk_size])` - **text iterator**
 * `def .close()` - **None**
 * `def .next()` - **Response**
 * `def .aread()` - **bytes**
-* `def .aiter_raw()` - **async bytes iterator**
-* `def .aiter_bytes()` - **async bytes iterator**
-* `def .aiter_text()` - **async text iterator**
-* `def .aiter_lines()` - **async text iterator**
+* `def .aiter_raw([chunk_size])` - **async bytes iterator**
+* `def .aiter_bytes([chunk_size])` - **async bytes iterator**
+* `def .aiter_text([chunk_size])` - **async text iterator**
+* `def .aiter_lines([chunk_size])` - **async text iterator**
 * `def .aclose()` - **None**
 * `def .anext()` - **Response**