def download(self, remotefile: str, localfile: str = None) -> bool:
"""Download file from FTP server
:param remotefile: path to remote file on the server
:param localfile: name of the downloaded file on the local filesystem,
if `None` will have same name as remote file
"""
if self.instance is None:
raise FTPException("No FTP connection")
try:
cmd = f"RETR {remotefile}"
if localfile is None:
localfile = remotefile
with open(localfile, "wb") as filepath:
self.instance.retrbinary(cmd, filepath.write, 1024)
notebook_file(localfile)
return True
except FileNotFoundError as e:
self.logger.warning(str(e))
return False
except error_perm as e:
self.logger.warning(str(e))
os.unlink(localfile)
return False
except all_errors as e:
raise FTPException from e
def _create_or_overwrite_target_file(
self,
path: str,
content: Any,
binary: bool,
overwrite: bool,
) -> None:
Path(path).parent.mkdir(parents=True, exist_ok=True)
if binary:
self.fs.create_binary_file(path, content, overwrite)
else:
self.fs.create_file(path, content, overwrite)
notebook_file(path)
def http_get(
self,
url: str,
target_file: str = None,
binary: bool = True,
verify: bool = True,
force_new_session: bool = False,
overwrite: bool = False,
) -> dict:
"""
A helper method for ``Get Request`` that will create a session, perform GET
request, and store the target file, if set by the ``target_file`` parameter.
The old session will be used if the URL scheme and the host are the same as
previously, e.g., 'https://www.google.fi' part of the URL.
``url`` target URL for GET request
``target_file`` filepath to save request content, default ``None``
``binary`` if file is saved as binary, default ``True``
``verify`` if SSL verification should be done, default ``True``
``force_new_session`` if new HTTP session should be created, default ``False``
``overwrite`` used together with ``target_file``, if ``True`` will overwrite
the target file, default ``False``
Returns request response.
"""
uc = urlparse(url)
http_host = f"{uc.scheme}://{uc.netloc}"
request_alias = f"{self.session_alias_prefix}{uc.scheme}{uc.netloc}"
url_path = url.replace(http_host, "")
if force_new_session or not self.session_exists(request_alias):
self.logger.info("Creating a new HTTP session")
self.create_session(request_alias, http_host, verify=verify)
else:
self.logger.info("Using already existing HTTP session")
self.current_session_alias = request_alias
response = self.get_request(request_alias, url_path)
if target_file is not None:
self._create_or_overwrite_target_file(target_file,
response.content, binary,
overwrite)
notebook_file(target_file)
return response
def _create_or_overwrite_target_file(
self,
path: str,
response: Any,
overwrite: bool,
) -> None:
CHUNK_SIZE = 32768
Path(path).parent.mkdir(parents=True, exist_ok=True)
file_exists = Path(path).is_file()
if not file_exists or (file_exists and overwrite):
with open(path, "wb") as f:
for chunk in response.iter_content(CHUNK_SIZE):
if chunk: # filter out keep-alive new chunks
f.write(chunk)
notebook_file(path)
def download(
self,
url: str,
target_file: str = None,
binary: bool = True,
verify: bool = True,
force_new_session: bool = False,
overwrite: bool = False,
) -> dict:
"""An alias for the ``HTTP Get`` keyword.
The difference in use is that the URL is always downloaded based on
the URL path (even without ``target_file``). If there is a filename
in the path, then that is used as ``target_file`` to save to. By default,
the filename will be "downloaded.html".
``url`` target URL for GET request
``target_file`` filepath to save request content, default ``None``
``binary`` if file is saved as binary, default ``True``
``verify`` if SSL verification should be done, default ``True``
``force_new_session`` if new HTTP session should be created, default ``False``
``overwrite`` used together with ``target_file``, if ``True`` will overwrite
the target file, default ``False``
"""
response = self.http_get(url, target_file, binary, verify,
force_new_session, overwrite)
if target_file is None:
uc = urlparse(url)
target = uc.path.rsplit("/", 1)[-1]
if not target:
target = "downloaded.html"
self._create_or_overwrite_target_file(target, response.content,
binary, overwrite)
notebook_file(target)
return response
