diff venv/lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.py @ 0:d67268158946 draft

planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b
author bcclaywell
date Mon, 12 Oct 2015 17:43:33 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/venv/lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.py	Mon Oct 12 17:43:33 2015 -0400
@@ -0,0 +1,131 @@
+# -*- coding: utf-8 -*-
+"""Utilities for dealing with streamed requests."""
+import collections
+import re
+
+from .. import exceptions as exc
+
+# Regular expressions stolen from werkzeug/http.py
+# cd2c97bb0a076da2322f11adce0b2731f9193396 L62-L64
+_QUOTED_STRING_RE = r'"[^"\\]*(?:\\.[^"\\]*)*"'
+_OPTION_HEADER_PIECE_RE = re.compile(
+    r';\s*(%s|[^\s;=]+)\s*(?:=\s*(%s|[^;]+))?\s*' % (_QUOTED_STRING_RE,
+                                                     _QUOTED_STRING_RE)
+)
+
+
+def _get_filename(content_disposition):
+    for match in _OPTION_HEADER_PIECE_RE.finditer(content_disposition):
+        k, v = match.groups()
+        if k == 'filename':
+            return v
+    return None
+
+
+def stream_response_to_file(response, path=None):
+    """Stream a response body to the specified file.
+
+    Either use the ``path`` provided or use the name provided in the
+    ``Content-Disposition`` header.
+
+    .. warning::
+
+        If you pass this function an open file-like object as the ``path``
+        parameter, the function will not close that file for you.
+
+    .. warning::
+
+        This function will not automatically close the response object
+        passed in as the ``response`` parameter.
+
+    If no ``path`` parameter is supplied, this function will parse the
+    ``Content-Disposition`` header on the response to determine the name of
+    the file as reported by the server.
+
+    .. code-block:: python
+
+        import requests
+        from requests_toolbelt import exceptions
+        from requests_toolbelt.downloadutils import stream
+
+        r = requests.get(url, stream=True)
+        try:
+            filename = stream.stream_response_to_file(r)
+        except exceptions.StreamingError as e:
+            # The toolbelt could not find the filename in the
+            # Content-Disposition
+            print(e.message)
+
+    You can also specify the filename as a string. This will be passed to
+    the built-in :func:`open` and we will read the content into the file.
+
+    .. code-block:: python
+
+        import requests
+        from requests_toolbelt.downloadutils import stream
+
+        r = requests.get(url, stream=True)
+        filename = stream.stream_response_to_file(r, path='myfile')
+
+    Instead, if you want to manage the file object yourself, you need to
+    provide either a :class:`io.BytesIO` object or a file opened with the
+    `'b'` flag. See the two examples below for more details.
+
+    .. code-block:: python
+
+        import requests
+        from requests_toolbelt.downloadutils import stream
+
+        with open('myfile', 'wb') as fd:
+            r = requests.get(url, stream=True)
+            filename = stream.stream_response_to_file(r, path=fd)
+
+        print('{0} saved to {1}'.format(url, filename))
+
+    .. code-block:: python
+
+        import io
+        import requests
+        from requests_toolbelt.downloadutils import stream
+
+        b = io.BytesIO()
+        r = requests.get(url, stream=True)
+        filename = stream.stream_response_to_file(r, path=b)
+        assert filename is None
+
+
+    :param response: A Response object from requests
+    :type response: requests.models.Response
+    :param path: *(optional)*, Either a string with the path to the location
+        to save the response content, or a file-like object expecting bytes.
+    :type path: :class:`str`, or object with a :meth:`write`
+    :returns: The name of the file, if one can be determined, else None
+    :rtype: str
+    :raises: :class:`requests_toolbelt.exceptions.StreamingError`
+    """
+    pre_opened = False
+    fd = None
+    filename = None
+    if path:
+        if isinstance(getattr(path, 'write', None), collections.Callable):
+            pre_opened = True
+            fd = path
+            filename = getattr(fd, 'name', None)
+        else:
+            fd = open(path, 'wb')
+            filename = path
+    else:
+        filename = _get_filename(response.headers['content-disposition'])
+        if filename is None:
+            raise exc.StreamingError(
+                'No filename given to stream response to.'
+            )
+        fd = open(filename, 'wb')
+
+    for chunk in response.iter_content(chunk_size=512):
+        fd.write(chunk)
+
+    if not pre_opened:
+        fd.close()
+
+    return filename