dstandish commented on a change in pull request #9677: URL: https://github.com/apache/airflow/pull/9677#discussion_r464133132
########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): + """ + Transfer files to Azure Blob Storage from SFTP server. + + :param sftp_source_path: The sftp remote path. This is the specified file path + for downloading the single file or multiple files from the SFTP server. + You can use only one wildcard within your path. The wildcard can appear + inside the path or at the end of the path. + :type sftp_source_path: str + :param container_name: Name of the container. + :type container_name: str + :param blob_name: Name of the blob. + :type blob_name: str + :param sftp_conn_id: The sftp connection id. The name or identifier for + establishing a connection to the SFTP server. + :type sftp_conn_id: str + :param wasb_conn_id: Reference to the wasb connection. + :type wasb_conn_id: str + :param load_options: Optional keyword arguments that + `WasbHook.load_file()` takes. + :type load_options: dict + :param move_object: When move object is True, the object is moved instead + of copied to the new location. This is the equivalent of a mv command + as opposed to a cp command. + :type move_object: bool + """ + template_fields = ("sftp_source_path", "container_name", "blob_name") + + @apply_defaults + def __init__( + self, + sftp_source_path: str, + container_name: str, + blob_name: str, + sftp_conn_id: str = "ssh_default", + wasb_conn_id: str = 'wasb_default', + load_options: Optional[dict] = None, + move_object: bool = False, + *args, + **kwargs + ) -> None: + super().__init__(*args, **kwargs) + + self.sftp_source_path = sftp_source_path + self.sftp_conn_id = sftp_conn_id + self.wasb_conn_id = wasb_conn_id + self.container_name = container_name + self.blob_name = blob_name + self.wasb_conn_id = wasb_conn_id + self.load_options = load_options if load_options is not None else {} + self.move_object = move_object + + def execute(self, + context: Optional[Dict[Any, Any]]) -> None: + """Upload a file from SFTP to Azure Blob Storage.""" + (sftp_hook, sftp_files) = self.get_sftp_files_map() Review comment: cleaner if you just put sftp hook under a `cached_property` then your method can just return a file list. and then you don't have to handle it in execute and pass it to other functions. ########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): Review comment: For this kind of operator, i think it's nice to implement `dry_run` ########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): + """ + Transfer files to Azure Blob Storage from SFTP server. + + :param sftp_source_path: The sftp remote path. This is the specified file path + for downloading the single file or multiple files from the SFTP server. + You can use only one wildcard within your path. The wildcard can appear + inside the path or at the end of the path. + :type sftp_source_path: str + :param container_name: Name of the container. + :type container_name: str + :param blob_name: Name of the blob. + :type blob_name: str + :param sftp_conn_id: The sftp connection id. The name or identifier for + establishing a connection to the SFTP server. + :type sftp_conn_id: str + :param wasb_conn_id: Reference to the wasb connection. + :type wasb_conn_id: str + :param load_options: Optional keyword arguments that + `WasbHook.load_file()` takes. + :type load_options: dict + :param move_object: When move object is True, the object is moved instead + of copied to the new location. This is the equivalent of a mv command + as opposed to a cp command. + :type move_object: bool + """ + template_fields = ("sftp_source_path", "container_name", "blob_name") + + @apply_defaults + def __init__( + self, + sftp_source_path: str, + container_name: str, + blob_name: str, + sftp_conn_id: str = "ssh_default", + wasb_conn_id: str = 'wasb_default', + load_options: Optional[dict] = None, + move_object: bool = False, + *args, + **kwargs + ) -> None: + super().__init__(*args, **kwargs) + + self.sftp_source_path = sftp_source_path + self.sftp_conn_id = sftp_conn_id + self.wasb_conn_id = wasb_conn_id + self.container_name = container_name + self.blob_name = blob_name + self.wasb_conn_id = wasb_conn_id + self.load_options = load_options if load_options is not None else {} + self.move_object = move_object + + def execute(self, + context: Optional[Dict[Any, Any]]) -> None: + """Upload a file from SFTP to Azure Blob Storage.""" + (sftp_hook, sftp_files) = self.get_sftp_files_map() + uploaded_files = self.upload_wasb(sftp_hook, sftp_files) Review comment: maybe clearer named `copy_files_to_wasb` ########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): + """ + Transfer files to Azure Blob Storage from SFTP server. + + :param sftp_source_path: The sftp remote path. This is the specified file path + for downloading the single file or multiple files from the SFTP server. + You can use only one wildcard within your path. The wildcard can appear + inside the path or at the end of the path. + :type sftp_source_path: str + :param container_name: Name of the container. + :type container_name: str + :param blob_name: Name of the blob. + :type blob_name: str + :param sftp_conn_id: The sftp connection id. The name or identifier for + establishing a connection to the SFTP server. + :type sftp_conn_id: str + :param wasb_conn_id: Reference to the wasb connection. + :type wasb_conn_id: str + :param load_options: Optional keyword arguments that + `WasbHook.load_file()` takes. + :type load_options: dict + :param move_object: When move object is True, the object is moved instead + of copied to the new location. This is the equivalent of a mv command + as opposed to a cp command. + :type move_object: bool + """ + template_fields = ("sftp_source_path", "container_name", "blob_name") + + @apply_defaults + def __init__( + self, + sftp_source_path: str, + container_name: str, + blob_name: str, + sftp_conn_id: str = "ssh_default", Review comment: should this not be `sftp_default`? ########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): + """ + Transfer files to Azure Blob Storage from SFTP server. + + :param sftp_source_path: The sftp remote path. This is the specified file path + for downloading the single file or multiple files from the SFTP server. + You can use only one wildcard within your path. The wildcard can appear + inside the path or at the end of the path. + :type sftp_source_path: str + :param container_name: Name of the container. + :type container_name: str + :param blob_name: Name of the blob. + :type blob_name: str + :param sftp_conn_id: The sftp connection id. The name or identifier for + establishing a connection to the SFTP server. + :type sftp_conn_id: str + :param wasb_conn_id: Reference to the wasb connection. + :type wasb_conn_id: str + :param load_options: Optional keyword arguments that + `WasbHook.load_file()` takes. + :type load_options: dict + :param move_object: When move object is True, the object is moved instead + of copied to the new location. This is the equivalent of a mv command + as opposed to a cp command. + :type move_object: bool + """ + template_fields = ("sftp_source_path", "container_name", "blob_name") + + @apply_defaults + def __init__( + self, + sftp_source_path: str, + container_name: str, + blob_name: str, + sftp_conn_id: str = "ssh_default", + wasb_conn_id: str = 'wasb_default', + load_options: Optional[dict] = None, + move_object: bool = False, + *args, + **kwargs + ) -> None: + super().__init__(*args, **kwargs) + + self.sftp_source_path = sftp_source_path + self.sftp_conn_id = sftp_conn_id + self.wasb_conn_id = wasb_conn_id + self.container_name = container_name + self.blob_name = blob_name + self.wasb_conn_id = wasb_conn_id + self.load_options = load_options if load_options is not None else {} + self.move_object = move_object + + def execute(self, + context: Optional[Dict[Any, Any]]) -> None: + """Upload a file from SFTP to Azure Blob Storage.""" + (sftp_hook, sftp_files) = self.get_sftp_files_map() + uploaded_files = self.upload_wasb(sftp_hook, sftp_files) + self.sftp_move(sftp_hook, uploaded_files) + + def get_sftp_files_map(self) -> Tuple[SFTPHook, List[Dict[str, str]]]: + """Get SFTP files from the source path, it may use a WILDCARD to this end.""" + sftp_files = [] + sftp_hook = SFTPHook(self.sftp_conn_id) + + if WILDCARD in self.sftp_source_path: + self.check_wildcards_limit() + + prefix, delimiter = self.sftp_source_path.split(WILDCARD, 1) + sftp_complete_path = os.path.dirname(prefix) + + found_files, _, _ = sftp_hook.get_tree_map( + sftp_complete_path, prefix=prefix, delimiter=delimiter + ) + + self.log.info( + "Found %s files at sftp source path: %s", + str(len(found_files)), + self.sftp_source_path + ) + + for file in found_files: + future_blob_name = os.path.basename(file) + sftp_files.append({SFTP_FILE_PATH: file, BLOB_NAME: future_blob_name}) + + else: + sftp_files.append({SFTP_FILE_PATH: self.sftp_source_path, BLOB_NAME: self.blob_name}) + + return sftp_hook, sftp_files + + def check_wildcards_limit(self) -> Any: + """Check if there is multiple Wildcard.""" + total_wildcards = self.sftp_source_path.count(WILDCARD) + if total_wildcards > 1: + raise AirflowException( + "Only one wildcard '*' is allowed in sftp_source_path parameter. " + "Found {} in {}.".format(total_wildcards, self.sftp_source_path) + ) + + def upload_wasb(self, + sftp_hook: SFTPHook, + sftp_files: List[Dict[str, str]]) -> List[str]: + """Upload a list of files from sftp_files to Azure Blob Storage with a new Blob Name.""" + uploaded_files = [] + wasb_hook = WasbHook(wasb_conn_id=self.wasb_conn_id) + for file in sftp_files: + + with NamedTemporaryFile("w") as tmp: + sftp_hook.retrieve_file(file[SFTP_FILE_PATH], tmp.name) + self.log.info( + 'Uploading %s to wasb://%s as %s', + file[SFTP_FILE_PATH], + self.container_name, + file[BLOB_NAME], + ) + wasb_hook.load_file(tmp.name, + self.container_name, + file[BLOB_NAME], + **self.load_options) + + uploaded_files.append(file[SFTP_FILE_PATH]) + + return uploaded_files + + def sftp_move(self, Review comment: this method doesn't move anything, it deletes. i think delete should be in name. e.g. `delete_sftp_files` and i would call it conditionally and delete always, rather than calling it always and having it delete conditionally ########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): + """ + Transfer files to Azure Blob Storage from SFTP server. + + :param sftp_source_path: The sftp remote path. This is the specified file path + for downloading the single file or multiple files from the SFTP server. + You can use only one wildcard within your path. The wildcard can appear + inside the path or at the end of the path. + :type sftp_source_path: str + :param container_name: Name of the container. + :type container_name: str + :param blob_name: Name of the blob. + :type blob_name: str + :param sftp_conn_id: The sftp connection id. The name or identifier for + establishing a connection to the SFTP server. + :type sftp_conn_id: str + :param wasb_conn_id: Reference to the wasb connection. + :type wasb_conn_id: str + :param load_options: Optional keyword arguments that + `WasbHook.load_file()` takes. + :type load_options: dict + :param move_object: When move object is True, the object is moved instead + of copied to the new location. This is the equivalent of a mv command + as opposed to a cp command. + :type move_object: bool + """ + template_fields = ("sftp_source_path", "container_name", "blob_name") + + @apply_defaults + def __init__( + self, + sftp_source_path: str, + container_name: str, + blob_name: str, + sftp_conn_id: str = "ssh_default", + wasb_conn_id: str = 'wasb_default', + load_options: Optional[dict] = None, + move_object: bool = False, + *args, + **kwargs + ) -> None: + super().__init__(*args, **kwargs) + + self.sftp_source_path = sftp_source_path + self.sftp_conn_id = sftp_conn_id + self.wasb_conn_id = wasb_conn_id + self.container_name = container_name + self.blob_name = blob_name + self.wasb_conn_id = wasb_conn_id + self.load_options = load_options if load_options is not None else {} + self.move_object = move_object + + def execute(self, + context: Optional[Dict[Any, Any]]) -> None: + """Upload a file from SFTP to Azure Blob Storage.""" + (sftp_hook, sftp_files) = self.get_sftp_files_map() + uploaded_files = self.upload_wasb(sftp_hook, sftp_files) + self.sftp_move(sftp_hook, uploaded_files) + + def get_sftp_files_map(self) -> Tuple[SFTPHook, List[Dict[str, str]]]: + """Get SFTP files from the source path, it may use a WILDCARD to this end.""" + sftp_files = [] + sftp_hook = SFTPHook(self.sftp_conn_id) + + if WILDCARD in self.sftp_source_path: + self.check_wildcards_limit() + + prefix, delimiter = self.sftp_source_path.split(WILDCARD, 1) + sftp_complete_path = os.path.dirname(prefix) + + found_files, _, _ = sftp_hook.get_tree_map( + sftp_complete_path, prefix=prefix, delimiter=delimiter + ) + + self.log.info( + "Found %s files at sftp source path: %s", + str(len(found_files)), + self.sftp_source_path + ) + + for file in found_files: + future_blob_name = os.path.basename(file) + sftp_files.append({SFTP_FILE_PATH: file, BLOB_NAME: future_blob_name}) Review comment: i recommend using dataclass or namedtuple instead ########## File path: airflow/providers/microsoft/azure/transfers/sftp_to_wasb.py ########## @@ -0,0 +1,166 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +This module contains SFTP to Azure Blob Storage operator. +""" +import os +from tempfile import NamedTemporaryFile +from typing import Any, Dict, List, Optional, Tuple + +from airflow.exceptions import AirflowException +from airflow.models import BaseOperator +from airflow.providers.microsoft.azure.hooks.wasb import WasbHook +from airflow.providers.sftp.hooks.sftp import SFTPHook +from airflow.utils.decorators import apply_defaults + +WILDCARD = "*" +SFTP_FILE_PATH = "SFTP_FILE_PATH" +BLOB_NAME = "BLOB_NAME" + + +class SFTPToWasbOperator(BaseOperator): + """ + Transfer files to Azure Blob Storage from SFTP server. + + :param sftp_source_path: The sftp remote path. This is the specified file path + for downloading the single file or multiple files from the SFTP server. + You can use only one wildcard within your path. The wildcard can appear + inside the path or at the end of the path. + :type sftp_source_path: str + :param container_name: Name of the container. + :type container_name: str + :param blob_name: Name of the blob. + :type blob_name: str + :param sftp_conn_id: The sftp connection id. The name or identifier for + establishing a connection to the SFTP server. + :type sftp_conn_id: str + :param wasb_conn_id: Reference to the wasb connection. + :type wasb_conn_id: str + :param load_options: Optional keyword arguments that + `WasbHook.load_file()` takes. + :type load_options: dict + :param move_object: When move object is True, the object is moved instead + of copied to the new location. This is the equivalent of a mv command + as opposed to a cp command. + :type move_object: bool + """ + template_fields = ("sftp_source_path", "container_name", "blob_name") + + @apply_defaults + def __init__( + self, + sftp_source_path: str, + container_name: str, + blob_name: str, Review comment: this is potentially confusing because when it is one file, `blob_name` is used but when you provide a wildcard, `blob_name` is ignored it might be better to have two classes for the distinct cases. e.g. if you look at the aws sftp to s3 operator, it's very simple and just does one file. in a second class tailored to the many files case, you could have more intuitive param names like `sftp_file_glob` and `blob_prefix` or, possibly `blob_name_mapper` which could take a function that maps sftp file path to blob name. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
