HaJunYoo opened a new pull request, #57713:
URL: https://github.com/apache/airflow/pull/57713
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
closes: #56134
Add `flatten_structure` parameter to `GCSToS3Operator` that removes
directory structure from transferred files, uploading only the filename to the
S3 destination path.
**Summary**
This PR adds a new `flatten_structure` parameter to the `GCSToS3Operator`
that allows users to upload files with only their filenames, removing the full
directory path structure.
**Use case/motivation**
Currently, `GCSToS3Operator` always preserves the full GCS object path
when uploading to S3. This makes it impossible to reorganize file structure
during transfer without creating intermediate buckets or complex workarounds.
**Example:**
```python
# Before (current behavior)
GCSToS3Operator(
gcs_bucket="my-bucket",
prefix="data/2025/01/15/file.parquet",
dest_s3_key="s3://target-bucket/processed/"
)
# Results in: s3://target-bucket/processed/data/2025/01/15/file.parquet
# After (with flatten_structure=True)
GCSToS3Operator(
gcs_bucket="my-bucket",
prefix="data/2025/01/15/file.parquet",
dest_s3_key="s3://target-bucket/processed/2025/01/15/",
flatten_structure=True
)
# Results in: s3://target-bucket/processed/2025/01/15/file.parquet
```
**Changes**
- Add flatten_structure parameter (default: False for backward
compatibility)
- Add _transform_file_path() method for path transformation logic
- Add duplicate filename detection and warning when files would overwrite
- Update file comparison logic to handle transformed paths
- Add comprehensive test coverage (5 new test cases)
- Update docstring with parameter documentation
**Test plan**
- Unit tests for _transform_file_path() method with various path patterns
- Integration tests for flatten_structure=True functionality
- Edge case tests for duplicate filename handling and warnings
- Backward compatibility tests ensuring existing behavior unchanged
- Parameter conflict tests (flatten_structure + keep_directory_structure)
- All existing tests continue to pass
**Backward compatibility**
This change is fully backward compatible:
- Default value is False, preserving existing behavior
- No changes to existing method signatures
- All existing tests pass without modification
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
