iter_lines() — requests Function Reference

Architecture documentation for the iter_lines() function in models.py from the requests codebase.

Function python CoreAPI SessionLifecycle calls 1

Entity Profile

CoreAPI→ SessionLifecycle→ iter_lines() — requests Function Reference

Dependency Diagram

graph TD
  6ee47ade_e2ec_47c7_716f_07feb21308f7["iter_lines()"]
  eb32847e_3797_d01a_6e44_345e9ea7e251["Response"]
  6ee47ade_e2ec_47c7_716f_07feb21308f7 -->|defined in| eb32847e_3797_d01a_6e44_345e9ea7e251
  1d84ce86_28dc_c5f4_e8af_24874e68169e["iter_content()"]
  6ee47ade_e2ec_47c7_716f_07feb21308f7 -->|calls| 1d84ce86_28dc_c5f4_e8af_24874e68169e
  style 6ee47ade_e2ec_47c7_716f_07feb21308f7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/requests/models.py lines 859–890

    def iter_lines(
        self, chunk_size=ITER_CHUNK_SIZE, decode_unicode=False, delimiter=None
    ):
        """Iterates over the response data, one line at a time.  When
        stream=True is set on the request, this avoids reading the
        content at once into memory for large responses.

        .. note:: This method is not reentrant safe.
        """

        pending = None

        for chunk in self.iter_content(
            chunk_size=chunk_size, decode_unicode=decode_unicode
        ):
            if pending is not None:
                chunk = pending + chunk

            if delimiter:
                lines = chunk.split(delimiter)
            else:
                lines = chunk.splitlines()

            if lines and lines[-1] and chunk and lines[-1][-1] == chunk[-1]:
                pending = lines.pop()
            else:
                pending = None

            yield from lines

        if pending is not None:
            yield pending