Source code for datafind.utils

import os
from urllib.parse import urlparse, unquote
from requests_pelican import PelicanAdapter
from igwn_auth_utils import Session
import shutil

import requests



[docs]
def download_file(url, directory="frames", name=None):
    """
    Download a file from a URL.

    Parameters
    ----------
    url : str
      The URL of the file to be downloaded.
    name: str, optional
      The name the file should be saved as.
      Defaults to the name of the file on the remote resource.
    directory : str, optional
      The name of the directory in which to store the
      downloaded file. Defaults to "frames".
    """
    os.makedirs(directory, exist_ok=True)
    parsed_url = urlparse(url)
    if not name:
        local_filename = os.path.basename(parsed_url.path)
    else:
        local_filename = name

    if not os.path.exists(os.path.join(directory, local_filename)):
                
        if parsed_url.scheme == "file":
            shutil.copyfile(url[16:], os.path.join(directory, local_filename))
        elif parsed_url.scheme == "osdf":
            with Session() as sess:
                sess.mount("osdf://", PelicanAdapter("osdf"))
                with sess.get(url, stream=True,  token_scope="read:/ligo read:/virgo read:/kagra read:/frames read:/shared") as r:
                    with open(os.path.join(directory, local_filename), "wb") as f:
                        shutil.copyfileobj(r.raw, f)

        else:
            with requests.get(url, stream=True) as r:
                with open(os.path.join(directory, local_filename), "wb") as f:
                    shutil.copyfileobj(r.raw, f)

    return local_filename