From 962dc0ba8ae04547b302ca90cf17023a80b7b8e6 Mon Sep 17 00:00:00 2001 From: Michael Rans Date: Tue, 25 Oct 2016 09:40:17 +0200 Subject: [PATCH] Add resource download function --- hdx/data/hdxobject.py | 4 ++-- hdx/data/resource.py | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/hdx/data/hdxobject.py b/hdx/data/hdxobject.py index a653b857..131293cb 100644 --- a/hdx/data/hdxobject.py +++ b/hdx/data/hdxobject.py @@ -84,7 +84,7 @@ def update_from_json(self, path: str): def _read_from_hdx(self, object_type: str, value: str, fieldname: Optional[str] = 'id', action: Optional[str] = None, - **kwargs) -> Union[Tuple[bool, dict], Tuple[bool, str]]: + **kwargs) -> Tuple[bool, Union[dict, str]]: """Makes a read call to HDX passing in given parameter. Args: @@ -95,7 +95,7 @@ def _read_from_hdx(self, object_type: str, value: str, fieldname: Optional[str] **kwargs: Other fields to pass to CKAN. Returns: - (bool, dict/str): (True/False, HDX object metadata/Error) + Tuple[bool, Union[dict, str]]: (True/False, HDX object metadata/Error) """ if not value: raise HDXError("Empty %s value!" % object_type) diff --git a/hdx/data/resource.py b/hdx/data/resource.py index 230ba2c8..92cf8ad7 100644 --- a/hdx/data/resource.py +++ b/hdx/data/resource.py @@ -5,7 +5,7 @@ import logging import os from os.path import join -from typing import Optional, List +from typing import Optional, List, Tuple from hdx.configuration import Configuration from hdx.utilities.downloader import download_file @@ -160,14 +160,14 @@ def delete_datastore(self) -> None: if not success: logger.debug(result) - def download(self, path: Optional[str] = None) -> (str, str): - """Download resource store in provided path or named temporary file if no path given + def download(self, path: Optional[str] = None) -> Tuple[str, str]: + """Download resource store to provided path or named temporary file if no path given Args: path (str): Path to download resource to. Defaults to None. Returns: - (str, str): (URL downloaded, Path of downloaded file) + Tuple[str, str]: (URL downloaded, Path to downloaded file) """ # Download the resource