curl_interface#

ioapps.curl_interface.get_webfile(url, path, local_filename=None, ignore_missing=False)[source]#

DESCRIPTION:

This function collects the specified URL path using the respective platform curl application executable.

Parameters:
url: str

A Python string specifying the path to the internet (world-wide web; WWW) file to be retrieved.

path: str

A Python string specifying the local path to which to write the retrieved file.

Keywords:
local_filename: str, optional

A Python string specifying the basename path to which the collected URL path is to be written; the respective (renamed) URL will be written to the directory in which the application was launched.

ignore_missing: bool, optional

A Python boolean valued variable specifying whether to ignore missing files (True) or raise a CurlInterfaceError exception for missing files (False).

Raises:
CurlInterfaceError:
  • raised if an exception is raised related to a missing URL path is encountered.

Return type:

None

ioapps.curl_interface.get_weblist(url, ext=None)[source]#

DESCRIPTION:

This function collects a list of files beneath the specified URL.

Parameters:
url: str

A Python string specifying the path to the internet (world-wide web; WWW) file to be retrieved.

Keywords:
ext: str, optional

A Python string specifying the web filename extension; if NoneType on entry the value defaults to to an empty string.

Returns:
weblist: List

A Python list containing the files beneath the specified URL.

Raises:
CurlInterfaceError:
  • raised if an Exception is encountered while attempting to compile a list of files beneath the specified URL.

Return type:

List