3
�P\� � @ sd d Z ddlZddlZddlZddlmZ dZej deef �Z
dZ dd � Z d
d � Z
de fd d
�ZdS )z-Utilities for dealing with streamed requests.� N� )�
exceptionsz"[^"\\]*(?:\\.[^"\\]*)*"z*;\s*(%s|[^\s;=]+)\s*(?:=\s*(%s|[^;]+))?\s*i c C s< x6t j| �D ](}|j� \}}|dkr tjj|�d S q W d S )N�filename� )�_OPTION_HEADER_PIECE_RE�finditer�groups�os�path�split)Zcontent_disposition�match�k�v� r � /usr/lib/python3.6/stream.py�
_get_filename s
r c C s\ |ot jj|�}|r | r |}n8t| jjdd��}|s@tjd��|rTt jj||�}n|}|S )a�
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`
zcontent-disposition� z'No filename given to stream response to) r r
�isdirr Zheaders�get�exc�StreamingError�join)�responser
Z path_is_dir�filepathZresponse_filenamer r r �get_download_file_path s
r c C s� d}d}d}|r:t t|dd�tj�r:d}|}t|dd�}n.t| |�}tjj|�r^tj d| ��t
|d�}x | j |d�D ]}|j |� qvW |s�|j
� |S ) a7 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`
FN�writeT�namezFile already exists: %s�wb)Z
chunk_size)�
isinstance�getattr� collections�Callabler r r
�existsr r �openZ iter_contentr �close)r r
Z chunksizeZ
pre_opened�fdr �chunkr r r �stream_response_to_fileG s W
r' )�__doc__r Zos.pathr �rer r r Z_QUOTED_STRING_RE�compiler Z_DEFAULT_CHUNKSIZEr r r' r r r r �<module> s
+