File: //lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.pyc
ó
Óµ Yc @ s„ d Z d d l Z d d l Z d d l Z d d l m Z d Z e j d e e f ƒ Z
d Z d „ Z d „ Z
d e d
„ Z d S( s- Utilities for dealing with streamed requests.iÿÿÿÿNi ( t
exceptionss "[^"\\]*(?:\\.[^"\\]*)*"s* ;\s*(%s|[^\s;=]+)\s*(?:=\s*(%s|[^;]+))?\s*i c C sP xI t j | ƒ D]8 } | j ƒ \ } } | d k r t j j | ƒ d Sq Wd S( Nt filenamei ( t _OPTION_HEADER_PIECE_REt finditert groupst ost patht splitt None( t content_dispositiont matcht kt v( ( sJ /usr/lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.pyt
_get_filename s
c C s‰ | o t j j | ƒ } | r. | r. | } nW t | j j d d ƒ ƒ } | sa t j d ƒ ‚ n | r t j j | | ƒ } n | } | S( sõ
Given a response and a path, return a file path for a download.
If a ``path`` parameter is a directory, this function will parse the
``Content-Disposition`` header on the response to determine the name of the
file as reported by the server, and return a file path in the specified
directory.
If ``path`` is empty or None, this function will return a path relative
to the process' current working directory.
If path is a full file path, return it.
:param response: A Response object from requests
:type response: requests.models.Response
:param str path: Directory or file path.
:returns: full file path to download as
:rtype: str
:raises: :class:`requests_toolbelt.exceptions.StreamingError`
s content-dispositiont s' No filename given to stream response to( R R t isdirR
t headerst gett exct StreamingErrort join( t responseR t path_is_dirt filepatht response_filename( ( sJ /usr/lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.pyt get_download_file_path s
c C sÞ t } d } d } | rW t t | d d ƒ t j ƒ rW t } | } t | d d ƒ } nF t | | ƒ } t j j
| ƒ rŽ t j d | ƒ ‚ n t
| d ƒ } x' | j d | ƒ D] } | j | ƒ q° W| sÚ | j ƒ n | S( s7 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 a ``path`` parameter is a directory, this function will parse the
``Content-Disposition`` header on the response to determine the name of the
file as reported by the server, and return a file path in the specified
directory. If no ``path`` parameter is supplied, this function will default
to the process' current working directory.
.. 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')
If the calculated download file path already exists, this function will
raise a StreamingError.
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`
:param int chunksize: (optional), Size of chunk to attempt to stream
(default 512B).
:returns: The name of the file, if one can be determined, else None
:rtype: str
:raises: :class:`requests_toolbelt.exceptions.StreamingError`
t writet names File already exists: %st wbt
chunk_sizeN( t FalseR t
isinstancet getattrt collectionst Callablet TrueR R R t existsR R t opent iter_contentR t close( R R t chunksizet
pre_openedt fdR t chunk( ( sJ /usr/lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.pyt stream_response_to_fileG s W$
( t __doc__R! t os.pathR t reR R R t _QUOTED_STRING_REt compileR t _DEFAULT_CHUNKSIZER
R R R, ( ( ( sJ /usr/lib/python2.7/site-packages/requests_toolbelt/downloadutils/stream.pyt <module> s
+