download_file#

sunpy.util.net.download_file(url, directory, default='file', overwrite=False)[source]#

Deprecated since version 7.0: The download_file function is deprecated and may be removed in a future version. Use parfive.Downloader.simple_download instead.

Download a file from a url into a directory.

Tries the “Content-Disposition”, if unavailable, extracts name from the URL. If this fails, the default keyword will be used.

Parameters:

url (str) – The file URL download.
directory (str) – The directory path to download the file in to.
default (str, optional) – The name to use if the first two methods fail. Defaults to “file”.
overwrite (bool, optional) – If True will overwrite a file of the same name. Defaults to False.

Returns:

str – The file path for the downloaded file.